feat(batch): sequential async processing of records for BatchProcessor

[arnabrahman]

Summary

By default, the BatchProcessor processes records in parallel using Promise.all(). We want to give users an option to process records sequentially.

Changes

• Introduce a new batch processing option, processInParallel, which indicates whether records should be processed in parallel or sequentially.
• I believe this option should only be available for BatchProcessor class but I couldn't make the optional property work as the class signature is similar for both BatchProcessor & BatchProcessorSync. I have omitted this property for SqsFifoPartialProcessor though.
• The records will be processed in parallel or sequentially based on the processInParallel option. If processInParallel is not provided, the records will default to being processed in parallel. Made the changes in theBasePartialProcessor class.
• For the tests, I restructured the async processing test cases. I ran all the tests for both parallel and sequential processing by introducing describe.each(). My rationale is that every feature for BatchProcessor should behave the same, regardless of whether records are processed in parallel or sequentially. This approach also avoids duplicating test cases for both options.
• Updated the documentation for processInParallel and made additional changes where necessary, using my judgment.

Issue number: #1829

---

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.

[dreamorosi]

Hi @arnabrahman, thank you for the PR!

I will start reviewing it tomorrow morning - I was on PTO for the first half of the week.

Regarding the SonarCloud findings, I think we can simplify the structure of the tests and remove the findings by just changing it to something like:

describe('Asynchronously processing', () => {
    const cases = [
      {
        description: 'in parallel',
        options: { processInParallel: true },
      },
      {
        description: 'sequentially',
        options: { processInParallel: false },
      },
    ];

    it.each(cases)('SQS Records $description', ({ options }) => {

    })
})

or similar

[arnabrahman]

@dreamorosi No worries, i will take a look at this tomorrow.

[dreamorosi]

Amazing work on this PR @arnabrahman, appreciate your help!

Thank you also for updating the docs with the new feature 🎉

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud