turbo-train 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 848a9382896a69a3cb1d57a569c0fd2fc3908a3599dc5338cd26acf732ee9992
-  data.tar.gz: 1672959f0bbae5254a6f97904db3322607080ffa7da940f1553732b883d96fcb
+  metadata.gz: d8f44643f00dc3a0c248fd990ffc95631a63bf9df53768ecb8e740a5dda4bc45
+  data.tar.gz: 92d303ac07e6402c9dc9ce4f71dcb9c56345c78980184c59692b7c7508daaf4d
 SHA512:
-  metadata.gz: 245d52890779c61021ac9b5e3877b164e93535dae1211e351dc883c1c024bd429b1ed4f48d09401d204de16cdf971ccaba1b9daea403c43ff38e47dc874039f9
-  data.tar.gz: a66cebab47ba27702446128492dfceac83bc6ae2382bf072547681de7989f9a98c81e2e20482d3d9fa9509c4c5d01a421b443b7349afc734b326bdfe5099327a
+  metadata.gz: 229de6bb9a249571e03daddb1b1288aa9138ddee9a1711538961bce90a6bc02e92ba2b83dd4f0062a78c75bb27cf92202126a40034303c10ae127bb9786eb34d
+  data.tar.gz: f2cd4ebef097ffc2d66fd6ec081537ae57b54c7318c132ed0cf508f26dfe03cdc2b13d3386839c209269062c344f9eb127ff8728593a7b82807db8407cb70dd2

data/app/assets/javascripts/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uscreentv/turbo-train",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "description": "",
   "main": "turbo-train.js",
   "type": "module",

data/app/assets/javascripts/turbo-train.js

@@ -2,7 +2,7 @@ import { Turbo } from "@hotwired/turbo-rails"
 
 export default class TurboTrain extends HTMLElement {
   static get observedAttributes() {
-    return [ 'href', 'session', 'name' ];
+    return [ 'href' ];
   }
 
   constructor() {
@@ -10,7 +10,7 @@ export default class TurboTrain extends HTMLElement {
   }
 
   connectedCallback() {
-    this.eventSource = new EventSource(`${this.href}/mercure?topic=${this.name}&authorization=${this.session}`);
+    this.eventSource = new EventSource(this.href);
     Turbo.connectStreamSource(this.eventSource);
   }
 
@@ -21,14 +21,6 @@ export default class TurboTrain extends HTMLElement {
   get href() {
     return this.getAttribute('href');
   }
-
-  get session() {
-    return this.getAttribute('session');
-  }
-
-  get name() {
-    return this.getAttribute('name');
-  }
 }
 
 if (

data/app/assets/javascripts/turbo-train.min.js

@@ -1 +1 @@
-import{Turbo as e}from"@hotwired/turbo-rails";export default class t extends HTMLElement{static get observedAttributes(){return["href","session","name"]}constructor(){super()}connectedCallback(){this.eventSource=new EventSource(`${this.href}/mercure?topic=${this.name}&authorization=${this.session}`),e.connectStreamSource(this.eventSource)}disconnectedCallback(){e.disconnectStreamSource(this.eventSource)}get href(){return this.getAttribute("href")}get session(){return this.getAttribute("session")}get name(){return this.getAttribute("name")}};"undefined"==typeof window||window.customElements.get("turbo-train-stream-source")||window.customElements.define("turbo-train-stream-source",t);
+import{Turbo as e}from"@hotwired/turbo-rails";export default class t extends HTMLElement{static get observedAttributes(){return["href"]}constructor(){super()}connectedCallback(){this.eventSource=new EventSource(this.href),e.connectStreamSource(this.eventSource)}disconnectedCallback(){e.disconnectStreamSource(this.eventSource)}get href(){return this.getAttribute("href")}};"undefined"==typeof window||window.customElements.get("turbo-train-stream-source")||window.customElements.define("turbo-train-stream-source",t);

data/app/helpers/turbo/train/streams_helper.rb

@@ -1,8 +1,6 @@
 module Turbo::Train::StreamsHelper
   def turbo_train_from(*streamables, **attributes)
-    attributes[:name] = Turbo::Train.signed_stream_name(streamables)
-    attributes[:session] = Turbo::Train.encode({ platform: "web" })
-    attributes[:href] = Turbo::Train.configuration.url
+    attributes[:href] = Turbo::Train.server(attributes[:server]&.to_sym).listen_url(streamables, platform: "web")
     tag.turbo_train_stream_source(**attributes)
   end
 end

data/lib/turbo/train/base_server.rb

@@ -0,0 +1,27 @@
+module Turbo
+  module Train
+    class BaseServer
+      attr_reader :configuration
+
+      def initialize(configuration)
+        @configuration = configuration
+      end
+
+      def publish(topics:, data:)
+        raise NotImplementedError
+      end
+
+      def server_config
+        raise NotImplementedError
+      end
+
+      def publish_url
+        server_config.publish_url
+      end
+
+      def listen_url(topic, **options)
+        server_config.listen_url(topic, **options)
+      end
+    end
+  end
+end

data/lib/turbo/train/broadcasts.rb

@@ -1,5 +1,5 @@
 module Turbo::Train::Broadcasts
-  def broadcast(streamables, content:)
+  def broadcast(streamables, content:, server: nil)
     topics = if streamables.is_a?(Array)
                streamables.map { |s| signed_stream_name(s) }
              else
@@ -11,13 +11,13 @@ module Turbo::Train::Broadcasts
       data: content
     }
 
-    Turbo::Train.server.publish(topics: topics, data: data)
+    Turbo::Train.server(server).publish(topics: topics, data: data)
   end
 
   def broadcast_action_to(*streamables, action:, target: nil, targets: nil, **rendering)
     broadcast(streamables, content: turbo_stream_action_tag(action, target: target, targets: targets, template:
       rendering.delete(:content) || rendering.delete(:html) || (rendering.any? ? render_format(:html, **rendering) : nil)
-    ))
+    ), server: rendering.delete(:server))
   end
 
   def broadcast_render_to(*streamables, **rendering)

