refactor: migrate to ESM #7331

LeoDog896 · 2023-12-29T23:45:06Z

Closes

Describe your changes:

Fixes #7330 (and continues the spirit of https://github.com/nasa/openmct/tree/esm), to hopefully unblock a few pending issues. I'm opening this now to test its effects on CI as I work on this. Import transformations were done via codemods 👍

All Submissions:

Have you followed the guidelines in our Contributing document?
Have you checked to ensure there aren't other open Pull Requests for the same update/change?
Is this change backwards compatible? For example, developers won't need to change how they are calling the API or how they've extended core plugins such as Tables or Plots.

Author Checklist

Changes address original issue?
Tests included and/or updated with changes?
Has this been smoke tested?
Have you associated this PR with a type: label? Note: this is not necessarily the same as the original issue.
Have you associated a milestone with this PR? Note: leave blank if unsure.
Is this a breaking change to be called out in the release notes?
Testing instructions included in associated issue OR is this a dependency/testcase change?

Reviewer Checklist

Changes appear to address issue?
Reviewer has tested changes by following the provided instructions?
Changes appear not to be breaking changes?
Appropriate automated tests included?
Code style and in-line documentation are appropriate?

this is where the fun begins

codecov · 2023-12-30T01:47:55Z

Codecov Report

Attention: 10 lines in your changes are missing coverage. Please review.

Comparison is base (68e60e3) 55.74% compared to head (d8a91e9) 55.65%.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #7331      +/-   ##
==========================================
- Coverage   55.74%   55.65%   -0.10%     
==========================================
  Files         656      656              
  Lines       26194    26192       -2     
  Branches     2546     2546              
==========================================
- Hits        14602    14576      -26     
- Misses      10890    10918      +28     
+ Partials      702      698       -4

Flag	Coverage Δ
e2e-full	`41.04% <ø> (-0.08%)`	⬇️
e2e-stable	`58.09% <ø> (-0.03%)`	⬇️
unit	`48.75% <52.38%> (-0.09%)`	⬇️

Files	Coverage Δ
example/dataVisualization/plugin.js	`100.00% <ø> (ø)`
example/eventGenerator/plugin.js	`100.00% <ø> (ø)`
example/exampleUser/ExampleUserProvider.js	`88.46% <ø> (ø)`
example/exampleUser/plugin.js	`100.00% <ø> (ø)`
example/faultManagement/exampleFaultSource.js	`30.76% <ø> (ø)`
example/generator/GeneratorProvider.js	`93.10% <ø> (ø)`
example/generator/plugin.js	`90.00% <ø> (ø)`
openmct.js	`100.00% <ø> (ø)`
src/MCT.js	`96.96% <ø> (ø)`
src/api/actions/ActionsAPI.js	`96.15% <ø> (ø)`
... and 135 more

... and 6 files with indirect coverage changes

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 68e60e3...d8a91e9. Read the comment docs.

this was manual. I'm committing this because I'm about to try the `cjstoesm` tool

e2e/playwright-ci.config.js

@@ -3,7 +3,7 @@
 // @ts-check

 // eslint-disable-next-line no-unused-vars
-const { devices } = require('@playwright/test');
+import { devices } from '@playwright/test';


e2e/playwright-watch.config.js

@@ -3,7 +3,7 @@
 // @ts-check

 // eslint-disable-next-line no-unused-vars
-const { devices } = require('@playwright/test');
+import { devices } from '@playwright/test';


e2e/tests/functional/plugins/clocks/remoteClock.e2e.spec.js

e2e/tests/functional/plugins/importAndExportAsJSON/exportAsJson.e2e.spec.js

e2e/tests/functional/plugins/importAndExportAsJSON/importAsJson.e2e.spec.js

e2e/tests/functional/plugins/clocks/remoteClock.e2e.spec.js

@@ -22,7 +22,7 @@

 // FIXME: Remove this eslint exception once tests are implemented
 // eslint-disable-next-line no-unused-vars
-const { test, expect } = require('../../../../baseFixtures');
+import { expect, test } from '../../../../baseFixtures.js';


e2e/tests/functional/plugins/importAndExportAsJSON/importAsJson.e2e.spec.js

@@ -26,7 +26,7 @@

 // FIXME: Remove this eslint exception once tests are implemented
 // eslint-disable-next-line no-unused-vars
-const { test, expect } = require('../../../../baseFixtures');
+import { expect, test } from '../../../../baseFixtures.js';


e2e/tests/functional/plugins/importAndExportAsJSON/exportAsJson.e2e.spec.js

@@ -26,7 +26,7 @@

 // FIXME: Remove this eslint exception once tests are implemented
 // eslint-disable-next-line no-unused-vars
-const { test, expect } = require('../../../../baseFixtures');
+import { expect, test } from '../../../../baseFixtures.js';


e2e/helper/faultUtils.js

e2e/helper/notebookUtils.js

deploysentinel · 2023-12-30T04:36:25Z

Current Playwright Test Results Summary

✅ 166 Passing - ⚠️ 5 Flaky

Run may still be in progress, this comment will be updated as current testing workflow or job completes...

(Last updated on 12/31/2023 04:23:35am UTC)

Run Details

Running Job e2e-stable on CircleCI

Commit: d8a91e9

Started: 12/31/2023 04:18:51am UTC

⚠️ Flakes

📄 functional/plugins/telemetryTable/telemetryTable.e2e.spec.js • 1 Flake

Test Case Results

Test Case	Last 7 days Failures	Last 7 days Flakes
Telemetry Table unpauses and filters data when paused by button and user changes bounds Retry 1 • Initial Attempt	5.71% (2) 2 / 35 runs failed over last 7 days	14.29% (5) 5 / 35 runs flaked over last 7 days

📄 functional/plugins/plot/logPlot.e2e.spec.js • 1 Flake

Test Case Results

Test Case	Last 7 days Failures	Last 7 days Flakes
Log plot tests Log Plot ticks are functionally correct in regular and log mode and after refresh Retry 1 • Initial Attempt	0% (0) 0 / 44 runs failed over last 7 days	25% (11) 11 / 44 runs flaked over last 7 days

📄 functional/plugins/notebook/restrictedNotebook.e2e.spec.js • 2 Flakes

Top 1 Common Error Messages

`null`	2 Test Cases Affected

Test Case Results

Test Case	Last 7 days Failures	Last 7 days Flakes
Restricted Notebook with a page locked and with an embed @addinit Allows embeds to be deleted if page unlocked @addinit Retry 1 • Initial Attempt	0% (0) 0 / 36 runs failed over last 7 days	50% (18) 18 / 36 runs flaked over last 7 days
Restricted Notebook with a page locked and with an embed @addinit Disallows embeds to be deleted if page locked @addinit Retry 1 • Initial Attempt	2.78% (1) 1 / 36 run failed over last 7 days	66.67% (24) 24 / 36 runs flaked over last 7 days

📄 functional/planning/timelist.e2e.spec.js • 1 Flake

Test Case Results

Test Case	Last 7 days Failures	Last 7 days Flakes
Time List Create a Time List, add a single Plan to it and verify all the activities are displayed with no milliseconds Retry 1 • Initial Attempt	5.56% (2) 2 / 36 runs failed over last 7 days	55.56% (20) 20 / 36 runs flaked over last 7 days

View Detailed Build Results

LeoDog896 · 2023-12-30T17:26:32Z

I have no clue why that test is failing - and it's definitely not flaky, I can reproduce the same behavior locally. I probably made a mistake when converting. I'll look through this

karma.conf.cjs

src/plugins/plugins.js

unlikelyzero

This looks great. This is amazing work. In terms of review, everything looks correct.

We will need to review the impact this will have to projects which treat open mct as a npm dependency and also build it from source (like akhenry/openmct-yamcs)

LeoDog896 · 2023-12-31T18:00:59Z

We will need the impact this will have to projects which treat open mct as a npm dependency and also build it from source (like akhenry/openmct-yamcs)

I didn't quite think of that - it does modify the openmct.js entry file, so this is technically a breaking change if they use that file.

EDIT: However, if they use dist, there isn't any impact.

ozyx · 2023-12-31T18:37:28Z

I'll go ahead and do some cursory testing against some of the consuming projects.

ozyx

Everything looks great! Tested this against some projects that use Open MCT as a dependency and everything just works. Thank you so much for taking this on! 🚀🚀🚀

e2e/README.md

e2e/appActions.js

LeoDog896 added 7 commits December 29, 2023 15:02

refactor: move package.json to type: module

c7a3942

this is where the fun begins

chore: move webpack common and prod to esm

b6fc686

chore: move webpack to esm, eslint to explicit cjs

03343d3

refactor: migrate all files to esm

6c89fb5

style: lint

7f7d5b1

refactor: begin moving karma to cjs, use dynamic esm import

f5b1cd9

refactor: move index-test to cjs

f39d6c6

LeoDog896 added 2 commits December 29, 2023 21:04

refactor: begin moving e2e to ESM

3b6b6db

this was manual. I'm committing this because I'm about to try the `cjstoesm` tool

refactor: move all to esm

ac55e7b

github-advanced-security bot found potential problems Dec 30, 2023

View reviewed changes

fix: make all e2e tests use .js imports

4b154fb

github-advanced-security bot found potential problems Dec 30, 2023

View reviewed changes

LeoDog896 added 5 commits December 29, 2023 22:07

refactor: begin moving exports to esm

12905bd

refactor: use URL transforms instead of __dirname

a8348fe

fix: use libraryExport: default to properly handle openmct

0dc0132

fix: export all playwright configs as modules

b0a5c9a

refactor: move all instances of __dirname to import.meta.url

6a4a4a1

github-advanced-security bot found potential problems Dec 30, 2023

View reviewed changes

e2e/helper/faultUtils.js Fixed Show resolved Hide resolved

e2e/helper/notebookUtils.js Fixed Show resolved Hide resolved

refactor: lint, drop unnecessary URL call

d43b0cf

LeoDog896 added 2 commits December 29, 2023 23:43

fix: use correct URL path on helper/addNoneditableObject.js

0d5fbb3

fix: more incorrect URL resolve issues

8ae8ee5

LeoDog896 mentioned this pull request Dec 31, 2023

[Test] Move from Karma to Jest #7329

Open

fix: parse json after reading it

d8a91e9

LeoDog896 marked this pull request as ready for review December 31, 2023 04:28

unlikelyzero requested review from ozyx and unlikelyzero December 31, 2023 17:27

unlikelyzero added the type:maintenance tests, chores, or project maintenance label Dec 31, 2023

unlikelyzero added the notable_change A change which should be noted in the changelog label Dec 31, 2023

unlikelyzero added this to the Target:3.3.0 milestone Dec 31, 2023

unlikelyzero reviewed Dec 31, 2023

View reviewed changes

karma.conf.cjs Show resolved Hide resolved

unlikelyzero reviewed Dec 31, 2023

View reviewed changes

src/plugins/plugins.js Show resolved Hide resolved

unlikelyzero approved these changes Dec 31, 2023

View reviewed changes

ozyx added the source:community Community contribution or request label Jan 1, 2024

ozyx approved these changes Jan 1, 2024

View reviewed changes

e2e/README.md Show resolved Hide resolved

e2e/appActions.js Show resolved Hide resolved

ozyx added pr:e2e:couchdb npm run test:e2e:couchdb and removed notable_change A change which should be noted in the changelog labels Jan 2, 2024

unlikelyzero added the notable_change A change which should be noted in the changelog label Jan 2, 2024

ozyx merged commit fce98a1 into nasa:master Jan 2, 2024
42 of 59 checks passed

unlikelyzero mentioned this pull request Jan 4, 2024

[lint] Add eslint-plugin-import to detect AMD or commonjs imports #7339

Open

unlikelyzero modified the milestones: Target:3.3.0, Target:4.0.0 Feb 1, 2024

ozyx mentioned this pull request Mar 16, 2024

chore: remove type: module, create openmct-e2e subpackage #7590

Merged

14 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor: migrate to ESM #7331

refactor: migrate to ESM #7331

LeoDog896 commented Dec 29, 2023 •

edited

Loading

codecov bot commented Dec 30, 2023 •

edited

Loading

deploysentinel bot commented Dec 30, 2023 •

edited

Loading

Test Case Results

Test Case Results

Top 1 Common Error Messages

Test Case Results

Test Case Results

LeoDog896 commented Dec 30, 2023 •

edited

Loading

unlikelyzero left a comment •

edited

Loading

LeoDog896 commented Dec 31, 2023 •

edited

Loading

ozyx commented Dec 31, 2023

ozyx left a comment

refactor: migrate to ESM #7331

refactor: migrate to ESM #7331

Conversation

LeoDog896 commented Dec 29, 2023 • edited Loading

Describe your changes:

All Submissions:

Author Checklist

Reviewer Checklist

codecov bot commented Dec 30, 2023 • edited Loading

Codecov Report

deploysentinel bot commented Dec 30, 2023 • edited Loading

Current Playwright Test Results Summary

⚠️ Flakes

Test Case Results

Test Case Results

Top 1 Common Error Messages

Test Case Results

Test Case Results

LeoDog896 commented Dec 30, 2023 • edited Loading

unlikelyzero left a comment • edited Loading

Choose a reason for hiding this comment

LeoDog896 commented Dec 31, 2023 • edited Loading

ozyx commented Dec 31, 2023

ozyx left a comment

Choose a reason for hiding this comment

LeoDog896 commented Dec 29, 2023 •

edited

Loading

codecov bot commented Dec 30, 2023 •

edited

Loading

deploysentinel bot commented Dec 30, 2023 •

edited

Loading

LeoDog896 commented Dec 30, 2023 •

edited

Loading

unlikelyzero left a comment •

edited

Loading

LeoDog896 commented Dec 31, 2023 •

edited

Loading