Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: loadFile ignore ts extend on readFileSync #294

Merged
merged 1 commit into from
Feb 16, 2025
Merged

Conversation

fengmk2
Copy link
Member

@fengmk2 fengmk2 commented Feb 16, 2025

eggjs/tegg#283

Summary by CodeRabbit

  • Bug Fixes
    • Updated the file loading functionality to properly differentiate TypeScript files from other file types. This modification prevents unintended processing behavior for TypeScript content, ensuring more reliable file operations and enhancing overall stability in handling various file formats.

Copy link

coderabbitai bot commented Feb 16, 2025

Walkthrough

The loadFile method in src/utils/index.ts has been updated. The change involves modifying the conditional check for the file extension. The new logic adds an extra condition to ensure files with the .ts extension are not processed as a buffer. Aside from this adjustment, the error handling and overall control flow remain unchanged.

Changes

File(s) Change Summary
src/utils/index.ts Modified loadFile logic to add a condition that excludes .ts files from being read as a buffer

Sequence Diagram(s)

sequenceDiagram
    participant Caller as Caller
    participant LoadFile as loadFile
    participant ExtCheck as Extension Check
    participant FileRead as File Read Logic

    Caller->>LoadFile: Call loadFile(filepath)
    LoadFile->>ExtCheck: Check if file extension is in allowed list
    ExtCheck-->>LoadFile: Return result
    alt File has .ts extension
        LoadFile->>Caller: Process file without buffer read
    else File is not .ts
        LoadFile->>FileRead: Read file as buffer
        FileRead-->>LoadFile: Return file data
        LoadFile->>Caller: Return file data
    end
Loading

Poem

In a burrow of code, I hop along,
Tweaking conditions, making changes strong.
.ts files now skip the buffer dance,
Logic refined for a smoother advance.
With every line, my whiskers twitch in delight,
Celebrating code that runs just right! 🐰

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.

src/utils/index.ts

Oops! Something went wrong! :(

ESLint: 8.57.1

ESLint couldn't find the plugin "eslint-plugin-eggache".

(The package "eslint-plugin-eggache" was not found when loaded as a Node module from the directory "".)

It's likely that the plugin isn't installed correctly. Try reinstalling by running the following:

npm install eslint-plugin-eggache@latest --save-dev

The plugin "eslint-plugin-eggache" was referenced from the config file in ".eslintrc » eslint-config-egg/typescript » ./index.js".

If you still can't figure out the problem, please stop by https://eslint.org/chat/help to chat with the team.

✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 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.
    • Generate unit testing code for this file.
    • 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 generate unit testing code for this file.
    • @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 generate unit testing code.
    • @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.

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. (Beta)
  • @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

pkg-pr-new bot commented Feb 16, 2025

Open in Stackblitz

npm i https://pkg.pr.new/eggjs/core/@eggjs/core@294

commit: 56c4a0e

Copy link

codecov bot commented Feb 16, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.46%. Comparing base (fa25d57) to head (56c4a0e).
Report is 2 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #294   +/-   ##
=======================================
  Coverage   97.46%   97.46%           
=======================================
  Files          11       11           
  Lines        3548     3548           
  Branches      631      631           
=======================================
  Hits         3458     3458           
  Misses         90       90           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link

@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: 0

🧹 Nitpick comments (1)
src/utils/index.ts (1)

81-81: Consider adding a comment explaining the TypeScript handling.

For better maintainability, consider adding a comment explaining why TypeScript files need special handling:

      // if not js module, just return content buffer
      const extname = path.extname(filepath);
+     // Ensure TypeScript files are imported properly instead of being read as raw buffers
      if (extname && !extensionNames.includes(extname) && extname !== '.ts') {
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 799d37f and 56c4a0e.

📒 Files selected for processing (1)
  • src/utils/index.ts (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (14)
  • GitHub Check: Node.js / Test (windows-latest, 23)
  • GitHub Check: Node.js / Test (windows-latest, 22)
  • GitHub Check: Node.js / Test (windows-latest, 20)
  • GitHub Check: Node.js / Test (windows-latest, 18.19.0)
  • GitHub Check: Node.js / Test (windows-latest, 18)
  • GitHub Check: Node.js / Test (ubuntu-latest, 23)
  • GitHub Check: Node.js / Test (ubuntu-latest, 22)
  • GitHub Check: Node.js / Test (ubuntu-latest, 20)
  • GitHub Check: Node.js / Test (ubuntu-latest, 18.19.0)
  • GitHub Check: Node.js / Test (macos-latest, 18.19.0)
  • GitHub Check: Node.js / Test (ubuntu-latest, 18)
  • GitHub Check: Node.js / Test (macos-latest, 22)
  • GitHub Check: Node.js / Test (macos-latest, 20)
  • GitHub Check: Node.js / Test (macos-latest, 18)
🔇 Additional comments (1)
src/utils/index.ts (1)

81-81: LGTM! Fix ensures TypeScript files are properly imported.

The change correctly ensures that TypeScript files are not read as raw buffers via readFileSync, but instead are properly imported using importModule. This fixes the handling of TypeScript files that were previously being treated as non-JS modules.

@fengmk2 fengmk2 merged commit 1cf0a53 into master Feb 16, 2025
24 checks passed
@fengmk2 fengmk2 deleted the fix-loadFile branch February 16, 2025 17:18
fengmk2 pushed a commit that referenced this pull request Feb 16, 2025
[skip ci]

## [6.3.2](v6.3.1...v6.3.2) (2025-02-16)

### Bug Fixes

* loadFile ignore ts extend on readFileSync ([#294](#294)) ([1cf0a53](1cf0a53))
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.

1 participant