data/lib/turbo/train/config.rb

@@ -1,18 +1,74 @@
 module Turbo
   module Train
-    class Configuration
-      attr_accessor :mercure_domain, :publisher_key, :subscriber_key, :skip_ssl_verification
+    class MercureConfiguration
+      attr_accessor :mercure_domain, :publisher_key, :subscriber_key
 
       def initialize
+        super
         @mercure_domain = 'localhost'
         @publisher_key = 'test'
         @subscriber_key = 'testing'
-        @skip_ssl_verification = Rails.env.development? || Rails.env.test?
       end
 
       def url
         "https://#{mercure_domain}/.well-known"
       end
+
+      def publish_url
+        "#{url}/mercure"
+      end
+
+      def listen_url(topic, platform: 'web')
+        "#{url}/mercure?topic=#{Turbo::Train.signed_stream_name(topic)}&authorization=#{jwt_auth_token({ platform: platform })}"
+      end
+
+      def jwt_auth_token(payload)
+        structured_payload = { mercure: { payload: payload } }
+        JWT.encode structured_payload, subscriber_key, ALGORITHM
+      end
+    end
+
+    class FanoutConfiguration
+      attr_accessor :fastly_api_url, :service_url, :fastly_key, :service_id
+
+      def initialize
+        super
+        @fastly_api_url = 'https://api.fastly.com'
+        @service_url = 'https://johnny-cage-fake-url.edgecompute.app'
+        @fastly_key = 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'
+      end
+
+      def publish_url
+        "#{@fastly_api_url}/service/#{@service_id}/publish/"
+      end
+
+      def listen_url(topic, **)
+        "#{service_url}/stream/sse?topic=#{Turbo::Train.signed_stream_name(topic)}"
+      end
+    end
+
+    class Configuration
+      attr_accessor :skip_ssl_verification, :mercure, :fanout, :default_server
+
+      def initialize
+        @skip_ssl_verification = Rails.env.development? || Rails.env.test?
+        @mercure = nil
+        @fanout = nil
+        @default_server = :mercure
+      end
+
+      def server(server_name)
+        case server_name
+        when :mercure
+          @mercure ||= MercureConfiguration.new
+          yield(@mercure)
+        when :fanout
+          @fanout ||= FanoutConfiguration.new
+          yield(@fanout)
+        else
+          raise ArgumentError, "Unknown server name: #{server_name}"
+        end
+      end
     end
 
     class << self

data/lib/turbo/train/fanout_server.rb

@@ -0,0 +1,36 @@
+module Turbo
+  module Train
+    class FanoutServer < BaseServer
+      def publish(topics:, data:)
+        uri = URI(server_config.publish_url)
+        req = Net::HTTP::Post.new(uri)
+        req['Fastly-Key'] = server_config.fastly_key
+
+        message = data[:data].gsub("\n", "")
+        payload = {items: []}
+
+        Array(topics).each do |topic|
+          payload[:items] << {channel: topic, formats: { 'http-stream': { content: "event: message\ndata: #{message}\n\n" } } }
+        end
+
+        req.body = payload.to_json
+
+        opts = {
+          use_ssl: uri.scheme == 'https'
+        }
+
+        if configuration.skip_ssl_verification
+          opts[:verify_mode] = OpenSSL::SSL::VERIFY_NONE
+        end
+
+        Net::HTTP.start(uri.host, uri.port, opts) do |http|
+          http.request(req)
+        end
+      end
+
+      def server_config
+        configuration.fanout
+      end
+    end
+  end
+end

data/lib/turbo/train/{server.rb → mercure_server.rb}

@@ -1,17 +1,11 @@
 module Turbo
   module Train
-    class Server
-      attr_reader :configuration
-
-      def initialize(configuration)
-        @configuration = configuration
-      end
-
+    class MercureServer < BaseServer
       def publish(topics:, data:)
         payload = { mercure: { publish: topics } }
-        token = JWT.encode payload, configuration.publisher_key, ALGORITHM
+        token = JWT.encode payload, server_config.publisher_key, ALGORITHM
 
-        uri = URI("#{configuration.url}/mercure")
+        uri = URI(publish_url)
 
         req = Net::HTTP::Post.new(uri)
         req['Content-Type'] = 'application/x-www-form-urlencoded'
@@ -30,6 +24,10 @@ module Turbo
           http.request(req)
         end
       end
+
+      def server_config
+        configuration.mercure
+      end
     end
   end
 end

data/lib/turbo/train/test_helper.rb

@@ -3,13 +3,31 @@ module Turbo
   module Train
     module TestHelper
       def before_setup
-        Turbo::Train.instance_variable_set(:@server, Turbo::Train::TestServer.new(Turbo::Train.configuration))
+        test_server = case ENV.fetch('TURBO_TRAIN_TEST_SERVER', 'mercure').to_sym
+                      when :mercure
+                        Turbo::Train::TestServer.new(Turbo::Train.mercure_server, Turbo::Train.configuration)
+                      when :fanout
+                        Turbo::Train::TestServer.new(Turbo::Train.fanout_server, Turbo::Train.configuration)
+                      else
+                        raise "Unknown test server: #{ENV['TURBO_TRAIN_TEST_SERVER']}"
+                      end
+
+        Turbo::Train.instance_variable_set(:@server, test_server)
         super
       end
 
       def after_teardown
+        test_server = case ENV.fetch('TURBO_TRAIN_TEST_SERVER', 'mercure').to_sym
+                      when :mercure
+                        Turbo::Train.mercure_server
+                      when :fanout
+                        Turbo::Train.fanout_server
+                      else
+                        raise "Unknown test server: #{ENV['TURBO_TRAIN_TEST_SERVER']}"
+                      end
+
         super
-        Turbo::Train.instance_variable_set(:@server, Turbo::Train::Server.new(Turbo::Train.configuration))
+        Turbo::Train.instance_variable_set(:@server, test_server)
       end
 
       def assert_broadcast_on(stream, data, &block)
