Merge pull request #659 from OpenC3/ruby32

ryanmelt · web-flow · commit 3bf6d9c7c319 · 2023-05-16T13:56:59.000-07:00
Alpine 3.18.0 and test ruby 3.2
diff --git a/.env b/.env
@@ -38,8 +38,8 @@ OPENC3_SR_REDIS_PASSWORD=scriptrunnerpassword
 OPENC3_SR_BUCKET_USERNAME=scriptrunnerminio
 OPENC3_SR_BUCKET_PASSWORD=scriptrunnerminiopassword
 # Build and repository settings
-ALPINE_VERSION=3.17
-ALPINE_BUILD=3
+ALPINE_VERSION=3.18
+ALPINE_BUILD=0
 APK_URL=https://dl-cdn.alpinelinux.org
 RUBYGEMS_URL=https://rubygems.org
 NPM_URL=https://registry.npmjs.org
diff --git a/.github/workflows/api_tests.yml b/.github/workflows/api_tests.yml
@@ -32,7 +32,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ["3.0", "3.1"]
+        ruby-version: ["3.1", "3.2"]
 
     steps:
       - uses: actions/checkout@v3
@@ -64,7 +64,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ["3.0", "3.1"]
+        ruby-version: ["3.1", "3.2"]
 
     steps:
       - uses: actions/checkout@v3
diff --git a/.github/workflows/clamav.yml b/.github/workflows/clamav.yml
@@ -18,10 +18,10 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
-      - name: Set up Ruby 3.1
+      - name: Set up Ruby 3.2
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 3.1
+          ruby-version: 3.2
           bundler-cache: false # runs 'bundle install' and caches installed gems automatically
           working-directory: openc3
       - name: openc3.sh build
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -29,10 +29,10 @@ jobs:
     environment: Release
     steps:
       - uses: actions/checkout@v3
-      - name: Set up Ruby 3.1
+      - name: Set up Ruby 3.2
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 3.1
+          ruby-version: 3.2
           bundler-cache: false # runs 'bundle install' and caches installed gems automatically
           working-directory: openc3
       - uses: actions/setup-node@v3
diff --git a/.github/workflows/ruby_unit_tests.yml b/.github/workflows/ruby_unit_tests.yml
@@ -24,7 +24,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ["3.0", "3.1"]
+        ruby-version: ["3.1", "3.2"]
 
     steps:
       - uses: actions/checkout@v3
diff --git a/.rubocop.yml b/.rubocop.yml
@@ -3,7 +3,7 @@ inherit_from:
 
 AllCops:
   NewCops: enable
-  TargetRubyVersion: 3.1
+  TargetRubyVersion: 3.2
 
 # Layout
 Layout/LineLength:
diff --git a/openc3-cosmos-cmd-tlm-api/Gemfile b/openc3-cosmos-cmd-tlm-api/Gemfile
@@ -21,7 +21,7 @@ gem 'prometheus-client', '~> 4.0'
 gem 'bootsnap', '>= 1.9.3', require: false
 
 # Use Rack CORS for handling Cross-Origin Resource Sharing (CORS), making cross-origin AJAX possible
-gem 'rack-cors', '~> 1.1'
+gem 'rack-cors', '~> 2.0'
 
 group :development do
   gem 'debase-ruby_core_source'
diff --git a/openc3-cosmos-cmd-tlm-api/app/controllers/internal_metrics_controller.rb b/openc3-cosmos-cmd-tlm-api/app/controllers/internal_metrics_controller.rb
@@ -17,7 +17,7 @@
 # All changes Copyright 2022, OpenC3, Inc.
 # All Rights Reserved
 #
-# This file may also be used under the terms of a commercial license 
+# This file may also be used under the terms of a commercial license
 # if purchased from OpenC3, Inc.
 
 require 'openc3/models/scope_model'
@@ -35,7 +35,7 @@
 #    foobar{code="200",method="get",path="/metrics"} 5.0
 # items = {"name|labels" => [value_array], ...}
 # items = {"http_server_requests_total|code=200,method=get,path=/metrics" => [1,2,3,4,5], ...}
-class InternalMetricsController < ActionController::Base
+class InternalMetricsController < ApplicationController
   def index
     OpenC3::Logger.debug("request for aggregator metrics")
     begin
diff --git a/openc3-cosmos-cmd-tlm-api/app/controllers/internal_status_controller.rb b/openc3-cosmos-cmd-tlm-api/app/controllers/internal_status_controller.rb
@@ -17,7 +17,7 @@
 # All changes Copyright 2022, OpenC3, Inc.
 # All Rights Reserved
 #
-# This file may also be used under the terms of a commercial license 
+# This file may also be used under the terms of a commercial license
 # if purchased from OpenC3, Inc.
 
 require 'openc3/models/info_model'
@@ -26,7 +26,7 @@
 # InternalStatusController is designed to check the status of OpenC3. Status will
 # check that Redis is up but that does not equal that everything is
 # working just that OpenC3 can talk to Redis.
-class InternalStatusController < ActionController::Base
+class InternalStatusController < ApplicationController
   def status
     begin
       render :json => { :status => OpenC3::PingModel.get() }, :status => 200
diff --git a/openc3-cosmos-script-runner-api/Gemfile b/openc3-cosmos-script-runner-api/Gemfile
@@ -21,7 +21,7 @@ gem 'prometheus-client', '~> 4.0'
 gem 'bootsnap', '>= 1.9.3', require: false
 
 # Use Rack CORS for handling Cross-Origin Resource Sharing (CORS), making cross-origin AJAX possible
-gem 'rack-cors', '~> 1.1'
+gem 'rack-cors', '~> 2.0'
 
 group :development, :test do
   # Call 'byebug' anywhere in the code to stop execution and get a debugger console
diff --git a/openc3-ruby/Dockerfile b/openc3-ruby/Dockerfile
@@ -48,6 +48,9 @@ RUN apk update \
   ruby-bigdecimal \
   ruby-io-console \
   ruby-irb \
+  python3 \
+  python3-dev \
+  py3-pip \
   ca-certificates \
   curl \
   libc6-compat \
@@ -56,6 +59,8 @@ RUN apk update \
   git \
   libxml2-dev \
   libxslt-dev \
+  # Ruby 3.2 no longer bundles libyaml so explicitly include it
+  yaml-dev \
   && gem update --system 3.3.14 \
   && gem install rake \
   && gem cleanup \
diff --git a/openc3/Gemfile b/openc3/Gemfile
@@ -9,7 +9,7 @@ gemspec :name => 'openc3'
 # Include the rails gems for the convenience of custom microservice plugins
 gem 'rails', '~> 7.0.0'
 gem 'bootsnap', '>= 1.9.3', require: false
-gem 'rack-cors', '~> 1.1'
+gem 'rack-cors', '~> 2.0'
 gem 'tzinfo-data'
 gem 'rspec-rails', '~> 6.0'
 gem 'simplecov', '~> 0.20'
diff --git a/openc3/lib/openc3.rb b/openc3/lib/openc3.rb
@@ -54,4 +54,4 @@
 # OpenC3 services need to die if something goes wrong so they can be restarted
 require 'thread'
 Thread.abort_on_exception = true
-Thread.report_on_exception = true
+Thread.report_on_exception = true
diff --git a/openc3/lib/openc3/core_ext.rb b/openc3/lib/openc3/core_ext.rb
@@ -23,9 +23,9 @@
 require 'openc3/core_ext/array'
 require 'openc3/core_ext/binding'
 require 'openc3/core_ext/class'
-require 'openc3/core_ext/httpclient'
 require 'openc3/core_ext/openc3_io'
 require 'openc3/core_ext/exception'
+require 'openc3/core_ext/faraday'
 require 'openc3/core_ext/file'
 require 'openc3/core_ext/hash'
 require 'openc3/core_ext/io'
diff --git a/openc3/lib/openc3/core_ext/faraday.rb b/openc3/lib/openc3/core_ext/faraday.rb
@@ -0,0 +1,8 @@
+require 'faraday'
+
+module Faraday
+  class Response
+    # Add an alias of status to code to feel more like httpclient
+    alias code status
+  end
+end
diff --git a/openc3/lib/openc3/io/json_api_object.rb b/openc3/lib/openc3/io/json_api_object.rb
@@ -14,7 +14,7 @@
 # GNU Affero General Public License for more details.
 
 # Modified by OpenC3, Inc.
-# All changes Copyright 2022, OpenC3, Inc.
+# All changes Copyright 2023, OpenC3, Inc.
 # All Rights Reserved
 #
 # This file may also be used under the terms of a commercial license
@@ -30,7 +30,7 @@
 # require 'drb/acl'
 require 'drb/drb'
 require 'uri'
-require 'httpclient'
+require 'faraday'
 
 
 module OpenC3
@@ -115,9 +115,14 @@ def shutdown
 
     def connect
       begin
-        @http = HTTPClient.new
-        @http.connect_timeout = @timeout
-        @http.receive_timeout = nil # Allow long polling
+        # Per https://github.com/lostisland/faraday/blob/main/lib/faraday/options/env.rb
+        # :timeout       - time limit for the entire request (Integer in seconds)
+        # :open_timeout  - time limit for just the connection phase (e.g. handshake) (Integer in seconds)
+        # :read_timeout  - time limit for the first response byte received from the server (Integer in seconds)
+        # :write_timeout - time limit for the client to send the request to the server (Integer in seconds)
+        @http = Faraday.new(request: { open_timeout: @timeout.to_i, read_timeout: nil }) do |f|
+          f.adapter :net_http # adds the adapter to the connection, defaults to `Faraday.default_adapter`
+        end
       rescue => e
         raise JsonApiError, e.message
       end
