feat(form): added a deployed form that can be public facing and trigger the workflow#1438
Closed
waleedlatif1 wants to merge 3 commits intostagingfrom
Closed
feat(form): added a deployed form that can be public facing and trigger the workflow#1438waleedlatif1 wants to merge 3 commits intostagingfrom
waleedlatif1 wants to merge 3 commits intostagingfrom
Conversation
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Greptile Overview
Summary
This PR implements a comprehensive deployed form feature that allows workflows to be triggered via public-facing forms. The implementation includes form configuration UI, public form rendering, robust API validation, and background workflow execution.
Key Changes:
- Public Form Pages: New
/form/[formId]route with form rendering component - Form APIs: Secure form retrieval and submission endpoints with validation, rate limiting, and usage controls
- Background Execution: Integration with workflow executor via Trigger.dev or direct execution
- Database Schema: New
workflow_formtable with proper indexing and constraints - Form Configuration: Rich UI for configuring form fields, validation, styling, and behavior
- Block Integration: New
form_triggerblock type with proper TypeScript definitions
Technical Highlights:
- Comprehensive form validation on both client and server sides
- Rate limiting and usage limit enforcement
- Idempotency handling for duplicate submissions
- Proper error handling and logging throughout the flow
- Integration with existing workflow execution infrastructure
Minor Issues Found:
- Some type assertions to
anyshould be replaced with proper interfaces - UUID generation logic in form management API needs consistency fix
- Hardcoded image path in form page could be improved
The feature is well-implemented with proper security considerations, error handling, and follows the established patterns in the codebase.
Confidence Score: 4/5
- This PR is safe to merge with minor improvements recommended
- Score reflects well-implemented core functionality with comprehensive security measures, proper error handling, and good integration patterns. Only minor style improvements and one logical fix needed.
- apps/sim/app/api/workflows/[id]/forms/route.ts needs the UUID generation logic fix
Important Files Changed
File Analysis
| Filename | Score | Overview |
|---|---|---|
| apps/sim/app/api/forms/[formId]/submit/route.ts | 4/5 | Form submission API with comprehensive validation, rate limiting, and idempotency handling - well implemented |
| apps/sim/background/form-execution.ts | 4/5 | Form execution with proper logging, error handling, and idempotency - solid implementation |
| apps/sim/app/form/[formId]/components/form-renderer.tsx | 4/5 | React form renderer with comprehensive validation and error handling - well-structured component |
| apps/sim/app/form/[formId]/page.tsx | 3/5 | Form page component with potential hardcoded URL issue - needs attention |
| apps/sim/app/api/workflows/[id]/forms/route.ts | 3/5 | Workflow forms API with potential UUID generation issue in POST vs PUT logic |
Sequence Diagram
sequenceDiagram
participant User
participant FormPage as Form Page<br/>(sim.ai/form/[id])
participant FormAPI as Form Submit API<br/>(/api/forms/[id]/submit)
participant BackgroundJob as Background Execution<br/>(form-execution.ts)
participant Executor as Workflow Executor
participant Database as Database
User->>FormPage: Access form URL
FormPage->>FormAPI: GET /api/forms/[id] (fetch form config)
FormAPI->>Database: Query workflow_form table
Database-->>FormAPI: Return form configuration
FormAPI-->>FormPage: Form config & styling
FormPage-->>User: Render form with fields
User->>FormPage: Fill form and submit
FormPage->>FormAPI: POST /api/forms/[id]/submit (form data)
FormAPI->>FormAPI: Validate form fields
FormAPI->>FormAPI: Check rate limits
FormAPI->>FormAPI: Check usage limits
alt Trigger.dev enabled
FormAPI->>BackgroundJob: Queue via trigger.dev
else Direct execution
FormAPI->>BackgroundJob: Execute directly
end
FormAPI-->>User: Success response with message
BackgroundJob->>Database: Load workflow configuration
BackgroundJob->>BackgroundJob: Process form data as workflow input
BackgroundJob->>Executor: Execute workflow with form data
Executor->>Executor: Run workflow blocks
BackgroundJob->>Database: Update execution stats
BackgroundJob->>Database: Save execution logs
22 files reviewed, 4 comments
| foundWorkflow = forms[0].workflow | ||
|
|
||
| try { | ||
| const formConfig = foundForm.formConfig as any |
Contributor
There was a problem hiding this comment.
style: avoid type assertion to any - should define proper interface for formConfig structure
Suggested change
| const formConfig = foundForm.formConfig as any | |
| const formConfig = foundForm.formConfig as { fields: Array<{ name: string; label: string; type: string; required: boolean }> } |
Context Used: Context - Avoid using type assertions to 'any' in TypeScript. Instead, ensure proper type definitions are used to maintain type safety. (link)
Comment on lines
+27
to
+30
| let foundWorkflow: any = null | ||
| let foundForm: any = null | ||
|
|
||
| let body: any |
Contributor
There was a problem hiding this comment.
style: avoid type assertion to any - define proper types for foundWorkflow and foundForm
Suggested change
| let foundWorkflow: any = null | |
| let foundForm: any = null | |
| let body: any | |
| let foundWorkflow: { id: string; userId: string; name: string } | null = null | |
| let foundForm: { id: string; formConfig: any; settings: any; blockId?: string } | null = null | |
| let body: Record<string, any> |
Context Used: Context - Avoid using type assertions to 'any' in TypeScript. Instead, ensure proper type definitions are used to maintain type safety. (link)
| className='inline-flex items-center gap-2 text-muted-foreground text-sm transition-colors hover:text-foreground' | ||
| > | ||
| <span>Powered by</span> | ||
| <img src='/logo/reverse/text/medium.png' alt='Sim' className='h-4' /> |
Contributor
There was a problem hiding this comment.
style: hardcoded image path may not work in all environments - consider using Next.js Image component or dynamic imports
Comment on lines
+46
to
+71
| const formPath = uuidv4() | ||
| const formData = { | ||
| workflowId, | ||
| blockId, | ||
| path: formPath, | ||
| title, | ||
| description, | ||
| formConfig, | ||
| styling: styling || {}, | ||
| settings: settings || {}, | ||
| isActive: true, | ||
| } | ||
|
|
||
| let result | ||
| if (existingForm.length > 0) { | ||
| result = await db | ||
| .update(workflowForm) | ||
| .set({ | ||
| ...formData, | ||
| path: existingForm[0].path, | ||
| updatedAt: new Date(), | ||
| }) | ||
| .where(eq(workflowForm.id, existingForm[0].id)) | ||
| .returning() | ||
|
|
||
| result[0] = { ...result[0], path: existingForm[0].path } |
Contributor
There was a problem hiding this comment.
logic: new UUID generated for every form update, but existing path is preserved - this creates inconsistent behavior between POST and PUT
Suggested change
| const formPath = uuidv4() | |
| const formData = { | |
| workflowId, | |
| blockId, | |
| path: formPath, | |
| title, | |
| description, | |
| formConfig, | |
| styling: styling || {}, | |
| settings: settings || {}, | |
| isActive: true, | |
| } | |
| let result | |
| if (existingForm.length > 0) { | |
| result = await db | |
| .update(workflowForm) | |
| .set({ | |
| ...formData, | |
| path: existingForm[0].path, | |
| updatedAt: new Date(), | |
| }) | |
| .where(eq(workflowForm.id, existingForm[0].id)) | |
| .returning() | |
| result[0] = { ...result[0], path: existingForm[0].path } | |
| const formPath = existingForm.length > 0 ? existingForm[0].path : uuidv4() | |
| const formData = { | |
| workflowId, | |
| blockId, | |
| path: formPath, | |
| title, | |
| description, | |
| formConfig, | |
| styling: styling || {}, | |
| settings: settings || {}, | |
| isActive: true, | |
| } | |
| let result | |
| if (existingForm.length > 0) { | |
| result = await db | |
| .update(workflowForm) | |
| .set({ | |
| ...formData, | |
| updatedAt: new Date(), | |
| }) | |
| .where(eq(workflowForm.id, existingForm[0].id)) | |
| .returning() |
waleedlatif1
force-pushed
the
staging
branch
from
f0c20a9 to
010753d
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
added a deployed form that can be public facing and trigger the workflow, when a user uses the
deployed forminput type, they can configure the form and it becomes public-facing at sim.ai/forms/[formId] and when someone submits the form, it will trigger the workflow and make those fields accessible via the tag dropdown.Type of Change
Testing
Tested manually.
Checklist