nulogy_message_bus_producer 3.4.1 → 3.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b40c306c32ccf50c2bf5b8cf87edc9335b3339bef8aa35d667608fdc99ded0e3
-  data.tar.gz: fd1f7a1e0b65e3246976d0ff8ae54c18c6ad2f9ec1bdd05c5d1546b5137906d5
+  metadata.gz: c697390ae3e8ef5704c9cec7f698efc708143254ee61a434a3954c63bb761a4e
+  data.tar.gz: c9d6cf6b80814090796993e3e82aab04405412fe41d56aa49fd00c54b8a50ffd
 SHA512:
-  metadata.gz: df2553a5bf95a76e169265147ee6955dd29902b84d4d10d180ae6ac99c835e950c3c3afd82bbfa9ed1687788239a1fc785240a2c87c3f055dd90be73a8556c9b
-  data.tar.gz: b6b96134a28963e8cacb83237703ce7adbf8ebd2e35af29bc63cf4b9f95b6a949646f6fa44899bd2129dce18b0448547034d84ffe5209665e0732f116a006c07
+  metadata.gz: 9f02675c37b6668344f704163531cd46e83aacd3a0e6d2ee6dee85b76182b0b0852f23e0954baac10ae978901b619399776ac38326b39c74b2f4540c59a2fdc3
+  data.tar.gz: 848f437d8e1dffc475648ff89a684b109a30457ae85f012ffefc98b6643087de3d6b2e6668281bcab83e2de4b8ac2662742825d990866c5c3916b9a38d93b649

data/README.md

@@ -8,6 +8,7 @@ This engine contains the classes and validations for producing messages to the M
 
 1. Add the gem to your Gemfile: `gem "nulogy_message_bus_producer"`
 2. Install the migrations: `rake railties:install:migrations`
