RedShirt.Example.JobWorker

General template for polling/processing messages out of a variety of message stores.

Repo features:

• Initialisation script for quick namespace adjustment.
• Configuration is based on environment variables.
• Message polling with:
  • Amazon SQS
  • Amazon Kinesis
  • Apache ActiveMQ Artemis
  • Azure Queue Storage
  • NATS
  • RabbitMQ

Configuration

For configuration examples, see the worker section of the test/local/docker-compose.yaml file.

Loader Mode

"Loader" mode is a new implementation of the handling of jobs pulled from the job source. Compared to the original "Batch" mode, it features:

• Automatic backlog population for fewer delays between job executions.
• Better separation of concerns for maintainability.

"Loader" mode is currently marked as experimental until it can be tested more in deployed environments, while the original "Batch" mode is the default. To enable "Loader" mode, either:

• Set the JOBS__LOADER__ENABLED environment variable to 1.
• Adjust the logic in RedShirt.Example.JobWorker.qCore project's Extensions/ServiceCollectionExtensions.cs (as part of initializing this template)

Initialisation

Recommended steps when using this as a template:

1. To change the namespace of this solution en-masse for your purposes, use the init-repo.sh script:

   bash init-repo.sh New.Namespace.Here

2. In the RedShirt.Example.JobWorker.Core project, update IJobDataModel interface and JobDataModel implementation to reflect the need of your project.

3. In the RedShirt.Example.JobWorker.Core project, update SourceMessageConverter and SourceMessageSorter to fit your needs for your project.

4. Update the RedShirt.Example.JobWorker.Core.Logic project to handle IJobDataModel jobs as needed by your project.

5. Select a message source type and remove the projects for the sources that you are not using.

Testing

For local testing, see the test/local/ folder.