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(di): fix intercept stored token on context.target #2940

Merged
merged 1 commit into from
Dec 13, 2024

Conversation

Romakita
Copy link
Collaborator

@Romakita Romakita commented Dec 13, 2024

Summary by CodeRabbit

  • New Features

    • Enhanced test coverage for the MyInterceptor class to verify context identification.
    • Adjusted interceptor context to improve interaction with target classes.
  • Bug Fixes

    • Improved handling of method invocation context within interceptors.
  • Tests

    • Expanded tests for method interception and error handling to include new assertions.

Copy link

coderabbitai bot commented Dec 13, 2024

Walkthrough

The pull request introduces enhancements to the intercept.spec.ts and intercept.ts files within the interceptor framework. The intercept.spec.ts file has been updated to include new imports and additional assertions in the MyInterceptor class to improve test coverage. In intercept.ts, the bindIntercept function has been modified to change the context.target reference, which may affect the interceptor's interaction with target classes. Overall, the changes focus on enhancing functionality and testing without altering any exported or public entity declarations.

Changes

File Path Change Summary
packages/di/src/common/decorators/intercept.spec.ts Added new imports and enhanced the MyInterceptor class with a new expectation to verify context names.
packages/di/src/common/decorators/intercept.ts Modified the bindIntercept function to change the context.target reference and updated invokeOpts.

Possibly related PRs

  • feat(di): add support chain interceptor on the same method #2915: The changes in this PR involve modifications to the intercept.spec.ts file and the bindIntercept function in intercept.ts, which are directly related to the enhancements made in the main PR regarding the MyInterceptor class and its testing. Both PRs focus on improving the functionality and testing of interceptors within the same framework.

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

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

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 53a5140 and 31d1f52.

📒 Files selected for processing (2)
  • packages/di/src/common/decorators/intercept.spec.ts (2 hunks)
  • packages/di/src/common/decorators/intercept.ts (1 hunks)
🔇 Additional comments (2)
packages/di/src/common/decorators/intercept.ts (1)

32-32: LGTM: Correct fix for context.target reference

The change from target to klass is the right fix as it ensures the interceptor context receives the actual class constructor instead of the prototype. This aligns with the expected behavior where interceptors should have access to the service class itself.

packages/di/src/common/decorators/intercept.spec.ts (1)

Line range hint 32-32: Verify other usages of context.target

Let's verify that this change doesn't affect other parts of the codebase that might rely on context.target.

✅ Verification successful

Based on the search results, I can now generate the final response:

No breaking changes detected in context.target usage

The search results show that context.target is used consistently across the codebase:

  • In documentation examples for error handling
  • In platform cache interceptor for:
    • Endpoint checks
    • Logging
    • Cache key generation
  • In the test file itself for name verification

All these usages are compatible with the current implementation and don't show any potential issues.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for other usages of context.target to ensure compatibility
rg -A 3 "context\.target" --type ts

Length of output: 2085

@@ -13,6 +13,8 @@ class MyInterceptor implements InterceptorMethods {
const r = typeof context.args[0] === "string" ? undefined : new Error(`Error message`);
const retValue = context.next(r);

expect(nameOf(context.target)).toContain("Service");
Copy link

Choose a reason for hiding this comment

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

🧹 Nitpick (assertive)

Consider a more precise assertion for context.target

While checking for "Service" works, it would be more robust to verify the exact class name matches the expected service class.

Consider updating the assertion to be more specific:

-expect(nameOf(context.target)).toContain("Service");
+expect(nameOf(context.target)).toBe("ServiceTest");

Committable suggestion skipped: line range outside the PR's diff.

@Romakita Romakita merged commit 8f407cb into production Dec 13, 2024
12 checks passed
@Romakita Romakita deleted the fix-di-interceptor-target branch December 13, 2024 15:05
@Romakita
Copy link
Collaborator Author

🎉 This PR is included in version 8.3.4 🎉

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.

2 participants