sqs-consumer icon indicating copy to clipboard operation
sqs-consumer copied to clipboard

feat!: replacing the isRunning method with status

Open nicholasgriffintn opened this issue 2 years ago • 0 comments

Description: Following on from #454, this removes the isRunning method in favour of a status method that returns both the running and polling state.

Type of change:

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

Why is this change required?: This would allow users to get the running and polling state from one method rather than creating multiple ways of getting this information, it can also be expanded in the future with more information.

This is a breaking change as it removes an existing method and a debugger, outside of that, this change should not actually effect how the Consumer processes messages.

Code changes:

  • Updated the README to document the old state and the removal of isRunning
  • Removed the handler_processing method as this is now effectively replaced with this new status method
  • Added a new getStatus method to return the states
  • Updated tests

TODO:

  • [ ] One of the tests are still failing, I'm not sure why, it's a bit too late to figure it out.

nicholasgriffintn avatar Feb 06 '24 20:02 nicholasgriffintn