Discover Moodle folder contents with bounded read-only traversal

Open
  • Is something wrong?
#37 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
45/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Active
Tech stack
javascript, node.js
Domain
api, backend

Research direction

Read AGENTS.md and docs/PROJECT_CONTEXT.md, then trace discovery through src/sections.js and src/resources.js, with src/pdf-resource.js as a resource handling reference. Inspect the existing authorization, safe-error, and synthetic-fixture patterns in test/. Add bounded, read-only folder traversal that meets the listed route, coverage, and safety criteria; run the relevant offline tests and checks, and report anything not run.

Written by the indexing model from the issue text.

Description

area:backend area:docs help wanted priority:medium type:feature

Part of #28 · Target: Discovery / v0.2

Goal and scope

Read discovered same-course folder modules; normalize nested resource identity and expose inaccessible/unsupported items. Validate every supported file/child route before fetching and carry provenance/coverage to consumers.

Implementation starting points

src/sections.js, src/resources.js, src/pdf-resource.js, test/. Follow AGENTS.md and docs/PROJECT_CONTEXT.md; reuse existing authorization, safe-error and synthetic-fixture patterns. New runtime dependencies need a documented reason.

Dependencies and readiness

Ready to discuss/start independently against current master.

Out of scope

No bulk download, arbitrary pluginfile paths, external origins or changing folder content.

Acceptance criteria and test plan

Synthetic nested folders, duplicate/cyclic links, denied items, unsafe redirects and count/depth/time limits return each supported item once. Existing discovery/reader authorization remains intact and missing content is explicitly partial.

Run the relevant offline tests, npm run check and git diff --check; runtime changes also require npm test and npm audit. Report checks not run. No faculty credentials or private course material are required for a contribution.

Contributing

Comment here before starting so the maintainer can coordinate the approach and avoid duplicate work. Fork the repository, branch from master, and open a focused PR referencing this issue. No assignee or delivery deadline is set; required checks and review apply.

Dominant language
JavaScript
Stars
0
Forks
0
Avg merge
1h 25m
Merged PRs (30d)
13

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from mahmutmft/courses-mcp

All issues in mahmutmft/courses-mcp

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.