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: adding the ability to update visibilityTimeout #379

Merged
merged 7 commits into from
Apr 10, 2023

Conversation

nicholasgriffintn
Copy link
Member

Resolves #370

Description:

As described in the feature request, this PR will add the ability for users to programatically update options for the Consumer. At the moment, this has only been configured with the ability to update visibilityTimeout, but in a way that'll be expandable in the future.

Type of change:

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Why is this change required?:

When an external factor occurs, users may want to trigger an update to the visibilityTimeout option that will take effect from that point on.

Rather than stopping and then restarting the Consumer, they would like to do this in the current instance.

Code changes:

  • Added a new public method .updateOption(), this will take an option and a value and then update the provided option with the provided value
  • Updated documentation around this

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@nicholasgriffintn nicholasgriffintn requested review from a team as code owners March 18, 2023 19:34
@codeclimate
Copy link

codeclimate bot commented Mar 18, 2023

Code Climate has analyzed commit 6bb1910 and detected 0 issues on this pull request.

The test coverage on the diff in this pull request is 100.0% (80% is the threshold).

This pull request will bring the total coverage in the repository to 94.7% (0.2% change).

View more on Code Climate.

@nicholasgriffintn nicholasgriffintn changed the title feat: adding the ability to update options feat: adding the ability to update visibilityTimeout Apr 10, 2023
@nicholasgriffintn nicholasgriffintn merged commit f692bbd into main Apr 10, 2023
@nicholasgriffintn nicholasgriffintn deleted the programatically-configure-visibility-timeout branch April 10, 2023 16:05
@github-actions github-actions bot locked and limited conversation to collaborators Apr 10, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Allow the option visibilityTimeout to be configured after initialisation
1 participant