Incremental sync for Attio provider

[mit-27]

• Fix #700

Summary by CodeRabbit

Release Notes

• New Features

  • Introduced a new database table for tracking synchronization data related to vertical objects.
  • Enhanced pagination mechanisms for syncing company, contact, deal, and task records from the Attio API, allowing for both initial and incremental data retrieval.
  • Expanded connector capabilities with new integration options for various services.

• Bug Fixes

  • Improved error handling during data synchronization processes.

• Documentation

  • Added structured type definitions for pagination parameters to improve data management and retrieval efficiency.

[naelob]

Qovery can create a Preview Environment for this PR. To trigger its creation, please post a comment with one of the following command.

Command	Blueprint environment
/qovery preview 783d0240-ec38-4387-a9a9-8e225f1bd3e1	dev
/qovery preview {all|UUID1,UUID2,...}	To preview multiple environments

---

This comment has been generated from Qovery AI :robot:. Below, a word from its wisdom :

Truth can only be found in one place: the code

[changeset-bot[bot]]

⚠️ No Changeset found

Latest commit: a9923517c523c901e3ba02cb54f6411554263c14

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[coderabbitai[bot]]

Walkthrough

Walkthrough

The pull request introduces a new database table for tracking synchronization data related to vertical objects and enhances the AttioService class across multiple modules to support both initial and incremental synchronization of company, contact, deal, and task records from the Attio API. This includes the implementation of pagination handling, allowing the service to efficiently manage large datasets and maintain state across synchronization operations.

Changes

Files	Change Summary
packages/api/scripts/init.sql	Added a new table vertical_objects_sync_track_data for tracking synchronization data with fields for UUID, vertical, provider slug, object, pagination type, connection ID, and JSON data.
packages/api/src/crm/company/services/attio/index.ts	Enhanced AttioService to implement a new pagination mechanism for syncing company records, supporting both initial and incremental sync based on pagination tracking data.
packages/api/src/crm/company/services/attio/types.ts	Added a new type alias paginationType to represent pagination parameters with an offset property.
packages/api/src/crm/contact/services/attio/index.ts	Updated AttioService to improve synchronization of contact records, incorporating initial and incremental sync strategies with pagination handling.
packages/api/src/crm/contact/services/attio/types.ts	Introduced a new type paginationType for handling pagination in contact-related operations.
packages/api/src/crm/deal/services/attio/index.ts	Modified AttioService to support both initial and incremental synchronization of deal records, utilizing pagination for efficient data retrieval.
packages/api/src/crm/deal/services/attio/types.ts	Added a new type paginationType for pagination handling in deal-related operations.
packages/api/src/crm/task/services/attio/index.ts	Enhanced AttioService for task synchronization, implementing both initial and incremental sync with pagination support.
packages/api/src/crm/task/services/attio/types.ts	Introduced a new type paginationType for managing pagination in task-related operations.

Assessment against linked issues

Objective	Addressed	Explanation
Support incremental sync for providers (Issue #700)	✅
Implement pagination handling for data synchronization (Issue #700)	✅

Possibly related PRs

• #421: The Gitlab Connector PR involves adding integration capabilities for various objects, which may relate to the new vertical_objects_sync_track_data model introduced in the main PR, as both involve managing connections and integrations.
• #484: The integration with Close CRM includes enhancements to the project connectors, which may relate to the new fields added in the connector_sets model in the main PR, indicating a broader integration strategy.
• #693: The SharePoint integration involves modifications to the Prisma schema and connector capabilities, which aligns with the changes made in the main PR regarding the connections model and its relationship with other data structures.
• #695: The Dropbox integration similarly expands the connector capabilities and modifies the schema, which is directly related to the changes made in the main PR regarding the connector_sets model and its new fields.

Suggested labels

🙋 Bounty claim

---

Recent review details

Configuration used: CodeRabbit UI Review profile: ASSERTIVE

Commits

Files that changed from the base of the PR and between 79f357ae5c35277e5bf6f4f55e979ed6502757c7 and a9923517c523c901e3ba02cb54f6411554263c14.

Files selected for processing (1)

• packages/api/prisma/schema.prisma (3 hunks)

Additional comments not posted (4)

packages/api/prisma/schema.prisma (4)

1303-1318: LGTM!

The new vertical_objects_sync_track_data field in the connections model looks good. It establishes a valid one-to-many relationship with the vertical_objects_sync_track_data model, allowing connections to be associated with multiple sync tracking records. The field definition is consistent with Prisma's schema design principles.

---

1350-1354: Looks good!

The new Boolean fields added to the connector_sets model (fs_dropbox, fs_googledrive, fs_sharepoint, fs_onedrive, crm_salesforce) are clear and self-explanatory. They appropriately represent integration options for various services, indicating an expansion of the connector capabilities. The fields being nullable is suitable as not all connector sets may have these integrations enabled.

---

2153-2163: Excellent addition!

The new vertical_objects_sync_track_data model is well-structured and serves a clear purpose of storing synchronization tracking information related to vertical objects. The fields are appropriately named and typed, with the Json type for the data field providing flexibility to handle diverse synchronization scenarios.

The model establishes a proper many-to-one relationship with the connections model through the id_connection field, allowing efficient tracking of sync states for each object and pagination management.

Overall, this model is a valuable addition to the schema and aligns well with the synchronization tracking requirements.

---

Line range hint 1-2163: Overall file review: Approved!

The changes made to the Prisma schema in this file are well-structured, purposeful, and consistent with the existing schema design. The introduction of the vertical_objects_sync_track_data model and the addition of fields to the connections and connector_sets models enhance the synchronization tracking capabilities of the application.

The new model and fields are appropriately named, typed, and establish correct relationships with other models. The changes do not introduce any apparent issues or inconsistencies that could negatively impact the codebase.

Overall, these modifications to the schema are valuable additions that align with the synchronization tracking requirements and maintain the integrity of the existing schema. Great job!

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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 generate interesting stats about this repository and render them as a table. -- @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 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 or @coderabbitai title 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.