Skip to content

feat(batch): simplify BatchProcessor for async and sync functions #1682

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

Closed
wants to merge 2 commits into from

Conversation

am29d
Copy link
Contributor

@am29d am29d commented Sep 14, 2023

Description of your changes

This PR flips the syntax of the AsyncBatchProcessor and BatchProcessor. During the implementation we oriented around the python implementation and replicated the names. In Node ecosystem the case with async and sync is the opposite. Most of the function from libraries are async and there are cases where a sync suffix on a function indicates that it's a synchronous function.

Therefore we rename AsyncBatchProcessor to BatchProcessor and BatchProcessor to BatchProcessorSync.

Related issues, RFCs

Issue number: closes #1677

Checklist

  • My changes meet the tenets criteria
  • I have performed a self-review of my own code
  • I have commented my code where necessary, particularly in areas that should be flagged with a TODO, or hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my change is effective and works
  • The PR title follows the conventional commit semantics

Breaking change checklist

Is it a breaking change?: NO

  • I have documented the migration process
  • I have added, implemented necessary warnings (if it can live side by side)

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.

@boring-cyborg boring-cyborg bot added batch This item relates to the Batch Processing Utility documentation Improvements or additions to documentation internal PRs that introduce changes in governance, tech debt and chores (linting setup, baseline, etc.) tests PRs that add or change tests labels Sep 14, 2023
@pull-request-size pull-request-size bot added the size/XXL PRs with 1K+ LOC, largely documentation related label Sep 14, 2023
@sonarqubecloud
Copy link

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

@github-actions github-actions bot added the feature PRs that introduce new features or minor changes label Sep 14, 2023
@am29d am29d self-assigned this Sep 14, 2023
@am29d am29d closed this Sep 14, 2023
@am29d am29d deleted the 1677-async-batch-default branch September 14, 2023 14:57
@am29d am29d restored the 1677-async-batch-default branch September 14, 2023 15:51
@am29d am29d deleted the 1677-async-batch-default branch September 14, 2023 15:53
@dreamorosi
Copy link
Contributor

Even though this was ultimately closed for the reasons discussed in #1680 I wanted to thank you for the time and effort put in the PR, I really appreciate the level of details.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
batch This item relates to the Batch Processing Utility documentation Improvements or additions to documentation feature PRs that introduce new features or minor changes internal PRs that introduce changes in governance, tech debt and chores (linting setup, baseline, etc.) size/XXL PRs with 1K+ LOC, largely documentation related tests PRs that add or change tests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Feature request: make async batch processor default one
2 participants