Skip to content

Fixed the missing icons in trigger spans #1506

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 28, 2024

Conversation

ericallam
Copy link
Member

@ericallam ericallam commented Nov 28, 2024

No description provided.

Copy link

changeset-bot bot commented Nov 28, 2024

🦋 Changeset detected

Latest commit: b39db5a

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

This PR includes changesets to release 11 packages
Name Type
@trigger.dev/sdk Patch
@trigger.dev/build Patch
@trigger.dev/core Patch
@trigger.dev/react-hooks Patch
@trigger.dev/rsc Patch
@trigger.dev/database Patch
@trigger.dev/otlp-importer Patch
trigger.dev Patch
@internal/redis-worker Patch
@internal/zod-worker 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 28, 2024

Walkthrough

The changeset introduces a patch for the @trigger.dev/sdk package, specifically resolving the issue of missing icons in trigger spans. Additionally, several modifications are made to the shared.ts file within the SDK, enhancing task triggering and batch processing capabilities. New functions for batch triggering tasks and polling for their results are added, alongside improvements in error handling and tracing for better monitoring and debugging.

Changes

File Path Change Summary
.changeset/popular-mails-sell.md Patch for @trigger.dev/sdk to fix missing icons in trigger spans.
packages/trigger-sdk/src/v3/shared.ts Added functions: batchTriggerTasks, batchTriggerAndWaitTasks, and triggerAndPoll. Enhanced error handling and tracing in task execution.

Possibly related PRs

Suggested reviewers

  • matt-aitken

🐇 "In the meadow where tasks do play,
Icons now shine bright as day.
Batch triggers hop, poll with glee,
Error handling's clear, you see!
With each change, we leap and bound,
In our SDK, joy is found!" 🌼

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.

packages/trigger-sdk/src/v3/shared.ts

Oops! Something went wrong! :(

ESLint: 8.45.0

ESLint couldn't find the config "custom" to extend from. Please check that the name of the config is correct.

The config "custom" was referenced from the config file in "/.eslintrc.js".

If you still have problems, please stop by https://eslint.org/chat/help to chat with the team.


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.

Copy link
Contributor

@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

🧹 Outside diff range and nitpick comments (6)
packages/trigger-sdk/src/v3/shared.ts (6)

820-822: Extract common span attributes to reduce code duplication

The attributes object with [SemanticInternalAttributes.STYLE_ICON]: "trigger" is repeated across multiple tracer spans. Consider extracting this into a constant or a utility function to enhance maintainability and reduce code duplication.


1152-1154: Extract common span attributes to reduce code duplication

Again, the attributes object with [SemanticInternalAttributes.STYLE_ICON]: "trigger" is used here. To avoid repetitive code, consider extracting this into a shared constant or utility function.


Line range hint 980-1155: Correct the JSDoc comments for batchTriggerAndWaitTasks

The JSDoc comments for the batchTriggerAndWaitTasks function are inconsistent with its actual parameters and usage. The documentation mentions BatchByIdAndWaitItem and BatchByIdResult<TTask>, which do not match the function's signature that uses BatchByTaskAndWaitItem<TTasks[K]> and returns BatchByTaskResult<TTasks>.

Please update the JSDoc comments to accurately reflect the function's parameters, return type, and provide an example that matches the usage of batchTriggerAndWaitTasks. This will help users understand and utilize the function correctly.


Line range hint 823-978: Update the JSDoc comments for batchTriggerTasks

The documentation for batchTriggerTasks seems to have inconsistencies. The comments reference parameters and types that do not align with the function's signature, potentially causing confusion.

Ensure that the JSDoc comments accurately describe the function's parameters, return type, and usage examples corresponding to batchTriggerTasks. This will improve clarity and developer experience.


1360-1362: Extract common span attributes to reduce code duplication

The attributes object with [SemanticInternalAttributes.STYLE_ICON]: "trigger" and accessoryAttributes is repeated. Consider creating a shared constant or helper function for these attributes to improve maintainability.


1455-1457: Extract common span attributes to reduce code duplication

The repetitive use of span attributes suggests an opportunity to refactor. Extracting [SemanticInternalAttributes.STYLE_ICON]: "trigger" and accessoryAttributes into a shared constant or utility function can enhance code readability and maintainability.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between d9bfe55 and b39db5a.

📒 Files selected for processing (2)
  • .changeset/popular-mails-sell.md (1 hunks)
  • packages/trigger-sdk/src/v3/shared.ts (4 hunks)
✅ Files skipped from review due to trivial changes (1)
  • .changeset/popular-mails-sell.md

@ericallam ericallam merged commit d67023a into main Nov 28, 2024
7 of 8 checks passed
@ericallam ericallam deleted the fix-missing-trigger-span-icons branch November 28, 2024 19:09
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