wsdirector-core 1.0.1 → 1.0.2

data/lib/.rbnext/3.1/wsdirector/protocols/action_cable.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module WSDirector
+  module Protocols
+    # ActionCable protocol
+    class ActionCable < Base
+      PING_IGNORE = /['"]type['"]:\s*['"]ping['"]/
+
+      # Add ping ignore and make sure that we receive Welcome message
+      def init_client(**options)
+        options[:ignore] ||= [PING_IGNORE]
+        options[:subprotocol] ||= "actioncable-v1-json"
+
+        super(**options)
+
+        receive("data>" => {"type" => "welcome"})
+        log(:done) { "Welcomed" }
+      end
+
+      def subscribe(step)
+        identifier = extract_identifier(step)
+
+        log { "Subsribing to #{identifier}" }
+
+        client.send({command: "subscribe", identifier: identifier}.to_json)
+
+        begin
+          receive(
+            "data" => {"type" => "confirm_subscription", "identifier" => identifier}
+          )
+          log(:done) { "Subsribed to #{identifier}" }
+        rescue UnmatchedExpectationError => e
+          raise unless /reject_subscription/.match?(e.message)
+          raise UnmatchedExpectationError, "Subscription rejected to #{identifier}"
+        end
+      end
+
+      def unsubscribe(step)
+        identifier = extract_identifier(step)
+
+        client.send({command: "unsubscribe", identifier: identifier}.to_json)
+
+        log(nil) { "Unsubscribed from #{identifier}" }
+      end
+
+      def perform(step)
+        identifier = extract_identifier(step)
+        action = step.delete("action")
+
+        raise Error, "Action is missing" unless action
+
+        data = step.fetch("data", {}).merge(action: action).to_json
+
+        client.send({command: "message", data: data, identifier: identifier}.to_json)
+
+        log(nil) { "Performed #{action} on #{identifier}" }
+      end
+
+      def receive(step)
+        return super unless step.key?("channel")
+
+        identifier = extract_identifier(step)
+
+        key = step.key?("data") ? "data" : "data>"
+
+        message = step.fetch(key, {})
+        super(key => {"identifier" => identifier, "message" => message})
+      end
+
+      def receive_all(step)
+        messages = step["messages"]
+
+        return super if messages.nil? || messages.empty?
+
+        messages.each do |msg|
+          next unless msg.key?("channel")
+          identifier = extract_identifier(msg)
+
+          key = msg.key?("data") ? "data" : "data>"
+
+          msg[key] = {"identifier" => identifier, "message" => msg[key]}
+        end
+
+        super
+      end
+
+      private
+
+      def extract_identifier(step)
+        channel = step.delete("channel")
+        step.fetch("params", {}).merge(channel: channel).to_json
+      end
+    end
+  end
+end

data/lib/.rbnext/3.1/wsdirector/protocols/phoenix.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+module WSDirector
+  module Protocols
+    # Phoenix Channels protocol
+    # See https://github.com/phoenixframework/phoenix/blob/master/lib/phoenix/socket/serializers/v2_json_serializer.ex
+    class Phoenix < Base
+      attr_reader :topics_to_join_ref
+      attr_accessor :refs_counter, :join_refs_counter
+
+      def initialize(...)
+        super
+
+        @refs_counter = 3
+        @join_refs_counter = 3
+        @topics_to_join_ref = {}
+      end
+
+      def init_client(**options)
+        options[:query] ||= {}
+        # Make sure we use the v2 of the protocol
+        options[:query][:vsn] = "2.0.0"
+
+        super(**options)
+      end
+
+      def join(step)
+        topic = step.fetch("topic")
+
+        join_ref = join_refs_counter
+        self.join_refs_counter += 1
+
+        ref = refs_counter
+        self.refs_counter += 1
+
+        log { "Joining #{topic} (##{ref})" }
+
+        cmd = new_command(:phx_join, topic, join_ref: join_ref, ref: ref)
+
+        client.send(cmd.to_json)
+
+        receive({"data>" => new_command(:phx_reply, topic, join_ref: join_ref, ref: ref, payload: {"status" => "ok"})})
+
+        log(:done) { "Joined #{topic} (##{ref})" }
+      end
+
+      def leave(step)
+        topic = step.fetch("topic")
+        join_ref = topics_to_join_ref.fetch(topic)
+
+        ref = refs_counter
+        self.refs_counter += 1
+
+        cmd = new_command(:phx_leave, topic, join_ref: join_ref, ref: ref)
+        client.send(cmd.to_json)
+
+        receive({"data>" => new_command(:phx_reply, topic, join_ref: join_ref, ref: ref, payload: {"status" => "ok"})})
+
+        log(nil) { "Left #{topic} (##{join_ref})" }
+      end
+
+      def send(step)
+        return super unless step.key?("topic")
+
+        ref = refs_counter
+        self.refs_counter += 1
+
+        topic = step.fetch("topic")
+        event = step.fetch("event")
+        payload = step["data"]
+
+        super({"data" => new_command(event, topic, payload: payload, ref: ref).to_json})
+      end
+
+      def receive(step)
+        return super unless step.key?("topic")
+
+        topic = step.fetch("topic")
+        event = step.fetch("event")
+
+        key = step.key?("data") ? "data" : "data>"
+        payload = step.fetch(key)
+
+        cmd = new_command(event, topic, payload: payload)
+
+        super({key => cmd})
+      end
+
+      private
+
+      def new_command(event, topic, join_ref: nil, ref: nil, payload: {})
+        [
+          join_ref&.to_s,
+          ref&.to_s,
+          topic.to_s,
+          event.to_s,
+          payload
+        ]
+      end
+    end
+  end
+end

data/lib/.rbnext/3.1/wsdirector/runner.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require "wsdirector/scenario_reader"
+require "wsdirector/clients_holder"
+require "wsdirector/results_holder"
+require "wsdirector/result"
+require "wsdirector/task"
+require "wsdirector/ext/deep_dup"
+
+module WSDirector
+  def self.run(scenario, scale: 1, connection_options: {}, locals: {}, **options)
+    scenario = ScenarioReader.parse(scenario, scale: scale, connection_options: connection_options, locals: locals)
+    Runner.new(scenario, scale: scale, **options).execute
+  end
+
+  # Initiates all clients as a separate tasks (=threads)
+  class Runner
+    using WSDirector::Ext::DeepDup
+
+    def initialize(scenario, url:, scale: 1, sync_timeout: 5, logger: nil, colorize: false)
+      @scenario = scenario
+      @url = url
+      @scale = scale
+      @logger = logger
+      @colorize = colorize
+      @total_count = scenario["total"]
+      @global_holder = ClientsHolder.new(total_count, sync_timeout: sync_timeout)
+      @results_holder = ResultsHolder.new
+    end
+
+    def execute
+      Thread.abort_on_exception = true
+
+      num = 0
+
+      tasks = scenario["clients"].flat_map do |client_config|
+        name = client_config.fetch("name")
+        result = Result.new(name)
+        results_holder << result
+
+        Array.new(client_config.fetch("multiplier")) do
+          num += 1
+          id = "#{name}_#{num}"
+          Thread.new do
+            Task.new(client_config.deep_dup, id: id, colorize: colorize, global_holder: global_holder, result: result, scale: scale, logger: logger)
+              .run(url)
+          end
+        end
+      end
+
+      tasks.each(&:join)
+
+      results_holder
+    end
+
+    private
+
+    attr_reader :scenario, :url, :scale, :total_count, :global_holder, :results_holder, :logger, :colorize
+  end
+end

data/lib/.rbnext/3.1/wsdirector/scenario_reader.rb

@@ -0,0 +1,172 @@
+# frozen_string_literal: true
+
+require "erb"
+require "json"
+require "wsdirector/ext/deep_dup"
+
+module WSDirector
+  # Read and parse different scenarios
+  class ScenarioReader
+    using WSDirector::Ext::DeepDup
+
+    include WSDirector::Utils
+
+    class << self
+      def parse(scenario, **options)
+        new(**options).parse(scenario)
+      end
+    end
+
+    attr_reader :default_connections_options, :locals
+
+    def initialize(scale: 1, connection_options: {}, locals: {})
+      @scale = scale
+      @default_connections_options = connection_options
+      @locals = locals
+    end
+
+    def parse(scenario)
+      contents =
+        if scenario.is_a?(String)
+          if File.file?(scenario)
+            parse_file(scenario)
+          else
+            parse_from_str(scenario).then do
+              next _1 if _1.is_a?(Array)
+              [_1]
+            end
+          end.flatten
+        else
+          scenario
+        end
+
+      contents.map! do |item|
+        item.is_a?(String) ? {item => {}} : item
+      end
+
+      if contents.first&.key?("client")
+        contents = transform_with_loop(contents, multiple: true)
+        parse_multiple_scenarios(contents)
+      else
+        contents = transform_with_loop(contents)
+        {"total" => 1, "clients" => [parse_simple_scenario(contents)]}
+      end
+    end
+
+    private
+
+    JSON_FILE_FORMAT = /.+.(json)\z/
+    private_constant :JSON_FILE_FORMAT
+
+    def parse_from_str(contents)
+      JSON.parse(contents)
+    rescue JSON::ParserError
+      parse_yaml(contents)
+    end
+
+    def parse_file(file)
+      if file.match?(JSON_FILE_FORMAT)
+        JSON.parse(File.read(file))
+      else
+        parse_yaml(file)
+      end
+    end
+
+    def parse_yaml(path)
+      contents = File.file?(path) ? File.read(path) : path
+
+      if defined?(ERB)
+        contents = ERB.new(contents).result(erb_context)
+      end
+
+      ::YAML.load(contents, aliases: true, permitted_classes: [Date, Time, Regexp]) || {}
+    rescue ArgumentError
+      ::YAML.load(contents) || {}
+    end
+
+    def handle_steps(steps)
+      steps.flat_map.with_index do |step, id|
+        if step.is_a?(Hash)
+          type, data = step.to_a.first
+
+          data["sample"] = [1, parse_multiplier(data["sample"])].max if data["sample"]
+
+          multiplier = parse_multiplier(data.delete("multiplier") || "1")
+          Array.new(multiplier) { {"type" => type, "id" => id}.merge(data) }
+        else
+          {"type" => step, "id" => id}
+        end
+      end
+    end
+
+    def parse_simple_scenario(
+      steps,
+      multiplier: 1, name: "default", ignore: nil, protocol: "base",
+      connection_options: {}
+    )
+      {
+        "multiplier" => multiplier,
+        "steps" => handle_steps(steps),
+        "name" => name,
+        "ignore" => ignore,
+        "protocol" => protocol,
+        "connection_options" => default_connections_options.merge(connection_options)
+      }
+    end
+
+    def parse_multiple_scenarios(definitions)
+      total_count = 0
+      clients = definitions.map.with_index do |client, i|
+        _, client = client.to_a.first
+        multiplier = parse_multiplier(client.delete("multiplier") || "1")
+        name = client.delete("name") || (i + 1).to_s
+        connection_options = client.delete("connection_options") || {}
+        total_count += multiplier
+        ignore = parse_ignore(client.fetch("ignore", nil))
+        protocol = client.fetch("protocol", "base")
+
+        parse_simple_scenario(
+          client.fetch("actions", []),
+          multiplier: multiplier,
+          name: name,
+          ignore: ignore,
+          protocol: protocol,
+          connection_options: connection_options
+        )
+      end
+      {"total" => total_count, "clients" => clients}
+    end
+
+    def transform_with_loop(contents, multiple: false)
+      contents.flat_map do |content|
+        loop_data = content.dig("client", "loop") || content.dig("loop")
+        next content unless loop_data
+
+        loop_multiplier = parse_multiplier(loop_data["multiplier"] || "1")
+
+        if multiple
+          content["client"]["actions"] = (loop_data["actions"] * loop_multiplier).map(&:deep_dup)
+          content
+        else
+          loop_data["actions"] * loop_multiplier
+        end
+      end
+    end
+
+    def parse_ignore(str)
+      return unless str
+
+      Array(str)
+    end
+
+    def erb_context
+      binding.then do |b|
+        locals.each do
+          b.local_variable_set(_1, _2)
+        end
+
+        b
+      end
+    end
+  end
+end

data/lib/.rbnext/3.1/wsdirector/task.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require "wsdirector/client"
+require "wsdirector/protocols"
+
+module WSDirector
+  # Single client operator
+  class Task
+    attr_reader :global_holder, :client
+
+    def initialize(config, id:, global_holder:, result:, scale:, logger:, colorize: false)
+      @id = id
+      @logger = logger
+      @ignore = config.fetch("ignore")
+      @steps = config.fetch("steps")
+      @connection_options = config.fetch("connection_options").transform_keys(&:to_sym)
+      @global_holder = global_holder
+      @result = result
+
+      protocol_class = Protocols.get(config.fetch("protocol", "base"))
+      @protocol = protocol_class.new(self, scale: scale, logger: logger, id: id, color: color_for_id(id, colorize))
+    end
+
+    def run(url)
+      connect!(url, **@connection_options)
+
+      steps.each(&protocol)
+
+      result.succeed
+    rescue Error => e
+      result.failed(e.message)
+    end
+
+    def sampled?(step)
+      return true unless step["sample"]
+
+      id, max = step["id"], step["sample"]
+
+      result.track_sample(id, max)
+    end
+
+    private
+
+    attr_reader :steps, :result, :protocol, :id, :logger, :ignore
+
+    def connect!(url, **options)
+      protocol.init_client(url: url, id: id, ignore: ignore, **options)
+    end
+
+    def color_for_id(id, colorize)
+      return unless colorize
+
+      String.colors[id.hash % String.colors.size]
+    end
+  end
+end

data/lib/wsdirector/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module WSDirector
-  VERSION = "1.0.1"
+  VERSION = "1.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wsdirector-core
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Vladimir Dementyev
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-29 00:00:00.000000000 Z
+date: 2023-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: websocket-client-simple
@@ -194,6 +194,19 @@ files:
 - LICENSE.txt
 - README.md
 - bin/wsdirector
+- lib/.rbnext/2.7/wsdirector/cli.rb
+- lib/.rbnext/2.7/wsdirector/client.rb
+- lib/.rbnext/2.7/wsdirector/protocols/base.rb
+- lib/.rbnext/2.7/wsdirector/protocols/phoenix.rb
+- lib/.rbnext/2.7/wsdirector/scenario_reader.rb
+- lib/.rbnext/3.0/wsdirector/ext/formatting.rb
+- lib/.rbnext/3.0/wsdirector/protocols/base.rb
+- lib/.rbnext/3.1/wsdirector/cli.rb
+- lib/.rbnext/3.1/wsdirector/protocols/action_cable.rb
+- lib/.rbnext/3.1/wsdirector/protocols/phoenix.rb
+- lib/.rbnext/3.1/wsdirector/runner.rb
+- lib/.rbnext/3.1/wsdirector/scenario_reader.rb
+- lib/.rbnext/3.1/wsdirector/task.rb
 - lib/wsdirector-cli.rb
 - lib/wsdirector.rb
 - lib/wsdirector/cli.rb