feat(plugin-vite): hot-restart 🔥 by caoxiemeihao · Pull Request #3203 · electron/forge

caoxiemeihao · 2023-04-01T10:25:11Z

I have read the contribution documentation for this project.
I agree to follow the code of conduct that this project follows, as appropriate.
The changes are appropriately documented (if applicable).
The changes have sufficient test coverage (if applicable).
The testsuite passes successfully on my local machine (if applicable).

Summarize your changes:

TODO:

~~write related test~~

2023-08-09

Hot restart Main process, this means restart the entire Electron App. ✅
Hot reload Preload scripts, refresh Renderer process can be reload the corresponding Preload script, it's will become better DX. ✅
HMR Renderer process, power by Vite. ✅

Custom restart or reload by forge.config.js

// forge.config.js

module.exports = {
  plugins: [
    {
      name: '@electron-forge/plugin-vite',
      config: {
        build: [
          {
            entry: 'src/main.js',
            config: 'vite.main.config.mjs',
            
            // Disable auto restart
            // restart: false,

            // Custome hot restart
            restart(args) {
              // Start Electron App after do something...
              args.restart();
            },
          },
          {
            entry: 'src/preload.js',
            config: 'vite.preload.config.mjs',

            // Hot reload
            restart(args) {
              // When a Preload script is rebuilt,
              // users can refresh the Renderer process by `ViteDevServer`,
              // instead of restart the entire Electron App.
              args.renderer.find(({ config }) => config.name === 'main_window').reload();
            },
          },
        ],
        renderer: [
          {
            name: 'main_window',
            config: 'vite.renderer.config.mjs',
          },
        ],
      },
    },
  ],
};

grsky360 · 2023-04-05T02:10:53Z

I tried this PR yesterday, and it looks great.
Just a small question, is there any way to not redirect my focus window to the restarted app?
I'm using WebStorm, everytime I changed something without over, the app restarted... And I don't want to close auto save function...

caoxiemeihao · 2023-04-05T13:15:28Z

At present, hot-restart just a simple-helper for dev.
Any time, if you want full custom the hot-restart logic you just emit rs command in the main process at the right time :)

process.emit('rs') // restart

TODO:

enhance hot-start

GitMurf · 2023-04-24T14:48:57Z

I am very bad at understanding where PRs stand ;) is this finished and will be in the next release?

caoxiemeihao · 2023-04-25T01:09:06Z

This feature changes the API design of forge.config.js and it should be seriously considered.
In Vite, it might be better to use a peparate plugin, for now you can try to use the existing plugins.

@GitMurf 👉 Here

// vite.main.config.mjs    - For Electron Main
// vite.preload.config.mjs - For Preload Scripts

import { defineConfig } from 'vite';
import { restart } from 'electron-forge-plugin-vite/plugin';

// https://vitejs.dev/config
export default defineConfig({
  plugins: [restart()],
});

BlackHole1 · 2023-04-25T01:09:14Z

is this finished and will be in the next release?

@GitMurf We cannot guarantee that. Currently, it appears that @caoxiemeihao still has some features that have not been implemented, so we need to wait until they are completed before conducting a code review.

caoxiemeihao · 2023-04-26T06:50:06Z

Maybe the feature implement here is better 🤔
https://github.com/electron/forge/pull/3220/files#diff-d1d8524b16d69b5d383151b395f4ac4151282b39dac16af4bd833cae8b689c8cR117

ferminc · 2023-08-12T21:04:46Z

any update on this?

caoxiemeihao · 2023-08-14T01:34:18Z

any update on this?

This PR will reopen when #3178 is merged :)

erickzhao · 2023-08-22T18:40:41Z

packages/plugin/vite/test/ViteConfig_spec.ts


      await viteDevServer.listen();
-      viteDevServer.printUrls();
+      // viteDevServer.printUrls();


question: is this commented out intentionally?

Yep! When I run test on my local machine, some verbose log print, so commented it.

Could we remove this before we ship it to users then?

The logs removed here are only for the CI test environment and will not affect the production environment.
Do we need to keep this log in the test environment?

Do we need to keep this log in the test environment?

No. If others need it, they can add it themselves.

packages/plugin/vite/src/VitePlugin.ts

packages/plugin/vite/src/util/plugins.ts

… feat/hot-restart

erickzhao · 2023-09-07T22:02:11Z

packages/plugin/vite/src/Config.ts

