Skip to content

Add individual run ids to auto-generated public access token when calling batchTrigger #1449

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

Merged
merged 1 commit into from
Nov 1, 2024

Conversation

ericallam
Copy link
Member

@ericallam ericallam commented Nov 1, 2024

Summary by CodeRabbit

  • New Features

    • Enhanced public access tokens now include individual run IDs for better tracking during batch operations.
    • Improved JWT generation with expanded scopes for granular permission control based on batch runs.
  • Bug Fixes

    • Maintained error handling for run results, ensuring consistent behavior for 404 errors.

Copy link

changeset-bot bot commented Nov 1, 2024

🦋 Changeset detected

Latest commit: bee9d76

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

This PR includes changesets to release 10 packages
Name Type
@trigger.dev/core Patch
@trigger.dev/build Patch
trigger.dev Patch
@trigger.dev/sdk Patch
@internal/redis-worker Patch
@internal/zod-worker Patch
@trigger.dev/react-hooks Patch
@trigger.dev/database Patch
@trigger.dev/otlp-importer Patch
@internal/testcontainers Patch

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

Copy link
Contributor

coderabbitai bot commented Nov 1, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

The changes introduce a feature to the batchTrigger function that appends individual run IDs to the auto-generated public access token. This modification enhances the tracking of individual runs within batch processes. Additionally, the batchTriggerTask method in the ApiClient class has been updated to construct JWT scopes more granularly by including permissions for each run in the batch, thereby improving the access control structure.

Changes

File Path Change Summary
.changeset/orange-llamas-jog.md Introduced feature to append individual run IDs to public access token in batchTrigger function.
packages/core/src/v3/apiClient/index.ts Updated batchTriggerTask to enhance JWT scope construction by including run-specific permissions.

Possibly related PRs

  • fix: cleanup ttl expire run graphile jobs #1373: The changes in this PR involve task run management, which may relate to the tracking of individual runs as mentioned in the main PR's enhancement of the batchTrigger function.
  • New runs fundamentals page #1401: This PR introduces a new documentation page about runs and attempts, which aligns with the main PR's focus on improving tracking and identification of individual runs in batch processes.

🐇 In the meadow, hops a little hare,
With tokens of runs, they dance in the air.
Each ID a story, a journey to share,
In batches they frolic, without a care.
Granular permissions, a joyful affair,
Hooray for the changes, let’s all be aware! 🎉


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 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 force-pushed the fix-run-scopes-on-batchTrigger-token branch from c1dbe51 to bee9d76 Compare November 1, 2024 13:22
@ericallam ericallam merged commit 2528548 into main Nov 1, 2024
6 checks passed
@ericallam ericallam deleted the fix-run-scopes-on-batchTrigger-token branch November 1, 2024 13:22
Copy link

pkg-pr-new bot commented Nov 1, 2024

@trigger.dev/build

pnpm add https://pkg.pr.new/triggerdotdev/trigger.dev/@trigger.dev/build@1449

@trigger.dev/core

pnpm add https://pkg.pr.new/triggerdotdev/trigger.dev/@trigger.dev/core@1449

@trigger.dev/sdk

pnpm add https://pkg.pr.new/triggerdotdev/trigger.dev/@trigger.dev/sdk@1449

trigger.dev

pnpm add https://pkg.pr.new/triggerdotdev/trigger.dev@1449

@trigger.dev/react-hooks

pnpm add https://pkg.pr.new/triggerdotdev/trigger.dev/@trigger.dev/react-hooks@1449

commit: bee9d76

@coderabbitai coderabbitai bot mentioned this pull request Feb 20, 2025
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