feat(bridge): wire BRIDGE interface keywords and DEFAULT bridge per scope by ryanmelt · Pull Request #3697 · OpenC3/cosmos

ryanmelt · 2026-08-10T18:33:16Z

Stacked PR 4 of 5 — base: pr3-bridge-runtime (#3696). Part of the #3688 split. Needs PR 2 + 3.

Wires the bridge into interface configuration:

New keywords: BRIDGE, BRIDGE_OPTION, BRIDGE_PROTOCOL, BRIDGE_SECRET
deploy_bridge / undeploy_bridge on the interface model
DEFAULT bridge per scope (migration 20260704000000_default_bridge.rb + scope_model)
interface_modifiers.yaml docs

Tests

Has the only tests in the series (interface_model_spec, scope_model_spec, interface_docs_spec). Also updates two Playwright admin tests, which start failing here because the DEFAULT bridge now adds a secret + microservice to the demo (row-scoped locators instead of positional).

Review after #3696.

🤖 Generated with Claude Code

codecov · 2026-08-10T18:38:25Z

Codecov Report

❌ Patch coverage is 76.66667% with 14 lines in your changes missing coverage. Please review.
✅ Project coverage is 79.28%. Comparing base (1d9b428) to head (e4bf403).

Files with missing lines	Patch %	Lines
openc3/lib/openc3/models/interface_model.rb	72.54%	14 Missing ⚠️

Additional details and impacted files

@@                  Coverage Diff                   @@
##           pr3-bridge-runtime    #3697      +/-   ##
======================================================
- Coverage               79.31%   79.28%   -0.03%     
======================================================
  Files                     885      887       +2     
  Lines                   65368    65511     +143     
  Branches                 2585     2537      -48     
======================================================
+ Hits                    51845    51941      +96     
- Misses                  12852    12897      +45     
- Partials                  671      673       +2

Flag	Coverage Δ
frontend	`63.51% <ø> (-0.14%)`	⬇️
python	`81.53% <ø> (+<0.01%)`	⬆️
ruby-api	`82.18% <ø> (-0.09%)`	⬇️
ruby-backend	`84.05% <76.66%> (-0.03%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

…cope Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

sonarqubecloud · 2026-08-10T23:19:26Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

ryan-pratt · 2026-08-17T20:36:18Z

+  python_example: |
+    INTERFACE DATA_INT openc3/interfaces/tcpip_client_interface.py host.docker.internal 8080 8081 10.0 nil BURST
+      MAP_TARGET DATA
+      PROTOCOL READ openc3/interfaces/protocols/ignore_packet_protocol.py INST IMAGE # Drop all INST IMAGE packets


BRIDGE_PROTOCOL READ

ryan-pratt · 2026-08-17T20:38:35Z

+  since: 7.4.0
+  parameters:
+    - name: Bridge Name
+      required: false


ryan-pratt · 2026-08-17T20:46:10Z

+        name = "#{scope}__BRIDGE__DEFAULT"
+        next if MicroserviceModel.get_model(name: name, scope: scope)
+
+        BridgeModel.build_microservice(bridge_name: "DEFAULT", scope: scope, shard: scope_model.shard).create


Does this also need to call deploy()? That's what ScopeModel does here

ryan-pratt · 2026-08-17T20:49:21Z

+    # removed. Leaving the model untouched lets the relay adapt live instead.
+    def deploy_bridge_relay
+      relay = MicroserviceModel.get_model(name: bridge_relay_name, scope: @scope)
+      raise "Bridge #{@bridge_name} does not exist" unless relay


I think this causes orphaned data in redis if not caught up by the caller for explicit cleanup

ryan-pratt · 2026-08-17T20:51:12Z

-
-    it "should have Ruby / Python parity" do
-      ruby_not_python = @ruby_interfaces - @python_interfaces - PYTHON_TODO_INTERFACES
-      expect(ruby_not_python).to be_empty, "Interfaces found in Ruby but not Python: #{ruby_not_python}"
-      python_not_ruby = @python_interfaces - @ruby_interfaces - %w(__init__)
-      expect(python_not_ruby).to be_empty, "Interfaces found in Python but not Ruby: #{python_not_ruby}"
-    end


Idk if we want to remove this entirely... Probably warrants a discussion

We don't want to remove this ... not yet. Simply add bridge_interface to the list at line 77

jmthomas · 2026-08-17T22:47:17Z

+    received by the interface while write acts on the data before it is sent out. READ_WRITE applies
+    the protocol to both reading and writing.<br/><br/>
+    For information on creating your own custom protocol please see [Protocols](../configuration/protocols.md)
+  since: 7.4.0


Throughout: Replace with since: _Coming Soon_ which will be updated on release

jmthomas · 2026-08-17T22:49:59Z

+
+      when 'BRIDGE'
+        parser.verify_num_parameters(1, 1, "#{keyword} <Bridge Name>")
+        @bridge_name = parameters[0]


Should normalize the name to upper case. Also options: [['BRIDGE_NAME', bridge_name.to_s.upcase]] in build_microservice.

jmthomas · 2026-08-17T22:53:19Z

+        relay = MicroserviceModel.get_model(name: "DEFAULT__BRIDGE__MYBRIDGE", scope: "DEFAULT")
+        expect(relay).to_not be_nil
+        expect(relay.cmd[1]).to eql "bridge_microservice.py"
+        expect(relay.options).to include(["BRIDGE_NAME", "mybridge"])


"mybridge" => "MYBRIDGE"

jmthomas · 2026-08-17T22:58:06Z

+        @target_names.each { |target_name| ensure_target_exists(target_name) }
+        microservice.create
+        microservice.deploy(gem_path, variables)
+        deploy_bridge_relay


This isn't actually deploying anything ... it's checking that the MicroserviceModel exists. Safe to do in the validate case and should be done before creating the microservice (see ryan-pratt comment).

Maybe the ensure_target_exists should also move outside the validate_only check?

jmthomas · 2026-08-17T23:01:52Z

+    # the connection options and secrets needed to open the device are included.
+    def deploy_host_microservice
+      host = HostMicroserviceModel.new(
+        name: @name,


Interface and router could share the same name and overwrite each other. We should probably just disallow this at a higher level because I don't think we account for that anywhere.

jmthomas · 2026-08-17T23:06:24Z

+            # connection options/secret_options belong to the host interface and
+            # are omitted, but protocols and target mapping stay in COSMOS.


How are those options omitted? I see lines 197 and 199 iterating over the options and secret_options.

jmthomas · 2026-08-17T23:07:43Z

-
-    it "should have Ruby / Python parity" do
-      ruby_not_python = @ruby_interfaces - @python_interfaces - PYTHON_TODO_INTERFACES
-      expect(ruby_not_python).to be_empty, "Interfaces found in Ruby but not Python: #{ruby_not_python}"
-      python_not_ruby = @python_interfaces - @ruby_interfaces - %w(__init__)
-      expect(python_not_ruby).to be_empty, "Interfaces found in Python but not Ruby: #{python_not_ruby}"
-    end


We don't want to remove this ... not yet. Simply add bridge_interface to the list at line 77

jmthomas · 2026-08-17T23:14:07Z

+      MAP_TARGET DATA
+      PROTOCOL READ openc3/interfaces/protocols/ignore_packet_protocol.py INST IMAGE # Drop all INST IMAGE packets
+BRIDGE_OPTION:
+  summary: Set a parameter on an bridge interface


on a bridge

jmthomas · 2026-08-17T23:14:26Z

+BRIDGE_OPTION:
+  summary: Set a parameter on an bridge interface
+  description:
+    When an bridge option is set the bridge interface class calls the set_option method.


When a bridge

jmthomas · 2026-08-17T23:15:57Z

+      required: false
+      description: Name of the secret store for stores with multipart keys
+      values: .*
+  example: |


Include the same context as BRIDGE_OPTION

ryanmelt mentioned this pull request Aug 10, 2026

feat(bridge): add bridges REST API, admin UI, and CLI enrollment #3698

Open

ryanmelt requested review from jmthomas, mcosgriff and ryan-pratt August 10, 2026 18:35

ryanmelt force-pushed the pr4-interface-wiring branch from 84b8e09 to 013b3f9 Compare August 10, 2026 19:51

feat(bridge): wire BRIDGE interface keywords and DEFAULT bridge per s…

e4bf403

…cope Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

ryanmelt force-pushed the pr4-interface-wiring branch from 013b3f9 to e4bf403 Compare August 10, 2026 23:17

ryan-pratt reviewed Aug 17, 2026

View reviewed changes

ryan-pratt requested changes Aug 17, 2026

View reviewed changes

jmthomas requested changes Aug 17, 2026

View reviewed changes

		# connection options/secret_options belong to the host interface and
		# are omitted, but protocols and target mapping stay in COSMOS.

Uh oh!

Conversation

ryanmelt commented Aug 10, 2026

Tests

Uh oh!

codecov Bot commented Aug 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

sonarqubecloud Bot commented Aug 10, 2026

Quality Gate passed

Uh oh!

ryan-pratt Aug 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

codecov Bot commented Aug 10, 2026 •

edited

Loading

ryan-pratt Aug 17, 2026 •

edited

Loading