search

panoratech / Panora

Add an integration catalog to your SaaS product in minutes
https://docs.panora.dev
Apache License 2.0
375 stars 76 forks source link

Feat: Cursor based Pagination #479

Closed mit-27 closed 3 weeks ago

mit-27 commented 1 month ago

/claim #479

Hello @naelob and @rflihxyz , currently I have added cursor pagination for GET: crm/contacts Unified API to validate the format of the response. Let me know if there are any changes required. then Upon your approval, I will implement cursor pagination for all unified APIs. Thanks.

API response Format

{
  data: [...],
  prev_cursor: value,
  next_cursor: value
}

Summary by CodeRabbit

vercel[bot] commented 1 month ago

@mit-27 is attempting to deploy a commit to the Panora Team on Vercel.

A member of the Team first needs to authorize it.

changeset-bot[bot] commented 1 month ago

⚠️ No Changeset found

Latest commit: a53062a9fd3c1e8c83314a6d7742ba8fb52ed5b9

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] commented 1 month ago

[!IMPORTANT]

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The changes introduce cursor-based pagination to the CRM API's contact management. This includes modifications to the contact.controller.ts and contact.service.ts to handle pagination parameters, and the creation of a GetContactsQueryDto for structured query handling. Additionally, the contact sync schedule has been updated to run every 2 minutes for testing purposes.

Changes

Files Change Summary
packages/api/src/crm/contact/contact.controller.ts Added UsePipes, ValidationPipe, and GetContactsQueryDto imports; updated getContacts method.
packages/api/src/crm/contact/services/contact.service.ts Added pagination logic and modified getUnifiedContacts method to handle pageSize and cursor.
packages/api/src/crm/contact/sync/sync.service.ts Changed cron schedule for syncing contacts from every 8 hours to every 2 minutes for testing.
packages/api/src/crm/contact/types/dto/get-contacts-query.dto.ts Created GetContactsQueryDto for handling pagination query parameters.

Sequence Diagram(s) (Beta)

sequenceDiagram
    participant User
    participant Controller
    participant Service
    participant Database

    User->>+Controller: GetContacts(pageSize, cursor)
    Controller->>+Service: getUnifiedContacts(pageSize, cursor)
    Service->>+Database: Fetch contacts with cursor
    Database-->>-Service: Return contacts, prev_cursor, next_cursor
    Service-->>-Controller: Return contacts, prev_cursor, next_cursor
    Controller-->>-User: Return paginated contacts

Assessment against linked issues

Objective (Issue #) Addressed Explanation
Implement cursor-based pagination (#430) ✅
Ensure pagination parameters are handled in controller (#430) ✅
Update cron schedule for contact syncing (#430) ✅

Poem

In fields of code, where data flows, A rabbit hops, where logic grows. With cursors set and pages turned, Contact lists are now well-learned. Syncs that tick like clockwork fine, Every two minutes, right on time. Hopping through the data stream, CodeRabbit makes the system gleam. 🐇✨

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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 show all the console.log statements in this repository.` - `@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 as 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. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
naelob commented 1 month ago

Hello @naelob and @rflihxyz , currently I have added cursor pagination for GET: crm/contacts Unified API to validate the format of the response. Let me know if there are any changes required. then Upon your approval, I will implement cursor pagination for all unified APIs. Thanks.

API response Format

{
  data: [...],
  prev_cursor: value,
  next_cursor: value
}

Summary by CodeRabbit

  • New Features

    • Introduced pagination support in the contact list with pageSize and cursor parameters.

  • Improvements

    • Enhanced contact retrieval with more efficient pagination logic.

  • Testing Enhancements

    • Adjusted contact sync schedule to every 2 minutes for testing purposes.

It sounds good for me.

naelob commented 3 weeks ago

/bounty 200

algora-pbc[bot] commented 3 weeks ago

💎 $200 bounty • Panora (YC S24)

Steps to solve:

  1. Start working: Comment /attempt #479 with your implementation plan
  2. Submit work: Create a pull request including /claim #479 in the PR body to claim the bounty
  3. Receive payment: 100% of the bounty is received 2-5 days post-reward. Make sure you are eligible for payouts

Additional opportunities:

Thank you for contributing to panoratech/Panora!

Add a bounty • Share on socials

Attempt Started (GMT+0) Review
🟢 @mit-27 Jun 11, 2024, 1:02:13 PM #479
mit-27 commented 3 weeks ago

/attempt #479

/claim #479

Algora profile Completed bounties Tech Active attempts Options
@mit-27 1 panoratech bounty
TypeScript, Python,
Jupyter Notebook & more
Cancel attempt
algora-pbc[bot] commented 3 weeks ago

💡 @mit-27 submitted a pull request that claims the bounty. You can visit your bounty board to reward.

algora-pbc[bot] commented 3 weeks ago

🎉🎈 @mit-27 has been awarded $200! 🎈🎊