@@ -216,17 +221,24 @@ def _send_request(method:, endpoint:, kwargs:)
     def _http_request(method:, uri:, kwargs:)
       case method
       when 'get', :get
-        return @http.get(uri, :header => kwargs[:headers], :query => kwargs[:query])
+        return @http.get(uri, kwargs[:query], kwargs[:headers])
       when 'post', :post
-        return @http.post(uri, :header => kwargs[:headers], :query => kwargs[:query], :body => kwargs[:data])
+        return @http.post(uri) do |req|
+          req.params = kwargs[:query]
+          req.headers = kwargs[:headers]
+          req.body = kwargs[:data]
+        end
       when 'put', :put
-        return @http.put(uri, :header => kwargs[:headers], :query => kwargs[:query], :body => kwargs[:data])
+        return @http.put(uri) do |req|
+          req.params = kwargs[:query]
+          req.headers = kwargs[:headers]
+          req.body = kwargs[:data]
+        end
       when 'delete', :delete
-        return @http.delete(uri, :header => kwargs[:headers], :query => kwargs[:query])
+        return @http.delete(uri, kwargs[:query], kwargs[:headers])
       else
         raise JsonApiError, "no method found: '#{method}'"
       end
     end
-
-  end # class JsonApiObject
+  end
 end
diff --git a/openc3/lib/openc3/io/json_drb_object.rb b/openc3/lib/openc3/io/json_drb_object.rb
@@ -14,7 +14,7 @@
 # GNU Affero General Public License for more details.
 
 # Modified by OpenC3, Inc.
-# All changes Copyright 2022, OpenC3, Inc.
+# All changes Copyright 2023, OpenC3, Inc.
 # All Rights Reserved
 #
 # This file may also be used under the terms of a commercial license
@@ -24,7 +24,6 @@
 require 'openc3/io/json_api_object'
 
 module OpenC3
-
   class JsonDRbError < JsonApiError; end
 
   # Used to forward all method calls to the remote server object. Before using
@@ -39,7 +38,6 @@ class JsonDRbError < JsonApiError; end
   #   server.cmd(*args)
   #
   class JsonDRbObject < JsonApiObject
-
     USER_AGENT = 'OpenC3 / v5 (ruby/openc3/lib/io/json_drb_object)'
 
     # @param url [String] The url of openc3-cosmos-cmd-tlm-api http://openc3-cosmos-cmd-tlm-api:2901
@@ -80,7 +78,6 @@ def method_missing(method_name, *method_params, **keyword_params)
 
     private
 
-    #
     def make_request(data:, token: nil)
       token = @authentication.token if @authentication and not token
       if token
@@ -98,7 +95,7 @@ def make_request(data:, token: nil)
       begin
         @log[0] = "Request: #{@uri.to_s} #{USER_AGENT} #{data.to_s}"
         STDOUT.puts @log[0] if JsonDRb.debug?
-        resp = @http.post(@uri, :body => data, :header => headers)
+        resp = @http.post(@uri, data, headers)
         @log[1] = "Response: #{resp.status} #{resp.headers} #{resp.body}"
         @response_data = resp.body
         STDOUT.puts @log[1] if JsonDRb.debug?
@@ -109,7 +106,6 @@ def make_request(data:, token: nil)
       end
     end
 
-    #
     def handle_response(response:)
       # The code below will always either raise or return breaking out of the loop
       if JsonRpcErrorResponse === response
@@ -122,5 +118,5 @@ def handle_response(response:)
         return response.result
       end
     end
-  end # class JsonDRbObject
+  end
 end
diff --git a/openc3/lib/openc3/models/gem_model.rb b/openc3/lib/openc3/models/gem_model.rb
@@ -23,7 +23,6 @@
 require 'fileutils'
 require 'open-uri'
 require 'nokogiri'
-require 'httpclient'
 require 'rubygems'
 require 'rubygems/uninstaller'
 require 'tempfile'
diff --git a/openc3/lib/openc3/script/metadata.rb b/openc3/lib/openc3/script/metadata.rb
@@ -35,7 +35,7 @@ module Script
     def metadata_all(limit: 100, scope: $openc3_scope)
       response = $api_server.request('get', "/openc3-api/metadata", query: { limit: limit }, scope: scope)
       # Non-existant just returns nil
-      return nil if response.nil? || response.code != 200
+      return nil if response.nil? || response.status != 200
       return JSON.parse(response.body, :allow_nan => true, :create_additions => true)
     end
     alias all_metadata metadata_all
@@ -50,7 +50,7 @@ def metadata_get(start: nil, scope: $openc3_scope)
         response = $api_server.request('get', "/openc3-api/metadata/latest", scope: scope)
       end
       # Non-existant just returns nil
-      return nil if response.nil? || response.code != 200
+      return nil if response.nil? || response.status != 200
       return JSON.parse(response.body, :allow_nan => true, :create_additions => true)
     end
     alias get_metadata metadata_get
@@ -70,11 +70,11 @@ def metadata_set(metadata, start: nil, color: nil, scope: $openc3_scope)
       data[:start] = start.iso8601 unless start.nil?
       response = $api_server.request('post', '/openc3-api/metadata', data: data, json: true, scope: scope)
       if response.nil?
-        raise "Failed to set metadata due to #{response.code}"
-      elsif response.code == 409
+        raise "Failed to set metadata due to #{response.status}"
+      elsif response.status == 409
         raise "Metadata overlaps existing metadata. Did you metadata_set within 1s of another?"
-      elsif response.code != 201
-        raise "Failed to set metadata due to #{response.code}"
+      elsif response.status != 201
+        raise "Failed to set metadata due to #{response.status}"
       end
       return JSON.parse(response.body, :allow_nan => true, :create_additions => true)
     end
@@ -101,7 +101,7 @@ def metadata_update(metadata, start: nil, color: nil, scope: $openc3_scope)
       data = { :color => color, :metadata => metadata }
       data[:start] = Time.at(start).iso8601
       response = $api_server.request('put', "/openc3-api/metadata/#{start}", data: data, json: true, scope: scope)
-      if response.nil? || response.code != 200
+      if response.nil? || response.status != 200
         raise "Failed to update metadata"
       end
       return JSON.parse(response.body, :allow_nan => true, :create_additions => true)
diff --git a/openc3/lib/openc3/script/screen.rb b/openc3/lib/openc3/script/screen.rb
@@ -25,7 +25,7 @@ def get_screen_list(scope: $openc3_scope)
         endpoint = "/openc3-api/screens"
         # Pass the name of the ENV variable name where we pull the actual bucket name
         response = $api_server.request('get', endpoint, scope: scope)
-        if response.nil? || response.code != 200
+        if response.nil? || response.status != 200
           raise "Unexpected response to get_screen_list: #{response.inspect}"
         end
         screen_list = {}
@@ -50,7 +50,7 @@ def get_screen_definition(target_name, screen_name, scope: $openc3_scope)
         response = $api_server.request('get', endpoint, headers: {
           Accept: 'text/plain',
         }, scope: scope)
-        if response.nil? || response.code != 200
+        if response.nil? || response.status != 200
           raise "Screen definition not found: #{target_name} #{screen_name}"
         end
         return response.body
@@ -68,7 +68,7 @@ def create_screen(target_name, screen_name, definition, scope: $openc3_scope)
           "text" => definition
         }
         response = $api_server.request('post', endpoint, :data => data, scope: scope)
-        if response.nil? || response.code != 200
+        if response.nil? || response.status != 200
           if response
             parsed = JSON.parse(response)
             raise "create_screen error: #{parsed['error']}"
@@ -86,7 +86,7 @@ def delete_screen(target_name, screen_name, scope: $openc3_scope)
       begin
         endpoint = "/openc3-api/screen/#{target_name.upcase}/#{screen_name.upcase}"
         response = $api_server.request('delete', endpoint, scope: scope)
-        if response.nil? || response.code != 200
+        if response.nil? || response.status != 200
           if response
             parsed = JSON.parse(response)
             raise "delete_screen error: #{parsed['error']}"
diff --git a/openc3/lib/openc3/script/script_runner.rb b/openc3/lib/openc3/script/script_runner.rb
diff --git a/openc3/lib/openc3/script/storage.rb b/openc3/lib/openc3/script/storage.rb
diff --git a/openc3/lib/openc3/topics/topic.rb b/openc3/lib/openc3/topics/topic.rb
diff --git a/openc3/lib/openc3/utilities/authentication.rb b/openc3/lib/openc3/utilities/authentication.rb
diff --git a/openc3/lib/openc3/utilities/open_telemetry.rb b/openc3/lib/openc3/utilities/open_telemetry.rb
diff --git a/openc3/lib/openc3/utilities/ruby_lex_utils.rb b/openc3/lib/openc3/utilities/ruby_lex_utils.rb
diff --git a/openc3/lib/openc3/utilities/store_autoload.rb b/openc3/lib/openc3/utilities/store_autoload.rb
diff --git a/openc3/openc3.gemspec b/openc3/openc3.gemspec
diff --git a/scripts/release/package_audit.rb b/scripts/release/package_audit.rb
diff --git a/scripts/release/package_audit_lib.rb b/scripts/release/package_audit_lib.rb
