chore: fix distribution, bundle ffmpeg in app package (#67)

adidahiya · web-flow · commit cec40cf11807 · 2024-02-07T18:55:51.000-05:00
diff --git a/.gitattributes b/.gitattributes
@@ -2,3 +2,4 @@
 /.yarn/releases/*    binary
 /.yarn/plugins/**/*  binary
 /.pnp.*              binary linguist-generated
+/packages/raga-app/bin/* binary
diff --git a/packages/raga-app/bin/ffmpeg-darwin-arm64 b/packages/raga-app/bin/ffmpeg-darwin-arm64
diff --git a/packages/raga-app/package.json b/packages/raga-app/package.json
@@ -24,11 +24,10 @@
     "@table-library/react-table-library": "^4.1.7",
     "@tinyhttp/app": "^2.2.3",
     "ansis": "^2.1.0",
+    "app-root-dir": "^1.0.2",
     "classnames": "^2.5.1",
-    "command-exists": "^1.2.9",
     "date-fns": "^3.3.1",
     "effection": "^3.0.2",
-    "electron-squirrel-startup": "^1.0.0",
     "framer-motion": "^11.0.3",
     "immer": "^10.0.3",
     "milliparsec": "^2.3.0",
@@ -51,11 +50,9 @@
     "@blueprintjs/node-build-scripts": "^9.2.0",
     "@electron-forge/cli": "^7.2.0",
     "@electron-forge/maker-deb": "^7.2.0",
-    "@electron-forge/maker-rpm": "^7.2.0",
-    "@electron-forge/maker-squirrel": "^7.2.0",
     "@electron-forge/maker-zip": "^7.2.0",
     "@electron-forge/plugin-vite": "^7.2.0",
-    "@types/command-exists": "^1.2.3",
+    "@types/app-root-dir": "^0.1.4",
     "@types/node": "^20.11.16",
     "@types/react": "^18.2.51",
     "@types/react-devtools": "^3.6.2",
diff --git a/packages/raga-app/src/client/components/common/tree.tsx b/packages/raga-app/src/client/components/common/tree.tsx
@@ -69,8 +69,6 @@ export default function UncontrolledTree<T extends object>({
           });
         }
 
-        console.log(draft);
-
         if (newSelected) {
           // apply our 'selected path' class at each level of the path
           for (let i = 0; i < nodePath.length; i++) {
diff --git a/packages/raga-app/src/client/store/slices/audioFilesServerSlice.ts b/packages/raga-app/src/client/store/slices/audioFilesServerSlice.ts
@@ -144,8 +144,10 @@ export const createAudioFilesServerSlice: AppStoreSliceCreator<
 
       try {
         const res = yield* convertTrackToMP3Request(serverBaseURL, trackDef);
+        const responseText = yield* call(res.text());
+
         if (res.ok) {
-          const outputFilePath = yield* call(res.text());
+          const outputFilePath = responseText;
           log.debug(
             `[client] Successfully converted track ${trackID} to MP3 at: ${outputFilePath}`,
           );
@@ -159,7 +161,7 @@ export const createAudioFilesServerSlice: AppStoreSliceCreator<
 
           return convertedFileURL;
         } else {
-          log.error(`[client] Failed to convert ${trackDef.Location} to MP3: ${res.statusText}`);
+          log.error(`[client] Failed to convert ${trackDef.Location} to MP3: ${responseText}`);
         }
       } catch (e) {
         log.error(
diff --git a/packages/raga-app/src/common/errorMessages.ts b/packages/raga-app/src/common/errorMessages.ts
@@ -33,7 +33,7 @@ export const ClientErrors = {
 export const ServerErrors = {
   AUDIO_FILE_NOT_FOUND: `Audio file not found`,
   AUDIO_FILES_ROOT_FOLDER_NOT_FOUND: `Audio files root folder does not exist or is empty`,
-  FFMPEG_NOT_INSTALLED: `ffmpeg is not installed on the system path`,
+  FFMPEG_UNAVAILABLE: `ffmpeg is not available, cannot convert audio files`,
   MP3_CODEC_UNAVAILABLE: `No MP3 codec is available`,
   INVALID_CONVERSION_REQUEST: `Invalid MP3 conversion request`,
   CONVERTED_AUDIO_FILE_NOT_FOUND: `Converted audio file not found`,
diff --git a/packages/raga-app/src/main.ts b/packages/raga-app/src/main.ts
@@ -20,11 +20,6 @@ import {
 } from "./common/events";
 import { createScopedLogger } from "./common/logUtils";
 
-// Handle creating/removing shortcuts on Windows when installing/uninstalling.
-if (require("electron-squirrel-startup")) {
-  app.quit();
-}
-
 // see https://www.electronforge.io/config/plugins/vite#hot-module-replacement-hmr
 declare const MAIN_WINDOW_VITE_DEV_SERVER_URL: string;
 declare const MAIN_WINDOW_VITE_NAME: string;
diff --git a/packages/raga-app/src/server.ts b/packages/raga-app/src/server.ts
@@ -1,6 +1,6 @@
 import { ServerEventChannel } from "./common/events";
 import { initAppServer } from "./server/appServer";
-import { log } from "./server/serverLogger";
+import { log } from "./server/common/serverLogger";
 
 // HACKHACK: we can't use top-level await until we migrate to ESM, which is currently blocked by
 // electron-vite support. Also, effection's main() function isn't running correctly for some reason,
diff --git a/packages/raga-app/src/server/appServer.ts b/packages/raga-app/src/server/appServer.ts
@@ -22,8 +22,8 @@ import {
   type WriteModifiedLibraryOptions,
 } from "../common/events";
 import { type AudioFilesServer, startAudioFilesServer } from "./audioFilesServer";
+import { log } from "./common/serverLogger";
 import { computeLibraryMetadata } from "./libraryMeta/computeLibraryMetadata";
-import { log } from "./serverLogger";
 import { writeAudioFileTag } from "./writeAudioFileTag";
 
 let library: SwinsianLibraryPlist | undefined;
diff --git a/packages/raga-app/src/server/audioFilesServer.ts b/packages/raga-app/src/server/audioFilesServer.ts
@@ -13,8 +13,9 @@ import { withTimeout } from "../common/asyncUtils";
 import { DEFAULT_AUDIO_FILES_SERVER_PORT } from "../common/constants";
 import { ServerErrors } from "../common/errorMessages";
 import { type AudioFilesServerStartedEventPayload } from "../common/events";
+import ffmpeg from "./common/ffmpeg";
+import { log } from "./common/serverLogger";
 import { getConvertToMP3RequestHandler } from "./handlers/convertToMP3Handler";
-import { log } from "./serverLogger";
 
 let audioFilesServer: AudioFilesServer | undefined;
 
@@ -67,7 +68,7 @@ function* createAudioFileConverterAndInitServer(
   validateRootFolderOrThrow(options.audioFilesRootFolder);
 
   log.debug(`Initializing audio files converter...`);
-  const converter = new AudioFileConverter();
+  const converter = new AudioFileConverter({ ffmpeg });
   const app = initServerApp(converter, options);
 
   const httpServer = yield* waitForHTTPServerToStart(app);
diff --git a/packages/raga-app/src/server/common/appPath.ts b/packages/raga-app/src/server/common/appPath.ts
@@ -0,0 +1,7 @@
+import { join, resolve } from "node:path";
+
+import appRootDir from "app-root-dir";
+
+// The "electron" module is not available in the server utility process, so we must get the app path ourselves
+// Note that "app-root-dir" returns a path inside the .vite/ folder, so we must go up one level.
+export const appPath = resolve(join(appRootDir.get(), ".."));
diff --git a/packages/raga-app/src/server/common/ffmpeg.ts b/packages/raga-app/src/server/common/ffmpeg.ts
@@ -0,0 +1,19 @@
+import { existsSync } from "node:fs";
+import { join } from "node:path";
+
+import ffmpeg from "fluent-ffmpeg";
+
+import { appPath } from "./appPath";
+import { log } from "./serverLogger";
+
+const ffmpegPath = join(appPath, "bin", "ffmpeg-darwin-arm64");
+export const isFfmpegAvailable = existsSync(ffmpegPath);
+
+if (isFfmpegAvailable) {
+  log.debug(`Using ffmpeg from ${ffmpegPath}`);
+  ffmpeg.setFfmpegPath(ffmpegPath);
+} else {
+  log.error("ffmpeg is not available");
+}
+
+export default ffmpeg;
diff --git a/packages/raga-app/src/server/common/serverLogger.ts b/packages/raga-app/src/server/common/serverLogger.ts
@@ -1,5 +1,5 @@
 import { green } from "ansis";
 
-import { createScopedLogger } from "../common/logUtils";
+import { createScopedLogger } from "../../common/logUtils";
 
 export const log = createScopedLogger("server", green);
diff --git a/packages/raga-app/src/server/devTools.ts b/packages/raga-app/src/server/devTools.ts
@@ -1,7 +1,7 @@
 import installExtension, { REACT_DEVELOPER_TOOLS } from "electron-devtools-installer";
 import { serializeError } from "serialize-error";
 
-import { log } from "./serverLogger";
+import { log } from "./common/serverLogger";
 
 export async function installReactDevTools() {
   try {
diff --git a/packages/raga-app/src/server/handlers/convertToMP3Handler.ts b/packages/raga-app/src/server/handlers/convertToMP3Handler.ts
@@ -3,14 +3,13 @@ import { fileURLToPath } from "node:url";
 
 import type { AudioFileConverter } from "@adahiya/raga-lib";
 import { type Handler, type NextFunction, type Response } from "@tinyhttp/app";
-import { sync as commandExistsSync } from "command-exists";
 import { action, type Operation, run, suspend } from "effection";
-import ffmpeg from "fluent-ffmpeg";
 import { json, type ReqWithBody as RequestWithBody } from "milliparsec";
 
 import type { ConvertTrackToMP3RequestBody } from "../../common/api/audioFilesServerAPI";
 import { ServerErrors } from "../../common/errorMessages";
-import { log } from "../serverLogger";
+import ffmpeg, { isFfmpegAvailable } from "../common/ffmpeg";
+import { log } from "../common/serverLogger";
 
 export function getConvertToMP3RequestHandler(converter: AudioFileConverter): Handler {
   return async (
@@ -44,10 +43,9 @@ export function getConvertToMP3RequestHandler(converter: AudioFileConverter): Ha
       return;
     }
 
-    const ffmpegExists = commandExistsSync("ffmpeg");
-    if (!ffmpegExists) {
+    if (!isFfmpegAvailable) {
       // 501 means server does not support the requested functionality, see https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/501
-      res.status(501).send(ServerErrors.FFMPEG_NOT_INSTALLED);
+      res.status(501).send(ServerErrors.FFMPEG_UNAVAILABLE);
       return;
     }
 
diff --git a/packages/raga-app/vite.main.config.mjs b/packages/raga-app/vite.main.config.mjs
@@ -2,6 +2,7 @@ import { defineConfig } from "vite";
 
 // https://vitejs.dev/config
 export default defineConfig({
+  assetsInclude: ["./bin/*"],
   resolve: {
     alias: {
       // buggy conditional import in node-fluent-ffmpeg, see https://github.com/fluent-ffmpeg/node-fluent-ffmpeg/issues/573#issuecomment-1082586875
diff --git a/packages/raga-lib/src/audio-file-converter/audioFileConverter.ts b/packages/raga-lib/src/audio-file-converter/audioFileConverter.ts
@@ -42,7 +42,11 @@ export interface MP3ConversionOptions {
 export default class AudioFileConverter {
   public temporaryOutputDir: string;
 
-  constructor() {
+  private get ffmpeg() {
+    return this.options.ffmpeg ?? ffmpeg;
+  }
+
+  constructor(private options: { ffmpeg?: typeof ffmpeg }) {
     // N.B. the `tempy` package is not compatible with Vite for some strange reason, so we
     // create temp directories ourself with built-in Node.js APIs
     const tempDir = join(tmpdir(), LIB_PACKAGE_NAME, "converted");
@@ -99,7 +103,7 @@ export default class AudioFileConverter {
 
     return new Promise<string>((resolve, reject) => {
       console.time(`convertAudioFileToMP3`);
-      ffmpeg(inputFileStream)
+      this.ffmpeg(inputFileStream)
         .audioCodec(codec)
         .audioBitrate(bitrate)
         .audioFrequency(sampleRate)
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -69,8 +69,6 @@ export default function UncontrolledTree<T extends object>({`
`69`	`69`	`});`
`70`	`70`	`}`
`71`	`71`
`72`		`- console.log(draft);`
`73`		`-`
`74`	`72`	`if (newSelected) {`
`75`	`73`	`// apply our 'selected path' class at each level of the path`
`76`	`74`	`for (let i = 0; i < nodePath.length; i++) {`