Modifying message content for approval workflow actions #15649

dannyroosevelt · 2025-02-18T05:36:48Z

WHY

Summary by CodeRabbit

New Features
- Gmail Approval Workflow: Now allows you to customize email content with optional HTML-formatted body text.
- Slack Approval Workflow: Enhanced messaging includes clearer text and improved button styles for approving or canceling actions.
Updates
- Updated versions for both Gmail and Slack packages to improve overall performance and compatibility.

vercel · 2025-02-18T05:36:51Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

3 Skipped Deployments

Name	Status	Preview	Updated (UTC)
docs-v2	⬜️ Ignored (Inspect)	Visit Preview	Feb 18, 2025 4:20pm
pipedream-docs	⬜️ Ignored (Inspect)		Feb 18, 2025 4:20pm
pipedream-docs-redirect-do-not-edit	⬜️ Ignored (Inspect)		Feb 18, 2025 4:20pm

coderabbitai · 2025-02-18T05:36:57Z

Walkthrough

This pull request updates the approval workflow actions for both Gmail and Slack components. In the Gmail action, it introduces a new optional property body along with a hidden bodyType defaulting to "html", and adjusts the email body construction logic. In the Slack action, the version is updated, the description is refined, and button styles for "Approve" and "Cancel" are explicitly defined. Both files now reflect a version bump from "0.0.1" to "0.0.2".

Changes

File(s)	Change Summary
`components/gmail/.../approve-workflow.mjs`	Updated version to "0.0.2". Added optional `body` property and hidden `bodyType` (default "html"). Modified `run` method to conditionally construct the email body based on the provided `body`.
`components/slack/.../approve-workflow.mjs`	Updated version to "0.0.2". Revised description (capitalized "Slack" and rephrased). Updated the text for the `message` property and added button styles (`style: "primary"` for Approve and `style: "danger"` for Cancel).
`components/gmail/package.json`	Updated package version from `0.2.0` to `0.2.1`.
`components/slack/package.json`	Updated package version from `0.9.0` to `0.9.1`.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant GmailModule as Gmail Action
    participant EmailServer
    User->>GmailModule: Request approval email
    alt Custom body provided?
      GmailModule->>GmailModule: Concatenate custom body with approval text (with <br> formatting)
    else
      GmailModule->>GmailModule: Use default approval text
    end
    GmailModule->>EmailServer: Send email

sequenceDiagram
    participant User
    participant SlackModule as Slack Action
    participant SlackServer
    User->>SlackModule: Request approval message
    SlackModule->>SlackModule: Build message with updated description and button styles ("primary" & "danger")
    SlackModule->>SlackServer: Send Slack message

Possibly related PRs

[FrontApp] Update body html description #12988: The changes in the main PR are related to the addition of a body property that supports HTML formatting, while the retrieved PR updates the description of a body property to specify that it "Accepts HTML," indicating a direct connection in functionality.
Human in the loop for apps #15628: The changes in the main PR are related to the modifications made to the approve-workflow.mjs file in the retrieved PR, as both involve updates to the same file and enhancements to the email approval workflow functionality.
Changing prop type of body from any to string. #14674: The changes in the main PR, which involve adding new properties to the props object and modifying the run method to handle the email body, are directly related to the retrieved PR that changes the prop type of the body property from any to string, as both modifications pertain to the handling of the body property in the Gmail actions.

Suggested labels

User submitted, ai-assisted

Suggested reviewers

GTFalcao

Poem

I'm a rabbit in the code, hopping with glee,
New properties and styles, as fresh as can be.
With custom bodies in Gmail and buttons that shine,
My little whiskers twitch with each version align.
A joyful hop-step through the branches of code—
Celebrating each change on this merry, upbeat road.
🐇✨

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.

components/gmail/actions/approve-workflow/approve-workflow.mjs