+         * renderer.find(({ config }) => config.name === 'main_window').reload();
+         * ```
+         */
+        renderer: {


Suggested change

renderer: {

renderers: {

Should this be renderers since it's a list of all renderer processes?

How about this API design? 🤔
It looks little simper.

export interface VitePluginBuildConfig { restart?: (rs: (options?: { reload: 'main_window' }) => void) => void; }

Usage

// Restart App restart(rs) { rs(); }; // Reload Renderer process restart(rs) { rs({ reload: 'main_window' }); };

I think @erickzhao means that because this is an array, it would be better to use plural for words.

erickzhao · 2023-09-07T23:20:53Z

packages/plugin/vite/src/util/plugins.ts

+) {
+  const restart = () => {
+    // https://github.com/electron/forge/blob/v6.1.1/packages/api/core/src/api/start.ts#L204-L211
+    process.stdin.emit('data', 'rs');


@MarshallOfSound pointed out to me that using stdin here is a bit of a hack here and there are edge cases where process.stdin could be null.

Ideally, we should instead expose additional start logic from the @electron-forge/core API to expose this functionality so that plugins can hook into it.

Okay! This does seem a little dangerous. 🚨

erickzhao · 2023-09-07T23:25:54Z

packages/plugin/vite/test/ViteConfig_spec.ts


      await viteDevServer.listen();
-      viteDevServer.printUrls();
+      // viteDevServer.printUrls();


Could we remove this before we ship it to users then?

caoxiemeihao · 2024-02-09T07:43:05Z

Implemented in #3468

caoxiemeihao requested a review from a team as a code owner April 1, 2023 10:25

caoxiemeihao force-pushed the feat/hot-restart branch 2 times, most recently from e6f7c9a to e243a4b Compare April 5, 2023 00:01

caoxiemeihao changed the title ~~feat(plugin-vite): hot-restart 🔥~~ wip(plugin-vite): hot-restart 🔥 Apr 26, 2023

caoxiemeihao changed the title ~~wip(plugin-vite): hot-restart 🔥~~ feat(wip(plugin-vite)): hot-restart 🔥 Apr 26, 2023

erickzhao marked this pull request as draft April 26, 2023 17:56

caoxiemeihao force-pushed the feat/hot-restart branch from e243a4b to bd0d802 Compare August 19, 2023 03:01

caoxiemeihao changed the title ~~feat(wip(plugin-vite)): hot-restart 🔥~~ feat(plugin-vite): hot-restart 🔥 Aug 19, 2023

caoxiemeihao requested a review from a team August 19, 2023 14:51

feat(plugin-vite): hot-restart 🔥

c09aa2a

caoxiemeihao force-pushed the feat/hot-restart branch from bd0d802 to c09aa2a Compare August 21, 2023 03:48

caoxiemeihao marked this pull request as ready for review August 21, 2023 03:48

Merge branch 'main' into feat/hot-restart

474d2f0

erickzhao requested changes Aug 22, 2023

View reviewed changes

caoxiemeihao added 2 commits August 24, 2023 09:02

fix(plugin-vite): correct use hotRestart

e358075

Merge branch 'feat/hot-restart' of github.com:caoxiemeihao/forge into…

440bec6

… feat/hot-restart

caoxiemeihao requested a review from erickzhao August 25, 2023 00:54

caoxiemeihao mentioned this pull request Aug 30, 2023

feat(vite-plugin): auto restart after rebuild Main process #3326

Closed

5 tasks

erickzhao reviewed Sep 7, 2023

View reviewed changes

erikian mentioned this pull request Oct 13, 2023

refactor(core): allow restart logic to be triggered using an event #3380

Closed

5 tasks

caoxiemeihao mentioned this pull request Jan 22, 2024

feat(plugin-vite): upgrade to vite@5 #3468

Merged

5 tasks

caoxiemeihao closed this Feb 9, 2024

Uh oh!

Comments

Conversation

caoxiemeihao commented Apr 1, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

grsky360 commented Apr 5, 2023

Uh oh!

caoxiemeihao commented Apr 5, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

GitMurf commented Apr 24, 2023

Uh oh!

caoxiemeihao commented Apr 25, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

BlackHole1 commented Apr 25, 2023

Uh oh!

caoxiemeihao commented Apr 26, 2023

Uh oh!

ferminc commented Aug 12, 2023

Uh oh!

caoxiemeihao commented Aug 14, 2023

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!

caoxiemeihao Sep 8, 2023 • 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!

BlackHole1 Oct 13, 2023 • 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!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

caoxiemeihao Sep 8, 2023 • 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!

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!

caoxiemeihao commented Feb 9, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

caoxiemeihao commented Apr 1, 2023 •

edited

Loading

caoxiemeihao commented Apr 5, 2023 •

edited

Loading

caoxiemeihao commented Apr 25, 2023 •

edited

Loading

caoxiemeihao Sep 8, 2023 •

edited

Loading

BlackHole1 Oct 13, 2023 •

edited

Loading

caoxiemeihao Sep 8, 2023 •

edited

Loading

caoxiemeihao commented Feb 9, 2024 •

edited

Loading