Skip to content

maintain proper context in metadata.root and parent getters #1917

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
Apr 17, 2025
Merged

maintain proper context in metadata.root and parent getters #1917

merged 2 commits into from
Apr 17, 2025

Conversation

CodeMan62
Copy link
Contributor

@CodeMan62 CodeMan62 commented Apr 11, 2025 •
edited by coderabbitai bot
Loading

maintain proper context in metadata.root and parent getters

Closes #1904

✅ Checklist

  • I have followed every step in the contributing guide
  • The PR title follows the convention.
  • I ran and tested the code works

Testing

Created several test cases to validate the fix:

  • Created a simple test that demonstrates the issue by showing how this-binding works in class methods
  • Verified that our fix properly maintains context when methods are chained
  • Confirmed that metadata operations are correctly captured regardless of where they're called from

Changelog

Fixed an issue where metadata.root.set() and similar methods would fail when used inside JavaScript classes. The fix properly maintains context when chaining method calls by storing local references to return objects instead of using this.root and this.parent.

Screenshots

N/A - This is an internal API fix with no visual changes.

Summary by CodeRabbit

  • Refactor
    • Improved internal metadata update operations for more consistent method chaining and context handling.
    • No changes to public functionality—users will experience the same behavior with enhanced reliability.

@changeset-bot changeset-bot
Copy link

changeset-bot bot commented Apr 11, 2025 •
edited
Loading

🦋 Changeset detected

Latest commit: b1009ea

The changes in this PR will be included in the next version bump.

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Apr 11, 2025 •
edited
Loading

Caution

Review failed

The pull request is closed.

"""

Walkthrough

The pull request refactors the implementations of the getter methods in both the StandardMetadataManager and NoopRunMetadataManager classes. Local variables are now used to capture the context previously accessed via this, ensuring consistent behavior in the updater objects. Methods such as set, update, and stream now return locally defined updater objects for proper method chaining. The underlying functionality remains unchanged, with improvements in context management and internal clarity.

Changes

Files Change Summary
packages/core/.../runMetadata/manager.ts Refactored StandardMetadataManager: Introduced local variable self and local updater objects (parentUpdater, rootUpdater) for context management in getters; updated the stream method to use self.doStream.
packages/core/.../runMetadata/noopManager.ts Refactored NoopRunMetadataManager: Utilized local updater objects in parent and root getters; updated the update method to return the local updater; added clarifying comments to support the context changes.

Sequence Diagram(s)

sequenceDiagram
  participant Client
  participant Manager as MetadataManager
  participant Updater as RunMetadataUpdater

  Client->>Manager: Invoke getter (root/parent)
  Manager-->>Client: Return updater (using local self & updater variable)
  Client->>Updater: Call set/update method
  Updater->>Manager: Append operation using local context
  Updater-->>Client: Return updater for chaining
  Client->>Updater: Invoke stream
  Updater->>Manager: Execute stream via self.doStream
  Manager-->>Updater: Return stream result
Loading

Assessment against linked issues

Objective Addressed Explanation
[TRI-5140] The metadata.set function doesn't work when used inside a JS class ([#1904]) ✅

Possibly related PRs

Poem

I'm a bunny in the code, swift and bright,
Hoping through updates with all my might,
Local self guides each hop and play,
Chain calls bounce in a clear, new way,
Carrots of context, crisp and true—
My rabbit code sings a revamped view! 🐰
"""

Tip

⚡💬 Agentic Chat (Pro Plan, General Availability)
  • We're introducing multi-step agentic chat in review comments and issue comments, within and outside of PR's. This feature enhances review and issue discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments and add commits to existing pull requests.
📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between aa79918 and b1009ea.

📒 Files selected for processing (1)
  • .changeset/two-tigers-dream.md (1 hunks)
🪧 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.
  • @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.

@ericallam ericallam merged commit e0fd064 into triggerdotdev:main Apr 17, 2025
5 of 7 checks passed
@github-actions github-actions bot mentioned this pull request Apr 17, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ericallam ericallam ericallam approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[TRI-5140] The metadata.set function doesn't work when used inside a JS class
2 participants
@CodeMan62 @ericallam