nulogy_message_bus_producer 3.2.0 → 4.0.0.alpha

data/spec/integration/lib/nulogy_message_bus_producer/{subscriber_graphql_schema_validator_spec.rb → subscriptions/query_validator_spec.rb}

@@ -1,12 +1,12 @@
 require "integration_spec_helper"
 
-RSpec.describe NulogyMessageBusProducer::SubscriberGraphqlSchemaValidator do
-  subject(:validator) { NulogyMessageBusProducer::SubscriberGraphqlSchemaValidator.new }
+RSpec.describe NulogyMessageBusProducer::Subscriptions::QueryValidator do
+  subject(:validator) { described_class.new }
 
   describe "#validate" do
     context "when a valid query is present" do
       it "return true" do
-        subscribe_to(query: <<~GRAPHQL)
+        self_serve_subscription(query: <<~GRAPHQL)
           foo {
             id
           }
@@ -18,13 +18,13 @@ RSpec.describe NulogyMessageBusProducer::SubscriberGraphqlSchemaValidator do
 
     context "when an invalid query is present" do
       let(:subscription_with_error) do
-        subscription = subscribe_to(query: <<~GRAPHQL)
+        subscription = self_serve_subscription(query: <<~GRAPHQL)
           foo {
             id
           }
         GRAPHQL
 
-        subscription.query.gsub!(/\bid\b/, 'a_field_that_does_not_exist')
+        subscription.query.gsub!(/\bid\b/, "a_field_that_does_not_exist")
         subscription.save(validate: false)
         subscription
       end

data/spec/integration/lib/nulogy_message_bus_producer/subscriptions/risky_subscription_blocker_spec.rb

@@ -17,24 +17,8 @@ RSpec.describe NulogyMessageBusProducer::Subscriptions::RiskySubscriptionBlocker
     )
   end
 
-  it "blocks subscriptions which would expand lists" do
-    query = <<~GRAPHQL
-      fooList {
-        id
-      }
-    GRAPHQL
-
-    result = attempt_subscription(query)
-
-    expect(result).to include_json(
-      errors: [{
-        message: "Lists may not be queried:\nfooList"
-      }]
-    )
-  end
-
   def attempt_subscription(query)
-    gql = <<~GRAPHQL
+    execute_graphql(<<~GRAPHQL, NulogyMessageBusProducer::Specs::TestSchema)
       subscription {
         testCreated (
           subscriptionId: "#{SecureRandom.uuid}",
@@ -45,7 +29,5 @@ RSpec.describe NulogyMessageBusProducer::Subscriptions::RiskySubscriptionBlocker
         }
       }
     GRAPHQL
-
-    execute_graphql(gql, NulogyMessageBusProducer::Specs::TestSchema)
   end
 end

data/spec/integration/lib/nulogy_message_bus_producer_spec.rb

@@ -0,0 +1,25 @@
+require "integration_spec_helper"
+
+RSpec.describe NulogyMessageBusProducer do
+  describe "publishing events" do
+    it "publishes an event" do
+      company_uuid = SecureRandom.uuid
+
+      described_class.publish(
+        topic: "some-topic",
+        type: "some-type",
+        company_uuid: company_uuid,
+        data: {
+          field: "value"
+        }
+      )
+
+      message = NulogyMessageBusProducer::SubscriptionEvent.last
+
+      expect(message).to be_present
+      expect(message.topic_name).to eq("some-topic")
+      expect(message.company_uuid).to eq(company_uuid)
+      expect(message.event_json).to eq({"field" => "value"})
+    end
+  end
+end

data/spec/integration_spec_helper.rb

@@ -1,6 +1,3 @@
-# Make all rspec configuration changes to this file.
-# Leave automatically generated configuration files untouched to facilitate gem upgrades.
-
 ENV["RAILS_ENV"] ||= "test"
 
 require File.expand_path("dummy/config/environment.rb", __dir__)
@@ -10,8 +7,6 @@ require "rspec/json_expectations"
 require "active_record"
 require "spec_helper"
 
-Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].sort.each { |f| require f }
-
 RSpec.configure do |config|
   # Uncomment this line to see full backtraces for spec failures
   # config.backtrace_exclusion_patterns = []
@@ -37,5 +32,4 @@ RSpec.configure do |config|
 
   config.include(SpecUtils)
   config.include(SqlHelpers)
-  config.include(SubscriptionHelpers)
 end

data/spec/nulogy_message_bus_producer/configuration/query_parser_spec.rb

