Implements namespaces

[zedtux]

Namespacing

This gem can isolate jobs within namespaces.

Default namespace

When not giving a namespace, the default one will be used.

In the case you'd like to change this value, create a new initializer like so:

config/initializers/sidekiq-cron.rb:

Sidekiq::Cron.configure do |config|
  config.default_namespace = 'statics'
end

Usage

When creating a new job, you can optionaly give a namespace attribute, and then you can pass it too in the find or destroy methods.

Sidekiq::Cron::Job.create(
  name: 'Hard worker - every 5min',
  namespace: 'Foo',
  cron: '*/5 * * * *',
  class: 'HardWorker'
)
# INFO: Cron Jobs - add job with name Hard worker - every 5min in the namespace Foo

# Without specifing the namespace, Sidekiq::Cron use the `default` one, therefore `count` return 0.
Sidekiq::Cron::Job.count
#=> 0

# Searching in the job's namespace returns 1.
Sidekiq::Cron::Job.count 'Foo'
#=> 1

# Same applies to `all`. Without a namespace, no jobs found.
Sidekiq::Cron::Job.all

# But giving the job's namespace returns it.
Sidekiq::Cron::Job.all 'Foo'
#=> [#<Sidekiq::Cron::Job:0x00007f7848a326a0 ... @name="Hard worker - every 5min", @namespace="Foo", @cron="*/5 * * * *", @klass="HardWorker", @status="enabled" ... >]

# If you'd like to get all the jobs across all the namespaces then pass an asterisk:
Sidekiq::Cron::Job.all '*'
#=> [#<Sidekiq::Cron::Job ...>]

job = Sidekiq::Cron::Job.find('Hard worker - every 5min', 'Foo').first
job.destroy
# INFO: Cron Jobs - deleted job with name Hard worker - every 5min from namespace Foo
#=> true

Sidekiq web update

A new bar has been added showing the namespaces, allowing to switch namespaces:

Notes

I haven't updated the slim files as slim has been removed 7 years ago from sidekiq, but if you really want it, I can update them.

[coveralls]

Coverage increased (+0.8%) to 92.275% when pulling 4ce54b3 on Pharmony:features/namespaces into 7ca90f9 on ondrejbartas:master.

[ondrejbartas]

@zedtux Very nice code. I like your approach. Can you rebase your code to master and change slim templates? I will like to release it with new version

[zedtux]

Thank you @ondrejbartas. Sure I'll do it.

For your information, this code is running in our prod since weeks.

[zedtux]

@ondrejbartas it's done !

[zedtux]

Don't know what is happening ... Github seem to have missed the Travis CI callback to set the build as passed 🤷‍♂.

[zedtux]

@ondrejbartas can you please have a look?

[zedtux]

@ondrejbartas please?

[zedtux]

@ondrejbartas is there any chance this get merged one day or should I wast my time in building a new gem?

[honzasterba]

@zedtux please update the PR to latest master, would love to merge this

[zedtux]

@honzasterba all conflicts fixed, can you please merge it now ?

[honzasterba]

missin unit tests

[zedtux]

Use a more official image (Alpine Ruby?)

I'm not sure what you mean here, ruby:2.7 refers to the officiel Ruby docker image registry : https://hub.docker.com/_/ruby. The Alpine version is a smaller version as a label from the same repository.

I could update it, if you really have an interest for it, but in my honest opinion, as this is only a development image, it doesn't matter much.
Image size is more about production environment in order to speed-up the deployment.

remove MAINTAINER Joao Serra joaopfserra@gmail.com (he is not maintaining anything in this organization)

Sure, it has to be changed to something else. Like you ? Or you don't want to specify a MAINTAINER?

Move Docker related files to a folder (docker/*) to avoid polluting the root workspace

I'm used to keep them at the root so that the commands are easier but I can understand your point of view since you're not a docker user.

Document how to use it (probably under this section https://github.com/sidekiq-cron/sidekiq-cron#contributing)

I will do it with pleasure.

Otherwise, about this PR, can you do the code review and merge or is it still @honzasterba who's doing it?

[markets]

ah ok! understood! let me clarify some points about Docker:

• Agree to use official Ruby image, I was confused by the MAINTAINER tag probably and my little knowledge about Docker. Maybe we can use a newer version btw, like 3.2?
• If the MAINTAINER tag is not mandatory, I'd just ✂️
• If having those files them under docker/* is not a problem or a bad practice in the ecosystem, I personally value having a clean root folder

About the code changes, since this patch is quite big, I'd like more eyes on it. Let me ping some people involved in this project for the latest years/releases. @honzasterba @ondrejbartas @jmettraux @serprex @engwan @petergoldstein @ybiquitous could you please take a look to this or test it locally when you have a chance 🙏🏼? Thank you in advance!

And thanks again to @zedtux for you amazing work 👏🏼 on this feature and your patience.

[zedtux]

Okay, so let's remove the MAINTAINER instruction, upgrade to ruby 3.2 and move files in a docker/ folder.

[zedtux]

Could anyone do the code review please, I really would love to see this merged! 😍

[zedtux]

Okay, so let's remove the MAINTAINER instruction, upgrade to ruby 3.2 and move files in a docker/ folder.

This has been done too!

[zedtux]

I don't understand why build matrix is red now, it doesn't look related to my changes... anyone has an idea please?

[serprex]

Regression caused by recent change to minitest removing some deprecated constant

freerange/mocha#614

Fixed by #420

[serprex]

@zedtux CI fixed, try updating PR with latest

[zedtux]

Thanks @serprex, the build is now green. 👍

[zedtux]

@honzasterba @markets the PR is now ready, any other review or are we good to go?

[markets]

Seems fine to me @zedtux 👍🏼 I'll try to merge it next week and it will be released as v2.0 soon. Sorry I'm on parental leave and my free time is limited until mid october.

Could you please add some docs about how to use docker support?

[zedtux]

Hello there,

Any news please ?

[markets]

Hi @zedtux, sorry the past 2 weeks we have been working in an relevant fix (more info #428) introduced some months ago.

I think we are now ready to merge this one, targeting a future v2 release (should be the next one and I'd like to launch this as v2-beta).

Let me ask a couple of details 🙏🏼:

• Document how to use docker for development (probably around this section https://github.com/sidekiq-cron/sidekiq-cron?tab=readme-ov-file#testing)
• Update screenshot that appears in the README: https://github.com/sidekiq-cron/sidekiq-cron/blob/master/docs/images/web-cron-ui.jpeg

[zedtux]

Let me ask a couple of details 🙏🏼:

• Document how to use docker for development (probably around this section https://github.com/sidekiq-cron/sidekiq-cron?tab=readme-ov-file#testing)
• Update screenshot that appears in the README: https://github.com/sidekiq-cron/sidekiq-cron/blob/master/docs/images/web-cron-ui.jpeg

Hey @markets,

1. Git rebase done
2. Docker doc written
3. Screenshot updated

All should be alright now. Let's merge it!

[markets]

Thanks again @zedtux 👍

I'd like to merge it during the christmas holidays and probably cut a release as v2.0.0-beta.

[zedtux]

@markets happy new year, let's get this PR merged! 🥳