openedx / openedx/frontend-base
Improve `getResolvedSiteConfigPath` error message logic
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 4
- Forks
- 13
- Avg merge
- 3h 21m
- Merged PRs (30d)
- 10
Description
When SITE_CONFIG_PATH is set but invalid, it silently falls through to try the default path instead of erroring immediately.
This means for the following flows:
SITE_CONFIG_PATH defined |
SITE_CONFIG_PATH exists |
defaultPath exists |
Result |
|---|---|---|---|
| ✅ | ✅ | N/A | No error. Site config path returned. |
| ✅ | ❌ | ✅ | No error. Default path returned. |
| ✅ | ❌ | ❌ | Error saying env var path is invalid, no mention of default path. |
| ❌ | ❌ | ✅ | No error. Default path returned. |
| ❌ | ❌ | ❌ | Error saying default path is invalid. |
The main issue here is that the error messaging doesn't accurately reflect what's happening. No mention of falling back to the default path, and only showing the env var error message when both the env var path and the default path are invalid.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start in tools/webpack/utils/getResolvedSiteConfigPath.ts at the linked lines and trace how SITE_CONFIG_PATH and defaultPath are checked. Compare the current behavior with each case in the issue table, then verify that the selected path and error message match those outcomes.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- build-system
- Issue type
- Bug
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 72/100