chore(app,app-shell,app-shell-odd, protocol-designer, labware-library, components, labware-designer): update Electron version to v27.0.0 #14314

koji · 2024-01-12T15:58:46Z

Overview

Update Electron version 27.0.0
https://www.electronjs.org/docs/latest/tutorial/electron-timelines#timeline

There is loadURL issue in the versions that include the following PR.
electron/electron#40143

At this moment we cannot update any newer version. (I'll keep checking the repo)

This PR also includes Nodejs update because of Electron v27's requirement.
This PR needs Nodejs v21.4.0 since M1 Mac has an issue about running Desktop app. (I'll keep an eye on this to support more nodejs version). M2 Mac can use nodejs v18.

Need NODE_OPTION due to OpenSSL version.
I tried to export NODE_OPTION in the top of Makefile, but somehow that has an impact on other part and prevent building the app(Desktop/ODD). I use NODE_OPTION separately.
Another reasons for this are labware-library and protocol-designer since the option prevents Cypress.

Running the application

node v21

CI

update Nodejs version (v16 -> v21)

OT-2

USB connection

Other applications

Protocol Designer
Labware Library
Labware Designer
Storybook

Commands

make check-js
make lint-js
make test-js

This PR removes usb-detection since the repo has been archived and not compatible with node v18+.
The new package we need to use is [node-usb](https://github.com/node-usb/node-usb)
https://working-wormhole-d95.notion.site/usb-detection-node-usb-a6637f72f5d44f3ba9c7520b4f0da24f

Test Plan

Run Desktop app and check that the app works as well as the current edge
Run ODD app and check that the app works as well as the current edge

Changelog

Review requests

Risk assessment

Update the Electron version from v21 to v23. Actually v23 is over the life but ODD has compatibility issues with Chromium v112 and later RAUT-

codecov · 2024-01-12T15:59:24Z

Codecov Report

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

Comparison is base (ffcc548) 68.29% compared to head (d559db9) 68.26%.
Report is 14 commits behind head on edge.

Additional details and impacted files

@@            Coverage Diff             @@
##             edge   #14314      +/-   ##
==========================================
- Coverage   68.29%   68.26%   -0.04%     
==========================================
  Files        1623     2514     +891     
  Lines       54858    72017   +17159     
  Branches     4115     9242    +5127     
==========================================
+ Hits        37466    49163   +11697     
- Misses      16705    20678    +3973     
- Partials      687     2176    +1489

Flag	Coverage Δ
app	`64.93% <41.46%> (+30.09%)`	⬆️
components	`49.62% <ø> (ø)`
g-code-testing	`96.48% <ø> (ø)`
labware-library	`41.10% <ø> (ø)`
protocol-designer	`38.01% <ø> (ø)`
react-api-client	`66.16% <ø> (ø)`
shared-data	`75.25% <ø> (ø)`
step-generation	`86.90% <ø> (ø)`
update-server	`63.58% <ø> (ø)`
usb-bridge	`76.94% <ø> (ø)`

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

Files	Coverage Δ
.../src/organisms/AdvancedSettings/U2EInformation.tsx	`100.00% <ø> (ø)`
app/src/redux/system-info/selectors.ts	`90.90% <ø> (ø)`
robot-server/robot_server/runs/run_store.py	`100.00% <ø> (ø)`
app-shell-odd/src/main.ts	`0.00% <0.00%> (ø)`
app-shell/src/system-info/index.ts	`84.21% <80.00%> (-5.79%)`	⬇️
app-shell/src/system-info/usb-devices.ts	`75.00% <55.55%> (-9.62%)`	⬇️
app-shell-odd/src/ui.ts	`0.00% <0.00%> (ø)`
app-shell/src/ui.ts	`0.00% <0.00%> (ø)`
app-shell/src/main.ts	`0.00% <0.00%> (ø)`

... and 893 files with indirect coverage changes

sfoster1 · 2024-01-26T16:40:05Z

Looks like flex builds will fail until we get node-native on >=18 https://github.com/Opentrons/oe-core/actions/runs/7659498340/job/20874747633

sfoster1 · 2024-01-26T19:11:23Z

Tracking the oe-core work here Opentrons/oe-core#128

sfoster1 · 2024-01-26T20:12:57Z

That build succeeded: https://builds.opentrons.com/ot3-oe/7672229872/ot3-system.zip

sfoster1 · 2024-01-26T20:30:23Z

And it works, happy with this from the ODD side

koji · 2024-01-26T22:32:14Z

try v18.19.0 again
solve conflicts
fix CI errors

brenthagen · 2024-01-30T19:45:07Z

I'm getting some strange behavior on this branch from locally simulated robots - reporting as unreachable but responding with 200s to various requests. I'm not sure why, digging a bit further.

this is an issue with node-fetch and dns default result order https://opentrons.slack.com/archives/CSCLVUW3C/p1706568971026189

i've pushed a commit to fix

brenthagen · 2024-01-30T19:49:03Z

app-shell-odd/src/main.ts

+ * setting the default to IPv4 fixes the issue
+ * https://github.com/node-fetch/node-fetch/issues/1624
+ */
+// TODO(bh, 2024-1-30): @types/node needs to be updated to address this type error. updating @types/node will also require updating our typescript version


this is failing because our wildcard @types/node version is 15 in yarn.lock. i'm looking into updating our wildcard @types/node version and typescript in a separate commit.

2a360ce tells node to prefer ipv4 addresses since in node >17 it prefers ipv6. Unfortunately, when we're running cypress we don't really have the ability to specify this since it happens in code. Instead, we can make sure that webpack-dev-server serves on ipv6 as well as ipv4; the right way to do this is to tell it to use the host :: which is ipv6 shorthand for "accept-all-incoming" in the same way that 0.0.0.0 is for ipv4. This should actually accept all incoming v4 requests too. You can test it by running make dev and then doing both curl --head 127.0.0.1:8080/ (the ipv4 version) curl --head '[::1]:8080/' (the ipv6 version; ::1 is ipv6 localhost, and the brackets are how ipv6 is written. if doing this in the shell you'll need single-quotes here) curl --head http://localhost:8080/

sfoster1 · 2024-01-31T15:22:47Z

labware-library/Makefile

 	node ./renderStatic.js

 # development assets server
 .PHONY: dev
 dev: export NODE_ENV := development
 dev:
-	webpack-dev-server --hot
+	export NODE_OPTIONS=--openssl-legacy-provider && webpack-dev-server --hot --host=::


the other side of the ipv4/v6 thing is that it also applies to cypress runs, and there we can't run our own js code, so let's just serve on v6 wildcard. you can test this by doing curl --head '[::1]:8080/' (note the single quotes - your shell will try and parse those brackets) when dev server is running, as well as curl --head 127.0.0.1:8080/ and curl --head http://localhost:8080/

think we need this in app also, i get same behavior locally on node 18 (but not 20 it seems).

and i guess labware-designer while we're at it

sfoster1 · 2024-01-31T16:23:02Z

fix ci errors

and twiddle some env exports a bit

sfoster1

Looks good to me! @koji I think you should have the honor of clicking merge!

…omponents,labware-designer): update Electron version to v27.0.0 (#14314) Update Electron version 27.0.0 https://www.electronjs.org/docs/latest/tutorial/electron-timelines#timeline This is the latest version of electron that does not include electron/electron#40143 which breaks the ability of the ODD to load content. This PR also includes Nodejs update because of Electron v27's requirement. The more recent nodejs requires some new options; specifically, webpack dev servers must serve on ipv6 wildcards, and internally in the shell we need to prefer v4 dns. We also need to use old openssl. --------- Co-authored-by: Brent Hagen <[email protected]> Co-authored-by: Seth Foster <[email protected]>

koji and others added 9 commits January 10, 2024 16:06

chore(app,app-shell,app-shell-odd): update Electron version to v23

b66513d

Update the Electron version from v21 to v23. Actually v23 is over the life but ODD has compatibility issues with Chromium v112 and later RAUT-

update Nodejs version in CI files

103fa6d

add node_option to labware designer

3dc8fb1

update ui deprecated part and remove usb-detection

2c9c929

updatet app-shell Makefile

abf9638

Windows works

feb5b55

use v27.0.0 instead of the end of life versions

adc2103

add node option to Makefile in components

287ea05

Merge branch 'edge' into chore_update-electron-v27.0.0

ffe43bd

koji requested a review from a team as a code owner January 12, 2024 15:58

koji requested a review from a team January 12, 2024 15:58

koji requested a review from a team as a code owner January 12, 2024 15:58

koji requested review from smb2268 and removed request for a team January 12, 2024 15:58

koji marked this pull request as draft January 12, 2024 15:58

koji removed request for a team and smb2268 January 12, 2024 15:59

koji changed the title ~~chore(app,app-shell,app-shell-odd): update Electron version to v23~~ chore(app,app-shell,app-shell-odd, protocol-designer, labware-library, components, labware-designer): update Electron version to v27.0.0 Jan 12, 2024

koji added 10 commits January 12, 2024 16:50

fix odd mode and update electron-context-menu

acd8450

remove webcontent.on new-window

fc16751

for building asar for ODD

5e9c263

update node version to 20

2afbbfc

Update Makefile

0e39e58

remove usb-detection related codes

e6c6084

update type for tests

3abacb1

update tests

309fe2c

fix type issues

e153d72

fix test case to use usb package

4f39838

koji and others added 10 commits January 27, 2024 00:26

address feedback use nodejs v18.19.0

f6c1c10

Merge branch 'edge' into chore_update-electron-v27.0.0

ed2ed1d

fix check-js errors

63e70ce

fix test-js error

2f8abb2

update Makefile for CI tests

d6968d2

update for CI test

38f7281

Merge branch 'edge' into chore_update-electron-v27.0.0

8a0f8df

Update yarn.lock

1061ac7

change node version to 18.19.0

ed6dc06

set ipv4first dns default result order

2a360ce

brenthagen reviewed Jan 30, 2024

View reviewed changes

brenthagen and others added 3 commits January 30, 2024 17:50

Merge branch 'edge' into chore_update-electron-v27.0.0

06d230d

fix yaml lint

e57d346

sfoster1 reviewed Jan 31, 2024

View reviewed changes

get some timing info on cypress

f9ce2c5

add v6 bindings to most all dev servers

d559db9

and twiddle some env exports a bit

sfoster1 approved these changes Jan 31, 2024

View reviewed changes

sfoster1 merged commit 3308ae5 into edge Jan 31, 2024
66 of 69 checks passed

sfoster1 deleted the chore_update-electron-v27.0.0 branch January 31, 2024 22:17

SyntaxColoring mentioned this pull request Feb 6, 2024

chore: Update .nvmrc from 16 to 18 #14430

Merged

shlokamin mentioned this pull request Feb 7, 2024

fix(app): open external links in browser #14447

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore(app,app-shell,app-shell-odd, protocol-designer, labware-library, components, labware-designer): update Electron version to v27.0.0 #14314

chore(app,app-shell,app-shell-odd, protocol-designer, labware-library, components, labware-designer): update Electron version to v27.0.0 #14314

koji commented Jan 12, 2024 •

edited

Loading

codecov bot commented Jan 12, 2024 •

edited

Loading

sfoster1 commented Jan 26, 2024

sfoster1 commented Jan 26, 2024

sfoster1 commented Jan 26, 2024

sfoster1 commented Jan 26, 2024

koji commented Jan 26, 2024 •

edited

Loading

brenthagen commented Jan 30, 2024

brenthagen Jan 30, 2024

sfoster1 Jan 31, 2024

brenthagen Jan 31, 2024

sfoster1 commented Jan 31, 2024 •

edited

Loading

sfoster1 left a comment

chore(app,app-shell,app-shell-odd, protocol-designer, labware-library, components, labware-designer): update Electron version to v27.0.0 #14314

chore(app,app-shell,app-shell-odd, protocol-designer, labware-library, components, labware-designer): update Electron version to v27.0.0 #14314

Conversation

koji commented Jan 12, 2024 • edited Loading

Overview

Running the application

CI

OT-2

Other applications

Commands

Test Plan

Changelog

Review requests

Risk assessment

codecov bot commented Jan 12, 2024 • edited Loading

Codecov Report

sfoster1 commented Jan 26, 2024

sfoster1 commented Jan 26, 2024

sfoster1 commented Jan 26, 2024

sfoster1 commented Jan 26, 2024

koji commented Jan 26, 2024 • edited Loading

brenthagen commented Jan 30, 2024

brenthagen Jan 30, 2024

Choose a reason for hiding this comment

sfoster1 Jan 31, 2024

Choose a reason for hiding this comment

brenthagen Jan 31, 2024

Choose a reason for hiding this comment

sfoster1 commented Jan 31, 2024 • edited Loading

sfoster1 left a comment

Choose a reason for hiding this comment

koji commented Jan 12, 2024 •

edited

Loading

codecov bot commented Jan 12, 2024 •

edited

Loading

koji commented Jan 26, 2024 •

edited

Loading

sfoster1 commented Jan 31, 2024 •

edited

Loading