Skip to content

Fix for v4 run failed alerts missing error #2031

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
May 9, 2025
Merged

Conversation

matt-aitken
Copy link
Member

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

About 6 months ago we added the error column to TaskRun. Previously they were only on the TaskRunAttempt.

So for the first version of run alerts we used the attempt error.

We can just use the TaskRun now and attempt database records don't exist in v4… so it meant all v4 run alerts were missing the error on them.

This is faster and more compatible.

Summary by CodeRabbit

  • Refactor
    • Simplified alert error handling by removing dependencies on task run attempts and relying solely on task run error information.
    • Cleaned up and reorganized imports for improved code clarity.

Copy link

changeset-bot bot commented May 8, 2025

⚠️ No Changeset found

Latest commit: bd29548

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.

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

Walkthrough

References to taskRunAttempt and related logic have been removed from the alert delivery service, simplifying error handling to rely solely on taskRun. Type definitions and error extraction methods were updated accordingly. Additionally, unused imports were cleaned up in the task run alerts performer file, with no changes to functional logic.

Changes

File(s) Change Summary
apps/webapp/app/v3/services/alerts/deliverAlert.server.ts Removed all taskRunAttempt references, related type extensions, and logic. Updated error parsing to use taskRun directly.
apps/webapp/app/v3/services/alerts/performTaskRunAlerts.server.ts Cleaned up and reordered import statements, removing unused imports.

Suggested reviewers

  • nicktrn

Poem

In the warren, code hops anew,
Old attempts now bid adieu.
Errors found in simpler ways,
Imports tidied, no more maze.
Alerts now run with lighter load,
A rabbit’s joy on every node! 🐇✨

Tip

⚡️ Faster reviews with caching
  • CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.

Enjoy the performance boost—your workflow just got faster.

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in 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.

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: 1

🔭 Outside diff range comments (1)
apps/webapp/app/v3/services/alerts/deliverAlert.server.ts (1)

978-999: 🛠️ Refactor suggestion

Fallback TaskRunError is missing message/stackTrace; may surface as undefined downstream

#getRunError now serialises the unknown data into raw, but leaves out
message/stackTrace. Later, Slack & e-mail builders call
createJsonErrorObject(taskRunError) and then access
error.stackTrace ?? error.message.
With the current object those properties will be undefined, producing empty
alerts.

-        return {
-          type: "CUSTOM_ERROR",
-          raw: JSON.stringify(alert.taskRun.error ?? "Unknown error"),
-        };
+        const raw = alert.taskRun.error ?? "Unknown error";
+        return {
+          type: "CUSTOM_ERROR",
+          message: typeof raw === "string" ? raw : "Unknown error",
+          stackTrace: undefined,
+          raw: typeof raw === "string" ? raw : JSON.stringify(raw),
+        };

This ensures every consumer has a sensible message field to display.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 6736cb5 and bd29548.

📒 Files selected for processing (2)
  • apps/webapp/app/v3/services/alerts/deliverAlert.server.ts (3 hunks)
  • apps/webapp/app/v3/services/alerts/performTaskRunAlerts.server.ts (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (7)
  • GitHub Check: Analyze (javascript-typescript)
  • GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - pnpm)
  • GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - npm)
  • GitHub Check: e2e / 🧪 CLI v3 tests (ubuntu-latest - pnpm)
  • GitHub Check: e2e / 🧪 CLI v3 tests (ubuntu-latest - npm)
  • GitHub Check: typecheck / typecheck
  • GitHub Check: units / 🧪 Unit Tests

Comment on lines +2 to +3
import { type prisma } from "~/db.server";
import { commonWorker } from "~/v3/commonWorker.server";
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

import { type prisma } … breaks typeof prisma – import the value, not just the type

FoundRun relies on typeof prisma.taskRun, which is a value query.
When prisma is imported with the type modifier, the symbol only exists in the
type-space; the value symbol is erased, so typeof prisma triggers TS 2749
(“only refers to a type, but is being used as a value here”).

-import { type prisma } from "~/db.server";
+import { prisma } from "~/db.server";

If you still want to avoid bringing the runtime value into the bundle, replace
typeof prisma.taskRun with the model–name type from @prisma/client instead
(e.g. Prisma.TaskRunDelegate).
Failing to adjust this will cause the file not to compile.

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
import { type prisma } from "~/db.server";
import { commonWorker } from "~/v3/commonWorker.server";
import { prisma } from "~/db.server";
import { commonWorker } from "~/v3/commonWorker.server";

@matt-aitken matt-aitken merged commit 37aadfc into main May 9, 2025
12 checks passed
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