cogworker 0.1.0

data/lib/cogworker.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+require 'socket'
+require 'securerandom'
+require 'zeitwerk'
+
+# Redis-backed background job processing: worker DSL, periodic (cron)
+# scheduling, process introspection, a Web UI, and a Prometheus exporter.
+module Cogworker
+  # `LOADER` autoloads everything under lib/cogworker/** — no internal
+  # `require_relative` between this gem's own files anywhere below; just
+  # reference the constant, Zeitwerk resolves file <-> constant by
+  # directory structure (lib/cogworker/foo/bar.rb <-> Cogworker::Foo::Bar).
+  # Two inflections don't follow the default snake_case -> CamelCase rule:
+  # `version.rb` defines the constant `VERSION` (conventional for gems, not
+  # `Version`), and `cli.rb` defines `CLI` (an acronym, not `Cli`).
+  LOADER = Zeitwerk::Loader.for_gem
+  LOADER.inflector.inflect('version' => 'VERSION', 'cli' => 'CLI')
+
+  # Reloading is opt-in and, by design, only ever triggered from
+  # `Cogworker::Web.call` (see web.rb) — never from a job-processing
+  # Processor thread. Redefining a job class's constant while another
+  # thread is mid-`perform` on an instance of it is exactly the kind of
+  # hazard Rails-style reloading is unsafe for in a worker process, which
+  # is why this must be enabled (if at all) only for a Web UI process, via
+  # `COGWORKER_RELOAD=true` — never unconditionally, never in `exe/cogworker`
+  # or `exe/cogworkerswarm`'s own boot path.
+  LOADER.enable_reloading if ENV['COGWORKER_RELOAD'] == 'true'
+  LOADER.setup
+
+  class << self
+    def logger
+      @logger ||= Logging.default_logger
+    end
+
+    attr_writer :logger
+
+    def config
+      @config ||= Config.new
+    end
+
+    # Skipping the block when `server?` is false is by design for a plain
+    # Web-only process (see `server?` below) — not necessarily a mistake, so
+    # this only logs at `debug` (silent under the default `info` level; bump
+    # `Cogworker.logger.level = Logger::DEBUG` while integrating to see it).
+    # It's the same skip either way whether that's intentional or the app's
+    # init file just happened to load before the CLI/swarm boot path called
+    # `server_process!` — this gem can't tell those apart, so it can only
+    # ever hint, not warn outright.
+    def configure_server
+      if server?
+        yield config
+      else
+        logger.debug do
+          'Cogworker.configure_server skipped: Cogworker.server? is false right now — either ' \
+            'intentional (a Web-only process), or configure_server ran before ' \
+            'Cogworker.server_process! was set (check init/boot ordering).'
+        end
+      end
+    end
+
+    def configure_client
+      if server?
+        logger.debug do
+          'Cogworker.configure_client skipped: Cogworker.server? is true right now — either ' \
+            'intentional (a worker-only process with no client-side pushes), or configure_client ' \
+            'ran after Cogworker.server_process! was already set (check init/boot ordering).'
+        end
+      else
+        yield config
+      end
+    end
+
+    # Whether this process is a Cogworker worker process (set by the CLI/swarm
+    # boot sequence before requiring app code). A plain web process loading
+    # the same initializer file should skip `configure_server` blocks (no
+    # Redis pool / middleware chain needed there) — this flag is what makes
+    # that possible without changing the initializer.
+    def server?
+      !!@server_process
+    end
+
+    def server_process!
+      @server_process = true
+    end
+
+    # No-op: exists so calling code doesn't need to change, but this gem
+    # simply never coerces job args, so there is nothing to toggle.
+    def strict_args!(_value = true)
+      true
+    end
+
+    # Recomputed fresh in every cogworkerswarm child (see Cogworker::Swarm) —
+    # never memoize this before a fork, or every child collapses onto the
+    # parent's identity in the heartbeat/ProcessSet/WorkSet Redis keys.
+    def identity
+      @identity ||= compute_identity
+    end
+
+    def reset_identity!
+      @identity = compute_identity
+    end
+
+    def hostname
+      ENV['DYNO'] || Socket.gethostname
+    end
+
+    private
+
+    def compute_identity
+      "#{hostname}:#{::Process.pid}:#{SecureRandom.hex(6)}"
+    end
+  end
+end