+3. Use the [Nulogy GraphQL API](https://github.com/nulogy/nulogy_graphql_api)'s schema specs to [ensure schema changes are safe](https://github.com/nulogy/nulogy_graphql_api#schema-generation)
 
 ## Usage
 
@@ -24,28 +25,7 @@ Debezium then reads this table from the PG replication log and pushes them into
 
 There are two ways to create subscriptions:
 
-#### Self-Serve (deprecated)
-
-You create these subscriptions via the public GraphQL API. e.g.
-
-```graphql
-subscription {
-  workOrderUpdated(subscriptionId: "uuid", subscriptionGroupId: "uuid", topicName: "some-topic") {
-    workOrder {
-      id
-      code
-    }
-  }
-}
-```
-
-These subscriptions are written to the `NulogyMessageBusProducer.subscriptions_table_name` table.
-
-This style of subscriptions may be removed in a future release.
-
-There is a [guide to migrate from Self-Serve to Configured](docs/self_serve_to_configured_subscriptions.md)
-
-#### Configured (new)
+#### Configured
 
 Subscriptions provided by configuration in the producer app:
 
@@ -68,6 +48,28 @@ NulogyMessageBusProducer.configure do |c|
 end
 ```
 
+#### Self-Serve (soft-deprecated)
+
+You create these subscriptions via the public GraphQL API. For testing, the [Insomnia](https://insomnia.rest/) client
+is highly recommended.
+
+```graphql
+subscription {
+  workOrderUpdated(subscriptionId: "uuid", subscriptionGroupId: "uuid", topicName: "some-topic") {
+    workOrder {
+      id
+      code
+    }
+  }
+}
+```
+
+These subscriptions are written to the `NulogyMessageBusProducer.subscriptions_table_name` table.
+
+This style of subscriptions may be removed in a future release.
+
+There is a [guide to migrate from Self-Serve to Configured](docs/self_serve_to_configured_subscriptions.md)
+
 ## Configuration
 
 | Configuration                  | Default                           | Description                                                                                        |
@@ -285,4 +287,4 @@ You must be listed as a gem owner [on rubygems](https://rubygems.org/gems/nulogy
   * Update `lib/nulogy_message_bus_producer/version.rb`
   * Run `bundle install`
   * Update the CHANGELOG
-* Run `rake release`
+* Run `bundle exec rake release`

data/lib/nulogy_message_bus_producer.rb

@@ -1,4 +1,5 @@
 require "graphql"
+require "pp"
 
 require "nulogy_message_bus_producer/config"
 require "nulogy_message_bus_producer/configuration/query_parser"

data/lib/nulogy_message_bus_producer/subscriptions/postgres_transport.rb

@@ -12,9 +12,9 @@ module NulogyMessageBusProducer
     #
     # NulogyMessageBusProducer.register_schema("some_schema", "SomeSchema")
     class PostgresTransport < GraphQL::Subscriptions
-      def initialize(options = {})
+      def initialize(schema:, **_rest)
         super
-        @schema_key = NulogyMessageBusProducer.resolve_schema_key(options.fetch(:schema))
+        @schema_key = NulogyMessageBusProducer.resolve_schema_key(schema)
       end
 
       def each_subscription_id(event)

data/lib/nulogy_message_bus_producer/version.rb

@@ -1,3 +1,3 @@
 module NulogyMessageBusProducer
-  VERSION = "3.4.1".freeze
+  VERSION = "3.5.0".freeze
 end

data/spec/dummy/bin/setup

@@ -1,33 +1,32 @@
 #!/usr/bin/env ruby
-require "pathname"
 require "fileutils"
-include FileUtils # rubocop:disable Style/MixinUsage
 
 # path to your application root.
-APP_ROOT = Pathname.new File.expand_path("../../", __FILE__)
+APP_ROOT = File.expand_path("..", __dir__)
 
 def system!(*args)
   system(*args) || abort("\n== Command #{args} failed ==")
 end
 
-chdir APP_ROOT do
-  # This script is a starting point to setup your application.
+FileUtils.chdir APP_ROOT do
+  # This script is a way to set up or update your development environment automatically.
+  # This script is idempotent, so that you can run it at any time and get an expectable outcome.
   # Add necessary setup steps to this file.
 
   puts "== Installing dependencies =="
   system! "gem install bundler --conservative"
   system("bundle check") || system!("bundle install")
 
-  # Install JavaScript dependencies if using Yarn
-  # system('bin/yarn')
+  # Install JavaScript dependencies
+  system! "bin/yarn"
 
   # puts "\n== Copying sample files =="
   # unless File.exist?('config/database.yml')
-  #   cp 'config/database.yml.sample', 'config/database.yml'
+  #   FileUtils.cp 'config/database.yml.sample', 'config/database.yml'
   # end
 
   puts "\n== Preparing database =="
-  system! "bin/rails db:setup"
+  system! "bin/rails db:prepare"
 
   puts "\n== Removing old logs and tempfiles =="
   system! "bin/rails log:clear tmp:clear"

data/spec/dummy/bin/yarn

@@ -1,9 +1,17 @@
 #!/usr/bin/env ruby
-VENDOR_PATH = File.expand_path("..", __dir__)
-Dir.chdir(VENDOR_PATH) do
-  exec "yarnpkg #{ARGV.join(" ")}"
-rescue Errno::ENOENT
-  warn "Yarn executable was not detected in the system."
-  warn "Download Yarn at https://yarnpkg.com/en/docs/install"
-  exit 1
+APP_ROOT = File.expand_path("..", __dir__)
+Dir.chdir(APP_ROOT) do
+  yarn = ENV["PATH"].split(File::PATH_SEPARATOR)
+    .select { |dir| File.expand_path(dir) != __dir__ }
+    .product(["yarn", "yarn.cmd", "yarn.ps1"])
+    .map { |dir, file| File.expand_path(file, dir) }
+    .find { |file| File.executable?(file) }
+
+  if yarn
+    exec yarn, *ARGV
+  else
+    warn "Yarn executable was not detected in the system."
+    warn "Download Yarn at https://yarnpkg.com/en/docs/install"
+    exit 1
+  end
 end

data/spec/dummy/config.ru

@@ -3,3 +3,4 @@
 require_relative "config/environment"
 
 run Rails.application
+Rails.application.load_server

data/spec/dummy/config/application.rb

@@ -1,22 +1,27 @@
 require_relative "boot"
 
 require "rails/all"
+require "nulogy_message_bus_producer"
 
+# Require the gems listed in Gemfile, including any gems
+# you've limited to :test, :development, or :production.
 Bundler.require(*Rails.groups)
-require "nulogy_message_bus_producer"
 
 module Dummy
   class Application < Rails::Application
     # Initialize configuration defaults for originally generated Rails version.
     config.load_defaults 5.1
 
-    # Settings in config/environments/* take precedence over those specified here.
-    # Application configuration should go into files in config/initializers
-    # -- all .rb files in that directory are automatically loaded.
-    config.assets.initialize_on_precompile = false
+    # Configuration for the application, engines, and railties goes here.
+    #
+    # These settings can be overridden in specific environments using the files
+    # in config/environments, which are processed later.
+    #
+    # config.time_zone = "Central Time (US & Canada)"
+    # config.eager_load_paths << Rails.root.join("extras")
 
     config.autoload_paths += %W[
-      #{config.root}/lib
+      "#{config.root}/lib"
     ]
   end
 end

data/spec/dummy/config/boot.rb

@@ -1,5 +1,3 @@
-# Set up gems listed in the Gemfile.
-ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../../Gemfile", __dir__)
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
 
-require "bundler/setup" if File.exist?(ENV["BUNDLE_GEMFILE"])
-$LOAD_PATH.unshift File.expand_path("../../../lib", __dir__)
+require "bundler/setup" # Set up gems listed in the Gemfile.

data/spec/dummy/config/cable.yml

@@ -2,9 +2,9 @@ development:
   adapter: async
 
 test:
-  adapter: async
+  adapter: test
 
 production:
   adapter: redis
-  url: redis://localhost:6379/1
+  url: <%= ENV.fetch("REDIS_URL") { "redis://localhost:6379/1" } %>
   channel_prefix: dummy_production

data/spec/dummy/config/environments/development.rb

@@ -1,8 +1,10 @@
+require "active_support/core_ext/integer/time"
+
 Rails.application.configure do
   # Settings specified here will take precedence over those in config/application.rb.
 
-  # In the development environment your application's code is reloaded on
-  # every request. This slows down response time but is perfect for development
+  # In the development environment your application's code is reloaded any time
+  # it changes. This slows down response time but is perfect for development
   # since you don't have to restart the web server when you make code changes.
   config.cache_classes = false
 
@@ -13,12 +15,14 @@ Rails.application.configure do
   config.consider_all_requests_local = true
 
   # Enable/disable caching. By default caching is disabled.
-  if Rails.root.join("tmp/caching-dev.txt").exist?
+  # Run rails dev:cache to toggle caching.
+  if Rails.root.join("tmp", "caching-dev.txt").exist?
     config.action_controller.perform_caching = true
+    config.action_controller.enable_fragment_cache_logging = true
 
     config.cache_store = :memory_store
     config.public_file_server.headers = {
-      "Cache-Control" => "public, max-age=#{2.days.seconds.to_i}"
+      "Cache-Control" => "public, max-age=#{2.days.to_i}"
     }
   else
     config.action_controller.perform_caching = false
@@ -26,6 +30,9 @@ Rails.application.configure do
     config.cache_store = :null_store
   end
 
+  # Store uploaded files on the local file system (see config/storage.yml for options).
+  config.active_storage.service = :local
+
   # Don't care if the mailer can't send.
   config.action_mailer.raise_delivery_errors = false
 
@@ -34,9 +41,18 @@ Rails.application.configure do
   # Print deprecation notices to the Rails logger.
   config.active_support.deprecation = :log
 
+  # Raise exceptions for disallowed deprecations.
+  config.active_support.disallowed_deprecation = :raise
+
+  # Tell Active Support which deprecation messages to disallow.
+  config.active_support.disallowed_deprecation_warnings = []
+
   # Raise an error on page load if there are pending migrations.
   config.active_record.migration_error = :page_load
 
+  # Highlight code that triggered database queries in logs.
+  config.active_record.verbose_query_logs = true
+
   # Debug mode disables concatenation and preprocessing of assets.
   # This option may cause significant delays in view rendering with a large
   # number of complex assets.
@@ -45,10 +61,16 @@ Rails.application.configure do
   # Suppress logger output for asset requests.
   config.assets.quiet = true
 
-  # Raises error for missing translations
-  # config.action_view.raise_on_missing_translations = true
+  # Raises error for missing translations.
+  # config.i18n.raise_on_missing_translations = true
+
+  # Annotate rendered view with file names.
+  # config.action_view.annotate_rendered_view_with_filenames = true
 
   # Use an evented file watcher to asynchronously detect changes in source code,
   # routes, locales, etc. This feature depends on the listen gem.
-  # config.file_watcher = ActiveSupport::EventedFileUpdateChecker
+  config.file_watcher = ActiveSupport::EventedFileUpdateChecker
+
+  # Uncomment if you wish to allow Action Cable access from any origin.
+  # config.action_cable.disable_request_forgery_protection = true
 end

data/spec/dummy/config/environments/production.rb

@@ -1,3 +1,5 @@
+require "active_support/core_ext/integer/time"
+
 Rails.application.configure do
   # Settings specified here will take precedence over those in config/application.rb.
 
@@ -14,32 +16,32 @@ Rails.application.configure do
   config.consider_all_requests_local = false
   config.action_controller.perform_caching = true
 
-  # Attempt to read encrypted secrets from `config/secrets.yml.enc`.
-  # Requires an encryption key in `ENV["RAILS_MASTER_KEY"]` or
-  # `config/secrets.yml.key`.
+  # Ensures that a master key has been made available in either ENV["RAILS_MASTER_KEY"]
+  # or in config/master.key. This key is used to decrypt credentials (and other encrypted files).
+  # config.require_master_key = true
   config.read_encrypted_secrets = false
 
   # Disable serving static files from the `/public` folder by default since
   # Apache or NGINX already handles this.
   config.public_file_server.enabled = ENV["RAILS_SERVE_STATIC_FILES"].present?
 
-  # Compress JavaScripts and CSS.
-  config.assets.js_compressor = :uglifier
+  # Compress CSS using a preprocessor.
   # config.assets.css_compressor = :sass
 
   # Do not fallback to assets pipeline if a precompiled asset is missed.
   config.assets.compile = false
 
-  # `config.assets.precompile` and `config.assets.version` have moved to config/initializers/assets.rb
-
   # Enable serving of images, stylesheets, and JavaScripts from an asset server.
-  # config.action_controller.asset_host = 'http://assets.example.com'
+  # config.asset_host = 'http://assets.example.com'
 
   # Specifies the header that your server uses for sending files.
   # config.action_dispatch.x_sendfile_header = 'X-Sendfile' # for Apache
   # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for NGINX
 
-  # Mount Action Cable outside main process or domain
+  # Store uploaded files on the local file system (see config/storage.yml for options).
+  config.active_storage.service = :local
+
+  # Mount Action Cable outside main process or domain.
   # config.action_cable.mount_path = nil
   # config.action_cable.url = 'wss://example.com/cable'
   # config.action_cable.allowed_request_origins = [ 'http://example.com', /http:\/\/example.*/ ]
@@ -47,9 +49,9 @@ Rails.application.configure do
   # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
   # config.force_ssl = true
 
-  # Use the lowest log level to ensure availability of diagnostic information
-  # when problems arise.
-  config.log_level = :debug
+  # Include generic and useful information about system operation, but avoid logging too much
+  # information to avoid inadvertent exposure of personally identifiable information (PII).
+  config.log_level = :info
 
   # Prepend all log lines with the following tags.
   config.log_tags = [:request_id]
@@ -57,9 +59,10 @@ Rails.application.configure do
   # Use a different cache store in production.
   # config.cache_store = :mem_cache_store
 
-  # Use a real queuing backend for Active Job (and separate queues per environment)
+  # Use a real queuing backend for Active Job (and separate queues per environment).
   # config.active_job.queue_adapter     = :resque
-  # config.active_job.queue_name_prefix = "dummy_#{Rails.env}"
+  # config.active_job.queue_name_prefix = "dummy_production"
+
   config.action_mailer.perform_caching = false
 
   # Ignore bad email addresses and do not raise email delivery errors.
@@ -73,11 +76,17 @@ Rails.application.configure do
   # Send deprecation notices to registered listeners.
   config.active_support.deprecation = :notify
 
+  # Log disallowed deprecations.
+  config.active_support.disallowed_deprecation = :log
+
+  # Tell Active Support which deprecation messages to disallow.
+  config.active_support.disallowed_deprecation_warnings = []
+
   # Use default logging formatter so that PID and timestamp are not suppressed.
   config.log_formatter = ::Logger::Formatter.new
 
   # Use a different logger for distributed setups.
-  # require 'syslog/logger'
+  # require "syslog/logger"
   # config.logger = ActiveSupport::TaggedLogging.new(Syslog::Logger.new 'app-name')
 
   if ENV["RAILS_LOG_TO_STDOUT"].present?
@@ -88,4 +97,25 @@ Rails.application.configure do
 
   # Do not dump schema after migrations.
   config.active_record.dump_schema_after_migration = false
+
+  # Inserts middleware to perform automatic connection switching.
+  # The `database_selector` hash is used to pass options to the DatabaseSelector
+  # middleware. The `delay` is used to determine how long to wait after a write
+  # to send a subsequent read to the primary.
+  #
+  # The `database_resolver` class is used by the middleware to determine which
+  # database is appropriate to use based on the time delay.
+  #
+  # The `database_resolver_context` class is used by the middleware to set
+  # timestamps for the last write to the primary. The resolver uses the context
+  # class timestamps to determine how long to wait before reading from the
+  # replica.
+  #
+  # By default Rails will store a last write timestamp in the session. The
+  # DatabaseSelector middleware is designed as such you can define your own
+  # strategy for connection switching and pass that into the middleware through
+  # these configuration options.
+  # config.active_record.database_selector = { delay: 2.seconds }
+  # config.active_record.database_resolver = ActiveRecord::Middleware::DatabaseSelector::Resolver
+  # config.active_record.database_resolver_context = ActiveRecord::Middleware::DatabaseSelector::Resolver::Session
 end

data/spec/dummy/config/environments/test.rb

@@ -1,10 +1,13 @@
+require "active_support/core_ext/integer/time"
+
+# The test environment is used exclusively to run your application's
+# test suite. You never need to work with it otherwise. Remember that
+# your test database is "scratch space" for the test suite and is wiped
+# and recreated between test runs. Don't rely on the data there!
+
 Rails.application.configure do
   # Settings specified here will take precedence over those in config/application.rb.
 
-  # The test environment is used exclusively to run your application's
-  # test suite. You never need to work with it otherwise. Remember that
-  # your test database is "scratch space" for the test suite and is wiped
-  # and recreated between test runs. Don't rely on the data there!
   config.cache_classes = true
 
   # Do not eager load code on boot. This avoids loading your whole application
@@ -15,18 +18,23 @@ Rails.application.configure do
   # Configure public file server for tests with Cache-Control for performance.
   config.public_file_server.enabled = true
   config.public_file_server.headers = {
-    "Cache-Control" => "public, max-age=#{1.hour.seconds.to_i}"
+    "Cache-Control" => "public, max-age=#{1.hour.to_i}"
   }
 
   # Show full error reports and disable caching.
   config.consider_all_requests_local = true
   config.action_controller.perform_caching = false
+  config.cache_store = :null_store
 
   # Raise exceptions instead of rendering exception templates.
   config.action_dispatch.show_exceptions = false
 
   # Disable request forgery protection in test environment.
   config.action_controller.allow_forgery_protection = false
+
+  # Store uploaded files on the local file system in a temporary directory.
+  config.active_storage.service = :test
+
   config.action_mailer.perform_caching = false
 
   # Tell Action Mailer not to deliver emails to the real world.
@@ -37,6 +45,15 @@ Rails.application.configure do
   # Print deprecation notices to the stderr.
   config.active_support.deprecation = :stderr
 
-  # Raises error for missing translations
-  # config.action_view.raise_on_missing_translations = true
+  # Raise exceptions for disallowed deprecations.
+  config.active_support.disallowed_deprecation = :raise
+
+  # Tell Active Support which deprecation messages to disallow.
+  config.active_support.disallowed_deprecation_warnings = []
+
+  # Raises error for missing translations.
+  # config.i18n.raise_on_missing_translations = true
+
+  # Annotate rendered view with file names.
+  # config.action_view.annotate_rendered_view_with_filenames = true
 end