Replace Webpack with Vite #1728

ryanmelt · 2024-11-28T02:05:31Z

No description provided.

This is a workaround so that `yarn serve` works like how it did in COSMOS 5. Eventually, we should try to figure out why the vite dev server isn't working how it's supposed to

This was effectively a polyfil for async js code. I removed it from index.html a little bit ago but forgot to remove it everywhere else

…ts. Make main.js default

codecov · 2024-11-28T02:06:54Z

Codecov Report

Attention: Patch coverage is 38.88889% with 11 lines in your changes missing coverage. Please review.

Project coverage is 76.28%. Comparing base (29cd729) to head (bdfeda3).
Report is 39 commits behind head on main.

Files with missing lines	Patch %	Lines
...os-cmd-tlm-api/app/controllers/tools_controller.rb	0.00%	7 Missing ⚠️
openc3/lib/openc3/models/tool_model.rb	50.00%	3 Missing ⚠️
.../app/controllers/script_autocomplete_controller.rb	75.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1728      +/-   ##
==========================================
- Coverage   76.30%   76.28%   -0.03%     
==========================================
  Files         603      602       -1     
  Lines       46103    46088      -15     
  Branches      844      844              
==========================================
- Hits        35180    35157      -23     
- Misses      10827    10834       +7     
- Partials       96       97       +1

