nulogy_message_bus_producer 3.2.1 → 3.6.0

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)
@@ -24,7 +24,7 @@ module NulogyMessageBusProducer
       end
 
       def read_subscription(subscription_id)
-        subscription = Subscription.find(subscription_id)
+        subscription = find_subscription(subscription_id)
         context = NulogyMessageBusProducer.context_for_subscription(subscription)
 
         {
@@ -50,7 +50,7 @@ module NulogyMessageBusProducer
 
       def write_subscription(query, events)
         events.each do |event|
-          Subscription.create_or_update(
+          SelfServeSubscription.create_or_update(
             id: event.arguments.fetch(:subscription_id),
             subscription_group_id: event.arguments.fetch(:subscription_group_id),
             event_type: event.name,
@@ -61,15 +61,16 @@ module NulogyMessageBusProducer
         end
       end
 
+      # TODO: how is this invoked?
       def delete_subscription(subscription_id)
-        Subscription.find_by(id: subscription_id).destroy
+        SelfServeSubscription.find_by(id: subscription_id).destroy
       end
 
       private
 
       def create_event(subscription_id, result)
         company_uuid = result.query.context.object[:company_uuid]
-        subscription = Subscription.find_by(id: subscription_id)
+        subscription = find_subscription(subscription_id)
 
         SubscriptionEvent.create_or_update(
           id: SecureRandom.uuid,
@@ -80,6 +81,12 @@ module NulogyMessageBusProducer
           topic_name: subscription.topic_name
         )
       end
+
+      def find_subscription(id)
+        Subscriptions::Finder
+          .new(NulogyMessageBusProducer.config)
+          .find(id)
+      end
     end
   end
 end

data/lib/nulogy_message_bus_producer/subscriptions/query_validator.rb

@@ -0,0 +1,47 @@
+module NulogyMessageBusProducer
+  module Subscriptions
+    # A custom validator that checks that the provided (or all) subscriptions have a query that is valid for its
+    # configured schema. Schemas must be registered with a `schema_key`, that is persisted in the database.
+    # It ties the subscription to a particular schema.
+    #
+    # This validator is run as part of an initializer as a last ditch effort to verify that the stored queries in the
+    # database are valid against the deployed schema, so that when events are generated in the system, they are always
+    # sucessfully created.
+    class QueryValidator
+      attr_reader :errors
+
+      def initialize
+        @errors = []
+      end
+
+      def validate(subscription_or_subscriptions = NulogyMessageBusProducer::SelfServeSubscription.all)
+        Array(subscription_or_subscriptions).each do |subscription|
+          schema = find_schema(subscription)
+          next unless schema
+
+          gql_errors = schema.validate(subscription.query)
+          errors = gql_errors.map { |e| "#{e.message} #{display_id(subscription.id)}" }
+
+          @errors.concat(errors)
+        end
+
+        @errors.empty?
+      end
+
+      private
+
+      def find_schema(subscription)
+        NulogyMessageBusProducer.resolve_schema(subscription.schema_key) do
+          @errors << "Could not find a schema for schema_key '#{subscription.schema_key}' #{display_id(subscription.id)}"
+          nil
+        end
+      end
+
+      def display_id(id)
+        normalized = id.presence || "<new_record>"
+
+        "(id: #{normalized})"
+      end
+    end
+  end
+end

data/lib/nulogy_message_bus_producer/subscriptions/risky_subscription_blocker.rb

@@ -43,11 +43,6 @@ module NulogyMessageBusProducer
           error_messages << "Arguments may not be used:\n#{node_names}"
         end
 
-        if @nodes_are_lists.any?
-          node_names = @nodes_are_lists.map(&:name).join("\n")
-          error_messages << "Lists may not be queried:\n#{node_names}"
-        end
-
         GraphQL::AnalysisError.new(error_messages.join("\n\n")) if error_messages.any?
       end
 

data/lib/nulogy_message_bus_producer/subscriptions/valid_for_schema_validator.rb

@@ -0,0 +1,14 @@
+module NulogyMessageBusProducer
+  module Subscriptions
+    class ValidForSchemaValidator < ActiveModel::EachValidator
+      def validate_each(record, attribute, _value)
+        return if record.schema_key.blank? || record.query.blank?
+
+        validator = NulogyMessageBusProducer::Subscriptions::QueryValidator.new
+
+        validator.validate(record)
+        validator.errors.each { |e| record.errors.add(attribute, e) }
+      end
+    end
+  end
+end

data/lib/nulogy_message_bus_producer/version.rb

@@ -1,3 +1,3 @@
 module NulogyMessageBusProducer
-  VERSION = "3.2.1".freeze
+  VERSION = "3.6.0".freeze
 end

data/spec/dummy/Rakefile

@@ -1,6 +1,6 @@
 # Add your own tasks in files placed in lib/tasks ending in .rake,
 # for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
 
-require_relative 'config/application'
+require_relative "config/application"
 
 Rails.application.load_tasks

data/spec/dummy/app/mailers/application_mailer.rb

@@ -1,4 +1,4 @@
 class ApplicationMailer < ActionMailer::Base
-  default from: 'from@example.com'
-  layout 'mailer'
+  default from: "from@example.com"
+  layout "mailer"
 end

data/spec/dummy/bin/bundle

@@ -1,3 +1,3 @@
 #!/usr/bin/env ruby
-ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
-load Gem.bin_path('bundler', 'bundle')
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile", __FILE__)
+load Gem.bin_path("bundler", "bundle")

data/spec/dummy/bin/rails

@@ -1,4 +1,4 @@
 #!/usr/bin/env ruby
-APP_PATH = File.expand_path('../config/application', __dir__)
-require_relative '../config/boot'
-require 'rails/commands'
+APP_PATH = File.expand_path("../config/application", __dir__)
+require_relative "../config/boot"
+require "rails/commands"

data/spec/dummy/bin/rake

@@ -1,4 +1,4 @@
 #!/usr/bin/env ruby
-require_relative '../config/boot'
-require 'rake'
+require_relative "../config/boot"
+require "rake"
 Rake.application.run

data/spec/dummy/bin/setup

@@ -1,38 +1,36 @@
 #!/usr/bin/env ruby
-require 'pathname'
-require 'fileutils'
-include FileUtils
+require "fileutils"
 
 # 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')
+  puts "== Installing dependencies =="
+  system! "gem install bundler --conservative"
+  system("bundle check") || system!("bundle install")
 
+  # 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'
+  system! "bin/rails log:clear tmp:clear"
 
   puts "\n== Restarting application server =="
-  system! 'bin/rails restart'
+  system! "bin/rails restart"
 end

data/spec/dummy/bin/update

@@ -1,10 +1,10 @@
 #!/usr/bin/env ruby
-require 'pathname'
-require 'fileutils'
-include FileUtils
+require "pathname"
+require "fileutils"
+include FileUtils # rubocop:disable Style/MixinUsage# rubocop:disable Style/MixinUsage
 
 # path to your application root.
-APP_ROOT = Pathname.new File.expand_path('../../', __FILE__)
+APP_ROOT = Pathname.new File.expand_path("../../", __FILE__)
 
 def system!(*args)
   system(*args) || abort("\n== Command #{args} failed ==")
@@ -14,16 +14,16 @@ chdir APP_ROOT do
   # This script is a way to update your development environment automatically.
   # Add necessary update steps to this file.
 
-  puts '== Installing dependencies =='
-  system! 'gem install bundler --conservative'
-  system('bundle check') || system!('bundle install')
+  puts "== Installing dependencies =="
+  system! "gem install bundler --conservative"
+  system("bundle check") || system!("bundle install")
 
   puts "\n== Updating database =="
-  system! 'bin/rails db:migrate'
+  system! "bin/rails db:migrate"
 
   puts "\n== Removing old logs and tempfiles =="
-  system! 'bin/rails log:clear tmp:clear'
+  system! "bin/rails log:clear tmp:clear"
 
   puts "\n== Restarting application server =="
-  system! 'bin/rails restart'
+  system! "bin/rails restart"
 end

data/spec/dummy/bin/yarn

@@ -1,11 +1,17 @@
 #!/usr/bin/env ruby
-VENDOR_PATH = File.expand_path('..', __dir__)
-Dir.chdir(VENDOR_PATH) do
-  begin
-    exec "yarnpkg #{ARGV.join(" ")}"
-  rescue Errno::ENOENT
-    $stderr.puts "Yarn executable was not detected in the system."
-    $stderr.puts "Download Yarn at https://yarnpkg.com/en/docs/install"
+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

@@ -1,5 +1,6 @@
 # This file is used by Rack-based servers to start the application.
 
-require_relative 'config/environment'
+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/database.yml

@@ -5,8 +5,8 @@ defaults: &defaults
   adapter: postgresql
   username: <%= ENV['NULOGY_MESSAGE_BUS_PRODUCER_DATABASE_USER'] || "nulogy" %>
   password: <%= ENV['NULOGY_MESSAGE_BUS_PRODUCER_DATABASE_PASS'] || "Nulogy4Ever" %>
-  host: <%= ENV['PM_DATABASE_HOST'] || "localhost" %>
-  port: 5437
+  host: <%= ENV['DATABASE_HOST'] || "localhost" %>
+  port: 5438
   min_messages: warning
   schema_search_path: "\"$user\", public"
 

data/spec/dummy/config/environment.rb

@@ -1,5 +1,5 @@
 # Load the Rails application.
-require_relative 'application'
+require_relative "application"
 
 # Initialize the Rails application.
 Rails.application.initialize!

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