Skip to content

Improve roadmap troubleshooting docs and clarify session/auth error messages#23

Merged
erseco merged 3 commits intomainfrom
copilot/implement-roadmap-task
Mar 16, 2026
Merged

Improve roadmap troubleshooting docs and clarify session/auth error messages#23
erseco merged 3 commits intomainfrom
copilot/implement-roadmap-task

Conversation

Copy link
Contributor

Copilot AI commented Mar 16, 2026

This takes a small roadmap item from Phase C: improve exception clarity and troubleshooting guidance. It makes common auth/session failures easier to diagnose and documents the current unit-vs-integration test workflow in one place.

  • Error messages

    • Reworded high-friction failures to point at the likely remediation path instead of surfacing generic errors.
    • Updated:
      • LoginError for invalid credentials
      • missing sesskey after login
      • missing webservice token / sesskey in MoodleSession
      • tokenless webservice calls
      • course listing without token or sesskey
  • Troubleshooting documentation

    • Added docs/troubleshooting.md with targeted guidance for:
      • invalid login / CAS setup issues
      • missing token or sesskey
      • course-listing credential failures
      • integration test configuration and local environment issues
    • Linked the new page into MkDocs navigation.
  • Contributor guidance

    • Updated docs/development.md to reflect the current test-layer split:
      • tests/unit/ for fast Moodle-free smoke tests
      • integration tests opt-in via --integration
    • Added concise troubleshooting notes for common test setup failures.
  • Focused regression coverage

    • Added unit tests for the revised user-facing error wording to keep the new diagnostics stable.

Example of the new messaging shape:

raise LoginError(
    "Moodle login failed: invalid username or password. "
    "Verify MOODLE_USERNAME and MOODLE_PASSWORD, and enable CAS "
    "login if your site requires single sign-on."
)
  • Docs preview
    • Added a dedicated troubleshooting page to the docs site.

Troubleshooting docs preview


🔒 GitHub Advanced Security automatically protects Copilot coding agent pull requests. You can protect all pull requests by enabling Advanced Security for your repositories. Learn more about Advanced Security.

Copilot AI and others added 2 commits March 16, 2026 13:22
Co-authored-by: erseco <1876752+erseco@users.noreply.github.com>
Co-authored-by: erseco <1876752+erseco@users.noreply.github.com>
Copilot AI changed the title [WIP] Add implementation for task from roadmap Improve roadmap troubleshooting docs and clarify session/auth error messages Mar 16, 2026
Copilot AI requested a review from erseco March 16, 2026 13:25
@erseco erseco marked this pull request as ready for review March 16, 2026 13:33
@erseco erseco merged commit 792cf8c into main Mar 16, 2026
13 checks passed
@erseco erseco deleted the copilot/implement-roadmap-task branch March 16, 2026 13:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants