stampeded 0.3.2-aarch64-linux-gnu → 0.4.1-aarch64-linux-gnu

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 30ba29fba7862a8c5b8877e8ab64babbc1c39868440dbb9f06d2d15cfd97412f
-  data.tar.gz: 948af6558ab6a9480dd147f3c75d242e4965cd0ff22589e7b3d5afab4ce3aa2b
+  metadata.gz: 6fc124e857302980de58695706ba4e80f94531bb21426c8c463565be81eddb7e
+  data.tar.gz: cee51f4df6c47377410b789a98156ca6eaa7b3379f818c40a2873385b9832c74
 SHA512:
-  metadata.gz: 8afb5700428b6820fc2e7f04e0c9662cfa25603fea90978684395993d5ac643e28c7a68e3bb53a347cdb6edd11e4ce68462210b9e4cac06f7561e70040e2fdff
-  data.tar.gz: 21c220abe7c5167325ae2d1b95ced35686152804498706b5fe965c09aab19128abf5068cd5600939aaad74aaa91d49e63d2b73cf4666ff9456af95d491419628
+  metadata.gz: c4d9554471d8829b2908ce9010b95991631b2e1e518774fe1f0133b7c7904e78732edb03c782f749c36b8249f1d21beefad4e16353e1c4de328258739b0e5bf1
+  data.tar.gz: 7d19ae8792459990eb3f20b752f694ce1c5378ff1e27d297c5886128c1f509e6be014fe04b3394b951970f4bc125feea80018eb655c4ca34145f81f2b71cbfe8

data/lib/stampeded/schema.rb

@@ -1,8 +1,11 @@
 # frozen_string_literal: true
 
+require "digest"
+
 module Stampeded
   module Schema
-    FILES = %w[schema.sql].freeze
+    # Where the daemon's sqlx migrator records what it applied.
+    TABLE = "stampeded_migrations"
 
     module_function
 
@@ -15,15 +18,40 @@ module Stampeded
         raise(Error, "cannot find schema/*.sql (looked in #{candidates.join(", ")})")
     end
 
-    def sql
-      FILES.map { |f| File.read(File.join(root, f)) }.join("\n")
+    # [version, description, sql] per migration, in order: sqlx's names.
+    def migrations
+      Dir[File.join(root, "*.sql")].sort.map do |path|
+        version, name = File.basename(path, ".sql").split("_", 2)
+        [Integer(version, 10), name.tr("_", " "), File.read(path)]
+      end
     end
 
+    def sql = migrations.map(&:last).join("\n")
+
+    # A fresh install, recorded as sqlx records it, so the daemon's
+    # --migrate finds nothing to apply.
     def install!(conn = nil)
       run = lambda do |c|
         c.exec("BEGIN")
         begin
-          c.exec(sql)
+          c.exec(<<~SQL)
+            CREATE TABLE #{TABLE} (
+                version BIGINT PRIMARY KEY,
+                description TEXT NOT NULL,
+                installed_on TIMESTAMPTZ NOT NULL DEFAULT now(),
+                success BOOLEAN NOT NULL,
+                checksum BYTEA NOT NULL,
+                execution_time BIGINT NOT NULL
+            )
+          SQL
+          migrations.each do |version, description, sql|
+            c.exec(sql)
+            c.exec_params(
+              "INSERT INTO #{TABLE} (version, description, success, checksum, execution_time) " \
+              "VALUES ($1, $2, true, decode($3, 'hex'), 0)",
+              [version, description, Digest::SHA384.hexdigest(sql)]
+            )
+          end
           c.exec("COMMIT")
         rescue StandardError
           c.exec("ROLLBACK")
@@ -39,7 +67,8 @@ module Stampeded
         c.exec(<<~SQL)
           DROP TABLE IF EXISTS stampeded_cron_occurrences, stampeded_schedules,
                                stampeded_queue_policies, stampeded_queue_counts,
-                               stampeded_jobs, stampeded_workers CASCADE;
+                               stampeded_jobs, stampeded_workers,
+                               stampeded_schema, stampeded_migrations CASCADE;
           DO $$
           DECLARE r record;
           BEGIN

data/lib/stampeded/tasks/stampeded.rake

@@ -22,10 +22,11 @@ namespace :stampeded do
     worker.run
   end
 
-  desc "Run the daemon (scheduler, reaper, pruner, dashboard). Not the worker."
+  desc "Run the daemon (scheduler, reaper, pruner, dashboard). Not the worker. Upgrades the schema first."
   task daemon: :environment do
     require "stampeded/daemon"
