fix: calculating path to file url; rename modules

Author: KatoakDR

electron/main/app.ts

@@ -64,8 +64,8 @@ logger.debug('app paths', {
 // This is necessary for both security and for single-page apps.
 // https://bishopfox.com/blog/reasonably-secure-electron
 if (appEnvIsProd) {
-  const { prodServe } = await import('./electron-next/prod-server.js');
-  prodServe({
+  const { serve } = await import('./electron-next/serve.prod.js');
+  serve({
     scheme: prodAppScheme,
     dirPath: prodRendererPath,
   });
@@ -80,8 +80,8 @@ const createMainWindow = async (): Promise<void> => {
     // If running in development, serve the renderer from localhost.
     // This must be done once the app is ready.
     // This enables hot reloading of the renderer.
-    const { devServe } = await import('./electron-next/dev-server.js');
-    await devServe({
+    const { serve } = await import('./electron-next/serve.dev.js');
+    await serve({
       port: devPort,
       dirPath: devRendererPath,
     });

electron/main/electron-next/__tests__/path-to-file-url.test.ts

@@ -13,13 +13,15 @@ describe('path-to-file-url', () => {
   });
 
   describe('#pathToFileURL', () => {
-    it('returns absolute file url to directory path joined with file path', async () => {
-      expect(
-        pathToFileURL({
-          dirPath: '/a/b/',
-          filePath: 'c.html',
-        })
-      ).toEqual('file:///a/b/c.html');
+    it('prepends file protocol when given absolute path', async () => {
+      const filePath = '/a/b/c.html';
+      expect(pathToFileURL(filePath)).toEqual(`file://${filePath}`);
+    });
+
+    it('prepends file protocol and working directory when given relative path', async () => {
+      const cwd = process.cwd();
+      const filePath = 'a/b/c.html';
+      expect(pathToFileURL(filePath)).toEqual(`file://${cwd}/${filePath}`);
     });
   });
 });

electron/main/electron-next/path-to-file-url.ts

@@ -1,20 +1,10 @@
-import path from 'node:path';
 import url from 'node:url';
 
 /**
- * Converts a relative file path to an absolute file URL.
- * Example: 'file.txt' -> 'file:///path/to/file.txt'
+ * Converts a file path to an absolute file URL.
+ * For most reliable results, provide an absolute file path.
+ * Example: '/path/to/file.txt' -> 'file:///path/to/file.txt'
  */
-export const pathToFileURL = (options: {
-  /**
-   * The directory path to resolve the file path against.
-   */
-  dirPath: string;
-  /**
-   * The relative file path to convert to a file URL.
-   */
-  filePath: string;
-}): string => {
-  const { dirPath, filePath } = options;
-  return url.pathToFileURL(path.join(dirPath, filePath)).toString();
+export const pathToFileURL = (filePath: string): string => {
+  return url.pathToFileURL(filePath).toString();
 };

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

@@ -13,7 +13,7 @@ import type { NextServer, NextServerOptions } from 'next/dist/server/next.js';
 import { runInBackground } from '../async/run-in-background.js';
 import { logger } from './logger.js';
 
-export const devServe = async (options: {
+export const serve = async (options: {
   /**
    * The directory to serve, relative to the app root directory.
    */

electron/main/electron-next/prod-server.ts electron/main/electron-next/serve.prod.ts

@@ -19,7 +19,7 @@ import { isSafePath } from './is-safe-path.js';
 import { logger } from './logger.js';
 import { pathToFileURL } from './path-to-file-url.js';
 
-export const prodServe = (options: {
+export const serve = (options: {
   /**
    * The protocol to serve the directory on.
    * All URL requests that use this protocol will be served from the directory.
@@ -37,7 +37,8 @@ export const prodServe = (options: {
     dirPath,
   });
 
-  const error404Page = pathToFileURL({ dirPath, filePath: '404.html' });
+  const error404Path = path.join(dirPath, '404.html');
+  const error404Page = pathToFileURL(error404Path);
 
   const requestHandler = async (httpReq: Request): Promise<Response> => {
     const requestURL = new URL(httpReq.url);
@@ -54,7 +55,7 @@ export const prodServe = (options: {
     const isSafe = isSafePath({ dirPath, filePath: pathToServe });
 
     if (isSafe) {
-      pageToServe = pathToFileURL({ dirPath, filePath: pathToServe });
+      pageToServe = pathToFileURL(pathToServe);
     } else {
       pageToServe = error404Page;
     }