Oops! Something went wrong! :(

ESLint: 8.57.1

Error [ERR_MODULE_NOT_FOUND]: Cannot find package 'jsonc-eslint-parser' imported from /eslint.config.mjs
at packageResolve (node:internal/modules/esm/resolve:839:9)
at moduleResolve (node:internal/modules/esm/resolve:908:18)
at defaultResolve (node:internal/modules/esm/resolve:1038:11)
at ModuleLoader.defaultResolve (node:internal/modules/esm/loader:557:12)
at ModuleLoader.resolve (node:internal/modules/esm/loader:525:25)
at ModuleLoader.getModuleJob (node:internal/modules/esm/loader:246:38)
at ModuleJob._link (node:internal/modules/esm/module_job:126:49)

📜 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 44af5e6 and 39bc74a.

📒 Files selected for processing (1)

components/gmail/actions/approve-workflow/approve-workflow.mjs (2 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (3)

GitHub Check: Publish TypeScript components
GitHub Check: pnpm publish
GitHub Check: Verify TypeScript components

🔇 Additional comments (4)

components/gmail/actions/approve-workflow/approve-workflow.mjs (4)

7-7: LGTM!

The version bump is consistent with the coordinated versioning effort across both Gmail and Slack components.

23-30: LGTM!

The body property is well-defined:

Reuses existing propDefinition for consistency

Clearly indicates HTML support in the description

Correctly marked as optional

31-38: LGTM!

The bodyType property is well-defined:

Reuses existing propDefinition for consistency

Correctly hidden as an implementation detail

Default value aligns with HTML support

44-49: Ensure consistent line break handling.

The email body construction uses HTML line breaks ( ), but this might not render correctly with plaintext body type. Additionally, the concatenation of user-provided body with approval text might need better visual separation.

Consider this improved implementation:
- const approvalText = `Click here to approve: ${resume_url} Cancel here: ${cancel_url}`;
+ const lineBreak = this.bodyType === "html" ? " " : "\n";
+ const doubleLineBreak = this.bodyType === "html" ? " " : "\n\n";
+ const approvalText = `Click here to approve:${lineBreak}${resume_url}${doubleLineBreak}Cancel here:${lineBreak}${cancel_url}`;
 const opts = await this.gmail.getOptionsToSendEmail($, {
 ...this,
- body: this.body
- ? `${this.body} ${approvalText}`
- : `${approvalText}`,
+ body: this.body
+ ? `${this.body}${doubleLineBreak}${approvalText}`
+ : approvalText,
 });

✨ Finishing Touches

📝 Generate Docstrings (Beta)

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. (Beta)
@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: 1

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between b4fb1d8 and d3dd2cb.

⛔ Files ignored due to path filters (1)

pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml

📒 Files selected for processing (2)

components/gmail/actions/approve-workflow/approve-workflow.mjs (2 hunks)
components/slack/actions/approve-workflow/approve-workflow.mjs (4 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (3)

GitHub Check: pnpm publish
GitHub Check: Publish TypeScript components
GitHub Check: Verify TypeScript components

🔇 Additional comments (3)

components/gmail/actions/approve-workflow/approve-workflow.mjs (1)

30-37: Verify the compatibility between bodyType and HTML formatting.

The bodyType property defaults to "plaintext", but the email body uses HTML line breaks ( ). This might cause the line breaks to be displayed as raw HTML in the email.

Consider one of these solutions:

Change the default bodyType to "html":
- default: "plaintext",
+ default: "html",
Use \n instead of   for plaintext formatting.
components/slack/actions/approve-workflow/approve-workflow.mjs (2)

66-66: LGTM! Enhanced button styling improves visual hierarchy.

The addition of "primary" and "danger" styles for the Approve and Cancel buttons respectively improves the user experience by making the actions more visually distinct and following Slack's design patterns.

Also applies to: 75-75

7-7: LGTM! Improved text clarity and consistency.

The description improvements enhance readability:

Properly capitalized "Slack" in the component description

Simplified the message property description

Also applies to: 39-39

components/gmail/actions/approve-workflow/approve-workflow.mjs

Modifying message content

d3dd2cb

dannyroosevelt changed the title ~~Modifying message content~~ Modifying message content for approval workflow actions Feb 18, 2025

dannyroosevelt requested a review from michelle0927 February 18, 2025 05:37

coderabbitai bot reviewed Feb 18, 2025

View reviewed changes

components/gmail/actions/approve-workflow/approve-workflow.mjs Show resolved Hide resolved

dannyroosevelt and others added 2 commits February 17, 2025 22:09

package json

44af5e6

updates

39bc74a

michelle0927 approved these changes Feb 18, 2025

View reviewed changes

dannyroosevelt merged commit e2c69e8 into master Feb 18, 2025
11 checks passed

dannyroosevelt deleted the danny/tweak-approval-messages branch February 18, 2025 16:39

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Modifying message content for approval workflow actions #15649

Modifying message content for approval workflow actions #15649

Uh oh!

dannyroosevelt commented Feb 18, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

vercel bot commented Feb 18, 2025 •

edited

Loading

Uh oh!

coderabbitai bot commented Feb 18, 2025 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Modifying message content for approval workflow actions #15649

Modifying message content for approval workflow actions #15649

Uh oh!

Conversation

dannyroosevelt commented Feb 18, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

WHY

Summary by CodeRabbit

Uh oh!

vercel bot commented Feb 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai bot commented Feb 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Possibly related PRs

Suggested labels

Suggested reviewers

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

dannyroosevelt commented Feb 18, 2025 •

edited by coderabbitai bot

Loading

vercel bot commented Feb 18, 2025 •

edited

Loading

coderabbitai bot commented Feb 18, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)