-    args = ["--no-worker", *ENV["STAMPEDED_ARGS"].to_s.split]
+    # --migrate is safe on every start: it upgrades an older schema in place.
+    args = ["--no-worker", "--migrate", *ENV["STAMPEDED_ARGS"].to_s.split]
     Stampeded::Daemon.exec!(*args, env: { "STAMPEDED_DATABASE_URL" => Stampeded.database_url_for_daemon })
   end
 end

data/lib/stampeded/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Stampeded
-  VERSION = "0.3.2" # x-release-please-version
+  VERSION = "0.4.1" # x-release-please-version
 end

data/schema/0002_dedup_key_period.sql

@@ -0,0 +1,14 @@
+-- Schema 2: the dedup key names its period. Without it, an hourly and a
+-- daily unique job of the same scope shared a key whenever their buckets
+-- started together (every midnight UTC, Mondays, the 1st of a month) and
+-- refused each other. The new key is strictly finer: no row can collide.
+ALTER TABLE stampeded_jobs ALTER COLUMN dedup_key SET EXPRESSION AS (
+    sha256((
+        dedup_scope || coalesce(
+            ':' || dedup_period || ':' || extract(
+                epoch FROM (date_trunc(dedup_period, inserted_at, 'UTC') - to_timestamp(0))
+            )::bigint::text,
+            ''
+        )
+    )::bytea)
+);

data/schema/0003_dedup_key_separator.sql

@@ -0,0 +1,17 @@
+-- Schema 3: the dedup key joins scope/period/bucket as bytea with a raw
+-- zero byte. The old ':' join let a crafted dedup_scope (e.g.
+-- 'a:hour:1700000000') forge the exact key of an unrelated periodic job
+-- (scope 'a', period 'hour', that epoch) -- same sha256, same unique index,
+-- wrongly rejected as a duplicate. No `text` value can ever decode to a
+-- zero byte (chr(0) itself is refused by Postgres), so the new separator
+-- can never be forged.
+ALTER TABLE stampeded_jobs ALTER COLUMN dedup_key SET EXPRESSION AS (
+    sha256(
+        dedup_scope::bytea || '\x00'::bytea || coalesce(
+            dedup_period::bytea || '\x00'::bytea || extract(
+                epoch FROM (date_trunc(dedup_period, inserted_at, 'UTC') - to_timestamp(0))
+            )::bigint::text::bytea,
+            ''::bytea
+        )
+    )
+);

data/schema/0004_dedup_key_raw_scope.sql

@@ -0,0 +1,12 @@
+-- Backslashes are doubled so `::bytea` keeps the scope's own bytes instead
+-- of reading escapes: `a` and `\x61` are distinct scopes.
+ALTER TABLE stampeded_jobs ALTER COLUMN dedup_key SET EXPRESSION AS (
+    sha256(
+        replace(dedup_scope, '\', '\\')::bytea || '\x00'::bytea || coalesce(
+            dedup_period::bytea || '\x00'::bytea || extract(
+                epoch FROM (date_trunc(dedup_period, inserted_at, 'UTC') - to_timestamp(0))
+            )::bigint::text::bytea,
+            ''::bytea
+        )
+    )
+);

data/schema/0005_schema_version_guard.sql

@@ -0,0 +1,9 @@
+-- stampeded 0.4 reads this and refuses a version above 3, rather than
+-- mistaking this database for an unversioned one and rewriting it.
+CREATE TABLE IF NOT EXISTS stampeded_schema (
+    version     integer     NOT NULL CHECK (version > 0),
+    changed_at  timestamptz NOT NULL DEFAULT now()
+);
+CREATE UNIQUE INDEX IF NOT EXISTS stampeded_schema_one_row ON stampeded_schema ((true));
+DELETE FROM stampeded_schema;
+INSERT INTO stampeded_schema (version) VALUES (5);

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stampeded
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.1
 platform: aarch64-linux-gnu
 authors:
 - Abdelkader Boudih
@@ -83,7 +83,11 @@ files:
 - lib/stampeded/worker.rb
 - libexec/libstampeded_ffi.so
 - libexec/stampeded
-- schema/schema.sql
+- schema/0001_init.sql
+- schema/0002_dedup_key_period.sql
+- schema/0003_dedup_key_separator.sql
+- schema/0004_dedup_key_raw_scope.sql
+- schema/0005_schema_version_guard.sql
 homepage: https://github.com/seuros/stampeded
 licenses:
 - BSD-3-Clause