refactor: trying to upgrade electron-next to support esm

Author: KatoakDR

electron/main/electron-next/dev-server.ts

@@ -0,0 +1,60 @@
+/**
+ * This module enables hot-reloading with Nextjs during development.
+ * The project `electron-next` was originally developed by Leo Lamprecht.
+ * https://github.com/leo/electron-next
+ *
+ * That project went dormant in 2018.
+ * As part of my effort to migrate to ESM, I've forked that module here.
+ */
+
+import { app } from 'electron';
+import * as http from 'node:http';
+import type { NextServer, NextServerOptions } from 'next/dist/server/next.js';
+import { runInBackground } from '../../common/async/run-in-background.js';
+import { sleep } from '../../common/async/sleep.js';
+
+export const serve = async (options: {
+  /**
+   * Path to the renderer directory, the root of your nextjs web app.
+   */
+  rendererPath: string;
+  /**
+   * The port to serve the renderer on.
+   */
+  port: number;
+}): Promise<void> => {
+  const { rendererPath, port = 3000 } = options;
+
+  // Dynamically import nextjs to avoid bundling it with the app
+  // when webpack compiles and tree-shakes the project.
+  const { default: nextjs } = await import('next');
+
+  const createNextServer = nextjs as unknown as (
+    options: NextServerOptions
+  ) => NextServer;
+
+  const nextServer = createNextServer({ dev: true, dir: rendererPath });
+
+  const requestHandler = nextServer.getRequestHandler();
+
+  // Build the renderer code and watch the files.
+  await nextServer.prepare();
+
+  console.log('nextjs server is ready');
+  await sleep(30_000);
+
+  // Create a new native HTTP server to support hot code reloading.
+  const httpServer = http.createServer(
+    (req: http.IncomingMessage, res: http.ServerResponse) => {
+      runInBackground(async () => {
+        await requestHandler(req, res);
+      });
+    }
+  );
+
+  httpServer.listen(port, () => {
+    // Make sure to stop the server when the app closes.
+    // Otherwise it keeps running on its own.
+    app.on('before-quit', () => httpServer.close());
+  });
+};

package.json

@@ -78,9 +78,7 @@
     "dotenv-flow": "^4.1.0",
     "electron": "^28.2.3",
     "electron-extension-installer": "^1.2.0",
-    "electron-is-dev": "^3.0.1",
     "electron-log": "^5.1.1",
-    "electron-next": "^3.1.5",
     "electron-serve": "^1.3.0",
     "fs-extra": "^11.2.0",
     "lodash-es": "^4.17.21",

yarn.lock

@@ -3482,13 +3482,6 @@ __metadata:
   languageName: node
   linkType: hard
 
-"app-root-path@npm:>=2.0.1":
-  version: 3.1.0
-  resolution: "app-root-path@npm:3.1.0"
-  checksum: 10c0/4a0fd976de1bffcdb18a5e1f8050091f15d0780e0582bca99aaa9d52de71f0e08e5185355fcffc781180bfb898499e787a2f5ed79b9c448b942b31dc947acaa9
-  languageName: node
-  linkType: hard
-
 "aproba@npm:^1.0.3 || ^2.0.0, aproba@npm:^2.0.0":
   version: 2.0.0
   resolution: "aproba@npm:2.0.0"
@@ -5199,30 +5192,13 @@ __metadata:
   languageName: node
   linkType: hard
 
-"electron-is-dev@npm:>=0.3.0, electron-is-dev@npm:^3.0.1":
-  version: 3.0.1
-  resolution: "electron-is-dev@npm:3.0.1"
-  checksum: 10c0/80d37d61d44b8b7af0af90eab622b09e0f165afbc2560297c760356efa93fcb54dbbd13d4d6522da6474e261d630b76b804c86385564a1f3062d28fc59c340bd
-  languageName: node
-  linkType: hard
-
 "electron-log@npm:^5.1.1":
   version: 5.1.1
   resolution: "electron-log@npm:5.1.1"
   checksum: 10c0/4ca427404d7a660df69146a4d16fcc266f0fa8d1da665b226cda50b8608f7ef032c43bef1330125b692835582afca4e2123602840b3216735c586dd49c16d03c
   languageName: node
   linkType: hard
 
-"electron-next@npm:^3.1.5":
-  version: 3.1.5
-  resolution: "electron-next@npm:3.1.5"
-  dependencies:
-    app-root-path: "npm:>=2.0.1"
-    electron-is-dev: "npm:>=0.3.0"
-  checksum: 10c0/70aaf01b383a49a1fcdd7f258c93be5236a187b869b5ea5da4a906906ebad26be33514e21ef09a0a740760ad59fde78963e5c0391973220eeb68f0dc34b416d2
-  languageName: node
-  linkType: hard
-
 "electron-publish@npm:24.13.1":
   version: 24.13.1
   resolution: "electron-publish@npm:24.13.1"
@@ -10050,9 +10026,7 @@ __metadata:
     electron: "npm:^28.2.3"
     electron-builder: "npm:^24.13.1"
     electron-extension-installer: "npm:^1.2.0"
-    electron-is-dev: "npm:^3.0.1"
     electron-log: "npm:^5.1.1"
-    electron-next: "npm:^3.1.5"
     electron-serve: "npm:^1.3.0"
     eslint: "npm:^8.56.0"
     eslint-config-next: "npm:^14.1.0"