App store API updates #2497

ryan-pratt · 2025-10-31T19:55:06Z

Update to new store API version
Plugin installs check for minimum cosmos version defined in gemspec
Add app store API key support for enterprise plugins

See also: https://github.com/OpenC3/app-store/pull/41

codecov · 2025-10-31T19:56:20Z

Codecov Report

❌ Patch coverage is 26.31579% with 42 lines in your changes missing coverage. Please review.
✅ Project coverage is 79.19%. Comparing base (31e88bd) to head (d35264e).
⚠️ Report is 9 commits behind head on main.

Files with missing lines	Patch %	Lines
...-cmd-tlm-api/app/controllers/plugins_controller.rb	20.00%	32 Missing ⚠️
openc3/lib/openc3/models/plugin_store_model.rb	16.66%	10 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2497      +/-   ##
==========================================
- Coverage   79.23%   79.19%   -0.05%     
==========================================
  Files         670      670              
  Lines       54182    54225      +43     
  Branches      734      734              
==========================================
+ Hits        42930    42941      +11     
- Misses      11172    11204      +32     
  Partials       80       80

Flag	Coverage Δ
python	`81.01% <ø> (+0.01%)`	⬆️
ruby-api	`83.61% <20.00%> (-0.60%)`	⬇️
ruby-backend	`82.21% <41.17%> (-0.01%)`	⬇️

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

☔ View full report in Codecov by Sentry.
📢 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.

jmthomas

Makes sense. What does this actually look like in the gemspec? Something like:

s.openc3_cosmos_minimim_version = '6.0.0'

Does it support a version like 6.0 or just 6?

ryan-pratt · 2025-11-03T17:21:38Z

@jmthomas You set it with the other app store properties like this:

s.metadata = {
    "openc3_cosmos_minimum_version" => "6.9.0",
    "openc3_store_title" => "Video Player",
    "openc3_store_description" => "This plugin provides COSMOS with an integrated video player capable of playing back most common video file types, as well as HLS streams. Included is the top-level tool and a widget that can be used in TlmViewer screens.",
    "openc3_store_keywords" => "video, streaming",
    "openc3_store_image" => "public/store_img.png"
}

It has to be a valid semver string, so you have to specify all three digits (6.0.0). It does support the -beta0 stuff we do for development, though

ryan-pratt · 2025-11-14T18:16:58Z

Do not merge until after the next App Store deployment (ETA: 11/24 - 11/26).

The app store changes that this depends on have been merged, but the infra needed for their prod deployment has not been set up yet.

jmthomas · 2025-12-03T17:05:12Z

openc3-cosmos-cmd-tlm-api/app/controllers/plugins_controller.rb

-      original_filename = File.basename(store_data['gem_url'])

+      # Try to find the correct hostname (in case it's localhost and needs to be host.docker.internal)
+      adjusted_gem_url = check_localhost_reachability(store_data['gem_url'], params[:store_id])


Why would a app store author publish a gem with a URL of localhost? That doesn't really make sense right? Don't we require these to be available at Rubygems or some internal repo like artifactory?

Being able to self-host the store is one of its requirements, so gems might be at localhost

ryan-pratt · 2026-01-05T20:38:14Z

Added API key support for Enterprise/allowlist plugins and caught this up with recent app store changes. Ready for re-review

jmthomas

Changes look good but I'm not sure why I'm getting the "Plugin Store Error" when I try to connect.

jmthomas · 2026-01-06T16:17:32Z

openc3-cosmos-cmd-tlm-api/app/controllers/plugins_controller.rb

+    api_key_setting = OpenC3::SettingModel.get(name: 'store_api_key', scope: 'DEFAULT')
+    api_key = api_key_setting['data'] if api_key_setting
+
+    test_url = "http://#{uri.host}:#{uri.port}/api/v1.1/cosmos_plugins/#{store_id}"


This is for deploying your own app store? How / where will this be documented?

It will be documented when we open source the app store

jmthomas · 2026-01-06T16:20:42Z

