sequel-pgt_outbox 0.2.0

data/ci/build_image.sh

@@ -0,0 +1,257 @@
+#!/usr/bin/env bash
+
+if readlink -f . >/dev/null 2>&1 # {{{ makes readlink work on mac
+then
+    readlink=readlink
+else
+    if greadlink -f . >/dev/null 2>&1
+    then
+        readlink=greadlink
+    else
+        printf "You must install greadlink to use this (brew install coreutils)\n" >&2
+    fi
+fi # }}}
+
+# Set here to the full path to this script
+me=${BASH_SOURCE[0]}
+[ -L "$me" ] && me=$($readlink -f "$me")
+here=$(cd "$(dirname "$me")" && pwd)
+just_me=$(basename "$me")
+
+repo_top=$(git rev-parse --show-toplevel)
+cd "$repo_top" || {
+    printf "Could not cd to %s\n" "$repo_top" >&2
+    exit 1
+}
+
+base_dir=$(basename "$(pwd)")
+: "${UBUNTU_VERSION:=bookworm}"
+: "${BUILD_CONTEXT:=$(pwd)}"
+: "${IMAGE_NAME:=$base_dir}"
+: "${LICENSE:=MIT}"
+: "${REGISTRY:=ghcr.io}"
+: "${RUBY_VERSION:=3.3.6}"
+: "${REGISTRY_TOKEN:=$GITHUB_TOKEN}"
+
+base_image_tag="$RUBY_VERSION-$UBUNTU_VERSION"
+base_exists=$(skopeo list-tags docker://docker.io/ruby |jq -r "any(.Tags[] == \"$base_image_tag\"; .)")
+if [ "$base_exists" = "false" ]
+then
+    printf "Base image %s does not exist at docker.io/ruby, cannot build.\n" "$base_image_tag" >&2
+    exit 99
+fi
+
+usage() { # {{{
+    cat <<-EOT
+    Build an image, optionally pushing it to the registry
+
+    Usage: $0 <options> <image_tag>
+        Options:
+            -c CONTAINERFILE  Path to the containerfile (default: ./oci/Containerfile)
+            -C CONTEXT        Build context (default: $BUILD_CONTEXT)
+            -i NAME           Name of the image (default: $IMAGE_NAME)
+            -l LICENSE        License of the image (default: $LICENSE)
+            -r REGISTRY       Registry to push the image to when -p is given (default: $REGISTRY)
+            -p                Push the image to the registry
+            -h                Show help / usage
+EOT
+} # }}}
+
+die() { # {{{
+    local -i code
+    code=$1
+    shift
+    error "$*"
+    printf "\n" >&2
+    usage >&2
+    # shellcheck disable=SC2086
+    exit $code
+} # }}}
+
+## Logging functions # {{{
+log() { # {{{
+    printf "%s [%s] <%s> %s\n" "$(date '+%Y-%m-%d %H:%M:%S.%6N')" "$$" "${just_me:-$0}" "$*"
+} # }}}
+
+debug() { # {{{
+    [ $verbose -lt 2 ] && return 0
+    # shellcheck disable=SC2059
+    log_line=$(printf "$@")
+    log "[DEBUG] $log_line" >&2
+} # }}}
+
+warn() { # {{{
+    # shellcheck disable=SC2059
+    log_line=$(printf "$@")
+    log "[WARN] $log_line" >&2
+} # }}}
+
+error() { # {{{
+    # shellcheck disable=SC2059
+    log_line=$(printf "$@")
+    log "[ERROR] $log_line" >&2
+} # }}}
+
+info() { # {{{
+    [ $verbose -lt 1 ] && return 0
+    # shellcheck disable=SC2059
+    log_line=$(printf "$@")
+    log "[INFO] $log_line" >&2
+} # }}}
+# }}}
+
+push=0
+verbose=0
+while getopts :hpvc:C:i:l:r: opt # {{{
+do
+    case $opt in
+        c)
+            CONTAINERFILE=$OPTARG
+            ;;
+        C)
+            BUILD_CONTEXT=$OPTARG
+            ;;
+        i)
+            IMAGE_NAME=$OPTARG
+            ;;
+        l)
+            LICENSE=$OPTARG
+            ;;
+        r)
+            REGISTRY=$OPTARG
+            ;;
+        p)
+            push=1
+            ;;
+        v)
+            verbose=$((verbose + 1))
+            ;;
+        h)
+            usage
+            exit
+            ;;
+        :)
+            printf "Option %s requires an argument\n" "$OPTARG" >&2
+            usage >&2
+            exit 28
+            ;;
+        ?)
+            printf "Invalid option '%s'\n" "$OPTARG" >&2
+            usage >&2
+            exit 27
+            ;;
+    esac
+done # }}}
+shift $((OPTIND-1))
+
+tag=$1
+[ -z "$tag" ] && die 1 "Missing image tag"
+shift
+
+# Check for extra argument
+if [ $# -gt 0 ]; then
+    # If we have the special argument '--' we shift it away, otherwise we die
+    [ "$1" != '--' ] && die 2 "Too many arguments"
+    # Once this is shifted away, the rest of the arguments are passed to the build command, below
+    shift
+fi
+
+if [ -z "$CONTAINERFILE" ]; then
+    printf "No containerfile specified, looking for default locations\n"
+    for containerfile in Containerfile Dockerfile
+    do
+        if [ -f ./oci/"$containerfile" ]; then
+            debug "Found ./oci/%s\n" "$containerfile"
+            containerfile=./oci/"$containerfile"
+            break
+        fi
+        if [ -f "$containerfile" ]; then
+            debug "Found %s\n" "$containerfile"
+            break
+        fi
+    done
+else
+    [ -f "$CONTAINERFILE" ] || die 3 "Containerfile '$CONTAINERFILE' not found"
+    debug "Using containerfile %s\n" "$CONTAINERFILE"
+    containerfile=$CONTAINERFILE
+fi
+
+[ -f "$containerfile" ] || die 4 "No containerfile found"
+
+[ -d "$BUILD_CONTEXT" ] || die 5 "Build context '$BUILD_CONTEXT' not found"
+
+debug 'Building image from %s in in %s\n' "$containerfile" "$here"
+# Build the image
+if command -v podman 2>/dev/null
+then
+    runtime=podman
+elif command -v docker 2>/dev/null
+then
+    runtime=docker
+else
+    die 6 "No container runtime found"
+fi
+
+revision=$(git rev-parse HEAD)
+shortref=$(git rev-parse --short "$revision")
+repo_url=$(git remote get-url upstream)
+if [ -z "$repo_url" ]
+then
+    die 7 "No remote found"
+fi
+if [[ $repo_url == *github.com/* ]]
+then
+    owner_and_repo=${repo_url#*github.com/}
+else
+    owner_and_repo=${repo_url##*:}
+fi
+# Get rid of the trailing .git
+service=$(basename "$owner_and_repo" .git)
+owner=$(dirname "$owner_and_repo")
+
+full_tag=$IMAGE_NAME:$tag-ruby$RUBY_VERSION-$UBUNTU_VERSION
+# Pass any extra arguments to the build command ("$@" contains the rest of the arguments)
+$runtime build --tag "$full_tag" "$@" \
+               --label org.opencontainers.image.created="$(date --utc --iso-8601=seconds)" \
+               --label org.opencontainers.image.description="Image for $service" \
+               --label org.opencontainers.image.licenses="$LICENSE" \
+               --label org.opencontainers.image.revision="$revision" \
+               --label org.opencontainers.image.url="$repo_url" \
+               --label org.opencontainers.image.title="$IMAGE_NAME" \
+               --label org.opencontainers.image.source="Generated by ruby-automation's build_image.sh ($USER@$HOSTNAME)" \
+               --label org.opencontainers.image.version="$full_tag" \
+               --label shortref="$shortref" \
+               --build-arg UBUNTU_VERSION="$UBUNTU_VERSION" \
+               --build-arg RUBY_VERSION="$RUBY_VERSION" \
+               -f "$containerfile" "$BUILD_CONTEXT" || die 8 "Failed to build image"
+
+[ $push -eq 1 ] || exit 0
+if ! $runtime login --get-login "$REGISTRY" >/dev/null 2>/dev/null
+then
+    printf "Not logged in to '%s', trying to login\n" "$REGISTRY" >&2
+    [ -z "$REGISTRY_TOKEN" ] && die 9 "No REGISTRY_TOKEN (nor GITHUB_TOKEN) set, cannot login"
+    printf "%s" "$REGISTRY_TOKEN" | $runtime login -u "$REGISTRY_TOKEN" --password-stdin "$REGISTRY" || die 10 "Failed to login to $REGISTRY"
+fi
+
+# Split 1.2.3 into 1.2.3, 1.2, 1. We want to tag our image with all 3 of these
+mapfile -t tags < <(echo "$tag" | awk -F'.' 'NF==3{print; print $1"."$2; print $1; next} NF==2{print; print $1; next} {print}')
+for t in "${tags[@]}"
+do
+    new_tag=$IMAGE_NAME:$t-ruby$RUBY_VERSION-$UBUNTU_VERSION
+    registry_image_name="$REGISTRY/$owner/$new_tag"
+    if [ "$runtime" = "podman" ]
+    then
+        if [ "$full_tag" != "$new_tag" ]
+        then
+            debug "Tagging %s as %s\n" "$full_tag" "$new_tag"
+            podman tag "$full_tag" "$new_tag" || die 11 "Failed to tag image $full_tag as $new_tag"
+        fi
+        podman push "$new_tag" "$registry_image_name" || die 12 "Failed to push image $new_tag to $registry_image_name"
+    else
+        debug "Tagging %s as %s\n" "$full_tag" "$registry_image_name"
+        docker tag "$full_tag" "$registry_image_name" || die 13 "Failed to tag image $full_tag as $registry_image_name"
+        docker push "$registry_image_name" || die 14 "Failed to push image $new_tag to $registry_image_name"
+    fi
+done
+
+# vim: set foldmethod=marker et ts=4 sts=4 sw=4 ft=bash :

data/ci/publish-gem.sh

@@ -0,0 +1,77 @@
+#!/usr/bin/env bash
+
+if readlink -f . >/dev/null 2>&1 # {{{ makes readlink work on mac
+then
+    readlink=readlink
+else
+    if greadlink -f . >/dev/null 2>&1
+    then
+        readlink=greadlink
+    else
+        printf "You must install greadlink to use this (brew install coreutils)\n" >&2
+    fi
+fi # }}}
+
+# Set here to the full path to this script
+me=${BASH_SOURCE[0]}
+[ -L "$me" ] && me=$($readlink -f "$me")
+here=$(cd "$(dirname "$me")" && pwd)
+just_me=$(basename "$me")
+
+: "${GEM_NAME:=sequel-pgt_outbox}"
+: "${GIT_ORG:=rubyists}"
+
+GEM_HOST=$1
+: "${GEM_HOST:=rubygems}"
+
+case "$GEM_HOST" in
+    rubygems)
+        gem_key='rubygems'
+        gem_host='https://rubygems.org'
+        ;;
+    github)
+        gem_key='github'
+        gem_host="https://rubygems.pkg.github.com/$GIT_ORG"
+        # Replace the gem host in the gemspec, so it allows pushing to the GitHub package registry
+        sed --in-place=.bak -e "s|https://rubygems.org|https://rubygems.pkg.github.com/$GIT_ORG|" "$here/../$GEM_NAME".gemspec
+        # Restore the original gemspec after the script finishes
+        trap 'mv -v "$here/../$GEM_NAME".gemspec.bak "$here/../$GEM_NAME".gemspec' EXIT
+        ;;
+    *)
+        printf 'Unknown GEM_HOST: %s\n' "$GEM_HOST" >&2
+        exit 1
+        ;;
+esac
+
+# We only want this part running in CI, with no ~/.gem dir
+# For local testing, you should have a ~/.gem/credentials file with
+# the keys you need to push to rubygems or github
+if [ ! -d ~/.gem ]
+then
+    if [ -z "$GEM_TOKEN" ]
+    then
+        printf 'No GEM_TOKEN provided, cannot publish\n' >&2
+        exit 1
+    fi
+    mkdir -p ~/.gem
+    printf '%s\n:%s: %s\n' '---' "$gem_key" "$GEM_TOKEN" > ~/.gem/credentials
+    chmod 600 ~/.gem/credentials
+fi
+
+if [ -f "$here"/../.version.txt ]
+then
+    version=$(<"$here"/../.version.txt)
+else
+    version=$(git describe --tags --abbrev=0 | sed -e 's/^v//')
+fi
+
+gem="$(printf '%s-%s.gem' "$GEM_NAME" "$version")"
+if [[ "${TRACE:-false}" == true || "${ACTIONS_STEP_DEBUG:-false}" == true ]]
+then
+    printf "DEBUG: [%s] Building And Publishing %s to %s\n" "$just_me" "$gem" "$gem_host" >&2
+fi
+
+bundle exec gem build
+bundle exec gem push -k "$gem_key" --host "$gem_host" "$gem"
+
+# vim: set foldmethod=marker et ts=4 sts=4 sw=4 ft=bash :

data/lib/sequel/extensions/pgt_outbox.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require_relative '../pgt_outbox'
+
+# The pgt_outbox extension adds support to the Database instance for
+# implementing the transactional outbox pattern using triggers.
+module Sequel
+  # Postgres namespace
+  module Postgres
+    # The PgtOutboxMethods module provides methods for creating outbox tables and triggers
+    module PgtOutboxMethods
+      class_eval(&Rubyists::PgtOutbox::DEFINITION)
+    end
+  end
+
+  Database.register_extension(:pgt_outbox, Postgres::PgtOutboxMethods)
+end

data/lib/sequel/pgt_outbox/database_methods.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require_relative '../pgt_outbox'
+
+module Sequel
+  module Postgres
+    # Extends the Sequel::Database class with the PgtOutbox methods
+    module DatabaseMethods
+      class_eval(&Rubyists::PgtOutbox::DEFINITION)
+    end
+  end
+end

data/lib/sequel/pgt_outbox/function.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require_relative '../pgt_outbox'
+
+module Rubyists
+  # Top-level module for the PgtOutbox gem
+  module PgtOutbox
+    # The Outbox Function
+    class Function
+      include PgtOutbox
+      DEFAULT_OPTS = { language: :plpgsql, returns: :trigger, replace: true }.freeze
+
+      attr_reader(*%i[outbox db opts])
+
+      def self.create!(outbox, opts: {})
+        new(outbox, opts: opts).create!
+      end
+
+      def initialize(outbox, opts: {})
+        @outbox = outbox
+        @db = outbox.db
+        @opts = opts
+      end
+
+      def name
+        @name = opts.fetch(:function_name, "pgt_outbox_#{mangled_table_name(db, outbox.name)}")
+      end
+
+      %i[data_after_column data_before_column event_prefix event_type_column quoted_name].each do |meth|
+        define_method(meth) { outbox.send(meth) }
+      end
+
+      def create!
+        db.create_function(name, function_sql, function_opts)
+        self
+      end
+
+      def function_sql
+        <<~SQL
+          BEGIN
+            #{depth_guard_clause}
+            IF (TG_OP = 'INSERT') THEN
+                INSERT INTO #{quoted_name} ("#{event_type_column}", "#{data_after_column}") VALUES
+                ('#{event_prefix}_created', to_jsonb(NEW));
+                RETURN NEW;
+            ELSIF (TG_OP = 'UPDATE') THEN
+                INSERT INTO #{quoted_name} ("#{event_type_column}", "#{data_before_column}", "#{data_after_column}") VALUES
+                ('#{event_prefix}_updated', to_jsonb(OLD), to_jsonb(NEW));
+                RETURN NEW;
+            ELSIF (TG_OP = 'DELETE') THEN
+                INSERT INTO #{quoted_name} ("#{event_type_column}", "#{data_before_column}") VALUES
+                ('#{event_prefix}_deleted', to_jsonb(OLD));
+                RETURN OLD;
+            END IF;
+          END;
+        SQL
+      end
+
+      private
+
+      def function_opts
+        @function_opts ||= DEFAULT_OPTS.merge(opts.fetch(:function_opts, {}))
+      end
+    end
+  end
+end

data/lib/sequel/pgt_outbox/table.rb

@@ -0,0 +1,161 @@
+# frozen_string_literal: true
+
+require_relative '../pgt_outbox'
+require_relative 'function'
+
+module Rubyists
+  module PgtOutbox
+    # The Outbox Table
+    class Table # rubocop:disable Metrics/ClassLength
+      attr_reader(*%i[table opts db])
+
+      def self.create!(table, db, opts: {})
+        new(table, db, opts:).create!
+      end
+
+      def initialize(table, db, opts: {})
+        @table = table
+        @opts  = opts
+        @db    = db
+      end
+
+      def create!
+        db.run 'CREATE EXTENSION IF NOT EXISTS "uuid-ossp"' if uuid_primary_key?
+        create_table!
+        integer_columns!
+        completed_column!
+        timestamp_columns!
+        string_columns!
+        jsonb_columns!
+        indexes!
+        self
+      end
+
+      def name
+        @name ||= opts.fetch(:outbox_table, "#{table}_outbox")
+      end
+
+      def timestamp_type
+        opts.fetch(:timestamp_type, :timestamptz)
+      end
+
+      def quoted_name
+        @quoted_name ||= db.send(:quote_schema_table, name)
+      end
+
+      def event_prefix
+        @event_prefix ||= opts.fetch(:event_prefix, table)
+      end
+
+      def created_column
+        @created_column ||= opts.fetch(:created_column, :created)
+      end
+
+      def updated_column
+        @updated_column ||= opts.fetch(:updated_column, :updated)
+      end
+
+      def completed_column
+        @completed_column ||= opts.fetch(:completed_column, :completed)
+      end
+
+      def attempts_column
+        @attempts_column ||= opts.fetch(:attempts_column, :attempts)
+      end
+
+      def attempted_column
+        @attempted_column ||= opts.fetch(:attempted_column, :attempted)
+      end
+
+      def event_type_column
+        @event_type_column ||= opts.fetch(:event_type_column, :event_type)
+      end
+
+      def last_error_column
+        @last_error_column ||= opts.fetch(:last_error_column, :last_error)
+      end
+
+      def data_after_column
+        @data_after_column ||= opts.fetch(:data_after_column, :data_after)
+      end
+
+      def data_before_column
+        @data_before_column ||= opts.fetch(:data_before_column, :data_before)
+      end
+
+      def metadata_column
+        @metadata_column ||= opts.fetch(:metadata_column, :metadata)
+      end
+
+      def boolean_completed_column
+        @boolean_completed_column ||= opts.fetch(:boolean_completed_column, false)
+      end
+
+      def uuid_primary_key?
+        @uuid_primary_key ||= opts.fetch(:uuid_primary_key, false)
+      end
+
+      def uuid_function
+        @uuid_function ||= opts.fetch(:uuid_function, :uuid_generate_v4)
+      end
+
+      def function
+        @function ||= Function.create!(self, opts:)
+      end
+
+      private
+
+      def create_table!
+        uuid_primary_key = uuid_primary_key?
+        uuid_func = uuid_function
+        db.create_table(name) do
+          if uuid_primary_key
+            uuid :id, default: Sequel.function(uuid_func), primary_key: true
+          else
+            primary_key :id
+          end
+        end
+      end
+
+      def completed_column!
+        if boolean_completed_column
+          db.add_column name, completed_column, FalseClass, null: false, default: false
+        else
+          db.add_column name, completed_column, timestamp_type
+        end
+        self
+      end
+
+      def integer_columns!
+        db.add_column name, attempts_column, Integer, null: false, default: 0
+        self
+      end
+
+      def timestamp_columns!
+        db.add_column name, created_column, timestamp_type
+        db.add_column name, updated_column, timestamp_type
+        db.add_column name, attempted_column, timestamp_type
+        self
+      end
+
+      def string_columns!
+        db.add_column name, event_type_column, String, null: false
+        db.add_column name, last_error_column, String
+        self
+      end
+
+      def jsonb_columns!
+        db.add_column name, data_before_column, :jsonb
+        db.add_column name, data_after_column, :jsonb
+        db.add_column name, metadata_column, :jsonb
+        self
+      end
+
+      def indexes!
+        db.add_index name, Sequel.asc(created_column)
+        db.add_index name, Sequel.desc(attempted_column)
+        self
+      end
+    end
+  end
+end

data/lib/sequel/pgt_outbox/trigger.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require_relative '../pgt_outbox'
+
+module Rubyists
+  module PgtOutbox
+    # The Outbox Trigger
+    class Trigger
+      DEFAULT_OPTS = { after: true, each_row: true }.freeze
+
+      attr_reader(*%i[db table function events opts])
+
+      def self.create!(db, table, function, events: %i[insert update delete], opts: { when: nil })
+        new(db, table, function, events: events, opts: opts).create!
+      end
+
+      def initialize(db, table, function, events: %i[insert update delete], opts: { when: nil })
+        @db = db
+        @table = table
+        @function = function
+        @events = events
+        @opts = opts
+      end
+
+      def name
+        @name ||= opts.fetch(:trigger_name, function)
+      end
+
+      def create!
+        db.create_trigger(table, name, function, events:, each_row:, after:, when: where)
+        self
+      end
+
+      def after
+        trigger_opts.fetch(:after)
+      end
+
+      def where
+        opts.fetch(:when, nil)
+      end
+
+      def each_row
+        trigger_opts.fetch(:each_row)
+      end
+
+      def trigger_opts
+        @trigger_opts ||= DEFAULT_OPTS.merge(opts.fetch(:trigger_opts, {}))
+      end
+    end
+  end
+end

data/lib/sequel/pgt_outbox/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Rubyists
+  module PgtOutbox
+    # x-release-please-start-version
+    VERSION = '0.2.0'
+    # x-release-please-end
+  end
+end