Skip to content

Add run metadata to runs.list endpoint #1542

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
Dec 10, 2024
Merged

Conversation

ericallam
Copy link
Member

@ericallam ericallam commented Dec 10, 2024

Summary by CodeRabbit

  • New Features

    • Enhanced metadata handling in run data with the addition of metadata and metadataType fields.
    • Improved asynchronous processing for better performance in data preparation.
  • Bug Fixes

    • Updated logging for better context on data processing results.
  • Documentation

    • Method signatures updated to reflect changes in the ApiRunListPresenter and RunListPresenter classes.

Copy link

changeset-bot bot commented Dec 10, 2024

⚠️ No Changeset found

Latest commit: b7c2d86

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

Copy link
Contributor

coderabbitai bot commented Dec 10, 2024

Caution

Review failed

The pull request is closed.

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.

apps/webapp/app/presenters/v3/ApiRunListPresenter.server.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.

Walkthrough

The changes involve modifications to two classes: ApiRunListPresenter and RunListPresenter. In ApiRunListPresenter, the call method is updated to process results asynchronously, utilizing Promise.all and integrating a new parsePacket function for enhanced metadata handling. In RunListPresenter, the call method's SQL query is expanded to include additional fields, metadata and metadataType, without altering the existing logic for filtering or pagination. Both changes aim to improve data handling while maintaining the overall functionality of the methods.

Changes

File Path Change Summary
apps/webapp/app/presenters/v3/ApiRunListPresenter.server.ts - Added parsePacket import.
- Updated call method to process results.runs asynchronously using Promise.all.
- Enhanced logging with new debug statements.
- Included parsed metadata in the returned data structure.
apps/webapp/app/presenters/v3/RunListPresenter.server.ts - Expanded SQL query in call method to include metadata and metadataType fields.
- Updated mapping of returned runs to include new fields without altering existing pagination or filtering logic.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant ApiRunListPresenter
    participant RunListPresenter
    participant Database

    Client->>ApiRunListPresenter: Call method
    ApiRunListPresenter->>RunListPresenter: Call method
    RunListPresenter->>Database: Execute SQL query (including metadata fields)
    Database-->>RunListPresenter: Return runs data with metadata
    RunListPresenter-->>ApiRunListPresenter: Return processed runs
    ApiRunListPresenter->>ApiRunListPresenter: Parse metadata using parsePacket
    ApiRunListPresenter-->>Client: Return final data with parsed metadata
Loading

🐇 In the meadow where data flows,
New fields sprout, as knowledge grows.
With packets parsed and runs in tow,
Asynchronous magic puts on a show!
Hopping through code, we celebrate,
Robust and bright, we innovate!
🌼


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between ea23dbd and b7c2d86.

📒 Files selected for processing (2)
  • apps/webapp/app/presenters/v3/ApiRunListPresenter.server.ts (2 hunks)
  • apps/webapp/app/presenters/v3/RunListPresenter.server.ts (3 hunks)

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.

@ericallam ericallam merged commit 86b1628 into main Dec 10, 2024
6 of 7 checks passed
@ericallam ericallam deleted the api-runs-list-metadata branch December 10, 2024 12:52
Copy link

pkg-pr-new bot commented Dec 10, 2024

@trigger.dev/build

npm i https://pkg.pr.new/triggerdotdev/trigger.dev/@trigger.dev/build@1542

trigger.dev

npm i https://pkg.pr.new/triggerdotdev/trigger.dev@1542

@trigger.dev/core

npm i https://pkg.pr.new/triggerdotdev/trigger.dev/@trigger.dev/core@1542

@trigger.dev/react-hooks

npm i https://pkg.pr.new/triggerdotdev/trigger.dev/@trigger.dev/react-hooks@1542

@trigger.dev/rsc

npm i https://pkg.pr.new/triggerdotdev/trigger.dev/@trigger.dev/rsc@1542

@trigger.dev/sdk

npm i https://pkg.pr.new/triggerdotdev/trigger.dev/@trigger.dev/sdk@1542

commit: b7c2d86

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