Human in the loop for apps #15628
Human in the loop for apps #15628
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎ 3 Skipped Deployments
|
WalkthroughThis pull request introduces new modules for workflow approval via Gmail, Microsoft Outlook, and Slack. Each module defines an "Approve Workflow" action that suspends a workflow, generates resume and cancel URLs, constructs a message, and sends it via the respective service. Additionally, package versions for these integrations have been updated. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant ApproveModule
participant WorkflowSystem
participant MessagingService
User->>ApproveModule: Trigger approval action
ApproveModule->>WorkflowSystem: Suspend workflow (generate URLs)
ApproveModule->>MessagingService: Construct and send approval message
MessagingService-->>ApproveModule: Confirm message delivery
ApproveModule-->>User: Return approval summary
Suggested labels
Suggested reviewers
Poem
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
components/gmail/actions/approve-workflow/approve-workflow.mjsOops! Something went wrong! :( ESLint: 8.57.1 Error [ERR_MODULE_NOT_FOUND]: Cannot find package 'jsonc-eslint-parser' imported from /eslint.config.mjs components/microsoft_outlook/actions/approve-workflow/approve-workflow.mjsOops! Something went wrong! :( ESLint: 8.57.1 Error [ERR_MODULE_NOT_FOUND]: Cannot find package 'jsonc-eslint-parser' imported from /eslint.config.mjs components/slack/actions/approve-workflow/approve-workflow.mjsOops! Something went wrong! :( ESLint: 8.57.1 Error [ERR_MODULE_NOT_FOUND]: Cannot find package 'jsonc-eslint-parser' imported from /eslint.config.mjs ✨ Finishing Touches
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Nitpick comments (3)
components/gmail/actions/approve-workflow/approve-workflow.mjs (1)
28-31: Enhance email content with HTML formatting and improve URL presentation.The current plain text implementation could be improved for better user experience and clarity.
Consider using HTML formatting and styled buttons:
- body: `Click here to approve the workflow: ${resume_url}, \nand cancel here: ${cancel_url}`, + body: ` + <html> + <body> + <p>A workflow requires your approval.</p> + <div style="margin: 20px 0;"> + <a href="${resume_url}" style="background-color: #4CAF50; color: white; padding: 10px 20px; text-decoration: none; margin-right: 10px;">Approve Workflow</a> + <a href="${cancel_url}" style="background-color: #f44336; color: white; padding: 10px 20px; text-decoration: none;">Cancel Workflow</a> + </div> + </body> + </html>`,components/slack/actions/approve-workflow/approve-workflow.mjs (2)
42-84: Add channel validation before sending message.The implementation should validate channel existence before attempting to send the message.
Add channel validation:
async run({ $ }) { + try { + // Validate channel exists + const conversationInfo = await this.slack.sdk().conversations.info({ + channel: this.conversation, + }); + + if (!conversationInfo.ok) { + throw new Error('Invalid or inaccessible channel'); + } + const { resume_url, cancel_url, } = $.flow.suspend(); // Rest of the implementation... + } catch (error) { + $.export("$summary", `Failed to send message: ${error.message}`); + throw error; + } },
1-1: Consider creating a base class for workflow approval actions.To improve consistency and maintainability across different platforms, consider implementing a base class that encapsulates common functionality.
Create a base class in a shared location:
// components/common/base/workflow-approval.mjs export default class WorkflowApprovalBase { async getApprovalUrls($) { return $.flow.suspend(); } validateResponse(response) { if (!response || response.error) { throw new Error(response.error || 'Operation failed'); } } async run({ $ }) { try { const urls = await this.getApprovalUrls($); const response = await this.sendApprovalRequest($, urls); this.validateResponse(response); $.export("$summary", this.getSuccessMessage()); return response; } catch (error) { $.export("$summary", `${this.getErrorPrefix()}: ${error.message}`); throw error; } } }Each platform-specific implementation can then extend this base class and override only the necessary methods:
sendApprovalRequest: Platform-specific message sendinggetSuccessMessage: Platform-specific success messagegetErrorPrefix: Platform-specific error prefix
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (6)
components/gmail/actions/approve-workflow/approve-workflow.mjs(1 hunks)components/gmail/package.json(1 hunks)components/microsoft_outlook/actions/approve-workflow/approve-workflow.mjs(1 hunks)components/microsoft_outlook/package.json(1 hunks)components/slack/actions/approve-workflow/approve-workflow.mjs(1 hunks)components/slack/package.json(1 hunks)
✅ Files skipped from review due to trivial changes (3)
- components/slack/package.json
- components/gmail/package.json
- components/microsoft_outlook/package.json
⏰ Context from checks skipped due to timeout of 90000ms (2)
- GitHub Check: Verify TypeScript components
- GitHub Check: Publish TypeScript components
🔇 Additional comments (1)
components/microsoft_outlook/actions/approve-workflow/approve-workflow.mjs (1)
30-35: Enhance message content with HTML formatting.Similar to Gmail implementation, the message could benefit from HTML formatting.
Consider using HTML formatting and styled buttons as suggested in the Gmail implementation.
components/microsoft_outlook/actions/approve-workflow/approve-workflow.mjs
Show resolved
Hide resolved
Resolves #15579
Summary by CodeRabbit