feat: add scatter-gather design pattern #3577

[bonigo1998]

Pull Request Template

What does this PR do?

[github-actions]

PR Summary

Introduced the Scatter-Gather module with core components, tests, and documentation to run multiple tasks concurrently, gather responses within a timeout, and aggregate results.

Changes

File	Summary
pom.xml	Modified root pom.xml to include the new scatter-gather module in the multi-module Maven project.
scatter-gather/README.md	New README documenting the Scatter-Gather pattern, intent, and a Java airline-search example.
scatter-gather/etc/scatter-gather-pattern.png	New architecture diagram illustrating the Scatter-Gather flow.
scatter-gather/pom.xml	New Maven module pom for scatter-gather including dependencies and build configuration.
scatter-gather/src/main/java/com/iluwatar/scattergather/Aggregator.java	Implements aggregation by joining gathered List<String> results with line separators.
scatter-gather/src/main/java/com/iluwatar/scattergather/AirlineService.java	Implements TaskSupplier, returning a formatted string like "Airline: $price" for a given airline.
scatter-gather/src/main/java/com/iluwatar/scattergather/App.java	New entry-point placeholder file for the Scatter-Gather module (expects a main class).
scatter-gather/src/main/java/com/iluwatar/scattergather/ScatterGatherExecutor.java	Executes multiple TaskSuppliers concurrently with a timeout, collecting successful results and ignoring failures.
scatter-gather/src/main/java/com/iluwatar/scattergather/TaskSupplier.java	Defines a TaskSupplier functional interface representing a unit of work for the scatter-gather operation.
scatter-gather/src/test/java/com/iluwatar/scattergather/AggregatorTest.java	Tests that Aggregator.aggregate correctly concatenates results and returns an empty string for no input.
scatter-gather/src/test/java/com/iluwatar/scattergather/AirlineServiceTest.java	Tests that AirlineService.execute returns the expected airline and price string.
scatter-gather/src/test/java/com/iluwatar/scattergather/ScatterGatherExecutorTest.java	Tests ScatterGatherExecutor across scenarios: all tasks succeed, timeout filtering, ignoring failed tasks, and no tasks.

---

autogenerated by presubmit.ai

[github-actions]

✅ LGTM!

Review Summary

Commits Considered (1)

• 50eb9d9: feat: add scatter-gather design pattern #3577

Files Processed (12)

• pom.xml (1 hunk)
• scatter-gather/README.md (1 hunk)
• scatter-gather/etc/scatter-gather-pattern.png (0 hunks)
• scatter-gather/pom.xml (1 hunk)
• scatter-gather/src/main/java/com/iluwatar/scattergather/Aggregator.java (1 hunk)
• scatter-gather/src/main/java/com/iluwatar/scattergather/AirlineService.java (1 hunk)
• scatter-gather/src/main/java/com/iluwatar/scattergather/App.java (1 hunk)
• scatter-gather/src/main/java/com/iluwatar/scattergather/ScatterGatherExecutor.java (1 hunk)
• scatter-gather/src/main/java/com/iluwatar/scattergather/TaskSupplier.java (1 hunk)
• scatter-gather/src/test/java/com/iluwatar/scattergather/AggregatorTest.java (1 hunk)
• scatter-gather/src/test/java/com/iluwatar/scattergather/AirlineServiceTest.java (1 hunk)
• scatter-gather/src/test/java/com/iluwatar/scattergather/ScatterGatherExecutorTest.java (1 hunk)

Actionable Comments (0)

Skipped Comments (5)

• scatter-gather/src/main/java/com/iluwatar/scattergather/ScatterGatherExecutor.java [58-58]

  best_practice: "Replace toList() with Collectors.toList() for compatibility"

• scatter-gather/src/main/java/com/iluwatar/scattergather/ScatterGatherExecutor.java [36-36]

  best_practice: "Add missing import for Collectors"

• scatter-gather/src/main/java/com/iluwatar/scattergather/TaskSupplier.java [32-32]

  readability: "Javadoc formatting"

• scatter-gather/src/main/java/com/iluwatar/scattergather/TaskSupplier.java [34-34]

  readability: "Typo in Javadoc"

• scatter-gather/pom.xml [46-49]

  best_practice: "Add junit-jupiter-api test dependency"

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 83.93%. Comparing base (41625d8) to head (00bf897).

Additional details and impacted files

@@             Coverage Diff              @@
##             master    #3590      +/-   ##
============================================
+ Coverage     83.79%   83.93%   +0.13%     
- Complexity     4277     4288      +11     
============================================
  Files          1121     1124       +3     
  Lines         15144    15168      +24     
  Branches        723      725       +2     
============================================
+ Hits          12690    12731      +41     
+ Misses         2159     2139      -20     
- Partials        295      298       +3     

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[iluwatar]

App.java seems to be empty. Usually we have here the main entry point of the program. You should supply commentary about the pattern and its implementation as well.

[iluwatar]

See also that it has certain level of logging so that execution can traced.

[github-actions]

✅ LGTM!

Review Summary

Commits Considered (1)

• 00bf897: Merge branch 'master' into feature/scatter-gather

Files Processed (1)

• pom.xml (1 hunk)

Actionable Comments (0)

Skipped Comments (1)

• pom.xml [216-216]

  enhancement: "Add new Maven module to multimodule build."