rsmp 0.35.2 → 0.37.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e5c0f93062b73555dd67edda6564054299c1df0240c4ce55f0b854abc7e94931
-  data.tar.gz: 2659660e29f1ba7b50533b3e89bb80c81ae69f81768cbc4012db6da6776ccebc
+  metadata.gz: 9f2687b5748524376a9316cadcf6776a6d9a9ccddbb8b763ea222246f7efb602
+  data.tar.gz: 942347899e8f26aae13eb6ead6dce7c2b2d17020c0e11b04af530a5e91904ed5
 SHA512:
-  metadata.gz: c48367c147156f5adb8cdabfd5fc81cde4cbb3e842f05c982307b6400f6fb33deb583cc57737faa2e7a1fe2a87f7e629dde7b335f063e126a403e45f49774c2f
-  data.tar.gz: 77c5e1343d7106bd9a60ff55e666d69cb4589655e7ad9bcbcf84cb95101e3b7c004bf373943f018d24b38d5cb6f6cccc97f7a0202fe2c8f5dc6ad7e687134c1b
+  metadata.gz: 77ba8af9b9be03e22bef3fa9a83c28f407c2371f7b6c3064e00396f8f9e2a1e088d52afb9c06270352c602cea91b88468e8674a5555b6a7383cd8b389f5a2567
+  data.tar.gz: 1f17f3055a0c88a2848fc5ef0b1fe93fd7ad02e321cdfbe90824f418c61054c6085940e5c3c87a186ab46ed7e6c5e8bceb0dc905e0109d055d484519cb030659

data/.github/copilot-instructions.md

@@ -0,0 +1,33 @@
+# rsmp gem
+This is a Ruby based repository contaning an implementation of RSMP (RoadSide Message Protocol), including:
+
+- Ruby classes that can be used to build tests or other RSMP tools.
+- Command-line tools for quickly running RSMP supervisors or sites and view messages exchanged.
+
+It relies on the gem `rsmp_schema` to validate RSMP message using JSON schema.
+
+Always reference these instructions first, and fall back to search or bash commands only when you encounter unexpected information that does not match the info here.
+
+## Development Flow
+- Ruby and required gems are already installed by the action .github/copilot-setup-steps.yml, do not install them again.
+- All gem executables must be run from the bundle environment using `bundle exec ...`
+- Before any commit, run `bundle exec rspec` to verify that all tests pass.
+
+## Repository Structure
+- `bin/`: Main service entry points and executables
+- `lib/`: Ruby source code
+- `spec/`: RSpec test files for validating Ruby code
+- `features/`: Cucumber test files for validating the CLI component
+- `config/`: Configuration files used when running the 'rsmp' command line
+- `documentation/`: Documentation
+
+## Guidelines
+- Follow Ruby best practices and idiomatic patterns.
+- Maintain existing code structure and organization.
+- Always use existing async patterns to handle concurrency, also in tests.
+- Code behaviour should adhere to the RSMP specifications defined at https://github.com/rsmp-nordic/rsmp_core.
+- Write and verify rspec tests for new functionality.
+- Document public APIs and complex logic. Suggest changes to the `documentation/` folder when appropriate.
+- Don't commit example scripts.
+- Prefer real classes over test doubles or mocks in tests and use async contexts to run sites and supervisors.
+- When reporting on progress, claims should be supported by tests or other data.

data/.github/workflows/copilot-setup-steps.yml

@@ -0,0 +1,35 @@
+name: "Copilot Setup Steps"
+
+# Automatically run the setup steps when they are changed to allow for easy validation, and
+# allow manual testing through the repository's "Actions" tab
+on:
+  workflow_dispatch:
+  push:
+    paths:
+      - .github/workflows/copilot-setup-steps.yml
+  pull_request:
+    paths:
+      - .github/workflows/copilot-setup-steps.yml
+
+jobs:
+  # The job MUST be called `copilot-setup-steps` or it will not be picked up by Copilot.
+  copilot-setup-steps:
+    runs-on: ubuntu-latest
+
+    # Set the permissions to the lowest permissions possible needed for your steps.
+    # Copilot will be given its own token for its operations.
+    permissions:
+      # If you want to clone the repository as part of your setup steps, for example to install dependencies, you'll need the `contents: read` permission. If you don't clone the repository in your setup steps, Copilot will do this for you automatically after the steps complete.
+      contents: read
+
+    # You can define any steps you want, and they will run before the agent starts.
+    # If you do not check out your code, Copilot will do this for you.
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.4
+          bundler-cache: true
+

