Skip to content

Simpler constructors#51

Merged
p14n merged 2 commits intomainfrom
simpler-constructors
Apr 28, 2025
Merged

Simpler constructors#51
p14n merged 2 commits intomainfrom
simpler-constructors

Conversation

@p14n
Copy link
Owner

@p14n p14n commented Apr 28, 2025

Summary by Sourcery

Introduce simpler constructors for LocalPersistentConsumer and ConsumerServer which automatically configure database connections and executors.

Enhancements:

  • Add constructors to LocalPersistentConsumer and ConsumerServer that create and manage default database connection pools and executors based on the provided configuration.

Documentation:

  • Add a new section to the README demonstrating in-process usage with LocalPersistentConsumer.
  • Update README examples to use the new simplified constructors.
  • Update performance latency figures in the README.

@p14n p14n merged commit e3ad487 into main Apr 28, 2025
1 check passed
@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Apr 28, 2025

Reviewer's Guide by Sourcery

This pull request introduces simpler constructors for LocalPersistentConsumer and ConsumerServer. The new constructors automatically handle the creation of the database connection pool, reducing the boilerplate code required for instantiation. The documentation in README.md has been updated to reflect these changes and provide clearer examples.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Added simpler constructors to consumer classes.
  • Added a new constructor to LocalPersistentConsumer that takes PostEventConfig and OpenTelemetry.
  • Added a new constructor to ConsumerServer that takes ConfigData and OpenTelemetry.
  • The new constructors internally create the database connection pool using DatabaseSetup.createPool.
library/src/main/java/com/p14n/postevent/LocalPersistentConsumer.java
library/src/main/java/com/p14n/postevent/ConsumerServer.java
Updated README.md with new constructors and clearer examples.
  • Added distinct sections for in-process and across-servers modes.
  • Updated code examples for LocalPersistentConsumer, ConsumerServer, and RemotePersistentConsumer to use the new constructors.
  • Adjusted configuration details in the code examples.
  • Refined the description of performance latency.
README.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @p14n - I've reviewed your changes - here's some feedback:

Overall Comments:

  • The README example for LocalPersistentConsumer appears to use a different constructor signature than the one added in the code.
  • The new constructors implicitly create a DataSource; consider if users might want to provide their own existing DataSource instance for more flexibility.
Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Tested on fargate 0.5vCPU/1GB with RDS db.t4g.micro
- Throughput: 200 events/second
- Latency: Y ms average
- Latency: < 50ms ms from topic publish to remote client receive in transaction
Copy link
Contributor

Choose a reason for hiding this comment

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

issue (typo): Typo: Duplicate 'ms' unit.

Remove the extra 'ms' unit.

Suggested change
- Latency: < 50ms ms from topic publish to remote client receive in transaction
- Latency: < 50ms from topic publish to remote client receive in transaction

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.

1 participant