openc3-cosmos-init/plugins/packages/openc3-vue-common/src/plugins/plugin-store/PluginProps.js


-const settingName = 'store_url'
+const SETTING_NAME = 'store_url'
+const DEFAULT_STORE_URL = 'https://store.openc3.com'


When I run this branch I get the following when browsing the app store: Error contacting plugin store at https://store.openc3.com (status: 404)

Works now that the app store is launched

jmthomas · 2026-01-06T16:21:56Z

openc3-cosmos-init/plugins/packages/openc3-vue-common/src/plugins/plugin-store/PluginProps.js

    image_url: String, // Set for app store plugins
    licenses: Array,
    // rating: Number,
    // downloads: Number,


What is with all the commented out fields here?

Features that were in the proof of concept, and will be implemented for real later

jmthomas · 2026-01-06T16:24:05Z

...it/plugins/packages/openc3-vue-common/src/plugins/plugin-store/PluginStoreSettingsDialog.vue

+        settings with the
+        <v-icon icon="mdi-cog" size="small" /> icon and paste your API key into
+        the API key field.
+      </v-card-text>


Is this all implemented in the App Store?

jmthomas · 2026-01-06T16:26:57Z

openc3/lib/openc3/models/plugin_model.rb

        'name' => @name,
        'variables' => @variables,
        'plugin_txt_lines' => @plugin_txt_lines,
+        'minimum_cosmos_version' => @minimum_cosmos_version,


Does this need a migration to support adding this field or I assume if it is nil we just ignore it.

If it's nil, we ignore it (assume minimum version of 5.0.0)

ryan-pratt requested review from jmthomas and ryanmelt October 31, 2025 19:55

jmthomas approved these changes Oct 31, 2025

View reviewed changes

jmthomas approved these changes Dec 3, 2025

View reviewed changes

ryan-pratt force-pushed the feat/store-gem-updates branch from 5d1a022 to d7bc517 Compare December 24, 2025 20:55

ryan-pratt force-pushed the feat/store-gem-updates branch from d7bc517 to 58363ce Compare January 5, 2026 20:35

ryan-pratt requested a review from jmthomas January 5, 2026 20:36

jmthomas approved these changes Jan 6, 2026

View reviewed changes

ryanmelt approved these changes Jan 9, 2026

View reviewed changes

ryan-pratt force-pushed the feat/store-gem-updates branch 2 times, most recently from d29b01c to 34c4275 Compare January 15, 2026 21:35

jmthomas approved these changes Jan 15, 2026

View reviewed changes

ryan-pratt added 7 commits January 16, 2026 12:04

better handling for store errors

6891cda

add minimum cosmos version for plugins

5f51106

fix model spec

80451e8

Add app store api key support

2be2ea0

Add alert for API key

c6d9552

Add app store info to demo plugin

36d2ab5

Fix plugin model tests for app store changes

95ab110

ryan-pratt force-pushed the feat/store-gem-updates branch from 6952b5b to 95ab110 Compare January 16, 2026 19:04

Fix bug with plugin store errors

d35264e

ryan-pratt merged commit 18ca89d into main Jan 16, 2026
46 of 47 checks passed

ryan-pratt deleted the feat/store-gem-updates branch January 16, 2026 21:40

App store API updates #2497

App store API updates #2497

Conversation

ryan-pratt commented Oct 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov bot commented Oct 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

jmthomas left a comment

Choose a reason for hiding this comment

Uh oh!

ryan-pratt commented Nov 3, 2025

Uh oh!

ryan-pratt commented Nov 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ryan-pratt Dec 24, 2025 • 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!

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

Uh oh!

Uh oh!

jmthomas left a comment

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!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

ryan-pratt commented Oct 31, 2025 •

edited

Loading

codecov bot commented Oct 31, 2025 •

edited

Loading

ryan-pratt commented Nov 14, 2025 •

edited

Loading

ryan-pratt Dec 24, 2025 •

edited

Loading

ryan-pratt commented Jan 5, 2026 •

edited

Loading