simplekiq 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4caaf4c9bfc49507c627f025b8847b4cbfd36805897abc1c5d14117327cb0313
-  data.tar.gz: cdff30ac40b315e7e8dca636d013153631b710b8fb65c2bfffdf36632900b293
+  metadata.gz: 20c1cf9ee3200ead5a9c6c0bba128b1688c1a7c7ecab72caaf024341c2d8ba35
+  data.tar.gz: 1b749cdbdead50f3458912b641b20cdf186a2e53a4581d8bd15a91df7e2bfa4b
 SHA512:
-  metadata.gz: 43789a7c661f3981035069935eecdefa4c03f8bfc2bd0eaeba8840018f54813f103475a5cd149752cbbef48e30f7c7363c98af548d85277995e0699df58b00dd
-  data.tar.gz: 9ab17b4b9d419d2551fd8cfe6070443015e35c1dc9c6adf195302a912aff52caf67fc7a5edea2c9f7733c43e0e799b790e00be07a4fbc4b6d0586501372be20d
+  metadata.gz: 5b77d61ceca98ea9d78e491b527e0a181b3e51803581083b39b0fece0303c9d0736e5b66eb3e68fed45222da5f66e6cb75ba82ecaa8034f0b8dd52bf252958bf
+  data.tar.gz: 91afa04b5e0879132c777dc816887f81ed4de6cdf04c916066fc1d634202eca0a8dbef32173c1a8329ffd0902135669be57ed6e33e1d44d228e5352193a89fcf

data/.circleci/config.yml

@@ -4,20 +4,28 @@ orbs:
   gem: doximity/gem-publisher@0
 
 executors:
-  ruby-2-6:
+  ruby:
     resource_class: small
     docker:
       - image: cimg/ruby:2.6
         environment:
-          BUNDLE_VERSION: "~> 1.17"
+          BUNDLE_VERSION: "~> 2.1.4"
+  ruby-with-redis:
+    resource_class: small
+    docker:
+      - image: cimg/ruby:2.6
+        environment:
+          BUNDLE_VERSION: "~> 2.1.4"
+      - image: redis:4-alpine
+        command: redis-server
 
 # yaml anchor filters
-master_only: &master_only
+always_run: &always_run
   filters:
     branches:
-      only: master
+      only: /.*/
     tags:
-      ignore: /.*/
+      only: /^v.*/
 pr_only: &pr_only
   filters:
     branches:
@@ -33,7 +41,7 @@ version_tags_only: &version_tags_only
 
 jobs:
   build:
-    executor: ruby-2-6
+    executor: ruby-with-redis
     steps:
       - checkout
       - run:
@@ -42,15 +50,14 @@ jobs:
             gem install bundler --version "${BUNDLE_VERSION}" --force
       - restore_cache:
           keys:
-            - v1-bundle-{{ checksum "Gemfile.lock" }}-
+            - v4-bundle-{{ checksum "Gemfile.lock" }}-
       - run:
           name: Install Ruby Dependencies
           command: |
             bundle config set --local path 'vendor/bundle'
-            bundle config set --local frozen 'true'
-            bundle install --local --jobs=4 --retry=3
+            bundle install --jobs=4 --retry=3
       - save_cache:
-          key: v1-bundle-{{ checksum "Gemfile.lock" }}-
+          key: v4-bundle-{{ checksum "Gemfile.lock" }}-
           paths:
             - vendor/bundle
       - run:
@@ -68,27 +75,19 @@ jobs:
             - vendor/bundle
 
 workflows:
-  version: 2
-
-  trunk:
-    jobs:
-      - build:
-          <<: *master_only
-      - gem/build:
-          <<: *master_only
-          executor: ruby-2-6
-          name: gem-build
-          requires:
-            - build
 
-  pull-requests:
+  main:
     jobs:
       - build:
-          <<: *pr_only
+          <<: *always_run
+          context: sidekiq-enterprise
       - gem/build:
-          <<: *pr_only
-          executor: ruby-2-6
+          <<: *always_run
+          context: sidekiq-enterprise
+          executor: ruby
           name: gem-build
