Skip to content

Run completed at fix and engine API rate limit whitelist #1899

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 5 commits into from
Apr 8, 2025

Conversation

matt-aitken
Copy link
Member

@matt-aitken matt-aitken commented Apr 8, 2025

We've been using the run updatedAt for completed because we didn't used to have that column. This worked well in general but metadata updates can come through after the run is complete if you use trigger() combined with metadata.root.set().

Added a whitelist for /engine/v1/worker-actions/ to the engine rate limiter.

Summary by CodeRabbit

  • New Features

    • Timelines and run lists now display more accurate completion times, enhancing clarity for run event tracking.
    • Compute details in task runs are now visible for all users in managed cloud environments.
  • Chores

    • Reduced debug output in real-time data streams for a cleaner operational log.
    • Adjusted rate limiting settings to better support engine actions.

Copy link

changeset-bot bot commented Apr 8, 2025

⚠️ No Changeset found

Latest commit: b51b044

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 Apr 8, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

This pull request updates several components to improve timestamp handling and control flow. In the timeline, it now prioritizes run.completedAt (with run.updatedAt as a fallback) for displaying event times. The TaskRunsTable no longer relies on the user's admin status to show compute info, using only the managed cloud flag. Additionally, the RunListPresenter now includes a new completedAt property with corresponding SQL and logic updates. Several routes have their debug flag turned off, and the engine rate limiter now exempts specific worker actions using a regex-based whitelist.

Changes

File(s) Change Summary
apps/webapp/app/components/run/RunTimeline.tsx Updated timeline item titles for "executing" and "legacy-executing" to use run.completedAt (with fallback to run.updatedAt) and modified the "finished" event date accordingly.
apps/webapp/app/components/runs/v3/TaskRunsTable.tsx Removed the user variable from useUser and simplified showCompute logic to check only isManagedCloud.
apps/webapp/app/presenters/v3/RunListPresenter.server.ts Added a new property completedAt and updated SQL selection and finishedAt logic to use run.completedAt (fallback to run.updatedAt).
apps/webapp/app/routes/engine.v1.dev.presence.ts
apps/webapp/app/routes/resources.orgs.$organizationSlug.projects.$projectParam.dev.presence.tsx
apps/webapp/app/routes/resources.orgs.$organizationSlug.projects.$projectParam.env.$envParam.queues.stream.tsx
Changed the debug flag from true to false in the configuration for SSE loaders to reduce debug output.
apps/webapp/app/services/engineRateLimit.server.ts Modified pathWhiteList to use a regex pattern that exempts paths starting with /engine/v1/worker-actions/ from rate limiting.

Sequence Diagram(s)

sequenceDiagram
  participant TC as Timeline Component
  participant BT as buildTimelineItems
  participant FD as formatDuration
  TC->>BT: Provide run data
  BT->>FD: Calculate title for "executing" (using run.completedAt then run.updatedAt)
  BT->>FD: Calculate title for "legacy-executing" (using run.completedAt then run.updatedAt)
  BT->>TC: Return timeline items with updated titles and date
Loading
sequenceDiagram
  participant TR as TaskRunsTable Component
  participant Env as Environment (isManagedCloud)
  TR->>Env: Check managed cloud status
  Env-->>TR: Return isManagedCloud flag
  TR->>TR: Determine showCompute (based solely on isManagedCloud)
  TR->>UI: Render compute info if enabled
Loading

Suggested reviewers

  • ericallam

Poem

I'm a rabbit, bouncing through code so bright,
Timestamps updated with precision and might.
Debug is silent, paths now clear,
Leaping over limits without a fear.
In every nibble of code, this bunny delights!
Hop on these updates and enjoy the flight!


📜 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 b51b044 and 6d40333.

📒 Files selected for processing (1)
  • apps/webapp/app/components/runs/v3/TaskRunsTable.tsx (2 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 plan to trigger planning for file edits and PR creation.
  • @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.

@matt-aitken matt-aitken merged commit 3cbbece into main Apr 8, 2025
11 of 12 checks passed
@matt-aitken matt-aitken deleted the run-completedat-engine-ratelimits branch April 8, 2025 19:55
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.

2 participants