data/.github/workflows/rspec.yaml

@@ -14,6 +14,7 @@ jobs:
     - uses: actions/checkout@v4
     - uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 3.3
+        ruby-version: 3.4
         bundler-cache: true
     - run: bundle exec rspec -f d
+

data/.gitignore

@@ -9,8 +9,9 @@ log
 /coverage/
 /doc/
 /pkg/
-/spec/reports/
 /tmp/
+/vendor/
+/spec/reports/
 /config/private/
 
 

data/Gemfile.lock

@@ -1,10 +1,11 @@
 PATH
   remote: .
   specs:
-    rsmp (0.35.2)
-      async (~> 2.21)
-      async-io (~> 1.43)
+    rsmp (0.37.0)
+      async (~> 2.32)
       colorize (~> 1.1)
+      io-endpoint (~> 0.15)
+      io-stream (~> 0.10)
       logger (~> 1.6)
       ostruct (~> 0.6)
       rsmp_schema (~> 0.8)
@@ -12,24 +13,22 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    aruba (2.3.0)
+    aruba (2.3.1)
       bundler (>= 1.17, < 3.0)
       contracts (>= 0.16.0, < 0.18.0)
-      cucumber (>= 8.0, < 10.0)
+      cucumber (>= 8.0, < 11.0)
       rspec-expectations (~> 3.4)
       thor (~> 1.0)
-    async (2.23.0)
+    async (2.32.0)
       console (~> 1.29)
       fiber-annotation
-      io-event (~> 1.9)
+      io-event (~> 1.11)
       metrics (~> 0.12)
-      traces (~> 0.15)
-    async-io (1.43.2)
-      async
-    bigdecimal (3.1.9)
+      traces (~> 0.18)
+    bigdecimal (3.2.3)
     builder (3.3.0)
     colorize (1.1.0)
-    console (1.29.3)
+    console (1.34.0)
       fiber-annotation
       fiber-local (~> 1.1)
       json
@@ -55,57 +54,63 @@ GEM
       bigdecimal
     cucumber-gherkin (27.0.0)
       cucumber-messages (>= 19.1.4, < 23)
-    cucumber-html-formatter (21.9.0)
+    cucumber-html-formatter (21.14.0)
       cucumber-messages (> 19, < 28)
     cucumber-messages (22.0.0)
     cucumber-tag-expressions (6.1.2)
-    diff-lcs (1.6.0)
-    ffi (1.17.1)
+    diff-lcs (1.6.2)
+    ffi (1.17.2)
+    ffi (1.17.2-arm64-darwin)
     fiber-annotation (0.2.0)
     fiber-local (1.1.0)
       fiber-storage
-    fiber-storage (1.0.0)
+    fiber-storage (1.0.1)
     hana (1.3.7)
-    io-event (1.9.0)
-    json (2.10.1)
-    json_schemer (2.3.0)
+    io-endpoint (0.15.2)
+    io-event (1.14.0)
+    io-stream (0.10.0)
+    json (2.14.1)
+    json_schemer (2.4.0)
       bigdecimal
       hana (~> 1.3)
       regexp_parser (~> 2.0)
       simpleidn (~> 0.2)
-    logger (1.6.6)
-    metrics (0.12.1)
+    logger (1.7.0)
+    memoist3 (1.0.0)
+    metrics (0.15.0)
     mini_mime (1.1.5)
     multi_test (1.1.0)
-    ostruct (0.6.1)
-    rake (13.2.1)
-    regexp_parser (2.10.0)
-    rsmp_schema (0.8.7)
-      json_schemer (~> 2.3.0)
-      thor (~> 1.3.1)
-    rspec (3.13.0)
+    ostruct (0.6.3)
+    rake (13.3.0)
+    regexp_parser (2.11.2)
+    rsmp_schema (0.8.9)
+      json_schemer (~> 2.4.0)
+      thor (~> 1.4.0)
+    rspec (3.13.1)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
       rspec-mocks (~> 3.13.0)
