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(swagger): avoid join error issue by return default string value when import.meta.dirname isn't available #2966

Merged
merged 1 commit into from
Jan 18, 2025

Conversation

Romakita
Copy link
Collaborator

@Romakita Romakita commented Jan 18, 2025

fix issue with jest

Summary by CodeRabbit

  • Chores
    • Updated directory path resolution mechanism to improve robustness and flexibility when retrieving root directory information.

Copy link

coderabbitai bot commented Jan 18, 2025

Walkthrough

The pull request modifies the ROOT_DIR constant in the packages/specs/swagger/src/constants.ts and packages/specs/scalar/src/constants.ts files. The changes involve replacing the direct use of import.meta.dirname with a more flexible approach using getValue() from @tsed/core. This modification allows for a safer extraction of the directory path by providing a default empty string if the dirname property is not available.

Changes

File Change Summary
packages/specs/swagger/src/constants.ts
packages/specs/scalar/src/constants.ts
- Updated ROOT_DIR constant to use getValue(import.meta, "dirname", "") instead of direct import.meta.dirname

Sequence Diagram

sequenceDiagram
    participant Code as Source Code
    participant getValue as getValue() Function
    participant ImportMeta as import.meta
    
    Code->>getValue: Call with import.meta, "dirname", ""
    getValue->>ImportMeta: Safely retrieve "dirname"
    getValue-->>Code: Return directory path or empty string
Loading

The sequence diagram illustrates how the getValue() function is used to safely extract the directory path from import.meta, providing a fallback empty string if the dirname property is not found.

Possibly related PRs

  • fix(prisma): change usr/bin/env ts-node by node #2929: This PR modifies the way the ROOT_DIR constant is defined in a similar manner to the main PR, changing the method of obtaining the directory path from a direct property access to a function call, although it is in a different file.

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between e2a5c09 and be110d9.

📒 Files selected for processing (2)
  • packages/specs/scalar/src/constants.ts (1 hunks)
  • packages/specs/swagger/src/constants.ts (1 hunks)
🧰 Additional context used
🪛 Biome (1.9.4)
packages/specs/scalar/src/constants.ts

[error] 2-2: A Node.js builtin module should be imported with the node: protocol.

Using the node: protocol is more explicit and signals that the imported module belongs to Node.js.
Unsafe fix: Add the node: protocol.

(lint/style/useNodejsImportProtocol)

⏰ Context from checks skipped due to timeout of 90000ms (9)
  • GitHub Check: test-third-parties (20.12.2)
  • GitHub Check: test-security (20.12.2)
  • GitHub Check: test-orm (20.12.2)
  • GitHub Check: test-graphql (20.12.2)
  • GitHub Check: test-specs (20.12.2)
  • GitHub Check: test-platform (20.12.2)
  • GitHub Check: test-core (20.12.2)
  • GitHub Check: lint (20.12.2)
  • GitHub Check: CodeQL-Build
🔇 Additional comments (4)
packages/specs/scalar/src/constants.ts (2)

4-4: LGTM! Robust solution for handling undefined dirname.

The use of getValue with a default empty string is a good defensive programming approach that prevents join errors when import.meta.dirname is unavailable.


1-1: 🧹 Nitpick (assertive)

Consider using the node: protocol for the path import.

For better clarity and explicit Node.js module identification, consider updating the path import.

-import {join} from "path";
+import {join} from "node:path";

Likely invalid or redundant comment.

packages/specs/swagger/src/constants.ts (2)

1-4: LGTM! Well-organized imports.

Good job on:

  • Using the node: protocol for the path import
  • Maintaining clear separation between built-in and package imports

7-7: LGTM! Consistent implementation across packages.

The implementation matches the scalar package, ensuring consistent and safe handling of import.meta.dirname across the codebase.

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.

@Romakita
Copy link
Collaborator Author

Romakita commented Jan 18, 2025

fix #2965

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: 2

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 4b7592d and e2a5c09.

📒 Files selected for processing (1)
  • packages/specs/swagger/src/constants.ts (1 hunks)
🧰 Additional context used
🪛 Biome (1.9.4)
packages/specs/swagger/src/constants.ts

[error] 2-2: A Node.js builtin module should be imported with the node: protocol.

Using the node: protocol is more explicit and signals that the imported module belongs to Node.js.
Unsafe fix: Add the node: protocol.

(lint/style/useNodejsImportProtocol)

⏰ Context from checks skipped due to timeout of 90000ms (9)
  • GitHub Check: test-third-parties (20.12.2)
  • GitHub Check: test-specs (20.12.2)
  • GitHub Check: test-security (20.12.2)
  • GitHub Check: test-platform (20.12.2)
  • GitHub Check: test-graphql (20.12.2)
  • GitHub Check: test-orm (20.12.2)
  • GitHub Check: test-core (20.12.2)
  • GitHub Check: lint (20.12.2)
  • GitHub Check: CodeQL-Build

packages/specs/swagger/src/constants.ts Outdated Show resolved Hide resolved
packages/specs/swagger/src/constants.ts Show resolved Hide resolved
…hen import.meta.dirname isn't available

fix issue with jest
@Romakita Romakita force-pushed the fix-import-meta-dirname-issue-jest branch from e2a5c09 to be110d9 Compare January 18, 2025 08:52
@Romakita Romakita merged commit 05846e2 into production Jan 18, 2025
12 checks passed
@Romakita Romakita deleted the fix-import-meta-dirname-issue-jest branch January 18, 2025 08:58
@Romakita
Copy link
Collaborator Author

🎉 This PR is included in version 8.4.3 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant