Feature/uepr 40 desktop feature parity #461

KManolov3 · 2025-02-10T18:08:05Z

Resolves

Resolves https://scratchfoundation.atlassian.net/browse/UEPR-140

Proposed Changes

Allow for test builds on Linux
Remove electron-webpack and handle webpack configuration manually

Reason for Changes

To be able to upgrade webpack to v5 - the version of GUI - and, consequently, catch up with latest GUI features

cwillisf

Wow, there's a lot going on here! There are a couple of things to change, but they're pretty minor... overall this looks good to me. It looks like maybe the development experience is even a little better than before...?

Do you think scratch-webpack-configuration would help here, or would that just complicate things? I'm not suggesting to add it to this PR, just curious about a possible future step.

cwillisf · 2025-02-10T21:44:06Z

package.json

+    "build:dev": "NODE_ENV=production npm run compile && npm run doBuild -- --mode=dev",
+    "build:dir": "NODE_ENV=production npm run compile && npm run doBuild -- --mode=dir",
+    "build:dist": "NODE_ENV=production npm run compile && npm run doBuild -- --mode=dist",


Why is NODE_ENV=production necessary here?

Assuming it is necessary, could you set this up to use crossenv instead? That will allow Windows users to run these commands, too.

This was previously set automatically via electron-webpack - the webpack config and the main process depend on it for setting the correct paths to load content from. Will update it with crossenv.

cwillisf · 2025-02-10T21:48:22Z

scripts/start.js

+        shell: true
+    });
+
+    mainProcess.on('exit', async (code) => {


Hmm... can't you do something like await spawn(...)?
(does some web searching)
...nevermind, this looks good. 😅

cwillisf · 2025-02-10T21:49:57Z

src/main/index.js

-
-const devToolKey = ((process.platform === 'darwin') ?
-    { // macOS: command+option+i
+const devToolKey = ((process.platform === 'darwin' || process.platform === 'linux') ?
+    { // macOS / linux: command+option+i


I think Linux wants the same control+shift+i key combo as Windows here

I think Linux wants the same control+shift+i key combo as Windows here

as a former linux user (and still somewhat uses it), i can confirm

cwillisf · 2025-02-10T21:53:57Z

src/main/index.js

-    const baseUrl = (isDevelopment ?
-        `http://localhost:${process.env.ELECTRON_WEBPACK_WDS_PORT}/` :
-        `file://${__dirname}/`
+    const baseUrl =  (isDevelopment ? 


Suggested change

const baseUrl = (isDevelopment ?

const baseUrl = (isDevelopment ?

KManolov3 · 2025-03-26T14:46:31Z

Regarding scratch-webpack-configuration - I definitely see it as a natural further step. A lot of the webpack config already follows rules similar to scratch-gui / scratch-www where the unified config is used. Although given that this has already turned into a pretty large technical task that has a lot of potential breaking changes, it seems better to do this after we release the scratch-android / scratch-desktop changes

…sktop-feature-parity

KManolov3 · 2025-03-26T16:08:20Z

scripts/fetchMediaLibraryAssets.js

@@ -9,7 +9,7 @@ const libraries = require('./lib/libraries');

 const ASSET_HOST = 'cdn.assets.scratch.mit.edu';
 const NUM_SIMULTANEOUS_DOWNLOADS = 5;
-const OUT_PATH = path.resolve('static', 'assets');
+const OUT_PATH = path.resolve('static', 'fetched');


This was due to a strange issue, where if these assets existed in a folder named static/assets (which was created outside of the dist packaged by Electron, .asar in the case of linux), we were unable to resolve tutorial images (which are also in a static/assets folder, but inside the packaged dist.

KManolov3 · 2025-03-26T16:25:44Z

webpack.makeConfig.js

-                    loader: 'file-loader',
-                    options: {
-                        outputPath: 'static/assets/'
+                    type: 'asset/resource',


For a reason I'm not completely sure of, this does not save files inside dist/renderer/static/assets (which file-loader previously did). The most plausible explanation seems to be that webpack is stricter on where it looks and it automatically excludes files in node_modules (although adding includePaths here does not have an effect).

This is why I am resolving to copying these assets from scratch-gui (with the CopyWebpackPlugin below).

I feel like I might be missing something on how these were previously output in the dist, but the current setup seems to work. We'll see soon if it causes issues on the other platforms.

cwillisf

Amazing work. Do you feel like you've run a marathon? I'm sorry you now know so much about Electron and Webpack! ;)

If you're confident about how to resolve the README.md TODO related to making a new desktop release, I'd update that, but I think it's also fine to leave it until we're doing a real release. I'd prefer obviously outdated instructions (or no instructions at all) over new-but-untested instructions ;)

cwillisf · 2025-03-28T22:22:38Z

README.md

@@ -5,6 +5,7 @@ Scratch 3.0 as a standalone desktop application
 ## Developer Instructions

 ### Releasing a new version
+# TODO: Update readme once scratch-desktop uses scratch-gui from an npm package


These instructions just start with step 2 now and skip 2.4-2.7, right?

Yes, that should be the case

cwillisf · 2025-03-28T22:23:35Z

electron-builder.yaml

@@ -45,3 +53,12 @@ appx:
 nsis:
  oneClick: false # allow user to choose per-user or per-machine
  artifactName: "Scratch ${version} Setup.${ext}"
+linux:


cwillisf · 2025-03-28T22:28:32Z

package.json

@@ -36,42 +39,52 @@
    "@babel/plugin-transform-optional-chaining": "7.25.9",
    "@babel/preset-env": "7.26.7",
    "@babel/preset-react": "7.26.3",
+    "@scratch/scratch-gui": "^11.0.0-beta.2",


🚀 👨‍🎤 🎸 🕺 💃

…desktop-feature-parity

KManolov3 added 2 commits February 3, 2025 16:46

feat: support development linux builds

650c21e

Switch out electron-webpack to be able to upgrade to webpack v5

ce97c9e

KManolov3 marked this pull request as draft February 10, 2025 18:12

cwillisf requested changes Feb 10, 2025

View reviewed changes

Update scratch-desktop to use webpack v5 and scratch-editor

b09ce5f

KManolov3 added 2 commits March 26, 2025 17:26

Add crossenv to build script

df43409

Merge remote-tracking branch 'origin/develop' into feature/uepr-40-de…

6759a05

…sktop-feature-parity

KManolov3 marked this pull request as ready for review March 26, 2025 15:38

KManolov3 changed the title ~~[WIP] Feature/uepr 40 desktop feature parity~~ Feature/uepr 40 desktop feature parity Mar 26, 2025

KManolov3 commented Mar 26, 2025

View reviewed changes

cwillisf approved these changes Mar 28, 2025

View reviewed changes

KManolov3 added 8 commits April 3, 2025 11:21

Add desktop platform prop

1ce8f1d

feat: use scratch-gui from packaged prerelease; upgrade electron builder

1211a5f

fix: copy the fetch worker from gui

aa3f36a

fix: only package webpack folders in dist

337213c

Merge remote-tracking branch 'upstream/develop' into feature/uepr-40-…

ee5cd79

…desktop-feature-parity

fix: gui component vm type

ea7ccdd

feat: update gui reference

8989601

fix: lint errors

725e1d0

KManolov3 mentioned this pull request Apr 10, 2025

[WIP] Feat/uepr 58 migrate scratch desktop react 18 #479

Open

fix: comment out the fetch-worker copy plugin with a comment

de384ba

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature/uepr 40 desktop feature parity #461

Feature/uepr 40 desktop feature parity #461

KManolov3 commented Feb 10, 2025 •

edited

Loading

cwillisf left a comment

cwillisf Feb 10, 2025

KManolov3 Mar 26, 2025 •

edited

Loading

cwillisf Feb 10, 2025

cwillisf Feb 10, 2025

AmpElectrecuted Feb 10, 2025

cwillisf Feb 10, 2025

KManolov3 commented Mar 26, 2025

KManolov3 Mar 26, 2025

KManolov3 Mar 26, 2025

cwillisf left a comment

cwillisf Mar 28, 2025

KManolov3 Apr 8, 2025

cwillisf Mar 28, 2025

cwillisf Mar 28, 2025

	const baseUrl = (isDevelopment ?
	const baseUrl = (isDevelopment ?

Feature/uepr 40 desktop feature parity #461

Are you sure you want to change the base?

Feature/uepr 40 desktop feature parity #461

Conversation

KManolov3 commented Feb 10, 2025 • edited Loading

Resolves

Proposed Changes

Reason for Changes

cwillisf left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

KManolov3 Mar 26, 2025 • edited Loading

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

KManolov3 commented Mar 26, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cwillisf 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

KManolov3 commented Feb 10, 2025 •

edited

Loading

KManolov3 Mar 26, 2025 •

edited

Loading