-    rspec-core (3.13.3)
+    rspec-core (3.13.5)
       rspec-support (~> 3.13.0)
-    rspec-expectations (3.13.3)
+    rspec-expectations (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-mocks (3.13.2)
+    rspec-mocks (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-support (3.13.2)
+    rspec-support (3.13.5)
     simpleidn (0.2.3)
-    sys-uname (1.3.1)
+    sys-uname (1.4.1)
       ffi (~> 1.1)
-    thor (1.3.2)
+      memoist3 (~> 1.0.0)
+    thor (1.4.0)
     timecop (0.9.10)
-    traces (0.15.2)
+    traces (0.18.2)
 
 PLATFORMS
   arm64-darwin-22
   arm64-darwin-23
+  arm64-darwin-24
   x64-mingw-ucrt
   x64-mingw32
   x86_64-darwin-19

data/bin/console

@@ -14,10 +14,8 @@ module IRB
   class MyInputMethod < StdioInputMethod
     def initialize
       super
-      @input = Async::IO::Protocol::Line.new(
-        Async::IO::Stream.new(
-          Async::IO::Generic.new($stdin)
-        )
+      @input = RSMP::Protocol.new(
+        IO::Stream::Buffered.new($stdin)
       )
     end
 

data/documentation/tasks.md

@@ -74,16 +74,16 @@ SiteProxy and SupervisorProxy both inherit from Proxy and have a reader task and
 ## Task Hierachy
 When you start an Async task, the parent will be the currently running task, unless you specify a different parent task.
 
-The Async task hierarchy is similar to the object hierachy, with the difference that proxies have reader and timer tasks. And Async::IO which is used to handle TPC connections concurently, will create some intermediate tasks:
+The Async task hierarchy is similar to the object hierachy, with the difference that proxies have reader and timer tasks. And IO::Endpoint which is used to handle TCP connections concurently, will create some intermediate tasks:
 
 ```
 Supervisor @task
-	accepting connections      # this task is created by Async::IO
-		incoming connection 1    # this task is created by Async::IO
+	accepting connections      # this task is created by IO::Endpoint
+		incoming connection 1    # this task is created by IO::Endpoint
 			SiteProxy @task
 				SiteProxy @reader
 				SiteProxy @timer
-		incoming connection 2    # this task is created by Async::IO
+		incoming connection 2    # this task is created by IO::Endpoint
 			SiteProxy @task
 				SiteProxy @reader
 				SiteProxy @timer

data/lib/rsmp/protocol.rb

@@ -0,0 +1,35 @@
+module RSMP
+  class Protocol
+    def initialize(stream)
+      @stream = stream
+      @peeked = nil
+    end
+
+    def read_line
+      if @peeked
+        line = @peeked
+        @peeked = nil
+        line
+      else
+        read
+      end
+    end
+
+    def peek_line
+      @peeked = read unless @peeked
+      @peeked
+    end
+
+    def write_lines(data)
+      @stream.write(data + RSMP::Proxy::WRAPPING_DELIMITER)
+      @stream.flush unless @stream.closed?
+    end
+  
+    protected
+    def read
+      line = @stream.gets(RSMP::Proxy::WRAPPING_DELIMITER)
+      return nil unless line
+      line.chomp(RSMP::Proxy::WRAPPING_DELIMITER)
+    end
+  end
+end

data/lib/rsmp/proxy.rb

@@ -169,16 +169,14 @@ module RSMP
     end
 
     def run_reader
-      @stream ||= Async::IO::Stream.new(@socket)
-      @protocol ||= Async::IO::Protocol::Line.new(@stream,WRAPPING_DELIMITER) # rsmp messages are json terminated with a form-feed
+      @stream ||= IO::Stream::Buffered.new(@socket)
+      @protocol ||= RSMP::Protocol.new(@stream) # rsmp messages are json terminated with a form-feed
       loop do
         read_line
       end
     rescue Restart
       log "Closing connection", level: :warning
       raise
-    rescue Async::Wrapper::Cancelled
-      # ignore exceptions raised when a wait is aborted because a task is stopped
     rescue EOFError, Async::Stop
       log "Connection closed", level: :warning
     rescue IOError => e

data/lib/rsmp/supervisor.rb

@@ -4,12 +4,15 @@
 
 module RSMP
   class Supervisor < Node
-    attr_reader :core_version, :site_id, :supervisor_settings, :proxies, :logger
+    attr_reader :core_version, :site_id, :supervisor_settings, :proxies, :logger, :ready_condition
+
+    attr_accessor :site_id_condition
 
     def initialize options={}
       handle_supervisor_settings( options[:supervisor_settings] || {} )
       super options
       @proxies = []
+      @ready_condition = Async::Notification.new
       @site_id_condition = Async::Notification.new
     end
 
@@ -58,19 +61,26 @@ module RSMP
     end
 
     # listen for connections
-    # Async::IO::Endpoint#accept createa an async task that we will wait for
     def run
       log "Starting supervisor on port #{@supervisor_settings["port"]}",
           level: :info,
           timestamp: @clock.now
 
-      @endpoint = Async::IO::Endpoint.tcp('0.0.0.0', @supervisor_settings["port"])
-      tasks = @endpoint.accept do |socket|  # creates async tasks
-        handle_connection(socket)
+      @endpoint = IO::Endpoint.tcp('0.0.0.0', @supervisor_settings["port"])
+      @accept_task = Async::Task.current.async do |task|
+        task.annotate "supervisor accept loop"
+        @endpoint.accept() do |socket|  # creates fibers
+          handle_connection(socket)
+        rescue StandardError => e
+          distribute_error e, level: :internal
+        end
+      rescue Async::Stop   # will happen at shutdown
       rescue StandardError => e
         distribute_error e, level: :internal
       end
-      tasks.each { |task| task.wait }
+
+      @ready_condition.signal
+      @accept_task.wait
     rescue StandardError => e
       distribute_error e, level: :internal
     end
@@ -78,6 +88,11 @@ module RSMP
     # stop
     def stop
       log "Stopping supervisor #{@supervisor_settings["site_id"]}", level: :info
+
+      @accept_task.stop if @accept_task
+      @accept_task = nil
+
+      @endpoint = nil
       super
     end
 
@@ -150,8 +165,8 @@ module RSMP
 
       authorize_ip info[:ip]
 
-      stream = Async::IO::Stream.new socket
-      protocol = Async::IO::Protocol::Line.new stream, Proxy::WRAPPING_DELIMITER
+      stream = IO::Stream::Buffered.new(socket)
+      protocol = RSMP::Protocol.new stream
 
       settings = {
         supervisor: self,

data/lib/rsmp/supervisor_proxy.rb

@@ -65,28 +65,22 @@ module RSMP
     end
 
     def connect_tcp
-      @endpoint = Async::IO::Endpoint.tcp(@ip, @port)
-
-      error = nil
-      # Async::IO::Endpoint#connect renames the current task. run in a subtask to avoid this see issue #22
-      result = @task.async do |task|
-        task.annotate 'socket task'
-        # this timeout is a workaround for connect hanging on windows if the other side is not present yet
-        timeout = @site_settings.dig('timeouts','connect') || 1.1
-        task.with_timeout timeout do
-          @socket = @endpoint.connect
-        end
-        delay = @site_settings.dig('intervals','after_connect')
-        task.sleep delay if delay
-      rescue Errno::ECONNREFUSED => e   # rescue to avoid log output
-        log "Connection refused", level: :warning
-        error = e
-      end.wait
-      raise error if error  # reraise any error outside task
-
-      @stream = Async::IO::Stream.new(@socket)
-      @protocol = Async::IO::Protocol::Line.new(@stream,WRAPPING_DELIMITER) # rsmp messages are json terminated with a form-feed
+      @endpoint = IO::Endpoint.tcp(@ip, @port)
+
+      # this timeout is a workaround for connect hanging on windows if the other side is not present yet
+      timeout = @site_settings.dig('timeouts','connect') || 1.1
+      task.with_timeout timeout do
+        @socket = @endpoint.connect
+      end
+      delay = @site_settings.dig('intervals','after_connect')
+      task.sleep delay if delay
+
+      @stream = IO::Stream::Buffered.new(@socket)
+      @protocol = RSMP::Protocol.new(@stream) # rsmp messages are json terminated with a form-feed
       set_state :connected
+    rescue Errno::ECONNREFUSED => e   # rescue to avoid log output
+      log "Connection refused", level: :warning
+      raise e
     end
 
     def handshake_complete

data/lib/rsmp/task.rb

@@ -13,12 +13,24 @@ module RSMP
     # run() will be called inside the task to perform actual long-running work
     def start
       return if @task
-      Async do |task|
-        task.annotate "#{self.class.name} main task"
-        @task = task
-        run
-        stop_subtasks
-        @task = nil
+      
+      # Use current task context if available, otherwise create new reactor
+      if Async::Task.current?
+        Async::Task.current.async do |task|
+          task.annotate "#{self.class.name} main task"
+          @task = task
+          run
+          stop_subtasks
+          @task = nil
+        end
+      else
+        Async do |task|
+          task.annotate "#{self.class.name} main task"
+          @task = task
+          run
+          stop_subtasks
+          @task = nil
+        end
       end
       self
     end

data/lib/rsmp/tlc/traffic_controller.rb

@@ -141,7 +141,12 @@ module RSMP
       end
 
       def move_cycle_counter
-        counter = Time.now.to_i % current_plan.cycle_time
+        plan = current_plan
+        if plan
+          counter = Time.now.to_i % plan.cycle_time
+        else
+          counter = 0
+        end
         changed = counter != @cycle_counter
         @cycle_counter = counter
         changed

data/lib/rsmp/version.rb

@@ -1,3 +1,3 @@
 module RSMP
-  VERSION = "0.35.2"
+  VERSION = "0.37.0"
 end

data/lib/rsmp.rb

@@ -1,8 +1,10 @@
 require 'yaml'
 require 'socket'
 require 'time'
-require 'async/io'
-require 'async/io/protocol/line'
+require 'async'
+require 'io/endpoint'
+require 'io/endpoint/host_endpoint'
+require 'io/stream'
 require 'colorize'
 require 'json'
 require 'securerandom'
@@ -14,6 +16,7 @@ require 'rsmp/task'
 require 'rsmp/deep_merge'
 require 'rsmp/inspect'
 require 'rsmp/logging'
+require 'rsmp/protocol'
 require 'rsmp/node'
 require 'rsmp/supervisor'
 require 'rsmp/components'

data/rsmp.gemspec

@@ -32,8 +32,9 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "logger", "~> 1.6"
   spec.add_dependency "ostruct", "~> 0.6"
-  spec.add_dependency "async", "~> 2.21"
-  spec.add_dependency "async-io", "~> 1.43"
+  spec.add_dependency "async", "~> 2.32"
+  spec.add_dependency "io-stream", "~> 0.10"
+  spec.add_dependency "io-endpoint", "~> 0.15"
   spec.add_dependency "colorize", "~> 1.1"
   spec.add_dependency "rsmp_schema", "~> 0.8"
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: rsmp
 version: !ruby/object:Gem::Version
-  version: 0.35.2
+  version: 0.37.0
 platform: ruby
 authors:
 - Emil Tin
 bindir: exe
 cert_chain: []
-date: 2025-03-04 00:00:00.000000000 Z
+date: 2025-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logger
@@ -43,28 +43,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.21'
+        version: '2.32'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.21'
+        version: '2.32'
 - !ruby/object:Gem::Dependency
-  name: async-io
+  name: io-stream
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.43'
+        version: '0.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.43'
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: io-endpoint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
 - !ruby/object:Gem::Dependency
   name: colorize
   requirement: !ruby/object:Gem::Requirement
@@ -199,6 +213,8 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/copilot-instructions.md"
+- ".github/workflows/copilot-setup-steps.yml"
 - ".github/workflows/rspec.yaml"
 - ".gitignore"
 - ".gitmodules"
@@ -253,6 +269,7 @@ files:
 - lib/rsmp/logging.rb
 - lib/rsmp/message.rb
 - lib/rsmp/node.rb
+- lib/rsmp/protocol.rb
 - lib/rsmp/proxy.rb
 - lib/rsmp/rsmp.rb
 - lib/rsmp/site.rb