metadata

@@ -0,0 +1,300 @@
+--- !ruby/object:Gem::Specification
+name: cogworker
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- vdonec
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: connection_pool
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: fugit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: rack-session
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.8'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.8'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.40'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.40'
+- !ruby/object:Gem::Dependency
+  name: cuprite
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+- !ruby/object:Gem::Dependency
+  name: puma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.4'
+- !ruby/object:Gem::Dependency
+  name: rackup
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.65'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.65'
+executables:
+- cogworker
+- cogworkerswarm
+extensions: []
+extra_rdoc_files: []
+files:
+- exe/cogworker
+- exe/cogworkerswarm
+- lib/cogworker.rb
+- lib/cogworker/basic_fetch.rb
+- lib/cogworker/cli.rb
+- lib/cogworker/client.rb
+- lib/cogworker/component.rb
+- lib/cogworker/config.rb
+- lib/cogworker/config_loader.rb
+- lib/cogworker/heartbeat.rb
+- lib/cogworker/history.rb
+- lib/cogworker/history/middleware.rb
+- lib/cogworker/history/storage.rb
+- lib/cogworker/job.rb
+- lib/cogworker/job_record.rb
+- lib/cogworker/job_util.rb
+- lib/cogworker/launcher.rb
+- lib/cogworker/logging.rb
+- lib/cogworker/manager.rb
+- lib/cogworker/middleware/chain.rb
+- lib/cogworker/periodic/claim.lua
+- lib/cogworker/periodic/entry.rb
+- lib/cogworker/periodic/manager.rb
+- lib/cogworker/periodic/release_middleware.rb
+- lib/cogworker/periodic/ticker.rb
+- lib/cogworker/process.rb
+- lib/cogworker/process_set.rb
+- lib/cogworker/processor.rb
+- lib/cogworker/prometheus/exporter.rb
+- lib/cogworker/queue.rb
+- lib/cogworker/redis_connection.rb
+- lib/cogworker/redis_keys.rb
+- lib/cogworker/scheduled.rb
+- lib/cogworker/signals.rb
+- lib/cogworker/stats.rb
+- lib/cogworker/status.rb
+- lib/cogworker/status/client_middleware.rb
+- lib/cogworker/status/server_middleware.rb
+- lib/cogworker/status/storage.rb
+- lib/cogworker/status/worker.rb
+- lib/cogworker/swarm.rb
+- lib/cogworker/testing.rb
+- lib/cogworker/unique_jobs.rb
+- lib/cogworker/unique_jobs/client_middleware.rb
+- lib/cogworker/unique_jobs/release_middleware.rb
+- lib/cogworker/version.rb
+- lib/cogworker/web.rb
+- lib/cogworker/web/action.rb
+- lib/cogworker/web/application.rb
+- lib/cogworker/web/assets/ag-grid/ag-grid-community.min.js
+- lib/cogworker/web/assets/ag-grid/ag-grid.min.css
+- lib/cogworker/web/assets/ag-grid/ag-theme-alpine.min.css
+- lib/cogworker/web/assets/chart.umd.min.js
+- lib/cogworker/web/assets/htmx.min.js
+- lib/cogworker/web/assets/tailwind.css
+- lib/cogworker/web/layout.rb
+- lib/cogworker/web/router.rb
+- lib/cogworker/web/routes/busy.rb
+- lib/cogworker/web/routes/dead.rb
+- lib/cogworker/web/routes/history.rb
+- lib/cogworker/web/routes/periodic.rb
+- lib/cogworker/web/routes/queues.rb
+- lib/cogworker/web/routes/retries.rb
+- lib/cogworker/web/routes/save_session.rb
+- lib/cogworker/web/routes/scheduled.rb
+- lib/cogworker/web/routes/stats.rb
+- lib/cogworker/web/views.rb
+- lib/cogworker/work.rb
+- lib/cogworker/work_set.rb
+- lib/cogworker/worker.rb
+- lib/cogworker/workers.rb
+homepage: https://github.com/vdonec/cogworker
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/vdonec/cogworker
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: 'Redis-backed background job processing: worker DSL, periodic scheduling,
+  and process introspection'
+test_files: []