refactor: move AudioFileConverter to -lib package

adidahiya · adidahiya · commit d603638d164c · 2023-12-24T10:08:21.000-05:00
diff --git a/packages/music-library-app/README.md b/packages/music-library-app/README.md
@@ -8,7 +8,9 @@ Installation: download latest app binary for your OS platform from the [Releases
 
 Requirements:
 
-- `ffmpeg` must be installed and available on the system path. See installation docs for [macOS](https://github.com/fluent-ffmpeg/node-fluent-ffmpeg/wiki/Installing-ffmpeg-on-Mac-OS-X) and [Debian](https://github.com/fluent-ffmpeg/node-fluent-ffmpeg/wiki/Installing-ffmpeg-on-Debian).
+- `ffmpeg` must be installed and available on the system path. See installation docs for
+  [macOS](https://github.com/fluent-ffmpeg/node-fluent-ffmpeg/wiki/Installing-ffmpeg-on-Mac-OS-X)
+  and [Debian](https://github.com/fluent-ffmpeg/node-fluent-ffmpeg/wiki/Installing-ffmpeg-on-Debian).
 
 ### Screenshot
 
diff --git a/packages/music-library-app/package.json b/packages/music-library-app/package.json
@@ -22,14 +22,12 @@
     "@roarr/browser-log-writer": "^1.3.0",
     "@tanstack/react-table": "^8.11.2",
     "@tinyhttp/app": "^2.2.1",
-    "@types/fluent-ffmpeg": "^2.1.24",
     "ansis": "^2.0.3",
     "classnames": "^2.3.2",
     "command-exists": "^1.2.9",
     "cross-env": "^7.0.3",
     "date-fns": "^3.0.6",
     "electron-squirrel-startup": "^1.0.0",
-    "fluent-ffmpeg": "^2.1.2",
     "immer": "^10.0.3",
     "milliparsec": "^2.3.0",
     "node-taglib-sharp": "^5.2.3",
diff --git a/packages/music-library-app/src/client/store/requestFactories/convertTrackToMP3Request.ts b/packages/music-library-app/src/client/store/requestFactories/convertTrackToMP3Request.ts
@@ -1,13 +1,16 @@
 import type { TrackDefinition } from "@adahiya/music-library-tools-lib";
 import { pick } from "radash";
 
-import { AudioFilesServerRoutes as Routes } from "../../../common/audioFilesServerRoutes";
+import {
+  AudioFilesServerRoutes as Routes,
+  type ConvertTrackToMP3RequestBody,
+} from "../../../common/api/audioFilesServerAPI";
 
 export default function convertTrackToMP3Request(serverBaseURL: string, trackDef: TrackDefinition) {
   return fetch(`${serverBaseURL}${Routes.POST_CONVERT_TO_MP3}`, {
     method: "POST",
     body: JSON.stringify({
-      trackProperties: pick(trackDef, ["Artist", "Album", "Location", "Name", "Track ID"]),
-    }),
+      trackDefinition: pick(trackDef, ["Location", "Persistent ID", "Track ID"]),
+    } satisfies ConvertTrackToMP3RequestBody),
   });
 }
diff --git a/packages/music-library-app/src/client/store/requestFactories/pingRequest.ts b/packages/music-library-app/src/client/store/requestFactories/pingRequest.ts
@@ -1,4 +1,4 @@
-import { AudioFilesServerRoutes as Routes } from "../../../common/audioFilesServerRoutes";
+import { AudioFilesServerRoutes as Routes } from "../../../common/api/audioFilesServerAPI";
 
 export default function pingRequest(serverBaseURL: string) {
   return fetch(`${serverBaseURL}${Routes.GET_PING}`);
diff --git a/packages/music-library-app/src/client/store/slices/audioFilesServerSlice.ts b/packages/music-library-app/src/client/store/slices/audioFilesServerSlice.ts
@@ -2,7 +2,7 @@ import type { TrackDefinition } from "@adahiya/music-library-tools-lib";
 import { Roarr as log } from "roarr";
 import type { ErrorObject } from "serialize-error";
 
-import { AudioFilesServerRoutes as ServerRoutes } from "../../../common/audioFilesServerRoutes";
+import { AudioFilesServerRoutes as ServerRoutes } from "../../../common/api/audioFilesServerAPI";
 import {
   AUDIO_FILES_SERVER_PING_TIMEOUT,
   DEFAULT_AUDIO_FILES_ROOT_FOLDER,
diff --git a/packages/music-library-app/src/common/api/audioFilesServerAPI.ts b/packages/music-library-app/src/common/api/audioFilesServerAPI.ts
@@ -0,0 +1,11 @@
+import type { BasicTrackDefinition } from "@adahiya/music-library-tools-lib";
+
+export const AudioFilesServerRoutes = {
+  GET_PING: "/ping",
+  GET_CONVERTED_MP3: "/convertedMP3",
+  POST_CONVERT_TO_MP3: "/convertToMP3",
+};
+
+export interface ConvertTrackToMP3RequestBody {
+  trackDefinition: BasicTrackDefinition;
+}
diff --git a/packages/music-library-app/src/common/audioFilesServerRoutes.ts b/packages/music-library-app/src/common/audioFilesServerRoutes.ts
diff --git a/packages/music-library-app/src/common/constants.ts b/packages/music-library-app/src/common/constants.ts
@@ -18,10 +18,6 @@ export const WRITE_AUDIO_FILE_TAG_TIMEOUT = 2_000;
 export const WRITE_MODIFIED_LIBRARY_TIMEOUT = 20_000;
 export const ANALYZE_AUDIO_FILE_TIMEOUT = 4_000;
 
-// audio conversion settings
-export const DEFAULT_MP3_BITRATE = 320;
-export const DEFAULT_AUDIO_SAMPLE_RATE = 44_100;
-
 // UI settings
 // eslint-disable-next-line @typescript-eslint/no-inferrable-types
 export const SHOW_TRACK_TABLE_CONTEXT_MENU: boolean = true;
diff --git a/packages/music-library-app/src/common/errorMessages.ts b/packages/music-library-app/src/common/errorMessages.ts
@@ -4,7 +4,6 @@ export const ServerErrors = {
   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`,
   MP3_CODEC_UNAVAILABLE: `No MP3 codec is available`,
-  TEMP_DIR_UNAVAILABLE: `Unable to create a temporary directory for audio file conversion`,
   INVALID_CONVERSION_REQUEST: `Invalid MP3 conversion request`,
   CONVERTED_AUDIO_FILE_NOT_FOUND: `Converted audio file not found`,
 };
diff --git a/packages/music-library-app/src/server/audioFilesServer.ts b/packages/music-library-app/src/server/audioFilesServer.ts
@@ -2,14 +2,14 @@ import { createReadStream, existsSync, readdirSync, statSync } from "node:fs";
 import { type Server } from "node:http";
 import { env } from "node:process";
 
+import { AudioFileConverter } from "@adahiya/music-library-tools-lib";
 import { App, type Request, type Response } from "@tinyhttp/app";
 import sirv from "sirv";
 
-import { AudioFilesServerRoutes as ServerRoutes } from "../common/audioFilesServerRoutes";
+import { AudioFilesServerRoutes as ServerRoutes } from "../common/api/audioFilesServerAPI";
 import { DEFAULT_AUDIO_FILES_SERVER_PORT } from "../common/constants";
 import { ServerErrors } from "../common/errorMessages";
 import { type AudioFilesServerStartedEventPayload } from "../common/events";
-import { AudioFilesConverter } from "./audioFilesConverter";
 import { getConvertToMP3RequestHandler } from "./handlers/convertToMP3Handler";
 import { log } from "./serverLogger";
 
@@ -24,7 +24,7 @@ export interface AudioFilesServerOptions {
 export interface AudioFilesServer {
   /** @internal */
   _app: App;
-  converter: AudioFilesConverter;
+  converter: AudioFileConverter;
   stop: () => void;
 }
 
@@ -46,7 +46,7 @@ export async function startAudioFilesServer(
       validateRootFolderOrThrow(options.audioFilesRootFolder);
 
       log.debug(`Initializing audio files converter...`);
-      const converter = new AudioFilesConverter(options);
+      const converter = new AudioFileConverter();
       const app = initServerApp(converter, options);
 
       if (app === undefined) {
@@ -84,7 +84,7 @@ export async function startAudioFilesServer(
 }
 
 function initServerApp(
-  converter: AudioFilesConverter,
+  converter: AudioFileConverter,
   options: AudioFilesServerOptions,
 ): App | undefined {
   const app = new App();
diff --git a/packages/music-library-app/src/server/handlers/convertToMP3Handler.ts b/packages/music-library-app/src/server/handlers/convertToMP3Handler.ts
@@ -1,21 +1,19 @@
 import { existsSync } from "node:fs";
 import { fileURLToPath } from "node:url";
 
+import type { AudioFileConverter } from "@adahiya/music-library-tools-lib";
 import { type Handler, type NextFunction, type Response } from "@tinyhttp/app";
 import { sync as commandExistsSync } from "command-exists";
 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 {
-  type AudioFilesConverter,
-  type AudioFilesConverterTrackDefinition,
-} from "../audioFilesConverter";
 import { log } from "../serverLogger";
 
-export function getConvertToMP3RequestHandler(converter: AudioFilesConverter): Handler {
+export function getConvertToMP3RequestHandler(converter: AudioFileConverter): Handler {
   return async (
-    req: RequestWithBody<{ trackProperties: AudioFilesConverterTrackDefinition }>,
+    req: RequestWithBody<ConvertTrackToMP3RequestBody>,
     res: Response,
     next: NextFunction,
   ) => {
@@ -31,11 +29,11 @@ export function getConvertToMP3RequestHandler(converter: AudioFilesConverter): H
       return;
     }
 
-    const { trackProperties } = req.body;
-    const inputFilePath = fileURLToPath(trackProperties.Location);
+    const { trackDefinition } = req.body;
+    const inputFilePath = fileURLToPath(trackDefinition.Location);
     log.debug(
       `Handling request for an track with file type unsupported by Web Audio: ${JSON.stringify(
-        trackProperties,
+        trackDefinition,
       )}`,
     );
 
@@ -59,9 +57,9 @@ export function getConvertToMP3RequestHandler(converter: AudioFilesConverter): H
     }
 
     try {
-      const outputFilePath = await converter.convertAudioFileToMP3(trackProperties, {
+      const outputFilePath = await converter.convertAudioFileToMP3(trackDefinition, {
         codec,
-        outputDirKind: "temp",
+        outputDirKind: "temporary",
       });
       res.status(200).send(outputFilePath);
     } catch (e) {
diff --git a/packages/music-library-tools-lib/README.md b/packages/music-library-tools-lib/README.md
@@ -4,7 +4,15 @@
 
 ## Usage guide
 
-Requirements: [Node.js](https://nodejs.org/en) v20.x (see version specified in `.nvmrc`)
+Requirements:
+
+- [Node.js](https://nodejs.org/en) v20.x (see version specified in `.nvmrc`)
+- (To use audio file conversion APIs) `ffmpeg` must be installed and available on the system path.
+  See installation docs for [macOS](https://github.com/fluent-ffmpeg/node-fluent-ffmpeg/wiki/Installing-ffmpeg-on-Mac-OS-X)
+  and [Debian](https://github.com/fluent-ffmpeg/node-fluent-ffmpeg/wiki/Installing-ffmpeg-on-Debian).
+  - Note: you may need to configure your module loader or bundler to patch a buggy conditional import
+    in the `fluent-ffmpeg` package. For example, use this
+    [`resolve.alias` in Vite](https://github.com/fluent-ffmpeg/node-fluent-ffmpeg/issues/573#issuecomment-1082586875)
 
 Installation:
 
diff --git a/packages/music-library-tools-lib/package.json b/packages/music-library-tools-lib/package.json
@@ -16,12 +16,14 @@
   "dependencies": {
     "ansis": "^2.0.3",
     "dedent": "^1.5.1",
+    "fluent-ffmpeg": "^2.1.2",
     "html-entities": "^2.4.0",
     "plist": "^3.1.0",
     "prompts": "^2.4.2"
   },
   "devDependencies": {
     "@types/dedent": "^0.7.2",
+    "@types/fluent-ffmpeg": "^2.1.24",
     "@types/node": "^20.10.5",
     "@types/plist": "^3.0.5",
     "@types/prompts": "^2.4.9",
diff --git a/packages/music-library-tools-lib/src/audio-file-converter/audioFileConverter.ts b/packages/music-library-tools-lib/src/audio-file-converter/audioFileConverter.ts
@@ -3,60 +3,55 @@ import { tmpdir } from "node:os";
 import { basename, dirname, extname, join } from "node:path";
 import { fileURLToPath } from "node:url";
 
-import type { TrackDefinition } from "@adahiya/music-library-tools-lib";
 import ffmpeg from "fluent-ffmpeg";
 
 import {
   DEFAULT_AUDIO_SAMPLE_RATE,
   DEFAULT_MP3_BITRATE,
-  LOCAL_STORAGE_KEY,
-} from "../common/constants";
-import { ServerErrors } from "../common/errorMessages";
-import { type AudioFilesServerOptions } from "./audioFilesServer";
-import { log } from "./serverLogger";
-
-export type AudioFilesConverterConfig = AudioFilesServerOptions;
-
-/** Minimal set of properties required to run the converter */
-export type AudioFilesConverterTrackDefinition = Pick<
-  TrackDefinition,
-  "Artist" | "Album" | "Name" | "Track ID" | "Location"
->;
+  LIB_PACKAGE_NAME,
+} from "../common/constants.js";
+import { LibErrors } from "../common/errrorMessages.js";
+import type { BasicTrackDefinition } from "../models/tracks.js";
+import { log } from "../utils/log.js";
 
 export interface MP3ConversionOptions {
-  /** "libmp3lame" is preferred */
-  codec: string;
-
-  /** Whether to write to a temp directory or to a permanent one (the input file directory) */
-  outputDirKind: "temp" | "permanent";
-
   /** @default 320 */
   bitrate?: number;
 
-  /** @default 44100 */
-  sampleRate?: number;
+  /** "libmp3lame" is preferred */
+  codec: string;
 
   /**
    * Force a re-conversion even if the output file already exists on disk.
    *
    * @default false
    */
   force?: boolean;
+
+  /**
+   * The kind of directory where the output file will be written, either:
+   *  - temporary (creates a temp OS dir path which includes the track ID)
+   *  - permament (same directory as the input file)
+   */
+  outputDirKind: "temporary" | "permanent";
+
+  /** @default 44100 */
+  sampleRate?: number;
 }
 
-export class AudioFilesConverter {
+export default class AudioFileConverter {
   public temporaryOutputDir: string;
 
-  constructor(public config: AudioFilesConverterConfig) {
+  constructor() {
     // 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(), LOCAL_STORAGE_KEY, "converted");
+    const tempDir = join(tmpdir(), LIB_PACKAGE_NAME, "converted");
 
     log.debug(`Creating temporary folder for audio conversion output ${tempDir}`);
     mkdirSync(tempDir, { recursive: true });
 
     if (!existsSync(tempDir)) {
-      throw new Error(ServerErrors.TEMP_DIR_UNAVAILABLE);
+      throw new Error(LibErrors.TEMP_DIR_UNAVAILABLE);
     }
 
     this.temporaryOutputDir = tempDir;
@@ -67,19 +62,14 @@ export class AudioFilesConverter {
    *
    * NOTE: this requires `ffmpeg` to be installed and available on the system path.
    *
-   * TODO: move this the music-library-tools-lib package once we figure out how to export values
-   * correctly (currently, only type exports work properly)
-   *
    * @returns the output file path on disk, if successful
    * @throws if the output file path could not be created on disk
    */
   public async convertAudioFileToMP3(
-    /** Track properties necessary for the conversion, including the input file location on disk */
-    trackProperties: AudioFilesConverterTrackDefinition,
-    /** MP3 conversion options forwarded to ffmpeg */
+    trackDef: BasicTrackDefinition,
     options: MP3ConversionOptions,
   ): Promise<string> {
-    const inputFilePath = fileURLToPath(trackProperties.Location);
+    const inputFilePath = fileURLToPath(trackDef.Location);
     const {
       bitrate = DEFAULT_MP3_BITRATE,
       codec,
@@ -92,8 +82,8 @@ export class AudioFilesConverter {
     const inputFileStream = createReadStream(inputFilePath);
     const outputFileName = basename(inputFilePath).replace(extname(inputFilePath), ".mp3");
     const outputFolder =
-      outputDirKind === "temp"
-        ? this.createTempOutputDirForTrack(trackProperties)
+      outputDirKind === "temporary"
+        ? this.createTempOutputDirForTrack(trackDef)
         : dirname(inputFilePath);
     const outputFilePath = join(outputFolder, outputFileName);
 
@@ -103,15 +93,15 @@ export class AudioFilesConverter {
     }
 
     return new Promise<string>((resolve, reject) => {
-      console.time(`audioFileConverter`);
+      console.time(`convertAudioFileToMP3`);
       ffmpeg(inputFileStream)
         .audioCodec(codec)
         .audioBitrate(bitrate)
         .audioFrequency(sampleRate)
         .noVideo()
         .save(outputFilePath)
         .on("end", () => {
-          console.timeEnd(`audioFileConverter`);
+          console.timeEnd(`convertAudioFileToMP3`);
           log.debug(`Wrote converted MP3 at ${outputFilePath}`);
           resolve(outputFilePath);
         })
@@ -126,13 +116,13 @@ export class AudioFilesConverter {
   }
 
   /** @throws if unable to create output dir */
-  private createTempOutputDirForTrack(trackProperties: AudioFilesConverterTrackDefinition): string {
-    const outputDir = join(this.temporaryOutputDir, `track-id-${trackProperties["Track ID"]}`);
-    mkdirSync(join(this.temporaryOutputDir, `track-id-${trackProperties["Track ID"]}`), {
+  private createTempOutputDirForTrack(trackDef: BasicTrackDefinition): string {
+    const outputDir = join(this.temporaryOutputDir, `track-id-${trackDef["Track ID"]}`);
+    mkdirSync(join(this.temporaryOutputDir, `track-id-${trackDef["Track ID"]}`), {
       recursive: true,
     });
     if (!existsSync(outputDir)) {
-      throw new Error(ServerErrors.TEMP_DIR_UNAVAILABLE);
+      throw new Error(LibErrors.TEMP_DIR_UNAVAILABLE);
     }
     return outputDir;
   }
diff --git a/packages/music-library-tools-lib/src/common/constants.ts b/packages/music-library-tools-lib/src/common/constants.ts
@@ -0,0 +1,5 @@
+export const LIB_PACKAGE_NAME = "@adahiya/music-library-tools-lib";
+
+// audio conversion settings
+export const DEFAULT_MP3_BITRATE = 320;
+export const DEFAULT_AUDIO_SAMPLE_RATE = 44_100;
diff --git a/packages/music-library-tools-lib/src/common/errrorMessages.ts b/packages/music-library-tools-lib/src/common/errrorMessages.ts
@@ -0,0 +1,3 @@
+export const LibErrors = {
+  TEMP_DIR_UNAVAILABLE: `Unable to create a temporary directory for audio file conversion`,
+};
diff --git a/packages/music-library-tools-lib/src/index.ts b/packages/music-library-tools-lib/src/index.ts
@@ -1,3 +1,7 @@
+export {
+  default as AudioFileConverter,
+  type MP3ConversionOptions,
+} from "./audio-file-converter/audioFileConverter.js";
 export {
   getDefaultSwinsianExportFolder,
   getOutputLibraryPath,
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import { AudioFilesServerRoutes as Routes } from "../../../common/audioFilesServerRoutes";`
	`1`	`+import { AudioFilesServerRoutes as Routes } from "../../../common/api/audioFilesServerAPI";`
`2`	`2`
`3`	`3`	`export default function pingRequest(serverBaseURL: string) {`
`4`	`4`	return fetch(`${serverBaseURL}${Routes.GET_PING}`);