Fix Sync Feature #467
Fix Sync Feature #467
Conversation
|
@mit-27 is attempting to deploy a commit to the Panora Team on Vercel. A member of the Team first needs to authorize it. |
|
WalkthroughThe recent updates focus on enhancing the synchronization feature across various modules and services within the project. Key changes include integrating the Changes
Sequence Diagram(s) (Beta)sequenceDiagram
participant Client
participant ConnectionsController
participant CoreSyncService
participant CRMService
participant AccountingService
participant MarketingAutomationService
participant TicketingService
Client ->> ConnectionsController: handleCallback()
ConnectionsController ->> CRMService: await crmService.handleCallback()
ConnectionsController ->> AccountingService: await accountingService.handleCallback()
ConnectionsController ->> MarketingAutomationService: await marketingAutomationService.handleCallback()
ConnectionsController ->> TicketingService: await ticketingService.handleCallback()
ConnectionsController ->> CoreSyncService: initialSync()
CoreSyncService ->> Database: Sync Data
CoreSyncService -->> ConnectionsController: Sync Complete
ConnectionsController -->> Client: Redirect with status
Assessment against linked issues
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 as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
There was a problem hiding this comment.
PR Summary
- Introduced initial sync feature in
connections.controller.tsfor new connections - Added multiple CRM and ticketing modules in
connections.module.ts - Implemented
initialSyncmethod inCoreSyncServicefor comprehensive sync - Modified error handling in
Utilsclass to returnundefinedfor missingtcg_contact - Improved immutability in
GitlabCommentMapperby using the spread operator
| @@ -42,9 +46,107 @@ export class CoreSyncService { | |||
| this.logger.setContext(CoreSyncService.name); | |||
| } | |||
|
|
|||
There was a problem hiding this comment.
Add a comment explaining the purpose of the initialSync method.
| @@ -126,7 +126,7 @@ export class Utils { | |||
| id_tcg_collection: uuid, | |||
There was a problem hiding this comment.
Returning undefined instead of throwing an error changes the method's behavior. Ensure that all calling code handles undefined appropriately.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Review Details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files ignored due to path filters (1)
packages/api/swagger/swagger-spec.jsonis excluded by!**/*.json
Files selected for processing (5)
- packages/api/src/@core/connections/connections.controller.ts (5 hunks)
- packages/api/src/@core/connections/connections.module.ts (2 hunks)
- packages/api/src/@core/sync/sync.service.ts (3 hunks)
- packages/api/src/ticketing/@lib/@utils/index.ts (1 hunks)
- packages/api/src/ticketing/comment/services/gitlab/mappers.ts (2 hunks)
Additional Context Used
Biome (47)
packages/api/src/@core/connections/connections.controller.ts (20)
55-55: Decorators are not valid here.
56-56: Decorators are not valid here.
57-57: Decorators are not valid here.
58-58: Decorators are not valid here.
136-136: Decorators are not valid here.
137-137: Decorators are not valid here.
138-138: Decorators are not valid here.
139-139: Decorators are not valid here.
140-140: Decorators are not valid here.
141-141: Decorators are not valid here.
142-142: Decorators are not valid here.
143-143: Decorators are not valid here.
161-161: Decorators are not valid here.
75-75: Other switch clauses can erroneously access this declaration.
Wrap the declaration in a block to restrict its access to the switch clause.
161-161: Unexpected any. Specify a different type.
8-9: All these imports are only used as types.
9-10: All these imports are only used as types.
10-11: All these imports are only used as types.
12-13: All these imports are only used as types.
14-15: All these imports are only used as types.
packages/api/src/@core/sync/sync.service.ts (20)
83-88: Other switch clauses can erroneously access this declaration.
Wrap the declaration in a block to restrict its access to the switch clause.
116-121: Other switch clauses can erroneously access this declaration.
Wrap the declaration in a block to restrict its access to the switch clause.
150-152: This code is unreachable
188-188: Do not use template literals if interpolation and special-character handling are not needed.
1-2: All these imports are only used as types.
4-5: All these imports are only used as types.
6-7: All these imports are only used as types.
7-8: All these imports are only used as types.
8-9: All these imports are only used as types.
9-10: All these imports are only used as types.
10-11: All these imports are only used as types.
11-12: All these imports are only used as types.
12-13: All these imports are only used as types.
13-14: All these imports are only used as types.
14-15: All these imports are only used as types.
15-16: All these imports are only used as types.
16-17: All these imports are only used as types.
17-18: All these imports are only used as types.
18-19: All these imports are only used as types.
19-20: All these imports are only used as types.
packages/api/src/ticketing/@lib/@utils/index.ts (1)
2-2: A Node.js builtin module should be imported with the node: protocol.
packages/api/src/ticketing/comment/services/gitlab/mappers.ts (6)
65-65: This variable implicitly has the any type.
1-1: All these imports are only used as types.
1-5: All these imports are only used as types.
5-6: All these imports are only used as types.
6-7: All these imports are only used as types.
9-10: All these imports are only used as types.
Additional comments not posted (8)
packages/api/src/@core/connections/connections.module.ts (3)
10-26: Ensure that all newly added modules are properly initialized and used within the system.
35-50: Verify that all modules are correctly imported and utilized in theimportsarray of the@Moduledecorator.
52-52: AddingCoreSyncServiceto providers ensures that it can be injected where needed in this module. Good encapsulation and modularity.packages/api/src/ticketing/comment/services/gitlab/mappers.ts (1)
87-87: The use of the spread operator to includeuser_idandticket_idinoptsensures that the existing properties are not overwritten, which is a good practice for maintaining data integrity.Also applies to: 105-109
packages/api/src/ticketing/@lib/@utils/index.ts (1)
129-129: The early return pattern used here prevents further execution ifresis null, which is a good practice for avoiding errors in subsequent lines of code.packages/api/src/@core/connections/connections.controller.ts (2)
20-20: The integration ofCoreSyncServicein the constructor and its use in thehandleCallbackmethod aligns with the PR objectives to trigger an initial sync upon a new connection. This is crucial for ensuring data consistency from the start.Also applies to: 38-38
Line range hint
54-128: ThehandleCallbackmethod is well-structured with clear error handling and appropriate redirects. The use ofswitchonverticalto handle different connection types is a good practice, ensuring that each type is handled according to its specific needs.packages/api/src/@core/sync/sync.service.ts (1)
49-140: TheinitialSyncmethod is comprehensive and well-structured. It handles synchronization tasks for different services based on thevertical. The use of asynchronous tasks and error handling within the sync operations is a good practice, ensuring robustness and reliability.
|
| GitGuardian id | GitGuardian status | Secret | Commit | Filename | |
|---|---|---|---|---|---|
| 9763120 | Triggered | Generic High Entropy Secret | 66aedfb | docs/mint.json | View secret |
🛠 Guidelines to remediate hardcoded secrets
- Understand the implications of revoking this secret by investigating where it is used in your code.
- Replace and store your secret safely. Learn here the best practices.
- Revoke and rotate this secret.
- If possible, rewrite git history. Rewriting git history is not a trivial act. You might completely break other contributing developers' workflow and you risk accidentally deleting legitimate data.
To avoid such incidents in the future consider
- following these best practices for managing and storing secrets including API keys and other credentials
- install secret detection on pre-commit to catch secret before it leaves your machine and ease remediation.
🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.
There was a problem hiding this comment.
Actionable comments posted: 0
Review Details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (2)
- packages/api/src/@core/connections/connections.controller.ts (5 hunks)
- packages/api/src/@core/sync/sync.service.ts (3 hunks)
Additional Context Used
Biome (40)
packages/api/src/@core/connections/connections.controller.ts (20)
55-55: Decorators are not valid here.
56-56: Decorators are not valid here.
57-57: Decorators are not valid here.
58-58: Decorators are not valid here.
127-127: Decorators are not valid here.
128-128: Decorators are not valid here.
129-129: Decorators are not valid here.
130-130: Decorators are not valid here.
131-131: Decorators are not valid here.
132-132: Decorators are not valid here.
133-133: Decorators are not valid here.
134-134: Decorators are not valid here.
152-152: Decorators are not valid here.
75-75: Other switch clauses can erroneously access this declaration.
Wrap the declaration in a block to restrict its access to the switch clause.
152-152: Unexpected any. Specify a different type.
8-9: All these imports are only used as types.
9-10: All these imports are only used as types.
10-11: All these imports are only used as types.
12-13: All these imports are only used as types.
14-15: All these imports are only used as types.
packages/api/src/@core/sync/sync.service.ts (20)
83-88: Other switch clauses can erroneously access this declaration.
Wrap the declaration in a block to restrict its access to the switch clause.
116-121: Other switch clauses can erroneously access this declaration.
Wrap the declaration in a block to restrict its access to the switch clause.
144-146: This code is unreachable
182-182: Do not use template literals if interpolation and special-character handling are not needed.
1-2: All these imports are only used as types.
4-5: All these imports are only used as types.
6-7: All these imports are only used as types.
7-8: All these imports are only used as types.
8-9: All these imports are only used as types.
9-10: All these imports are only used as types.
10-11: All these imports are only used as types.
11-12: All these imports are only used as types.
12-13: All these imports are only used as types.
13-14: All these imports are only used as types.
14-15: All these imports are only used as types.
15-16: All these imports are only used as types.
16-17: All these imports are only used as types.
17-18: All these imports are only used as types.
18-19: All these imports are only used as types.
19-20: All these imports are only used as types.
Additional comments not posted (12)
packages/api/src/@core/connections/connections.controller.ts (8)
20-20: Added import forCoreSyncService.This import is necessary for the new functionality introduced in the
handleCallbackmethod.
38-38: AddedcoreSyncServiceas a private property.This is a good practice for dependency injection and will be used in the
handleCallbackmethod.
54-54: MethodhandleCallbackis now asynchronous.Changing this method to async is appropriate since it now includes asynchronous operations such as
initialSync.
76-76: Call tocrmConnectionsService.handleCRMCallBackwithin the CRM case of the switch statement.This is a necessary call to handle CRM-specific callback logic.
89-89: Call toaccountingConnectionsService.handleAccountingCallBackwithin the Accounting case of the switch statement.Proper handling of the accounting callback as per the new sync requirements.
101-101: Call tomarketingAutomationConnectionsService.handleMarketingAutomationCallBackwithin the Marketing Automation case of the switch statement.Ensures that marketing automation callbacks are handled correctly.
109-109: Call toticketingConnectionsService.handleTicketingCallBackwithin the Ticketing case of the switch statement.Correct implementation for handling ticketing callbacks.
118-118: Integration ofinitialSyncin thehandleCallbackmethod.This integration is crucial for initiating the sync process once the callback is handled.
packages/api/src/@core/sync/sync.service.ts (4)
3-5: Added imports forConnectorCategory,CrmObject, andENGAGEMENTS_TYPE.These imports are necessary for the new functionality in the
initialSyncmethod.
28-28: Constructor now includesPrismaServiceand various sync services.This setup is essential for the operations performed in the
initialSyncmethod.
49-138: Implementation of theinitialSyncmethod.The method is well-structured and handles different verticals appropriately. However, consider adding a comment explaining the purpose of this method for better maintainability.
49-49: Add a comment explaining the purpose of theinitialSyncmethod.This comment was previously suggested by another reviewer and is still valid.
There was a problem hiding this comment.
Actionable comments posted: 0
Review Details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files ignored due to path filters (3)
docs/logo/fav.pngis excluded by!**/*.png,!**/*.pngdocs/logo/favicon.pngis excluded by!**/*.png,!**/*.pngdocs/mint.jsonis excluded by!**/*.json
Files selected for processing (5)
- docs/api-reference/introduction.mdx (1 hunks)
- packages/api/scripts/connectorUpdate.js (3 hunks)
- packages/api/src/@core/connections/connections.controller.ts (6 hunks)
- packages/api/src/@core/sync/sync.service.ts (3 hunks)
- packages/api/src/@core/utils/types/original/original.ticketing.ts (4 hunks)
Files skipped from review due to trivial changes (1)
- docs/api-reference/introduction.mdx
Additional Context Used
Biome (78)
packages/api/scripts/connectorUpdate.js (18)
10-10: A Node.js builtin module should be imported with the node: protocol.
11-11: A Node.js builtin module should be imported with the node: protocol.
12-12: A Node.js builtin module should be imported with the node: protocol.
75-75: Template literals are preferred over string concatenation.
79-120: Prefer for...of instead of forEach.
162-197: Prefer for...of instead of forEach.
201-205: Template literals are preferred over string concatenation.
251-269: Prefer for...of instead of forEach.
253-253: Template literals are preferred over string concatenation.
260-260: This regular expression contains unclear uses of consecutive spaces.
263-263: Template literals are preferred over string concatenation.
284-284: Change to an optional chain.
295-301: Prefer for...of instead of forEach.
35-35: This let declares a variable that is only assigned once.
71-71: Reassigning a function parameter is confusing.
140-140: This let declares a variable that is only assigned once.
279-279: This let declares a variable that is only assigned once.
285-285: This let declares a variable that is only assigned once.
packages/api/src/@core/connections/connections.controller.ts (20)
55-55: Decorators are not valid here.
56-56: Decorators are not valid here.
57-57: Decorators are not valid here.
58-58: Decorators are not valid here.
125-125: Decorators are not valid here.
126-126: Decorators are not valid here.
127-127: Decorators are not valid here.
128-128: Decorators are not valid here.
129-129: Decorators are not valid here.
130-130: Decorators are not valid here.
131-131: Decorators are not valid here.
132-132: Decorators are not valid here.
150-150: Decorators are not valid here.
75-75: Other switch clauses can erroneously access this declaration.
Wrap the declaration in a block to restrict its access to the switch clause.
150-150: Unexpected any. Specify a different type.
8-9: All these imports are only used as types.
9-10: All these imports are only used as types.
10-11: All these imports are only used as types.
12-13: All these imports are only used as types.
14-15: All these imports are only used as types.
packages/api/src/@core/sync/sync.service.ts (20)
83-88: Other switch clauses can erroneously access this declaration.
Wrap the declaration in a block to restrict its access to the switch clause.
116-121: Other switch clauses can erroneously access this declaration.
Wrap the declaration in a block to restrict its access to the switch clause.
144-146: This code is unreachable
182-182: Do not use template literals if interpolation and special-character handling are not needed.
1-2: All these imports are only used as types.
4-5: All these imports are only used as types.
6-7: All these imports are only used as types.
7-8: All these imports are only used as types.
8-9: All these imports are only used as types.
9-10: All these imports are only used as types.
10-11: All these imports are only used as types.
11-12: All these imports are only used as types.
12-13: All these imports are only used as types.
13-14: All these imports are only used as types.
14-15: All these imports are only used as types.
15-16: All these imports are only used as types.
16-17: All these imports are only used as types.
17-18: All these imports are only used as types.
18-19: All these imports are only used as types.
19-20: All these imports are only used as types.
packages/api/src/@core/utils/types/original/original.ticketing.ts (20)
2-6: All these imports are only used as types.
6-7: All these imports are only used as types.
7-8: All these imports are only used as types.
8-12: All these imports are only used as types.
12-16: All these imports are only used as types.
16-20: All these imports are only used as types.
20-24: All these imports are only used as types.
24-28: All these imports are only used as types.
28-32: All these imports are only used as types.
32-36: All these imports are only used as types.
36-40: All these imports are only used as types.
40-44: All these imports are only used as types.
44-48: All these imports are only used as types.
48-52: All these imports are only used as types.
52-56: All these imports are only used as types.
56-60: All these imports are only used as types.
60-64: All these imports are only used as types.
64-68: All these imports are only used as types.
68-72: All these imports are only used as types.
72-76: All these imports are only used as types.
Additional comments not posted (11)
packages/api/src/@core/connections/connections.controller.ts (5)
20-20: Added import forCoreSyncService.This import is necessary for the new functionality related to synchronization.
38-38: AddedcoreSyncServiceto the constructor.This is essential for accessing the synchronization service within this controller.
54-54: ConvertedhandleCallbackto an async function.This change supports the asynchronous operations within the method, particularly the new sync functionality.
76-76: Added async calls to handle callbacks for different services.These additions are part of enhancing the callback handling by integrating various services.
Also applies to: 87-87, 99-99, 107-107
116-116: Added a call toinitialSyncinhandleCallback.This is a crucial addition for initiating the synchronization process as described in the PR objectives.
packages/api/src/@core/utils/types/original/original.ticketing.ts (1)
158-160: Updated type definitions with vertical bars.This change clarifies the type options, making the code more readable and maintainable.
Also applies to: 183-185, 224-226, 256-258
packages/api/src/@core/sync/sync.service.ts (3)
3-5: Added necessary imports for new functionality.These imports are essential for the new synchronization features implemented in this service.
28-28: AddedPrismaServiceto the constructor.This is necessary for database operations within the synchronization processes.
49-138: ImplementedinitialSyncmethod.This method is well-structured and aligns with the PR objectives to handle initial synchronization based on the provided vertical.
packages/api/scripts/connectorUpdate.js (2)
279-279: UpdatedenumNametobaseConnectors.This change aligns with the updated file paths and naming conventions used in the project.
331-333: Updated file paths for providers and enums.These updates are necessary to reflect the new directory structure for connectors.
Implemented Changes