@@ -0,0 +1,58 @@
+require "spec_helper"
+
+module NulogyMessageBusProducer
+  module Configuration
+    RSpec.describe QueryParser do
+      it "parses queries" do
+        query = <<~QUERY
+          subscription {
+            testCreated(subscriptionId: "abc", subscriptionGroupId: "123", topicName: "test-topic") {
+              foo {
+                id
+              }
+            }
+          }
+        QUERY
+
+        qp = QueryParser.new(query)
+
+        expect(qp.subscription_id).to eq("abc")
+        expect(qp.subscription_group_id).to eq("123")
+        expect(qp.event_type).to eq("testCreated")
+        expect(qp.topic).to eq("test-topic")
+      end
+
+      context "when query is invalid" do
+        it "raises errors for event type" do
+          query = <<~QUERY
+            testCreated(subscriptionId: "abc", subscriptionGroupId: "123", topicName: "test-topic") {
+              foo {
+                id
+              }
+            }
+          QUERY
+
+          qp = QueryParser.new(query)
+
+          expect { qp.event_type }.to raise_error QueryParser::ParseError, /Error extracting event type/
+        end
+
+        it "raises errors for topic" do
+          query = <<~QUERY
+            subscription {
+              testCreated(subscriptionId: "abc", subscriptionGroupId: "123") {
+                foo {
+                  id
+                }
+              }
+            }
+          QUERY
+
+          qp = QueryParser.new(query)
+
+          expect { qp.topic }.to raise_error QueryParser::ParseError, /Error extracting topic/
+        end
+      end
+    end
+  end
+end

data/spec/nulogy_message_bus_producer/subscriptions/subscription_spec.rb

@@ -0,0 +1,9 @@
+require "spec_helper"
+
+module NulogyMessageBusProducer
+  module Subscriptions
+    RSpec.describe ConfiguredSubscription do
+      include_examples "subscription validations"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,4 +1,8 @@
-# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+require "rails/all"
+require "nulogy_message_bus_producer"
+
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].sort.each { |f| require f }
+
 RSpec.configure do |config|
   config.expect_with(:rspec) do |expectations|
     # This is generally recommended, and will default to `true` in RSpec 4.
@@ -32,4 +36,24 @@ RSpec.configure do |config|
   # test failures related to randomization by passing the same `--seed` value
   # as the one that triggered the failure.
   Kernel.srand(config.seed)
+
+  config.around do |example|
+    if example.metadata[:subscriptions]
+      old_config = NulogyMessageBusProducer.config
+
+      NulogyMessageBusProducer.config = NulogyMessageBusProducer::Config.new
+      NulogyMessageBusProducer.config.register_schema(
+        schema: "NulogyMessageBusProducer::Specs::TestSchema",
+        key: "test"
+      )
+
+      example.run
+
+      NulogyMessageBusProducer.config = old_config
+    else
+      example.run
+    end
+  end
+
+  config.include(SubscriptionHelpers)
 end

data/spec/support/kafka.rb

@@ -24,7 +24,7 @@ module Kafka
   end
 
   def test_bootstrap_servers
-    "localhost:9092"
+    "kafka:29093"
   end
 
   def setup_kafka_producer
@@ -33,6 +33,8 @@ module Kafka
 
   def setup_kafka_consumer(topic_name)
     consumer = kafka_config.consumer
+    puts "Subscribing to #{topic_name}"
+    sleep 10
     consumer.subscribe(topic_name)
     wait_for_assignment(consumer)
     consumer
@@ -44,11 +46,9 @@ module Kafka
     loop do
       message = consumer.poll(timeout)
 
-      if message
-        messages << message
-      else
-        return messages
-      end
+      return messages unless message
+
+      messages << message
     end
   end
 
@@ -62,15 +62,21 @@ module Kafka
   end
 
   def create_topic(topic_name)
-    run("docker-compose exec -T kafka kafka-topics --zookeeper zookeeper:2181 --create --replication-factor 1 --partitions 3 --if-not-exists --topic #{topic_name}")
+    cmd = [
+      "kaf topic create #{topic_name}",
+      "--brokers kafka:29093",
+      "--replicas 1",
+      "--partitions 3"
+    ]
+    run(cmd.join(" "))
   end
 
   def delete_topic(topic_name)
-    run("docker-compose exec -T kafka kafka-topics --zookeeper zookeeper:2181 --delete --topic #{topic_name}")
+    run("kaf topic delete #{topic_name} --brokers kafka:29093")
   end
 
   def list_topics
-    topics = run("docker-compose exec -T kafka kafka-topics --zookeeper zookeeper:2181 --list")
+    topics = run("kaf topics --brokers kafka:29093")
     topics.split(" ")
   end
 

data/spec/support/kafka_connect.rb

@@ -28,4 +28,4 @@ class KafkaConnect
     response = @http.request(request)
     JSON.parse(response.body, symbolize_names: true)
   end
-end
+end

data/spec/support/shared_examples/subscription_validations.rb

@@ -0,0 +1,77 @@
+RSpec.shared_examples "subscription validations" do
+  context "when validating" do
+    it "is invalid without an id" do
+      model = build_subscription(id: "")
+
+      model.validate
+
+      expect(model.errors[:id]).to contain_exactly("can't be blank")
+    end
+
+    it "is invalid without a subscription_group_id" do
+      model = build_subscription(subscription_group_id: "")
+
+      model.validate
+
+      expect(model.errors[:subscription_group_id]).to contain_exactly("can't be blank")
+    end
+
+    it "is invalid with a blank query" do
+      model = build_subscription(query: "")
+
+      model.validate
+
+      expect(model.errors[:query]).to contain_exactly("can't be blank")
+    end
+
+    it "is invalid with blank schema_key" do
+      model = build_subscription(schema_key: "")
+
+      model.validate
+
+      expect(model.errors[:schema_key]).to contain_exactly("can't be blank")
+    end
+
+    it "is invalid with an invalid schema_key" do
+      model = build_subscription(schema_key: "invalid")
+
+      model.validate
+
+      expect(model.errors[:query]).to contain_exactly(/Could not find a schema for schema_key 'invalid'/)
+    end
+
+    it "is invalid with an invalid query" do
+      model = build_subscription(
+        query: subscription_query(query: "foo { a_field_that_does_not_exist }")
+      )
+
+      model.validate
+
+      expect(model).not_to be_valid
+      expect(model.errors[:query]).to contain_exactly(
+        match(/Field 'a_field_that_does_not_exist' doesn't exist on type 'testObject'/)
+      )
+    end
+
+    it "valid with a valid query" do
+      model = build_subscription(
+        query: subscription_query(query: "foo { id }")
+      )
+
+      model.validate
+
+      expect(model.errors).not_to include(:query)
+    end
+  end
+
+  def build_subscription(overrides = {})
+    attrs = {
+      id: SecureRandom.uuid,
+      subscription_group_id: SecureRandom.uuid,
+      schema_key: "test",
+      query: subscription_query
+    }.merge(overrides)
+
+    described_class.new(attrs)
+  end
+end

data/spec/support/spec_utils.rb

@@ -4,12 +4,13 @@ module SpecUtils
   def wait_for(attempts: 100, interval: 0.1)
     attempts.times do
       return if yield
+
       sleep interval
     end
     raise "Waited for #{attempts} times but it never resolved"
   end
 
   def uuid(entity_number)
-    sprintf("00000000-0000-0000-0000-%12.12d", entity_number)
+    format("00000000-0000-0000-0000-%<id>12.12d", id: entity_number)
   end
-end
+end

data/spec/support/sql_helpers.rb

@@ -1,11 +1,9 @@
 module SqlHelpers
   def without_transaction
-    begin
-      ActiveRecord::Base.connection.rollback_transaction
-      yield
-    ensure
-      truncate_db
-    end
+    ActiveRecord::Base.connection.rollback_transaction
+    yield
+  ensure
+    truncate_db
   end
 
   def truncate_db
@@ -16,10 +14,10 @@ module SqlHelpers
 
     # Just incase these models weren't loaded, do them explicitly
     ActiveRecord::Base.connection.execute("TRUNCATE #{NulogyMessageBusProducer::SubscriptionEvent.table_name}")
-    ActiveRecord::Base.connection.execute("TRUNCATE #{NulogyMessageBusProducer::Subscription.table_name}")
+    ActiveRecord::Base.connection.execute("TRUNCATE #{NulogyMessageBusProducer::SelfServeSubscription.table_name}")
   end
 
-  def get_replication_slots
+  def replication_slots
     results = ActiveRecord::Base.connection.exec_query(<<~SQL)
       SELECT slot_name FROM pg_replication_slots
     SQL
@@ -35,13 +33,13 @@ module SqlHelpers
 
   def wait_for_replication_slot(slot_name)
     wait_for do
-      get_replication_slots.any? { |replication_slot| replication_slot == slot_name }
+      replication_slots.any? { |replication_slot| replication_slot == slot_name }
     end
   end
 
   def wait_for_replication_slot_cleanup(slot_name)
     wait_for do
-      get_replication_slots.none? { |replication_slot| replication_slot == slot_name }
+      replication_slots.none? { |replication_slot| replication_slot == slot_name }
     end
   end
-end
+end

data/spec/support/subscription_helpers.rb

@@ -1,17 +1,35 @@
 module SubscriptionHelpers
-  def subscribe_to(
+  def self_serve_subscription(
     schema: NulogyMessageBusProducer::Specs::TestSchema,
     subscription_id: SecureRandom.uuid,
     **query_args
   )
     gql = subscription_query(subscription_id: subscription_id, **query_args)
 
-    expect do
+    expect {
       gql_response = execute_graphql(gql, schema)
       expect(gql_response).to eq(data: {})
-    end.to change(NulogyMessageBusProducer::Subscription, :count).by(1)
+    }.to change(NulogyMessageBusProducer::SelfServeSubscription, :count).by(1)
 
-    NulogyMessageBusProducer::Subscription.find(subscription_id)
+    NulogyMessageBusProducer::SelfServeSubscription.find(subscription_id)
+  end
+
+  def configured_subscription(
+    schema: NulogyMessageBusProducer::Specs::TestSchema,
+    subscription_id: SecureRandom.uuid,
+    subscription_group_id: SecureRandom.uuid,
+    **query_args
+  )
+    gql = subscription_query(
+      subscription_id: subscription_id,
+      subscription_group_id: subscription_group_id,
+      **query_args
+    )
+
+    NulogyMessageBusProducer.config.add_subscription!(
+      schema: schema.name,
+      query: gql
+    )
   end
 
   def subscription_query(