Flag	Coverage Δ
python	`84.01% <ø> (+0.03%)`	⬆️
ruby-api	`48.60% <27.27%> (-0.11%)`	⬇️
ruby-backend	`82.13% <57.14%> (-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.

jmthomas

Mostly questions and clarifications. Look forward to a faster build and better support going foward with vite!

jmthomas · 2024-12-02T18:02:10Z

docs.openc3.com/docusaurus-plugin.config.js

@@ -17,6 +17,10 @@ const config = {
  tagline: 'OpenC3 COSMOS Documentation',
  favicon: 'img/favicon.png',

+  future: {
+    experimental_faster: true,
+  },


This makes the build faster?

Yep. See the Docusaurus 3.6 release notes.

jmthomas · 2024-12-02T18:03:29Z

examples/hostinstall/centos7/openc3_install_openc3.sh

@@ -52,7 +52,7 @@ GEMS="$SCRIPT_DIR/../../../openc3-cosmos-init/plugins/gems/"
 OPENC3_RELEASE_VERSION=5.21.0-beta0

 mkdir -p ${GEMS}
-cd ${PLUGINS}openc3-tool-base && yarn install && yarn run build && rake build VERSION=${OPENC3_RELEASE_VERSION} && mv *.gem ${GEMS}
+cd ${PLUGINS}packages/openc3-tool-base && yarn run build && rake build VERSION=${OPENC3_RELEASE_VERSION} && mv *.gem ${GEMS}


Are we planning on deleting this hostinstall example?

I thought you already did that?
If not, then yes I want that removed for the 6.0 release.

jmthomas · 2024-12-02T18:04:50Z

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

        elsif item['data_type'] == 'STRING'
-          default = "'#{item['default']}'" || ''
+          default = "'#{item['default']}'"


Was this to address a specific issue with BLOCK vs STRING?

That or never did anything so I removed it.

jmthomas · 2024-12-02T18:07:00Z

openc3-cosmos-init/plugins/packages/openc3-cosmos-demo/package.json

-    "@openc3/tool-common": "5.21.0-beta0",
-    "vue": "3.5.4",
-    "vuetify": "3.7.1"
+    "@openc3/tool-common": "5.21.0-beta0"


vue and vuetify go away because they're externals now?

jmthomas · 2024-12-02T18:08:27Z

openc3-cosmos-init/plugins/packages/openc3-cosmos-demo/vite-BigWidget.config.js

+  resolve: {
+    extensions: [...DEFAULT_EXTENSIONS, '.vue'], // not recommended but saves us from having to change every SFC import
+  },
+})


Do we need to generate this vite config file now?

We should make a note to update all the templates to match the new Vue, Vuetify, and Vite syntax

jmthomas · 2024-12-02T18:14:10Z

openc3-cosmos-init/plugins/packages/openc3-tool-base/src/main.js


 defineCustomElements()

+Object.getPrototypeOf(System).firstGlobalProp = true;


What does this do?

I don't remember the technical details, but it has to do with making systemjs work with Vue 3 since there's no global Vue anymore like there was with Vue 2. Vue 3 is just a module import

systemjs/systemjs#2272

jmthomas · 2024-12-02T18:16:06Z

openc3-cosmos-init/plugins/packages/openc3-tool-base/src/router.js

    },
  ],
 })

 router.beforeEach(({ path }) => {
  if (['/', '/tools', '/tools/'].includes(path)) {
-    navigateToUrl(DEFAULT_TOOL_PATH)
+    singleSpaNavigate(DEFAULT_TOOL_PATH)


AppNav.vue does a bunch of navigateToUrl ... does it also need to change to singleSpaNavigate?

As far as I understand, they are interchangeable. It's just navigateToUrl has to be imported while singleSpaNavigate is just added as a global via the window object. I had changed them from singleSpaNavigate to navigateToUrl during the initial vue 3 migration stuff (while I was trying to get single-spa actually working), but that change should just be vestigial by now.

https://single-spa.js.org/docs/api/#navigatetourl

jmthomas · 2024-12-02T18:21:44Z

openc3/data/config/tool.yaml

@@ -82,3 +82,15 @@ TOOL:
          required: false
          description: Regex to match against filenames. If match, then no ERB processing
          values: .+
+    IMPORT_MAP_ITEM:
+      summary: Add an item to the import map


Can I get a description with a little more information about when and why this is needed?
"Needed for custom tools because ..."

This isn't currently needed. It will be needed when we go to a single import map to support ESM modules, but for now its just a neato feature that noone will use.

Ok ... let's remember to update the docs when we get to that point!

jmthomas · 2024-12-02T18:23:59Z

openc3/python/openc3/models/interface_model.py

@@ -138,6 +139,9 @@ def __init__(
        self.env = {} if env is None else env
        self.container = container
        self.prefix = prefix
+        self.shard = shard
+        if self.shard is None:
+            self.shard = 0


Does this shard stuff need migrations?

No. It is upgrade safe.

jmthomas · 2024-12-02T18:27:49Z

openc3/python/openc3/models/microservice_model.py

-                    parser,
-                    f"Unknown keyword and parameters for Microservice: {keyword} {' '.join(parameters)}",
-                )
-        return None


Only the Ruby code processes the microservice model via the plugin_model. This must have been during my port everything to Python activity!

sonarqubecloud · 2024-12-03T17:02:18Z

Quality Gate passed

Issues
13 New issues
0 Accepted issues

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

See analysis details on SonarQube Cloud

ryan-pratt and others added 23 commits November 13, 2024 16:07

starting to get things working on vite

0cfb18b

fix up vite things

2783eab

migrate the rest of the tools to vite except admin

783c2e4

migrate admin to vite

f57e0a2

fix graph styles and widgets

9b399f6

partial work migrating demo to vite

5be3a76

partial work

9ca6513

change from base to base_url

63dc5a1

Add dev server plugin

7a22ffa

This is a workaround so that `yarn serve` works like how it did in COSMOS 5. Eventually, we should try to figure out why the vite dev server isn't working how it's supposed to

Merge branch 'vite-serve' into vite

9e432b7

Vite with working externals

88d8ca5

Single import map

19ba780

Fix module syntax for notify plugin

f389120

Include index-allow-http.html in build

95b1e1b

Fix rux component warnings

8cd2e4f

Remove regenerator-runtime

1a60377

This was effectively a polyfil for async js code. I removed it from index.html a little bit ago but forgot to remove it everywhere else

Add single-spa to externals. Add index to public. Adjust index conten…

b96a7f8

…ts. Make main.js default

compile base like other tools

d4dddaf

Fix hash use on chunks and assets

f545a6c

Move openc3-tool-base into packages like everything else

703b705

Properly external vuetify

f8823a0

Merge branch 'main' into vite

1c8a3c4

Finish externalize vuetify

9edee64

ryanmelt requested review from jmthomas and ryan-pratt November 28, 2024 02:05

ryanmelt added 4 commits November 27, 2024 22:47

fix vue warnings. Switch to production vue by default

d379d5b

Address CICD issues

6f4e56b

fix spelling action

6fd3a0c

Merge branch 'main' into vite

9941b5f

ryanmelt added 3 commits November 28, 2024 21:47

Add shard to python models. Remove python microservice config handling

8b00a5d

Fix ruff

eb54aa8

docusaurus 3.6

66af742

jmthomas approved these changes Dec 2, 2024

View reviewed changes

ryan-pratt approved these changes Dec 3, 2024

View reviewed changes

import lodash. remove comment

bdfeda3

ryanmelt merged commit 463ca20 into main Dec 3, 2024
27 of 28 checks passed

ryanmelt deleted the vite branch December 3, 2024 19:09

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Replace Webpack with Vite #1728

Replace Webpack with Vite #1728

ryanmelt commented Nov 28, 2024

codecov bot commented Nov 28, 2024 •

edited

Loading

jmthomas left a comment

jmthomas Dec 2, 2024

ryanmelt Dec 3, 2024

jmthomas Dec 2, 2024

ryanmelt Dec 3, 2024

jmthomas Dec 2, 2024

ryanmelt Dec 3, 2024

jmthomas Dec 2, 2024

ryanmelt Dec 3, 2024

jmthomas Dec 2, 2024

ryanmelt Dec 3, 2024

jmthomas Dec 3, 2024

jmthomas Dec 2, 2024

ryan-pratt Dec 3, 2024

jmthomas Dec 2, 2024

ryan-pratt Dec 3, 2024

jmthomas Dec 2, 2024

ryanmelt Dec 3, 2024

jmthomas Dec 3, 2024

jmthomas Dec 2, 2024

ryanmelt Dec 3, 2024

jmthomas Dec 2, 2024

sonarqubecloud bot commented Dec 3, 2024


		defineCustomElements()

		Object.getPrototypeOf(System).firstGlobalProp = true;

Replace Webpack with Vite #1728

Replace Webpack with Vite #1728

Conversation

ryanmelt commented Nov 28, 2024

codecov bot commented Nov 28, 2024 • edited Loading

Codecov Report

jmthomas left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sonarqubecloud bot commented Dec 3, 2024

Quality Gate passed

codecov bot commented Nov 28, 2024 •

edited

Loading