+          vendor-cache: false
+          cache-salt: simplekiq-v2
           requires:
             - build
       - pre-release-approval:
@@ -98,26 +97,17 @@ workflows:
             - gem-build
       - gem/publish:
           <<: *pr_only
-          name: gem-publish
+          executor: ruby
+          name: gem-publish-pre
           to_rubygems: true
           pre_release: true
           requires:
             - pre-release-approval
           context: artifact_publishing
-
-  final-release:
-    jobs:
-      - build:
-          <<: *version_tags_only
-      - gem/build:
-          <<: *version_tags_only
-          executor: ruby-2-6
-          name: gem-build
-          requires:
-            - build
       - gem/publish:
           <<: *version_tags_only
-          name: gem-publish
+          name: gem-publish-final
+          executor: ruby
           to_rubygems: true
           pre_release: false
           requires:

data/CHANGELOG.md

@@ -4,11 +4,29 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.1.0] (pre-release for 1.0)
+* Fix typo in CONTRIBUTORS
+  [#5](https://github.com/doximity/simplekiq/pull/5)
+* Fix incorrectly named spec file
+  [#9](https://github.com/doximity/simplekiq/pull/9)
+* README fix
+  [#10](https://github.com/doximity/simplekiq/pull/10)
+* Updating CONTRIBUTING license
+  [#16](https://github.com/doximity/simplekiq/pull/16)
+* Fix CHANGELOG typo
+  [#18](https://github.com/doximity/simplekiq/pull/18)
+* Add sidekiq-pro as an explicit dependency and loosen sidekiq requirements
+  [#19](https://github.com/doximity/simplekiq/pull/19)
+* Add new toplevel batch to encapsulate all batches within an orchestration
+  [#21](https://github.com/doximity/simplekiq/pull/21)
+* Fix bug with toplevel batch and include batch descriptions
+  [#23](https://github.com/doximity/simplekiq/pull/23)
+
 ## [0.0.3]
-* Misc minimal fixes to get the gem building and releasable
-  [#2](https://github.com/doximity/rake-ui/pull/3)
+* Misc minimal fixes to get the gem building and releasable according to our open source standards
+  [#3](https://github.com/doximity/simplekiq/pull/3)
 * Copy over library code from prior sources with maintained history
-  [#1](https://github.com/doximity/simplekiq/pull/1)
+  [#2](https://github.com/doximity/simplekiq/pull/2)
 
 ## [0.0.2]
 * Scrubbed version from rubygems, do not use

data/CONTRIBUTING.md

@@ -1,31 +1,30 @@
-# Contributing
+# Contributing to Doximity
 
 We welcome contributions to this repository. Feel free to submit issues for bugs you encounter and pull requests for code and documentation contributions.
+In order to prevent licensing issues, Doximity Inc. (“Doximity”, “we”, “us”) requires all contributors to agree to an Individual Contributor License Agreement (“CLA”), which is reproduced below.  By submitting your contributions to us, you agree that you have read and are bound by the CLA.  If you do not agree with the CLA, you may not submit contributions.
 
-In order to prevent licensing issues, we require all contributors to sign an individual contributor license agreement, which is reproduced below:
+## Doximity Individual Contributor License Agreement
 
-## Individual Contributor License Agreement
+This license is for your protection as a Contributor as well as the protection of Doximity; it does not change your rights to use your own Contributions for any other purpose.
 
-In order to clarify the intellectual property license granted with Contributions from any person or entity, Doximity Inc. ("Doximity") must have a Contributor License Agreement ("CLA") on file that has been signed by each Contributor, indicating agreement to the license terms below. This license is for your protection as a Contributor as well as the protection of Doximity; it does not change your rights to use your own Contributions for any other purpose.
-
-You accept and agree to the following terms and conditions for Your present and future Contributions submitted to Doximity. Except for the license granted herein to Doximity and recipients of software distributed by Doximity, You reserve all right, title, and interest in and to Your Contributions.
+You accept and agree to the following terms and conditions for Your present and future Contributions submitted to Doximity. Except for the license granted herein to Doximity and recipients of software distributed by Doximity, You reserve all right, titles, and interests in and to Your Contributions.
 
 ### Definitions
 
-"You" (or "Your") shall mean the copyright owner or legal entity authorized by the copyright owner that is making this Agreement with Doximity. For legal entities, the entity making a Contribution and all other entities that control, are controlled by, or are under common control with that entity are considered to be a single Contributor. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
+"You" (or "Your" or the “Contributor”) shall mean the copyright owner or legal entity authorized by the copyright owner that is making this Agreement with Doximity. For legal entities, the entity making a Contribution and all other entities that control, are controlled by, or are under common control with that entity are considered to be a single Contributor. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
 
-1. "Contribution" shall mean any original work of authorship, including any modifications or additions to an existing work, that is intentionally submitted by You to Doximity for inclusion in, or documentation of, any of the products owned or managed by Doximity (the "Work"). For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to Doximity or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, Doximity for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by You as "Not a Contribution."
+1. "Contribution" shall mean the code, documentation, or any original work of authorship, including any modifications or additions to an existing work, that is intentionally submitted by You to Doximity for inclusion in, or documentation of, any of the products owned or managed by Doximity (the "Work"). For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to Doximity or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, Doximity for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by You as "Not a Contribution."
 
 2. Grant of Copyright License. Subject to the terms and conditions of this Agreement, You hereby grant to Doximity and to recipients of software distributed by Doximity a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, sublicense, and distribute Your Contributions and such derivative works.
 
-3. Grant of Patent License. Subject to the terms and conditions of this Agreement, You hereby grant to Doximity and to recipients of software distributed by Doximity a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by You that are necessarily infringed by Your Contribution(s) alone or by combination of Your Contribution(s) with the Work to which such Contribution(s) was submitted. If any entity institutes patent litigation against You or any other entity (including a cross-claim or counterclaim in a lawsuit) alleging that your Contribution, or the Work to which you have contributed, constitutes direct or contributory patent infringement, then any patent licenses granted to that entity under this Agreement for that Contribution or Work shall terminate as of the date such litigation is filed.
+3. Grant of Patent License. Subject to the terms and conditions of this Agreement, You hereby grant to Doximity and to recipients of software distributed by Doximity a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by You that are necessarily infringed by Your Contribution(s) alone or by a combination of Your Contribution(s) with the Work to which such Contribution(s) was submitted. If any entity institutes patent litigation against You or any other entity (including a cross-claim or counterclaim in a lawsuit) alleging that your Contribution, or the Work to which you have contributed, constitutes a direct or contributory patent infringement, then any patent licenses granted to that entity under this Agreement for that Contribution or Work shall terminate as of the date such litigation is filed.
 
-4. You represent that you are legally entitled to grant the above license. If your employer(s) has rights to intellectual property that you create that includes your Contributions, you represent that you have received permission to make Contributions on behalf of that employer, that your employer has waived such rights for your Contributions to Doximity, or that your employer has executed a separate Corporate CLA with Doximity.
+4. You represent that You are legally entitled to grant the above license. If your employer(s) has rights to intellectual property that you create that includes your Contributions, you represent that you have received permission to make Contributions on behalf of that employer, that your employer has waived such rights for your Contributions to Doximity, or that your employer has executed a separate Corporate CLA with Doximity.
 
 5. You represent that each of Your Contributions is Your original creation (see section 7 for submissions on behalf of others). You represent that Your Contribution submissions include complete details of any third-party license or other restriction (including, but not limited to, related patents and trademarks) of which you are personally aware and which are associated with any part of Your Contributions.
 
-6. You are not expected to provide support for Your Contributions, except to the extent You desire to provide support. You may provide support for free, for a fee, or not at all. Unless required by applicable law or agreed to in writing, You provide Your Contributions on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON- INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE.
+6. You are not expected to provide support for Your Contributions, except to the extent You desire to provide support. You may provide support for free, for a fee, or not at all. Unless required by applicable law or agreed to in writing, You provide Your Contributions on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE.
 
-7. Should You wish to submit work that is not Your original creation, You may submit it to Doximity separately from any Contribution, identifying the complete details of its source and of any license or other restriction (including, but not limited to, related patents, trademarks, and license agreements) of which you are personally aware, and conspicuously marking the work as "Submitted on behalf of a third-party: [[]named here]".
+7. Should You wish to submit work that is not Your original creation, You may submit it to Doximity separately from any Contribution, identifying the complete details of its source and of any license or other restriction (including, but not limited to, related patents, trademarks, and license agreements) of which you are personally aware, and conspicuously marking the work as "Submitted on behalf of a third-party: [named here]".
 
-8. You agree to notify Doximity of any facts or circumstances of which you become aware that would make these representations inaccurate in any respect.
+8. You agree to notify Doximity of any facts or circumstances of which you become aware that would make these representations inaccurate in any respect.

data/CONTRIBUTORS.md

@@ -1,22 +1,29 @@
 ## List of All Known Code Contributors to Simplekiq
 
-### Jack Noble
+### Jack Noble (Doximity)
 * Collaborated on initial concept
 * Wrote the majority of the code as of initial release
+* Helpful contributions to maintenance of specs, README, etc
 
-### John Wilkinson
+### John Wilkinson (Doximity)
 * Collaborated on initial concept
 * Conducted the gem extraction and release
 
-### Brian Dillard
+### Jason Hagglund (Doximity)
+* Finagled a way into getting us the ability to specify `sidekiq-pro` as an explicit dependency despite it not being publicly available and without exposing it to the public in the process.
+
+### Brian Dillard (Doximity)
 * Added additional comment documentation
 * Added support for `on_complete` batch callback support in `Simplekiq::BatchingJob`
 
-### Austin Madden
+### Austen Madden (Doximity)
 * Fixed bug with batch statuses in callbacks for empty batches
 
-### Tiffany Troha
+### Tiffany Troha (Doximity)
 * Added support for specifying `sidekiq_options` for the child job in `Simplekiq::BatchingJob`
 
 ### [Daniel Pepper](https://github.com/dpep)
 * On request, graciously took down his unused `simplekiq` placeholder from rubygems so we could continue using the name :raised_hands:
+
+### [Jeremy Smith](https://github.com/jeremysmithco)
+* Helpfully and respectfully nudged us towards loosening our sidekiq version requirement

data/Gemfile

@@ -1,4 +1,10 @@
 source "https://rubygems.org"
 
+source "https://enterprise.contribsys.com/" do
+  gem "sidekiq-pro", "5.2.1"
+end
+
+gem "sidekiq", "6.1.0"
+
 # Specify your gem's dependencies in simplekiq.gemspec
 gemspec

data/Gemfile.lock

@@ -1,11 +1,13 @@
 PATH
   remote: .
   specs:
-    simplekiq (0.0.3)
-      sidekiq (~> 5.2.9)
+    simplekiq (0.1.0)
+      sidekiq (>= 5.2.9)
+      sidekiq-pro (~> 5.0)
 
 GEM
   remote: https://rubygems.org/
+  remote: https://enterprise.contribsys.com/
   specs:
     ast (2.4.2)
     coderay (1.1.3)
@@ -13,56 +15,56 @@ GEM
     diff-lcs (1.5.0)
     method_source (1.0.0)
     parallel (1.22.1)
-    parser (3.1.1.0)
+    parser (3.1.2.0)
       ast (~> 2.4.1)
-    pry (0.13.1)
+    pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    rack (2.2.3)
-    rack-protection (2.2.0)
-      rack
+    rack (2.2.4)
     rainbow (3.1.1)
     rake (12.3.3)
-    redis (4.5.1)
-    regexp_parser (2.2.1)
+    redis (4.7.1)
+    regexp_parser (2.3.1)
     rexml (3.2.5)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.1)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.3)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
     rspec_junit_formatter (0.5.1)
       rspec-core (>= 2, < 4, != 2.12.0)
-    rubocop (1.26.1)
+    rubocop (1.28.2)
       parallel (~> 1.10)
       parser (>= 3.1.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 1.16.0, < 2.0)
+      rubocop-ast (>= 1.17.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.16.0)
+    rubocop-ast (1.17.0)
       parser (>= 3.1.1.0)
     rubocop-performance (1.13.3)
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
     ruby-progressbar (1.11.0)
-    sidekiq (5.2.10)
-      connection_pool (~> 2.2, >= 2.2.2)
+    sidekiq (6.1.0)
+      connection_pool (>= 2.2.2)
       rack (~> 2.0)
-      rack-protection (>= 1.5.0)
-      redis (~> 4.5, < 4.6.0)
-    standard (1.9.1)
-      rubocop (= 1.26.1)
+      redis (>= 4.2.0)
+    sidekiq-pro (5.2.1)
+      connection_pool (>= 2.2.3)
+      sidekiq (>= 6.1.0)
+    standard (1.11.0)
+      rubocop (= 1.28.2)
       rubocop-performance (= 1.13.3)
     unicode-display_width (2.1.0)
 
@@ -74,6 +76,8 @@ DEPENDENCIES
   rake (~> 12.0)
   rspec (~> 3.2)
   rspec_junit_formatter
+  sidekiq (= 6.1.0)
+  sidekiq-pro (= 5.2.1)!
   simplekiq!
   standard
 

data/README.md

@@ -10,7 +10,7 @@ Add this line to your application's Gemfile:
 gem "simplekiq"
 ```
 
-Note that this gem requires you be a Sidekiq Pro paid subscriber to be able to use it, so after following the installation docs for getting the private gem configured with your system, ensure you have `sidekiq-pro` at version `~> 5.0.0` or higher and that it's being required:
+Note that this gem requires you be a Sidekiq Pro paid subscriber to be able to use it, so after following the installation docs for getting the private gem configured with your system, ensure you have `sidekiq-pro` at version `~> 5.0.0` or higher (need at least version `5.2.1` if you want to capture `on_death` callbacks [percolating up to parent batches](https://github.com/mperham/sidekiq/blob/main/Pro-Changes.md#521) - a supported feature which is not required for typical orchestration behavior) and that it's being required:
 
 ```ruby
 gem "sidekiq-pro", "~> 5.0.0"
@@ -38,8 +38,7 @@ There are currently two primary components of the system which were designed to
 Mixing in the [Simplekiq::Orchestration](./lib/simplekiq/orchestration_job.rb) module lets you define a human-readable workflow of jobs in a single file with almost* no special requirements or restrictions on how the child jobs are designed. In most cases, Sidekiq jobs not designed for use in orchestrations should be compatible for use in orchestrations. A job implementing `OrchestrationJob` might look like:
 
 ```ruby
-class SomeOrchestrationJob < BaseJob
-  include Sidekiq::Worker
+class SomeOrchestrationJob
   include Simplekiq::OrchestrationJob
 
   def perform_orchestration(some_id)
@@ -56,6 +55,17 @@ class SomeOrchestrationJob < BaseJob
     run SomeFinalizationJob, some_model.id # 4.
   end
 
+  def on_death(status, options) # 5.
+    SomeModel.find(options["args"].first).failure_happened!
+  end
+
+  def on_complete(status, options) # 6.
+    failures = Array(status&.failure_info) # sidekiq-pro batch status api
+    return if failures.empty?
+
+    SomeModel.find(options["args"].first).it_was_these_failures(failures)
+  end
+
   private
 
   attr_reader :some_model
@@ -72,6 +82,8 @@ Let's use the above example to describe some specifics of how the flow works.
 2. It does some initial work in `SomeInitialSetupJob`, which blocks the rest of the workflow until it completes successfully.
 3. Then it will run a `SomeParallelizableJob` for each of some number of associated models `some_related_models`. These jobs will all run parallel to each other independently.
 4. Finally, after all of the parallel jobs from #3 complete successfully, `SomeFinalizationJob` will run and then after it finishes the orchestration will be complete.
+5. If it ran into an error at some point, `on_death` will get fired with the first failure. (please use `sidekiq-pro` of at least `5.2.1` for this feature)
+6. It will call `on_complete` at the end of the orchestration no matter what, this is the place to collect all the failures and persist them somewhere.
 
 **Note** - it's fine to add utility methods and `attr_accessor`s to keep the code tidy and maintainable.
 
@@ -105,26 +117,28 @@ The crux of the problem was that each job was highly coupled to its position in
 
 ## Versioning
 
-This project follows semantic versioning. At time of writing it is sitting at 0.0.1 until its integration with the application it was extracted from is confirmed to be stable. Once confirmed it will be started off at 1.0.0 as it has otherwise been used in a production system already for some time.
+This project follows semantic versioning. See https://semver.org/ for details.
 
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Note that this depends on `sidekiq-pro` which requires a [commercial license](https://sidekiq.org/products/pro.html) to install and use.
 
-Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+Then, run `rake ci:specs` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To get a new release cut, please either open a PR or an issue with your ask with as much context as possible and someone from Doximity will consider your request. If it makes sense for the direction of the project we'll get it done and inform you of when a release has been made available with the changes.
 
-TODO: Update this section with more specific/appropriate instructions once this is a public repository.
+For internal employees: consult the company wiki on the current standard process for conducting releases for our public gems.
 
 ## Contributing
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
-6. Sign the CLA if you haven't yet. See CONTRIBUTING.md
+1. See [CONTRIBUTING.md](./CONTRIBUTING.md)
+2. Fork it
+3. Create your feature branch (`git checkout -b my-new-feature`)
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create a new Pull Request
 
 ## License
 

data/lib/simplekiq/batch_tracker_job.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+# This job serves two purposes:
+# * TODO: It provides a convenient way to track top-level orchestration batches
+# * The top-level orchestration batch would otherwise be empty (aside from
+#   child-batches) and all sidekiq-pro batches must have at least 1 job
+
+module Simplekiq
+  class BatchTrackerJob
+    include Sidekiq::Worker
+
+    def perform(klass_name, bid, args)
+      # In the future, this will likely surface the toplevel batch to a callback method on the
+      # orchestration job. We're holding off on this until we have time to design a comprehensive
+      # plan for providing simplekiq-wide instrumentation, ideally while being backwards compatible
+      # for in-flight orchestrations.
+
+      # For now, it's just satisfying the all-batches-must-have-jobs limitation in sidekiq-pro
+      # described at the head of the file.
+    end
+  end
+end

data/lib/simplekiq/batching_job.rb

@@ -108,10 +108,7 @@ module Simplekiq
       if !batches.empty?
         flush_batches(args)
       else
-        # Empty batches with no jobs will never invoke callbacks, so handle
-        # that case by immediately manually invoking :complete & :success.
-        on_complete(nil, {"args" => args}) if respond_to?(:on_complete)
-        on_success(nil, {"args" => args}) if respond_to?(:on_success)
+        Simplekiq.run_empty_callbacks(self, args: args)
       end
     end
 
@@ -119,9 +116,7 @@ module Simplekiq
       batch_job_class = self.class.const_get(BATCH_CLASS_NAME)
       sidekiq_batch.description ||= "Simplekiq Batch Jobs for #{self.class.name}, args: #{args}"
 
-      sidekiq_batch.on("death", self.class, "args" => args) if respond_to?(:on_death)
-      sidekiq_batch.on("complete", self.class, "args" => args) if respond_to?(:on_complete)
-      sidekiq_batch.on("success", self.class, "args" => args) if respond_to?(:on_success)
+      Simplekiq.auto_define_callbacks(sidekiq_batch, args: args, job: self)
 
       sidekiq_batch.jobs do
         batches.each do |job_args|

data/lib/simplekiq/orchestration.rb

@@ -21,10 +21,6 @@ module Simplekiq
       serial_workflow
     end
 
-    def execute(parent_batch)
-      OrchestrationExecutor.execute(workflow: serialized_workflow, parent_batch: parent_batch)
-    end
-
     def serialized_workflow
       @serialized_workflow ||= serial_workflow.map do |step|
         case step[0]

data/lib/simplekiq/orchestration_executor.rb

@@ -2,45 +2,50 @@
 
 module Simplekiq
   class OrchestrationExecutor
-    def self.execute(workflow:, parent_batch:)
-      new.run_step(parent_batch, workflow, 0)
-    end
+    def self.execute(args:, job:, workflow:)
+      if workflow.empty?
+        Simplekiq.run_empty_callbacks(job, args: args)
+        return
+      end
 
-    def run_step(parent_batch, workflow, step)
-      return if workflow.empty?
-
-      nest_under(parent_batch) do
-        *jobs = workflow.at(step)
-        sidekiq_batch = Sidekiq::Batch.new
-        sidekiq_batch.on(
-          :success,
-          self.class,
-          "orchestration_workflow" => workflow, "step" => step + 1
-        )
-
-        sidekiq_batch.jobs do
-          jobs.each do |job|
-            Object.const_get(job["klass"]).perform_async(*job["args"])
-          end
-        end
+      orchestration_batch = Sidekiq::Batch.new
+      orchestration_batch.description = "#{job.class.name} Simplekiq orchestration"
+      Simplekiq.auto_define_callbacks(orchestration_batch, args: args, job: job)
+
+      orchestration_batch.jobs do
+        Simplekiq::BatchTrackerJob.perform_async(job.class.name, orchestration_batch.bid, args)
+
+        new.run_step(workflow, 0)
       end
     end
 
-    def nest_under(parent_batch)
-      if parent_batch
-        parent_batch.jobs do
-          yield
+    def run_step(workflow, step)
+      *jobs = workflow.at(step)
+      # This will never be empty because Orchestration#serialized_workflow skips inserting
+      # a new step for in_parallel if there were no inner jobs specified.
+
+      next_step = step + 1
+      step_batch = Sidekiq::Batch.new
+      step_batch.description = "Simplekiq orchestrated step #{next_step}"
+      step_batch.on(
+        "success",
+        self.class,
+        {"orchestration_workflow" => workflow, "step" => next_step}
+      )
+
+      step_batch.jobs do
+        jobs.each do |job|
+          Object.const_get(job["klass"]).perform_async(*job["args"])
         end
-      else
-        yield
       end
     end
 
     def on_success(status, options)
       return if options["step"] == options["orchestration_workflow"].length
 
-      parent_batch = Sidekiq::Batch.new(status.parent_bid)
-      run_step(parent_batch, options["orchestration_workflow"], options["step"])
+      Sidekiq::Batch.new(status.parent_bid).jobs do
+        run_step(options["orchestration_workflow"], options["step"])
+      end
     end
   end
 end

data/lib/simplekiq/orchestration_job.rb

@@ -11,7 +11,14 @@ module Simplekiq
 
     def perform(*args)
       perform_orchestration(*args)
-      orchestration.execute(batch)
+
+      # This makes it so that if there is a parent batch which this orchestration is run under, then the layered batches will be:
+      # parent_batch( orchestration_batch( batch_of_first_step_of_the_orchestration ) )
+      # If there is no parent batch, then it will simply be:
+      # orchestration_batch( batch_of_first_step_of_the_orchestration )
+      conditionally_within_parent_batch do
+        OrchestrationExecutor.execute(args: args, job: self, workflow: orchestration.serialized_workflow)
+      end
     end
 
     def workflow_plan(*args)
@@ -21,6 +28,16 @@ module Simplekiq
 
     private
 
+    def conditionally_within_parent_batch
+      if batch
+        batch.jobs do
+          yield
+        end
+      else
+        yield
+      end
+    end
+
     def orchestration
       @orchestration ||= Orchestration.new
     end

data/lib/simplekiq/version.rb

@@ -1,3 +1,3 @@
 module Simplekiq
-  VERSION = "0.0.3"
+  VERSION = "0.1.0"
 end

data/lib/simplekiq.rb

@@ -1,14 +1,27 @@
 # frozen_string_literal: true
 
 require "sidekiq"
-
-# NB: You must explicitly require sidekiq-ent in your app!
-# require "sidekiq-ent"
+require "sidekiq-pro"
 
 require "simplekiq/orchestration_executor"
 require "simplekiq/orchestration"
 require "simplekiq/orchestration_job"
 require "simplekiq/batching_job"
+require "simplekiq/batch_tracker_job"
 
 module Simplekiq
+  class << self
+    # Empty batches with no jobs will never invoke callbacks, so handle
+    # that case by immediately manually invoking :complete & :success.
+    def run_empty_callbacks(job, args:)
+      job.on_complete(nil, {"args" => args}) if job.respond_to?(:on_complete)
+      job.on_success(nil, {"args" => args}) if job.respond_to?(:on_success)
+    end
+
+    def auto_define_callbacks(batch, args:, job:)
+      batch.on("death", job.class, "args" => args) if job.respond_to?(:on_death)
+      batch.on("complete", job.class, "args" => args) if job.respond_to?(:on_complete)
+      batch.on("success", job.class, "args" => args) if job.respond_to?(:on_success)
+    end
+  end
 end

data/simplekiq.gemspec

@@ -29,10 +29,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "pry"
   spec.add_development_dependency "standard"
 
-  spec.add_dependency "sidekiq", "~> 5.2.9"
-
-  # Can't define this explicitly because it would be inappropriate to vendor this
-  # pay-to-use library into the gem and it is not available on rubygems and
-  # this otherwise interferes with our publishing process.
-  # spec.add_dependency "sidekiq-pro", "~> 5.0.0"
+  spec.add_dependency "sidekiq", ">= 5.2.9"
+  spec.add_dependency "sidekiq-pro", "~> 5.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simplekiq
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - Jack Noble
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-04-20 00:00:00.000000000 Z
+date: 2022-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -85,16 +85,30 @@ dependencies:
   name: sidekiq
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 5.2.9
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 5.2.9
+- !ruby/object:Gem::Dependency
+  name: sidekiq-pro
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
 description: Provides tools for representing long chains of parallel and serial jobs
   in a flat, simple way.
 email:
@@ -117,6 +131,7 @@ files:
 - bin/console
 - bin/setup
 - lib/simplekiq.rb
+- lib/simplekiq/batch_tracker_job.rb
 - lib/simplekiq/batching_job.rb
 - lib/simplekiq/orchestration.rb
 - lib/simplekiq/orchestration_executor.rb
@@ -124,34 +139,6 @@ files:
 - lib/simplekiq/version.rb
 - simplekiq.gemspec
 - tasks/ci.rake
-- vendor/cache/ast-2.4.2.gem
-- vendor/cache/coderay-1.1.3.gem
-- vendor/cache/connection_pool-2.2.5.gem
-- vendor/cache/diff-lcs-1.5.0.gem
-- vendor/cache/method_source-1.0.0.gem
-- vendor/cache/parallel-1.22.1.gem
-- vendor/cache/parser-3.1.1.0.gem
-- vendor/cache/pry-0.13.1.gem
-- vendor/cache/rack-2.2.3.gem
-- vendor/cache/rack-protection-2.2.0.gem
-- vendor/cache/rainbow-3.1.1.gem
-- vendor/cache/rake-12.3.3.gem
-- vendor/cache/redis-4.5.1.gem
-- vendor/cache/regexp_parser-2.2.1.gem
-- vendor/cache/rexml-3.2.5.gem
-- vendor/cache/rspec-3.10.0.gem
-- vendor/cache/rspec-core-3.10.1.gem
-- vendor/cache/rspec-expectations-3.10.1.gem
-- vendor/cache/rspec-mocks-3.10.2.gem
-- vendor/cache/rspec-support-3.10.3.gem
-- vendor/cache/rspec_junit_formatter-0.5.1.gem
-- vendor/cache/rubocop-1.26.1.gem
-- vendor/cache/rubocop-ast-1.16.0.gem
-- vendor/cache/rubocop-performance-1.13.3.gem
-- vendor/cache/ruby-progressbar-1.11.0.gem
-- vendor/cache/sidekiq-5.2.10.gem
-- vendor/cache/standard-1.9.1.gem
-- vendor/cache/unicode-display_width-2.1.0.gem
 homepage: https://github.com/doximity/simplekiq
 licenses:
 - APACHE-2.0