@@ -36,6 +54,26 @@ module Turbo
 
         assert message, "No messages sent with #{data} to #{Turbo::Train.stream_name_from(stream)}"
       end
+
+      def assert_body_match(r)
+        if Turbo::Train.server.real_server.is_a?(Turbo::Train::FanoutServer)
+          assert_match "Published\n", r.body
+        elsif Turbo::Train.server.real_server.is_a?(Turbo::Train::MercureServer)
+          assert_match /urn:uuid:.*/, r.body
+        else
+          raise "Unknown server type"
+        end
+      end
+
+      def assert_response_from_mercure_server(r)
+        assert_equal r.code, '200'
+        assert_match /urn:uuid:.*/, r.body
+      end
+
+      def assert_response_from_fanout_server(r)
+        assert_equal r.code, '200'
+        assert_match "Published\n", r.body
+      end
     end
   end
 end

data/lib/turbo/train/test_server.rb

@@ -1,11 +1,12 @@
 module Turbo
   module Train
-    class TestServer < Server
-      attr_reader :configuration, :channels_data
+    class TestServer < BaseServer
+      attr_reader :configuration, :channels_data, :real_server
 
-      def initialize(configuration)
+      def initialize(real_server, configuration)
         @configuration = configuration
         @channels_data = {}
+        @real_server = real_server
       end
 
       def publish(topics:, data:)
@@ -14,7 +15,7 @@ module Turbo
           @channels_data[topic] << data[:data]
         end
 
-        super
+        real_server.publish(topics: topics, data: data) if real_server
       end
 
       def broadcasts(channel)

data/lib/turbo/train/train.rb

@@ -18,8 +18,27 @@ module Turbo
         Turbo.signed_stream_verifier.generate stream_name_from(streamables)
       end
 
-      def server
-        @server ||= Server.new(configuration)
+      def server(server = nil)
+        @server ||= case server || configuration.default_server
+        when :mercure
+          mercure_server
+        when :fanout
+          fanout_server
+        else
+          raise ArgumentError, "Unknown server: #{server}"
+        end
+      end
+
+      def mercure_server
+        raise ArgumentError, "Mercure configuration is missing" unless configuration.mercure
+
+        @mercure_server ||= MercureServer.new(configuration)
+      end
+
+      def fanout_server
+        raise ArgumentError, "Fanout configuration is missing" unless configuration.fanout
+
+        @fanout_server ||= FanoutServer.new(configuration)
       end
 
       def stream_name_from(streamables)
@@ -30,10 +49,6 @@ module Turbo
         end
       end
 
-      def url
-        configuration.url
-      end
-
       private
 
       def render_format(format, **rendering)

data/lib/turbo/train/version.rb

@@ -1,5 +1,5 @@
 module Turbo
   module Train
-    VERSION = "0.2.0"
+    VERSION = "0.3.0"
   end
 end

data/lib/turbo/train.rb

@@ -1,7 +1,9 @@
 require "turbo/train/version"
 require "turbo/train/config"
 require 'turbo/train/broadcasts'
-require 'turbo/train/server'
+require 'turbo/train/base_server'
+require 'turbo/train/mercure_server'
+require 'turbo/train/fanout_server'
 require 'turbo/train/test_server'
 require 'turbo/train/test_helper'
 require "turbo/train/engine"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: turbo-train
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Nick Savrov
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-15 00:00:00.000000000 Z
+date: 2023-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -84,10 +84,12 @@ files:
 - lib/install/install_node.rb
 - lib/tasks/install_tasks.rake
 - lib/turbo/train.rb
+- lib/turbo/train/base_server.rb
 - lib/turbo/train/broadcasts.rb
 - lib/turbo/train/config.rb
 - lib/turbo/train/engine.rb
-- lib/turbo/train/server.rb
+- lib/turbo/train/fanout_server.rb
+- lib/turbo/train/mercure_server.rb
 - lib/turbo/train/test_helper.rb
 - lib/turbo/train/test_server.rb
 - lib/turbo/train/train.rb