feat(api): prebuilt endpoints #2642
Conversation
| @@ -414,18 +377,14 @@ export async function deployPreBuilt({ | |||
| let nango_config_id: number; | |||
| let provider_config_key: string; | |||
|
|
|||
| if (nangoYamlBody) { | |||
There was a problem hiding this comment.
It felt unused/impossible let me know
There was a problem hiding this comment.
Yeah, don't see any case for this.
There was a problem hiding this comment.
Looked at this again and I think this PR breaks the admin deploy command https://github.com/NangoHQ/nango/blob/master/packages/cli/lib/services/deploy.service.ts#L79-L99
It is not really used anymore (internal only) so maybe we should remove that functionality completely?
| }; | ||
|
|
||
| const reEnableFlow = async (flow: ExtendedFlow): Promise<boolean> => { | ||
| const reEnableFlow = async (flow: any): Promise<boolean> => { |
There was a problem hiding this comment.
yes indeed, I should have added a comment.
WalkthroughThe changes involve significant modifications across various components, primarily focusing on the deployment and management of pre-built flows. Key updates include the introduction of new properties for tracking deletions, the removal of certain methods and interfaces, and the restructuring of API endpoints. Additionally, several files have been refactored to streamline functionality and improve type definitions, enhancing the overall organization of the codebase. Changes
Poem
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: 5
Outside diff range, codebase verification and nitpick comments (1)
packages/types/lib/deploy/incomingFlow.ts (1)
49-49: Ensurepublic_routeis included inIncomingPreBuiltFlowConfiginstances.The
public_routefield is expected in theIncomingPreBuiltFlowConfiginterface. It appears to be missing in theonboarding.controller.tsfile. Please verify and update the instances to include this field.
- File:
packages/server/lib/controllers/onboarding.controller.ts
- Line:
const config: IncomingPreBuiltFlowConfig[] = [...](Ensurepublic_routeis included)Analysis chain
Verify the usage of
IncomingPreBuiltFlowConfig.Ensure that all instances of
IncomingPreBuiltFlowConfigare updated to include thepublic_routefield.Run the following script to verify the usage:
Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify all instances of `IncomingPreBuiltFlowConfig` include the `public_route` field. # Test: Search for the interface usage. Expect: Only occurrences with the `public_route` field. rg --type typescript -A 5 $'IncomingPreBuiltFlowConfig'Length of output: 89
Script:
#!/bin/bash # Description: Verify all instances of `IncomingPreBuiltFlowConfig` include the `public_route` field. # Test: Search for the interface usage. Expect: Only occurrences with the `public_route` field. rg --type ts -A 5 $'IncomingPreBuiltFlowConfig'Length of output: 4834
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files ignored due to path filters (1)
packages/cli/lib/services/__snapshots__/deploy.service.unit.cli-test.ts.snapis excluded by!**/*.snap
Files selected for processing (19)
- packages/cli/lib/services/deploy.service.ts (1 hunks)
- packages/server/lib/controllers/flow.controller.ts (4 hunks)
- packages/server/lib/controllers/onboarding.controller.ts (2 hunks)
- packages/server/lib/controllers/v1/flow/preBuilt/postDeploy.ts (1 hunks)
- packages/server/lib/controllers/v1/flow/preBuilt/putUpgrade.ts (1 hunks)
- packages/server/lib/routes.ts (3 hunks)
- packages/server/lib/utils/tests.ts (1 hunks)
- packages/shared/lib/services/flow.service.ts (2 hunks)
- packages/shared/lib/services/sync/config/config.service.ts (1 hunks)
- packages/shared/lib/services/sync/config/deploy.service.ts (10 hunks)
- packages/shared/lib/services/sync/config/deploy.service.unit.test.ts (2 hunks)
- packages/types/lib/api.ts (2 hunks)
- packages/types/lib/deploy/incomingFlow.ts (1 hunks)
- packages/types/lib/flow/http.api.ts (1 hunks)
- packages/webapp/src/pages/Integration/FlowPage.tsx (3 hunks)
- packages/webapp/src/pages/Integration/Scripts.tsx (2 hunks)
- packages/webapp/src/pages/Integration/components/EnableDisableSync.tsx (4 hunks)
- packages/webapp/src/types.ts (1 hunks)
- packages/webapp/src/utils/api.tsx (2 hunks)
Additional context used
Biome
packages/shared/lib/services/sync/config/deploy.service.ts
[error] 274-274: Avoid the delete operator which can impact performance.
Unsafe fix: Use an undefined assignment instead.
(lint/performance/noDelete)
Additional comments not posted (34)
packages/types/lib/deploy/incomingFlow.ts (1)
49-49: Verify the usage ofIncomingFlowConfig.Ensure that all instances of
IncomingFlowConfigare updated to include theproviderConfigKeyfield.Run the following script to verify the usage:
Verification successful
Verification Successful:
providerConfigKeyis included inIncomingFlowConfiginstances.The
providerConfigKeyfield is present in the instances ofIncomingFlowConfigacross the codebase, confirming that the updates have been applied correctly.
- Instances of
IncomingFlowConfiginclude theproviderConfigKeyfield as expected.Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify all instances of `IncomingFlowConfig` include the `providerConfigKey` field. # Test: Search for the interface usage. Expect: Only occurrences with the `providerConfigKey` field. rg --type typescript -A 5 $'IncomingFlowConfig'Length of output: 81
Script:
#!/bin/bash # Description: Find all TypeScript files and search for `IncomingFlowConfig` usage to verify the inclusion of `providerConfigKey`. # Find all TypeScript files and search for `IncomingFlowConfig` usage fd --extension ts --exec rg 'IncomingFlowConfig' -A 5Length of output: 5643
packages/types/lib/api.ts (2)
1-1: Verify the usage ofApiError.Ensure that the
TErrorstype is used consistently across the codebase.Run the following script to verify the usage:
Verification successful
Consistent usage of
ApiErrorwithTErrorstype verified.The
TErrorstype in theApiErrorinterface is used consistently across the codebase, leveraging the flexibility provided by changing it toany. No inconsistencies were found.
- Instances of
ApiErrorare used with various error codes and types, such asValidationError[], indicating effective utilization of the flexibility.Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the consistent usage of `ApiError` with the `TErrors` type. # Test: Search for the interface usage. Expect: Consistent usage of `TErrors` type. rg --type typescript -A 5 $'ApiError'Length of output: 71
Script:
#!/bin/bash # Description: Verify the consistent usage of `ApiError` with the `TErrors` type. # Test: Search for the interface usage. Expect: Consistent usage of `TErrors` type. rg -A 5 $'ApiError'Length of output: 35227
75-75: Verify the usage ofEndpoint.Ensure that the new type condition for the
Errorsproperty is used consistently across the codebase.Run the following script to verify the usage:
Verification successful
The new type condition for the
Errorsproperty is consistently applied.The usage of the
Errorsproperty across the codebase aligns with the new type condition, confirming its consistent application. No further action is required.Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the consistent usage of `Endpoint` with the new type condition for the `Errors` property. # Test: Search for the interface usage. Expect: Consistent usage of the new type condition. rg --type typescript -A 5 $'Endpoint'Length of output: 71
Script:
#!/bin/bash # Description: Verify the consistent usage of `Endpoint` with the new type condition for the `Errors` property. # Test: Search for the interface usage. Expect: Consistent usage of the new type condition. rg --type ts -A 5 $'Endpoint'Length of output: 131217
Script:
#!/bin/bash # Description: Verify the consistent usage of the `Errors` property within the `Endpoint` interface. # Test: Search for the `Errors` property usage in the context of `Endpoint`. rg --type ts -A 5 $'Errors'Length of output: 34231
packages/server/lib/controllers/v1/flow/preBuilt/putUpgrade.ts (2)
1-7: LGTM!The import statements are relevant and necessary for the file's functionality.
9-19: LGTM!The validation schema is well-defined and ensures that the request body is correctly validated.
packages/server/lib/controllers/v1/flow/preBuilt/postDeploy.ts (2)
1-8: LGTM!The import statements are relevant and necessary for the file's functionality.
10-17: LGTM!The validation schema is well-defined and ensures that the request body is correctly validated.
packages/server/lib/utils/tests.ts (1)
68-70: LGTM!The modification simplifies the type assertion and aligns with the expected structure of the error response.
packages/webapp/src/types.ts (1)
Line range hint
1-1: LGTM! But verify the impact of the removal on the codebase.The removal of the
PreBuiltFlowinterface suggests that the functionality related to pre-built flows has been deprecated or refactored. Ensure that all components or services that relied on this interface are updated to accommodate this change.The code changes are approved.
Run the following script to verify the impact of the removal on the codebase:
packages/shared/lib/services/flow.service.ts (1)
68-77: LGTM! But verify the correctness of the method.The method is correctly implemented. However, ensure that the method retrieves the correct flow based on the provided integration provider and script name.
The code changes are approved.
Run the following script to verify the correctness of the method:
Verification successful
The
getFlowByIntegrationAndNamemethod is correctly implemented and used.The method is used in
putUpgrade.tsandpostDeploy.tsto retrieve flows based on the provided parameters. The error handling for unknown flows is appropriate, confirming that the method functions as intended.
- Files using the method:
packages/server/lib/controllers/v1/flow/preBuilt/putUpgrade.tspackages/server/lib/controllers/v1/flow/preBuilt/postDeploy.tsScripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the correctness of the `getFlowByIntegrationAndName` method. # Test: Search for the usage of the `getFlowByIntegrationAndName` method. Expect: Correct flow retrieval. rg --type javascript 'getFlowByIntegrationAndName'Length of output: 85
Script:
#!/bin/bash # Description: Verify the correctness of the `getFlowByIntegrationAndName` method. # Test: Search for the usage of the `getFlowByIntegrationAndName` method. Expect: Correct flow retrieval. rg --type typescript 'getFlowByIntegrationAndName'Length of output: 85
Script:
#!/bin/bash # Description: Verify the correctness of the `getFlowByIntegrationAndName` method. # Test: Search for the usage of the `getFlowByIntegrationAndName` method. Expect: Correct flow retrieval. rg --type ts 'getFlowByIntegrationAndName'Length of output: 619
Script:
#!/bin/bash # Extract relevant lines from putUpgrade.ts to analyze the usage of getFlowByIntegrationAndName rg --type ts -A 5 'getFlowByIntegrationAndName' packages/server/lib/controllers/v1/flow/preBuilt/putUpgrade.ts # Extract relevant lines from postDeploy.ts to analyze the usage of getFlowByIntegrationAndName rg --type ts -A 5 'getFlowByIntegrationAndName' packages/server/lib/controllers/v1/flow/preBuilt/postDeploy.tsLength of output: 701
packages/server/lib/controllers/flow.controller.ts (3)
15-16: LGTM!The updated import statements reflect a shift in the method used to retrieve configuration data, specifically altering the way configurations are fetched by utilizing the new method that likely aligns with the updated data structure or API.
The code changes are approved.
98-98: LGTM!The modification of the
downloadFlowmethod to utilizegetSyncConfigByIdsuggests a reorganization of how flow configurations are accessed, emphasizing the new method's role in fetching configurations based on the environment ID and a specific ID.The code changes are approved.
Line range hint
1-1: LGTM! But verify the impact of the removal on the codebase.The removal of the
deployPreBuiltFlowmethod suggests a potential shift in how pre-built flows are managed. Ensure that the responsibility for deploying pre-built flows is correctly delegated to another part of the application or refactored.The code changes are approved.
Run the following script to verify the impact of the removal on the codebase:
Verification successful
Removal of
deployPreBuiltFlowVerified: ThedeployPreBuiltFlowmethod has been successfully removed with no remaining references in the codebase. This confirms that the removal does not negatively impact other parts of the application.Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the impact of the removal of the `deployPreBuiltFlow` method on the codebase. # Test: Search for the usage of the `deployPreBuiltFlow` method. Expect: No occurrences. rg --type javascript 'deployPreBuiltFlow'Length of output: 76
Script:
#!/bin/bash # Description: Verify the impact of the removal of the `deployPreBuiltFlow` method on the codebase. # Test: Search for the usage of the `deployPreBuiltFlow` method. Expect: No occurrences. rg 'deployPreBuiltFlow'Length of output: 23
packages/shared/lib/services/sync/config/deploy.service.unit.test.ts (2)
71-72: LGTM!The addition of the
track_deletesproperty enhances the functionality by enabling tracking of deleted models.
110-111: LGTM!The addition of the
track_deletesproperty enhances the functionality by enabling tracking of deleted models.packages/webapp/src/pages/Integration/components/EnableDisableSync.tsx (6)
11-11: LGTM!The import of the
PostPreBuiltDeploytype is necessary for the changes in the function signatures.
69-76: LGTM!The change in the function signature reflects a shift in the expected input structure for creating new flows.
Line range hint
79-90: LGTM!The change in the function signature indicates a reduction in type specificity.
Line range hint
93-114: LGTM!The removal of the
_model_schemaparameter simplifies the function implementation.
147-167: LGTM!The function
onEnableSynccorrectly uses the updatedcreateNewFlowandreEnableFlowfunctions.
Line range hint
24-165: LGTM!The
EnableDisableSynccomponent correctly uses the updatedFlowPropsinterface.packages/server/lib/controllers/onboarding.controller.ts (3)
191-192: Addition oftrack_deletesproperty for sync configuration.The
track_deletesproperty is conditionally set based ongithubDemoSync.track_deletes. This enhances the configuration by allowing the tracking of deletions.The code changes are approved.
205-206: Addition oftrack_deletesproperty for action configuration.The
track_deletesproperty is conditionally set based ongithubDemoAction.track_deletes. This enhances the configuration by allowing the tracking of deletions.The code changes are approved.
210-210: Removal ofnangoYamlBodyparameter.The call to
deployPreBuiltSyncConfighas been updated to remove thenangoYamlBodyparameter, indicating a potential simplification or change in the deployment process.The code changes are approved.
packages/cli/lib/services/deploy.service.ts (1)
407-408: Addition oftrack_deletesproperty to action configuration.The
track_deletesproperty is added to the action configuration and is set tofalse. This indicates an enhancement in the service's capability to manage or log deletion actions.The code changes are approved.
packages/server/lib/routes.ts (2)
51-51: Update import path forputUpgradePreBuilt.The import path for
putUpgradePreBuilthas been updated, suggesting a reorganization of the file structure for better clarity or modularity.The code changes are approved.
273-274: Update routing endpoints for deploying and upgrading pre-built flows.The routing endpoints have been updated to reflect the new structure, potentially improving the logical grouping of related functionalities under the
pre-builtcategory.The code changes are approved.
packages/webapp/src/utils/api.tsx (1)
820-824: LGTM! But verify the function usage in the codebase.The function is correctly implemented with the new parameter type and endpoint URL. However, ensure that all function calls to
useCreateFlowmatch the new signature.The code changes are approved.
Run the following script to verify the function usage:
packages/shared/lib/services/sync/config/config.service.ts (1)
647-658: LGTM! But verify the function usage in the codebase.The function is correctly implemented with the new parameters and SQL query. However, ensure that all function calls to
getSyncConfigByIdmatch the new signature.The code changes are approved.
Run the following script to verify the function usage:
Verification successful
Function usage is consistent with the new implementation.
The function
getSyncConfigByIdis correctly used with the new parameters across the codebase. No discrepancies were found in the function calls.
flow.controller.ts: Correct usage withenvironmentIdandid.putUpgrade.ts: Correct usage withenvironmentIdandid.Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify all function calls to `getSyncConfigById` match the new signature. # Test: Search for the function usage. Expect: Only occurrences of the new signature. rg --type ts $'getSyncConfigById'Length of output: 737
packages/shared/lib/services/sync/config/deploy.service.ts (2)
Line range hint
220-336: LGTM! But verify the function usage in the codebase.The function is correctly implemented with the new parameters and optimized internal logic. However, ensure that all function calls to
upgradePreBuiltmatch the new signature.The code changes are approved.
Run the following script to verify the function usage:
Verification successful
Function Usage Verified:
The
upgradePrebuiltFlowfunction is correctly called with the new parameters inputUpgrade.ts, matching the updated signature. No issues were found with the function usage in the codebase.
- File:
packages/server/lib/controllers/v1/flow/preBuilt/putUpgrade.ts- Function Call: Correct parameters are used.
Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify all function calls to `upgradePreBuilt` match the new signature. # Test: Search for the function usage. Expect: Only occurrences of the new signature. rg --type ts $'upgradePreBuilt'Length of output: 313
Script:
#!/bin/bash # Description: Check how `upgradePrebuiltFlow` is used in `putUpgrade.ts`. # Test: Search for the usage of `upgradePrebuiltFlow` in the file. rg --type ts 'upgradePrebuiltFlow' -A 5Length of output: 1185
Line range hint
364-536: LGTM! But verify the function usage in the codebase.The function is correctly implemented with the new parameters and consolidated logic for handling public templates. However, ensure that all function calls to
deployPreBuiltmatch the new signature.The code changes are approved.
Run the following script to verify the function usage:
Verification successful
Function Usage Verified:
deployPreBuiltThe function
deployPreBuiltis used correctly with its new signature across the codebase. All instances match the expected parameters.
- Files Verified:
packages/server/lib/controllers/onboarding.controller.tspackages/server/lib/controllers/flow.controller.tspackages/server/lib/controllers/v1/flow/preBuilt/postDeploy.tsScripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify all function calls to `deployPreBuilt` match the new signature. # Test: Search for the function usage. Expect: Only occurrences of the new signature. rg --type ts $'deployPreBuilt'Length of output: 922
Script:
#!/bin/bash # Extract lines where `deployPreBuilt` is called in the identified files to verify the new signature. # Check usage in onboarding.controller.ts rg --type ts --context 5 'deployPreBuiltSyncConfig' packages/server/lib/controllers/onboarding.controller.ts # Check usage in flow.controller.ts rg --type ts --context 5 'deployPreBuiltSyncConfig' packages/server/lib/controllers/flow.controller.ts # Check usage in postDeploy.ts rg --type ts --context 5 'deployPreBuilt' packages/server/lib/controllers/v1/flow/preBuilt/postDeploy.tsLength of output: 2641
packages/webapp/src/pages/Integration/FlowPage.tsx (3)
26-26: LGTM!The import statement is correct and aligns with the changes in the file.
267-274: LGTM!The changes to the
upgradeFlowobject are correct and align with the new data model.
277-277: LGTM!The change in the API endpoint aligns with the new RESTful principles mentioned in the PR summary.
| export type PutUpgradePreBuiltFlow = Endpoint<{ | ||
| Method: 'PUT'; | ||
| Path: '/api/v1/flow/upgrade/pre-built'; | ||
| Body: IncomingFlowConfigUpgrade; | ||
| Error: ApiError<'upgrade_failed'>; | ||
| Path: '/api/v1/flow/pre-built/upgrade'; | ||
| Body: { | ||
| id: number; | ||
| provider: string; | ||
| scriptName: string; | ||
| type: ScriptTypeLiteral; | ||
| upgradeVersion: string; | ||
| lastDeployed: string; | ||
| providerConfigKey: string; | ||
| }; | ||
| Error: ApiError<'upgrade_failed'> | ApiError<'unknown_provider'> | ApiError<'unknown_sync_config'> | ApiError<'unknown_flow'> | ApiError<'invalid_version'>; |
There was a problem hiding this comment.
Consider validating the lastDeployed field.
Ensure that the lastDeployed field follows a proper date format to avoid potential issues with date handling.
Apply this diff to add a validation comment:
Body: {
id: number;
provider: string;
scriptName: string;
type: ScriptTypeLiteral;
upgradeVersion: string;
- lastDeployed: string;
+ lastDeployed: string; // Ensure this follows a proper date format
providerConfigKey: string;
};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.
| export type PutUpgradePreBuiltFlow = Endpoint<{ | |
| Method: 'PUT'; | |
| Path: '/api/v1/flow/upgrade/pre-built'; | |
| Body: IncomingFlowConfigUpgrade; | |
| Error: ApiError<'upgrade_failed'>; | |
| Path: '/api/v1/flow/pre-built/upgrade'; | |
| Body: { | |
| id: number; | |
| provider: string; | |
| scriptName: string; | |
| type: ScriptTypeLiteral; | |
| upgradeVersion: string; | |
| lastDeployed: string; | |
| providerConfigKey: string; | |
| }; | |
| Error: ApiError<'upgrade_failed'> | ApiError<'unknown_provider'> | ApiError<'unknown_sync_config'> | ApiError<'unknown_flow'> | ApiError<'invalid_version'>; | |
| export type PutUpgradePreBuiltFlow = Endpoint<{ | |
| Method: 'PUT'; | |
| Path: '/api/v1/flow/pre-built/upgrade'; | |
| Body: { | |
| id: number; | |
| provider: string; | |
| scriptName: string; | |
| type: ScriptTypeLiteral; | |
| upgradeVersion: string; | |
| lastDeployed: string; // Ensure this follows a proper date format | |
| providerConfigKey: string; | |
| }; | |
| Error: ApiError<'upgrade_failed'> | ApiError<'unknown_provider'> | ApiError<'unknown_sync_config'> | ApiError<'unknown_flow'> | ApiError<'invalid_version'>; |
| export type PostPreBuiltDeploy = Endpoint<{ | ||
| Method: 'POST'; | ||
| Path: '/api/v1/flow/pre-built/deploy'; | ||
| Body: { | ||
| provider: string; | ||
| providerConfigKey: string; | ||
| scriptName: string; | ||
| type: ScriptTypeLiteral; | ||
| }; | ||
| Error: ApiError<'unknown_provider'> | ApiError<'resource_capped'> | ApiError<'failed_to_deploy', Error[]> | ApiError<'unknown_flow'>; | ||
| Success: { | ||
| data: { | ||
| id: number; | ||
| }; | ||
| }; | ||
| }>; |
There was a problem hiding this comment.
Consider validating the providerConfigKey field.
Ensure that the providerConfigKey field follows a proper format to avoid potential issues with configuration handling.
Apply this diff to add a validation comment:
Body: {
provider: string;
providerConfigKey: string;
scriptName: string;
type: ScriptTypeLiteral;
};
Error: ApiError<'unknown_provider'> | ApiError<'resource_capped'> | ApiError<'failed_to_deploy', Error[]> | ApiError<'unknown_flow'>;
Success: {
data: {
id: number;
};
};
+// Ensure `providerConfigKey` follows a proper formatCommittable 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.
| export type PostPreBuiltDeploy = Endpoint<{ | |
| Method: 'POST'; | |
| Path: '/api/v1/flow/pre-built/deploy'; | |
| Body: { | |
| provider: string; | |
| providerConfigKey: string; | |
| scriptName: string; | |
| type: ScriptTypeLiteral; | |
| }; | |
| Error: ApiError<'unknown_provider'> | ApiError<'resource_capped'> | ApiError<'failed_to_deploy', Error[]> | ApiError<'unknown_flow'>; | |
| Success: { | |
| data: { | |
| id: number; | |
| }; | |
| }; | |
| }>; | |
| export type PostPreBuiltDeploy = Endpoint<{ | |
| Method: 'POST'; | |
| Path: '/api/v1/flow/pre-built/deploy'; | |
| Body: { | |
| provider: string; | |
| providerConfigKey: string; | |
| scriptName: string; | |
| type: ScriptTypeLiteral; | |
| }; | |
| Error: ApiError<'unknown_provider'> | ApiError<'resource_capped'> | ApiError<'failed_to_deploy', Error[]> | ApiError<'unknown_flow'>; | |
| Success: { | |
| data: { | |
| id: number; | |
| }; | |
| }; | |
| // Ensure `providerConfigKey` follows a proper format | |
| }>; |
| track_deletes: boolean; | ||
| providerConfigKey: string; |
There was a problem hiding this comment.
Document the track_deletes field.
Add documentation to explain the purpose of the track_deletes field.
Apply this diff to add documentation:
track_deletes: boolean;
+// Indicates whether deletes are tracked
providerConfigKey: string;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.
| track_deletes: boolean; | |
| providerConfigKey: string; | |
| track_deletes: boolean; | |
| // Indicates whether deletes are tracked | |
| providerConfigKey: string; |
| export const putUpgradePreBuilt = asyncWrapper<PutUpgradePreBuiltFlow>(async (req, res) => { | ||
| const emptyQuery = requireEmptyQuery(req, { withEnv: true }); | ||
| if (emptyQuery) { | ||
| res.status(400).send({ error: { code: 'invalid_query_params', errors: zodErrorToHTTP(emptyQuery.error) } }); | ||
| return; | ||
| } | ||
|
|
||
| const val = validation.safeParse(req.body); | ||
| if (!val.success) { | ||
| res.status(400).send({ | ||
| error: { code: 'invalid_body', errors: zodErrorToHTTP(val.error) } | ||
| }); | ||
| return; | ||
| } | ||
|
|
||
| const body: PutUpgradePreBuiltFlow['Body'] = val.data; | ||
| const { environment, account } = res.locals; | ||
|
|
||
| const syncConfig = await getSyncConfigById(environment.id, body.id); | ||
| if (!syncConfig) { | ||
| res.status(400).send({ | ||
| error: { code: 'unknown_sync_config' } | ||
| }); | ||
| return; | ||
| } | ||
|
|
||
| const config = await configService.getProviderConfig(body.providerConfigKey, environment.id); | ||
| if (!config) { | ||
| res.status(400).send({ error: { code: 'unknown_provider' } }); | ||
| return; | ||
| } | ||
|
|
||
| const flow = flowService.getFlowByIntegrationAndName({ provider: body.provider, type: body.type, scriptName: body.scriptName }); | ||
| if (!flow) { | ||
| res.status(400).send({ error: { code: 'unknown_flow' } }); | ||
| return; | ||
| } | ||
|
|
||
| if (flow.version !== body.upgradeVersion) { | ||
| res.status(400).send({ error: { code: 'invalid_version' } }); | ||
| return; | ||
| } | ||
|
|
||
| const result = await upgradePrebuiltFlow({ | ||
| environment, | ||
| account, | ||
| config, | ||
| syncConfig, | ||
| flow, | ||
| logContextGetter | ||
| }); | ||
|
|
||
| if (result.isOk()) { | ||
| res.send({ success: true }); | ||
| return; | ||
| } | ||
|
|
||
| res.status(400).send({ error: { code: 'upgrade_failed', message: result.error.message } }); | ||
| }); |
There was a problem hiding this comment.
Consider refactoring for improved readability and error handling.
The function is well-structured and handles various scenarios effectively. However, consider the following improvements:
- Refactor the function to reduce complexity and improve readability.
- Use a centralized error handling mechanism to handle errors consistently.
Example refactor:
export const putUpgradePreBuilt = asyncWrapper<PutUpgradePreBuiltFlow>(async (req, res) => {
const emptyQuery = requireEmptyQuery(req, { withEnv: true });
if (emptyQuery) {
return res.status(400).send({ error: { code: 'invalid_query_params', errors: zodErrorToHTTP(emptyQuery.error) } });
}
const val = validation.safeParse(req.body);
if (!val.success) {
return res.status(400).send({ error: { code: 'invalid_body', errors: zodErrorToHTTP(val.error) } });
}
const body: PutUpgradePreBuiltFlow['Body'] = val.data;
const { environment, account } = res.locals;
try {
const syncConfig = await getSyncConfigById(environment.id, body.id);
if (!syncConfig) throw new Error('unknown_sync_config');
const config = await configService.getProviderConfig(body.providerConfigKey, environment.id);
if (!config) throw new Error('unknown_provider');
const flow = flowService.getFlowByIntegrationAndName({ provider: body.provider, type: body.type, scriptName: body.scriptName });
if (!flow) throw new Error('unknown_flow');
if (flow.version !== body.upgradeVersion) throw new Error('invalid_version');
const result = await upgradePrebuiltFlow({ environment, account, config, syncConfig, flow, logContextGetter });
if (!result.isOk()) throw new Error(result.error.message);
res.send({ success: true });
} catch (error) {
res.status(400).send({ error: { code: error.message } });
}
});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.
| export const putUpgradePreBuilt = asyncWrapper<PutUpgradePreBuiltFlow>(async (req, res) => { | |
| const emptyQuery = requireEmptyQuery(req, { withEnv: true }); | |
| if (emptyQuery) { | |
| res.status(400).send({ error: { code: 'invalid_query_params', errors: zodErrorToHTTP(emptyQuery.error) } }); | |
| return; | |
| } | |
| const val = validation.safeParse(req.body); | |
| if (!val.success) { | |
| res.status(400).send({ | |
| error: { code: 'invalid_body', errors: zodErrorToHTTP(val.error) } | |
| }); | |
| return; | |
| } | |
| const body: PutUpgradePreBuiltFlow['Body'] = val.data; | |
| const { environment, account } = res.locals; | |
| const syncConfig = await getSyncConfigById(environment.id, body.id); | |
| if (!syncConfig) { | |
| res.status(400).send({ | |
| error: { code: 'unknown_sync_config' } | |
| }); | |
| return; | |
| } | |
| const config = await configService.getProviderConfig(body.providerConfigKey, environment.id); | |
| if (!config) { | |
| res.status(400).send({ error: { code: 'unknown_provider' } }); | |
| return; | |
| } | |
| const flow = flowService.getFlowByIntegrationAndName({ provider: body.provider, type: body.type, scriptName: body.scriptName }); | |
| if (!flow) { | |
| res.status(400).send({ error: { code: 'unknown_flow' } }); | |
| return; | |
| } | |
| if (flow.version !== body.upgradeVersion) { | |
| res.status(400).send({ error: { code: 'invalid_version' } }); | |
| return; | |
| } | |
| const result = await upgradePrebuiltFlow({ | |
| environment, | |
| account, | |
| config, | |
| syncConfig, | |
| flow, | |
| logContextGetter | |
| }); | |
| if (result.isOk()) { | |
| res.send({ success: true }); | |
| return; | |
| } | |
| res.status(400).send({ error: { code: 'upgrade_failed', message: result.error.message } }); | |
| }); | |
| export const putUpgradePreBuilt = asyncWrapper<PutUpgradePreBuiltFlow>(async (req, res) => { | |
| const emptyQuery = requireEmptyQuery(req, { withEnv: true }); | |
| if (emptyQuery) { | |
| return res.status(400).send({ error: { code: 'invalid_query_params', errors: zodErrorToHTTP(emptyQuery.error) } }); | |
| } | |
| const val = validation.safeParse(req.body); | |
| if (!val.success) { | |
| return res.status(400).send({ error: { code: 'invalid_body', errors: zodErrorToHTTP(val.error) } }); | |
| } | |
| const body: PutUpgradePreBuiltFlow['Body'] = val.data; | |
| const { environment, account } = res.locals; | |
| try { | |
| const syncConfig = await getSyncConfigById(environment.id, body.id); | |
| if (!syncConfig) throw new Error('unknown_sync_config'); | |
| const config = await configService.getProviderConfig(body.providerConfigKey, environment.id); | |
| if (!config) throw new Error('unknown_provider'); | |
| const flow = flowService.getFlowByIntegrationAndName({ provider: body.provider, type: body.type, scriptName: body.scriptName }); | |
| if (!flow) throw new Error('unknown_flow'); | |
| if (flow.version !== body.upgradeVersion) throw new Error('invalid_version'); | |
| const result = await upgradePrebuiltFlow({ environment, account, config, syncConfig, flow, logContextGetter }); | |
| if (!result.isOk()) throw new Error(result.error.message); | |
| res.send({ success: true }); | |
| } catch (error) { | |
| res.status(400).send({ error: { code: error.message } }); | |
| } | |
| }); |
| export const postPreBuiltDeploy = asyncWrapper<PostPreBuiltDeploy>(async (req, res) => { | ||
| const emptyQuery = requireEmptyQuery(req, { withEnv: true }); | ||
| if (emptyQuery) { | ||
| res.status(400).send({ error: { code: 'invalid_query_params', errors: zodErrorToHTTP(emptyQuery.error) } }); | ||
| return; | ||
| } | ||
|
|
||
| const val = validation.safeParse(req.body); | ||
| if (!val.success) { | ||
| res.status(400).send({ | ||
| error: { code: 'invalid_body', errors: zodErrorToHTTP(val.error) } | ||
| }); | ||
| return; | ||
| } | ||
|
|
||
| const body: PostPreBuiltDeploy['Body'] = val.data; | ||
|
|
||
| const { environment, account } = res.locals; | ||
| const environmentId = environment.id; | ||
|
|
||
| const config = await configService.getConfigIdByProviderConfigKey(body.providerConfigKey, environmentId); | ||
| if (!config) { | ||
| res.status(400).send({ error: { code: 'unknown_provider' } }); | ||
| return; | ||
| } | ||
|
|
||
| if (account.is_capped) { | ||
| const isCapped = await connectionService.shouldCapUsage({ providerConfigKey: body.providerConfigKey, environmentId, type: 'activate' }); | ||
| if (isCapped) { | ||
| res.status(400).send({ error: { code: 'resource_capped' } }); | ||
| return; | ||
| } | ||
| } | ||
|
|
||
| const flow = flowService.getFlowByIntegrationAndName({ provider: body.provider, type: body.type, scriptName: body.scriptName }); | ||
| if (!flow) { | ||
| res.status(400).send({ error: { code: 'unknown_flow' } }); | ||
| return; | ||
| } | ||
|
|
||
| const { success, error, response } = await deployPreBuilt({ | ||
| environment, | ||
| account, | ||
| configs: [ | ||
| { | ||
| ...flow, | ||
| public_route: body.provider, | ||
| provider: body.provider, | ||
| providerConfigKey: body.providerConfigKey, | ||
| model_schema: flow.models as unknown as any, | ||
| is_public: true, | ||
| type: flow.type!, | ||
| models: flow.returns, | ||
| track_deletes: flow.track_deletes === true, | ||
| metadata: { description: flow.description, scopes: flow.scopes } | ||
| } | ||
| ], | ||
| logContextGetter, | ||
| orchestrator | ||
| }); | ||
|
|
||
| if (!success || response === null) { | ||
| res.status(503).send({ error: { code: 'failed_to_deploy', errors: [error!] } }); | ||
| return; | ||
| } | ||
|
|
||
| await syncManager.triggerIfConnectionsExist(response.result, environmentId, logContextGetter, orchestrator); | ||
|
|
||
| res.status(201).send({ data: { id: response.result[0]!.id! } }); |
There was a problem hiding this comment.
Consider refactoring for improved readability and error handling.
The function is well-structured and handles various scenarios effectively. However, consider the following improvements:
- Refactor the function to reduce complexity and improve readability.
- Use a centralized error handling mechanism to handle errors consistently.
Example refactor:
export const postPreBuiltDeploy = asyncWrapper<PostPreBuiltDeploy>(async (req, res) => {
const emptyQuery = requireEmptyQuery(req, { withEnv: true });
if (emptyQuery) {
return res.status(400).send({ error: { code: 'invalid_query_params', errors: zodErrorToHTTP(emptyQuery.error) } });
}
const val = validation.safeParse(req.body);
if (!val.success) {
return res.status(400).send({ error: { code: 'invalid_body', errors: zodErrorToHTTP(val.error) } });
}
const body: PostPreBuiltDeploy['Body'] = val.data;
const { environment, account } = res.locals;
const environmentId = environment.id;
try {
const config = await configService.getConfigIdByProviderConfigKey(body.providerConfigKey, environmentId);
if (!config) throw new Error('unknown_provider');
if (account.is_capped) {
const isCapped = await connectionService.shouldCapUsage({ providerConfigKey: body.providerConfigKey, environmentId, type: 'activate' });
if (isCapped) throw new Error('resource_capped');
}
const flow = flowService.getFlowByIntegrationAndName({ provider: body.provider, type: body.type, scriptName: body.scriptName });
if (!flow) throw new Error('unknown_flow');
const { success, error, response } = await deployPreBuilt({
environment,
account,
configs: [
{
...flow,
public_route: body.provider,
provider: body.provider,
providerConfigKey: body.providerConfigKey,
model_schema: flow.models as unknown as any,
is_public: true,
type: flow.type!,
models: flow.returns,
track_deletes: flow.track_deletes === true,
metadata: { description: flow.description, scopes: flow.scopes }
}
],
logContextGetter,
orchestrator
});
if (!success || response === null) throw new Error(error!.message);
await syncManager.triggerIfConnectionsExist(response.result, environmentId, logContextGetter, orchestrator);
res.status(201).send({ data: { id: response.result[0]!.id! } });
} catch (error) {
res.status(400).send({ error: { code: error.message } });
}
});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.
| export const postPreBuiltDeploy = asyncWrapper<PostPreBuiltDeploy>(async (req, res) => { | |
| const emptyQuery = requireEmptyQuery(req, { withEnv: true }); | |
| if (emptyQuery) { | |
| res.status(400).send({ error: { code: 'invalid_query_params', errors: zodErrorToHTTP(emptyQuery.error) } }); | |
| return; | |
| } | |
| const val = validation.safeParse(req.body); | |
| if (!val.success) { | |
| res.status(400).send({ | |
| error: { code: 'invalid_body', errors: zodErrorToHTTP(val.error) } | |
| }); | |
| return; | |
| } | |
| const body: PostPreBuiltDeploy['Body'] = val.data; | |
| const { environment, account } = res.locals; | |
| const environmentId = environment.id; | |
| const config = await configService.getConfigIdByProviderConfigKey(body.providerConfigKey, environmentId); | |
| if (!config) { | |
| res.status(400).send({ error: { code: 'unknown_provider' } }); | |
| return; | |
| } | |
| if (account.is_capped) { | |
| const isCapped = await connectionService.shouldCapUsage({ providerConfigKey: body.providerConfigKey, environmentId, type: 'activate' }); | |
| if (isCapped) { | |
| res.status(400).send({ error: { code: 'resource_capped' } }); | |
| return; | |
| } | |
| } | |
| const flow = flowService.getFlowByIntegrationAndName({ provider: body.provider, type: body.type, scriptName: body.scriptName }); | |
| if (!flow) { | |
| res.status(400).send({ error: { code: 'unknown_flow' } }); | |
| return; | |
| } | |
| const { success, error, response } = await deployPreBuilt({ | |
| environment, | |
| account, | |
| configs: [ | |
| { | |
| ...flow, | |
| public_route: body.provider, | |
| provider: body.provider, | |
| providerConfigKey: body.providerConfigKey, | |
| model_schema: flow.models as unknown as any, | |
| is_public: true, | |
| type: flow.type!, | |
| models: flow.returns, | |
| track_deletes: flow.track_deletes === true, | |
| metadata: { description: flow.description, scopes: flow.scopes } | |
| } | |
| ], | |
| logContextGetter, | |
| orchestrator | |
| }); | |
| if (!success || response === null) { | |
| res.status(503).send({ error: { code: 'failed_to_deploy', errors: [error!] } }); | |
| return; | |
| } | |
| await syncManager.triggerIfConnectionsExist(response.result, environmentId, logContextGetter, orchestrator); | |
| res.status(201).send({ data: { id: response.result[0]!.id! } }); | |
| export const postPreBuiltDeploy = asyncWrapper<PostPreBuiltDeploy>(async (req, res) => { | |
| const emptyQuery = requireEmptyQuery(req, { withEnv: true }); | |
| if (emptyQuery) { | |
| return res.status(400).send({ error: { code: 'invalid_query_params', errors: zodErrorToHTTP(emptyQuery.error) } }); | |
| } | |
| const val = validation.safeParse(req.body); | |
| if (!val.success) { | |
| return res.status(400).send({ error: { code: 'invalid_body', errors: zodErrorToHTTP(val.error) } }); | |
| } | |
| const body: PostPreBuiltDeploy['Body'] = val.data; | |
| const { environment, account } = res.locals; | |
| const environmentId = environment.id; | |
| try { | |
| const config = await configService.getConfigIdByProviderConfigKey(body.providerConfigKey, environmentId); | |
| if (!config) throw new Error('unknown_provider'); | |
| if (account.is_capped) { | |
| const isCapped = await connectionService.shouldCapUsage({ providerConfigKey: body.providerConfigKey, environmentId, type: 'activate' }); | |
| if (isCapped) throw new Error('resource_capped'); | |
| } | |
| const flow = flowService.getFlowByIntegrationAndName({ provider: body.provider, type: body.type, scriptName: body.scriptName }); | |
| if (!flow) throw new Error('unknown_flow'); | |
| const { success, error, response } = await deployPreBuilt({ | |
| environment, | |
| account, | |
| configs: [ | |
| { | |
| ...flow, | |
| public_route: body.provider, | |
| provider: body.provider, | |
| providerConfigKey: body.providerConfigKey, | |
| model_schema: flow.models as unknown as any, | |
| is_public: true, | |
| type: flow.type!, | |
| models: flow.returns, | |
| track_deletes: flow.track_deletes === true, | |
| metadata: { description: flow.description, scopes: flow.scopes } | |
| } | |
| ], | |
| logContextGetter, | |
| orchestrator | |
| }); | |
| if (!success || response === null) throw new Error(error!.message); | |
| await syncManager.triggerIfConnectionsExist(response.result, environmentId, logContextGetter, orchestrator); | |
| res.status(201).send({ data: { id: response.result[0]!.id! } }); | |
| } catch (error) { | |
| res.status(400).send({ error: { code: error.message } }); | |
| } | |
| }); |
Describe your changes
Contributes to https://linear.app/nango/issue/NAN-1537/script-v2-integrate-ui
/deploy|upgrade/pre-built->/pre-build/deploy|upgradejust for the sake of REST logic🧪 Test
Summary by CodeRabbit
New Features
Bug Fixes
Refactor
Documentation
Tests
track_deletesproperty.