Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: update to common utils #460

Merged
merged 1 commit into from
Apr 5, 2024
Merged

feat: update to common utils #460

merged 1 commit into from
Apr 5, 2024

Conversation

carlbrugger
Copy link
Contributor

@carlbrugger carlbrugger commented Apr 4, 2024

Please explain how to summarize this PR for the Changelog:

This PR updates the common utils to include a new deleteRecords utility and a chunkify utility. It also fixes a typing bug in processRecords when updating the records by removing the updatedAt field.

Tell code reviewer how and what to test:

Closes https://github.com/FlatFilers/support-triage/issues/1186

Summary by CodeRabbit

  • New Features
    • Introduced a function to delete records using the Flatfile API.
    • Added a package for common utility functions within the Flatfile Plugin ecosystem.
  • Refactor
    • Improved the process of handling records by excluding the updatedAt property before processing.
    • Enhanced code modularity in the asyncBatch function through a new chunkify function.
  • Chores
    • Updated GitHub workflows to ignore Markdown files in pull request triggers.

Copy link
Contributor

coderabbitai bot commented Apr 4, 2024

Warning

Rate Limit Exceeded

@carlbrugger has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 3 minutes and 2 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.
Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.
Please see our FAQ for further information.

Commits Files that changed from the base of the PR and between c95bc9a and 3617871.

Walkthrough

The recent updates introduce a new utility package for the Flatfile Plugin ecosystem, enhancing functionality and code organization. Key changes include removing the updatedAt property from records before processing, refactoring array chunking into a separate function, adding a new function for deleting records, and updating workflow configurations to ignore Markdown files. These modifications aim to streamline operations, improve code readability, and address specific customer issues related to record rejection handling.

Changes

Files Change Summary
.utils/common/src/all.records.ts Added logic to delete updatedAt property before processing records.
.utils/common/src/async.batch.ts Refactored array chunking logic into a separate chunkify function.
.utils/common/src/delete.records.ts Introduced a new function deleteRecords for deleting records using Flatfile API.
.utils/common/src/index.ts Updated to export delete.records.
.utils/common/README.md Added documentation for the new utility package.
.github/workflows/lint.yml, test.yml Updated to ignore Markdown files in pull request triggers.

Assessment against linked issues

Objective Addressed Explanation
#1186: rejectionResponse expecting updatedAt value The changes do not directly address the issue of updatedAt being required by the response rejection plugin. The modification to remove updatedAt before processing records might affect how data is handled internally but does not resolve the external requirement or expectation for this property in rejection responses.

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>.
    • 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.

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @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 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/coderabbit-overrides.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.

utils/common/src/delete.records.ts Show resolved Hide resolved
utils/common/src/all.records.ts Outdated Show resolved Hide resolved
@carlbrugger carlbrugger force-pushed the feat/common-utils-update branch from 90f43a2 to 7634be4 Compare April 4, 2024 15:14
utils/common/README.md Outdated Show resolved Hide resolved
@carlbrugger carlbrugger force-pushed the feat/common-utils-update branch from 21df78f to 8e39722 Compare April 4, 2024 17:45
@carlbrugger carlbrugger force-pushed the feat/common-utils-update branch from 8e39722 to 3617871 Compare April 4, 2024 17:52
Copy link
Collaborator

@bangarang bangarang left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚀

@carlbrugger carlbrugger merged commit 7796706 into main Apr 5, 2024
2 checks passed
@carlbrugger carlbrugger deleted the feat/common-utils-update branch April 5, 2024 14:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants