Skip to content

fix: the new FileLoader did not implement fallback correctly [sc-24179]#1073

Merged
sorccu merged 1 commit intomainfrom
simokinnunen/sc-24179/cli-fix-mixedfileloader-fallback
May 21, 2025
Merged

fix: the new FileLoader did not implement fallback correctly [sc-24179]#1073
sorccu merged 1 commit intomainfrom
simokinnunen/sc-24179/cli-fix-mixedfileloader-fallback

Conversation

@sorccu
Copy link
Member

@sorccu sorccu commented May 21, 2025

This would cause the loader to fail if Jiti could not be found, or an earlier version of Jiti was used.

The reason why I did not spot this earlier is that during manual testing, I used a symlink to the checkly package, which led to Node finding the appropriate version of jiti in the checkly-cli repo (or in other words, from the node_modules folder relative to the actual file behind the symlink). So it seemed to work, but in fact did not. I have now correctly verified both the issue and the fix with npm pack and using the generated archive instead.

Affected Components

  • CLI
  • Create CLI
  • Test
  • Docs
  • Examples
  • Other

Notes for the Reviewer

Resolves #[issue-number]

New Dependency Submission

This would cause the loader to fail if Jiti could not be found, or an earlier
version of Jiti was used.
@coderabbitai
Copy link
Contributor

coderabbitai bot commented May 21, 2025

Walkthrough

The loadFile method in the MixedFileLoader class was updated to correctly await asynchronous loader calls. Handling of UnsupportedFileLoaderError was improved by removing the failing loader from the set and explicitly continuing the loop, ensuring all loaders are tried as intended.

Changes

File(s) Change Summary
packages/cli/src/loader/mixed.ts Refactored loadFile to properly await loader calls, handle UnsupportedFileLoaderError by removing loaders, and explicitly continue the loop.

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

npm warn config production Use --omit=dev instead.
npm error Exit handler never called!
npm error This is an error with npm itself. Please report this error at:
npm error https://github.com/npm/cli/issues
npm error A complete log of this run can be found in: /.npm/_logs/2025-05-21T09_44_04_725Z-debug-0.log

✨ Finishing Touches
  • 📝 Generate Docstrings

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b15a6f2 and 9991969.

📒 Files selected for processing (1)
  • packages/cli/src/loader/mixed.ts (1 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (1)
packages/cli/src/loader/mixed.ts (1)
packages/cli/src/loader/loader.ts (1)
  • UnsupportedFileLoaderError (37-42)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: test - windows-latest
  • GitHub Check: test - ubuntu-latest
🔇 Additional comments (1)
packages/cli/src/loader/mixed.ts (1)

24-45: Approve the fixed fallback implementation

The changes correctly address the issue described in the PR objectives. By properly awaiting the asynchronous loader calls and ensuring the loop continues to try other loaders after removing a failing one, the fallback mechanism now works as intended even when certain loaders fail.

@sorccu sorccu merged commit 02c9a3b into main May 21, 2025
4 checks passed
@sorccu sorccu deleted the simokinnunen/sc-24179/cli-fix-mixedfileloader-fallback branch May 21, 2025 09:51
sorccu added a commit that referenced this pull request May 21, 2025
This would cause the loader to fail if Jiti could not be found, or an earlier
version of Jiti was used.
@geoffharcourt
Copy link

Thanks! We have a failure we suspect was caused by the prior change and will be fixed by this PR.

@sorccu
Copy link
Member Author

sorccu commented May 22, 2025

Sorry about that @geoffharcourt. I certainly do not take breaking stuff lightly but in this case it managed to pass through. We need a new test suite to properly test the loader.

Note that release 5.4.1 includes this fix.

@geoffharcourt
Copy link

Already in use, thanks!

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