feat: introduce run templates for reusing test run configs #2253

myftija · 2025-07-09T16:41:57Z

This PR introduces run templates to enable saving and reusing test task
configs. The following fields are populated when selecting a run template:
payload, metadata, queue, concurrencyKey, ttl, maxAttempts, maxDuration, tags
and machinePreset.

Drive-by: did a few improvements to form handling in the test page.

changeset-bot · 2025-07-09T16:42:02Z

⚠️ No Changeset found

Latest commit: e2d36a5

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

coderabbitai · 2025-07-09T16:42:05Z

Walkthrough

This change introduces a new feature for managing "Task Run Templates" within the application. It adds a new database model and migration for storing task run templates, along with corresponding Prisma schema updates. Backend service classes are implemented for creating and deleting templates, with input validation provided by new Zod schemas. The presenter and service layers are updated to handle and return task run templates alongside existing test task data. On the frontend, the test task page and forms are extended to support the creation, deletion, listing, and selection of run templates, including new UI components for template management and user feedback. The action handler is refactored to support multiple form actions related to templates and task runs.

✨ 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.
- Explain this complex logic.
- 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 explain this code block.
- @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 explain its main purpose.
- @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.

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (4)

apps/webapp/app/v3/services/deleteTaskRunTemplate.server.ts (1)
13-17: Consider more specific error handling.

The current error handling is functional but generic. Consider differentiating between "template not found" and other database errors for better user experience.
-    } catch (e) {
-      throw new Error(
-        `Error deleting template: ${e instanceof Error ? e.message : JSON.stringify(e)}`
-      );
-    }
+    } catch (e) {
+      if (e instanceof Error && e.message.includes('Record to delete does not exist')) {
+        throw new Error('Template not found or access denied');
+      }
+      throw new Error(
+        `Error deleting template: ${e instanceof Error ? e.message : JSON.stringify(e)}`
+      );
+    }
apps/webapp/app/presenters/v3/TestTaskPresenter.server.ts (1)
313-327: Simplify conditional with optional chaining.

The conditional check can be simplified using optional chaining.
-              scheduledTaskPayload:
-                scheduledTaskPayload && scheduledTaskPayload.success
-                  ? scheduledTaskPayload.data
-                  : undefined,
+              scheduledTaskPayload: scheduledTaskPayload?.success
+                ? scheduledTaskPayload.data
+                : undefined,
apps/webapp/app/routes/_app.orgs.$organizationSlug.projects.$projectParam.env.$envParam.test.tasks.$taskParam/route.tsx (2)
389-390: Consider consolidating duplicate success message state.

Both StandardTaskForm and ScheduledTaskForm have identical state management for template creation success messages. Consider lifting this state up or creating a custom hook.

Create a custom hook to manage the success message state:
function useTemplateSuccessMessage() {
  const [showMessage, setShowMessage] = useState(false);
  
  const showSuccess = useCallback(() => {
    setShowMessage(true);
    setTimeout(() => setShowMessage(false), 2000);
  }, []);
  
  return { showMessage, showSuccess };
}
Also applies to: 835-836

1561-1568: Success message timeout management.

The 2-second timeout for hiding the success message is set correctly. However, ensure this timeout is cleared if the component unmounts to avoid memory leaks.
  useEffect(() => {
    if (lastSubmission && "success" in lastSubmission && lastSubmission.success === true) {
      setIsModalOpen(false);
      setShowCreatedSuccessMessage(true);
-     setTimeout(() => {
+     const timeoutId = setTimeout(() => {
        setShowCreatedSuccessMessage(false);
      }, 2000);
+     return () => clearTimeout(timeoutId);
    }
  }, [lastSubmission]);

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between dbcf632 and e2d36a5.

📒 Files selected for processing (8)

apps/webapp/app/presenters/v3/TestTaskPresenter.server.ts (8 hunks)
apps/webapp/app/routes/_app.orgs.$organizationSlug.projects.$projectParam.env.$envParam.test.tasks.$taskParam/route.tsx (20 hunks)
apps/webapp/app/v3/services/deleteTaskRunTemplate.server.ts (1 hunks)
apps/webapp/app/v3/services/taskRunTemplate.server.ts (1 hunks)
apps/webapp/app/v3/services/testTask.server.ts (2 hunks)
apps/webapp/app/v3/taskRunTemplate.ts (1 hunks)
internal-packages/database/prisma/migrations/20250709162608_add_task_run_template_model/migration.sql (1 hunks)
internal-packages/database/prisma/schema.prisma (1 hunks)

🧰 Additional context used

📓 Path-based instructions (5)

`apps/webapp/**/*.ts`: In the webapp, all environment variables must be accessed through the `env` export of `env.server.ts`, instead of directly accessing `process.env`.

apps/webapp/**/*.ts: In the webapp, all environment variables must be accessed through the env export of env.server.ts, instead of directly accessing process.env.

📄 Source: CodeRabbit Inference Engine (.cursor/rules/webapp.mdc)