gerdur-core 2.18.0 → 2.19.0

package/CHANGELOG.md

@@ -1,5 +1,39 @@
 # Changelog
 
+## 2.19.0 - 2026-08-31
+
+### Changed
+
+- **The Musixmatch lyrics fallback now latches off when it isn't working.**
+  For tracks Deezer has no lyrics for, the tagger scrapes Musixmatch — two page
+  loads each. Where Musixmatch blocks the request (it 403s from many networks and
+  most datacentres) every one of those still costs a round trip and still returns
+  nothing. Measured on a 14-track album: **2021 ms, 70% of total tagging time**,
+  for 3 KB of error pages.
+
+  After three consecutive *transport* failures the scraper stops being attempted
+  for the rest of the process. A track simply not being on Musixmatch does **not**
+  count toward that — the service is working fine in that case — so a run of
+  obscure tracks cannot disable a fallback that would otherwise succeed, and any
+  success resets the counter.
+
+  Measured, same album, default options: **2880 ms → 2641 ms on the first album
+  (the latch trips part-way through), then 653 / 729 ms — 77% faster in steady
+  state**, which is the case that matters for a library sync.
+
+### Added
+
+- **`configureMusixmatch({maxFailures?, enabled?})`** and **`musixmatchStatus()`**
+  → `{available, consecutiveFailures, maxFailures}`. Re-enabling clears the
+  count; nonsensical thresholds are rejected.
+
+### Not done, deliberately
+
+- Sending `Accept-Encoding` on the clients that don't set it. Measured the wire
+  first: a 14-track album transfers 176 KB, of which **111 KB is cover-art JPEG**
+  (incompressible) and 65 KB is `api.deezer.com` JSON that is **already gzipped**.
+  Musixmatch returns 3 KB total. The saving would have been ~0.
+
 ## 2.18.0 - 2026-08-31
 
 Write operations — the first part of this package that changes an account.

package/README.md

@@ -589,7 +589,7 @@ model.contributors;  // normalised producers / engineers / performers / …
 | `album` / `lyrics` / `publicTrack` | — | pre-fetched payloads — pass once per album to skip refetching |
 | `embedCover` / `embedArtistImage` | `true` | |
 | `writeLyrics` / `embedSyncedLyrics` | `true` | synced LRC goes to FLAC Vorbis only (no ID3v2.3 `SYLT`) |
-| `lyricsFallback` | `true` | scrape Musixmatch when Deezer has no lyrics — 2 requests per such track, and they fail where Musixmatch blocks you |
+| `lyricsFallback` | `true` | scrape Musixmatch when Deezer has no lyrics — 2 requests per such track. Latches off automatically after 3 consecutive transport failures (see below) |
 | `richCredits` | `true` | hydrate credits + BPM for album/playlist tracks that omit them |
 | `deezerIds` / `includeRank` | `true` | write `DEEZER_*_ID` / popularity rank |
 
@@ -616,6 +616,22 @@ await pipeline(stream, createTagStream(model), createWriteStream('track.flac'));
 `resolveTagModel(track, options?)` does exactly what `addTrackTags` does minus
 the writing — same fetches, same coalescing, same `AddTrackTagsOptions`.
 
+**The Musixmatch fallback looks after itself.** Where Musixmatch blocks you — it
+403s from many networks and most datacentres — those scrapes cost a round trip
+each and return nothing: 2021 ms on a 14-track album, 70% of tagging time. After
+three consecutive *transport* failures it stops being attempted for the rest of
+the process, taking that album to 653 ms. A track simply not being on Musixmatch
+doesn't count toward the latch, so it can't disable itself where it actually
+works, and any success resets it.
+
+```ts
+import {configureMusixmatch, musixmatchStatus} from 'gerdur-core';
+
+musixmatchStatus();                          // {available, consecutiveFailures, maxFailures}
+configureMusixmatch({maxFailures: 5});       // more patient
+configureMusixmatch({enabled: false});       // never scrape at all
+```
+
 Building blocks, if you want the model without writing tags:
 
 - **`getRichAlbum(albId)`** → merged gw + public album metadata (`RichAlbum`).
@@ -860,7 +876,8 @@ import type {
 `addFavoriteTracks` · `removeFavoriteTracks` · `addFavoriteAlbum` ·
 `removeFavoriteAlbum` · `addFavoriteArtist` · `removeFavoriteArtist` ·
 `followPlaylist` · `unfollowPlaylist` · `addFavoriteShow` · `createPlaylist` ·
-`addTracksToPlaylist` · `removeTracksFromPlaylist`
+`addTracksToPlaylist` · `removeTracksFromPlaylist` · `configureMusixmatch` ·
+`musixmatchStatus`
 </details>
 
 <details>

package/dist/metadata-writer/index.d.ts

@@ -5,6 +5,8 @@ import type { lyricsType, trackType, trackTypePublicApi } from '../types';
 export { normalizeContributors } from './contributors';
 export type { NormalizedContributors } from './contributors';
 export { toLrc } from './lrc';
+export { configureMusixmatch, musixmatchStatus } from './musixmatchLyrics';
+export type { MusixmatchOptions } from './musixmatchLyrics';
 export { getRichAlbum } from './rich-album';
 export type { RichAlbum } from './rich-album';
 export { buildTagModel } from './model';

package/dist/metadata-writer/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.addTrackTags = exports.resolveTagModel = exports.probeAudioOffset = exports.createTagStream = exports.MAX_COVER_SIZE = exports.downloadArtistImage = exports.downloadAlbumCover = exports.buildTagModel = exports.getRichAlbum = exports.toLrc = exports.normalizeContributors = void 0;
+exports.addTrackTags = exports.resolveTagModel = exports.probeAudioOffset = exports.createTagStream = exports.MAX_COVER_SIZE = exports.downloadArtistImage = exports.downloadAlbumCover = exports.buildTagModel = exports.getRichAlbum = exports.musixmatchStatus = exports.configureMusixmatch = exports.toLrc = exports.normalizeContributors = void 0;
 const abumCover_1 = require("./abumCover");
 const getTrackLyrics_1 = require("./getTrackLyrics");
 const id3_1 = require("./id3");
@@ -12,6 +12,9 @@ var contributors_1 = require("./contributors");
 Object.defineProperty(exports, "normalizeContributors", { enumerable: true, get: function () { return contributors_1.normalizeContributors; } });
 var lrc_1 = require("./lrc");
 Object.defineProperty(exports, "toLrc", { enumerable: true, get: function () { return lrc_1.toLrc; } });
+var musixmatchLyrics_1 = require("./musixmatchLyrics");
+Object.defineProperty(exports, "configureMusixmatch", { enumerable: true, get: function () { return musixmatchLyrics_1.configureMusixmatch; } });
+Object.defineProperty(exports, "musixmatchStatus", { enumerable: true, get: function () { return musixmatchLyrics_1.musixmatchStatus; } });
 var rich_album_2 = require("./rich-album");
 Object.defineProperty(exports, "getRichAlbum", { enumerable: true, get: function () { return rich_album_2.getRichAlbum; } });
 var model_2 = require("./model");

package/dist/metadata-writer/musixmatchLyrics.d.ts

@@ -1 +1,17 @@
+declare let maxFailures: number;
+export interface MusixmatchOptions {
+    /** consecutive transport failures before the scraper latches off. Default 3. */
+    maxFailures?: number;
+    /** force it back on (or off) — also clears the failure count when enabling */
+    enabled?: boolean;
+}
+/** Tune or reset the Musixmatch fallback. */
+export declare const configureMusixmatch: (options?: MusixmatchOptions) => void;
+/** Whether the fallback is still being attempted, and how close it is to latching off. */
+export declare const musixmatchStatus: () => {
+    available: boolean;
+    consecutiveFailures: number;
+    maxFailures: number;
+};
 export declare const getLyricsMusixmatch: (query: string) => Promise<string>;
+export {};

package/dist/metadata-writer/musixmatchLyrics.js

@@ -1,10 +1,47 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getLyricsMusixmatch = void 0;
+exports.getLyricsMusixmatch = exports.musixmatchStatus = exports.configureMusixmatch = void 0;
 const node_html_parser_1 = require("node-html-parser");
 const http_1 = require("../lib/http");
 const useragents_1 = require("./useragents");
 const baseUrl = 'https://musixmatch.com';
+/**
+ * Musixmatch is a *fallback* for tracks Deezer has no lyrics for — two scraped
+ * page loads each. Where Musixmatch blocks the request (it 403s from plenty of
+ * networks and datacentres) every one of those still costs a round trip and
+ * still returns nothing: measured at **2021 ms per 14-track album, 70% of all
+ * tagging time**, for 3 KB of error pages.
+ *
+ * So after a few consecutive *transport* failures the scraper latches off for
+ * the rest of the process. A track simply not being on Musixmatch does **not**
+ * count — that means the service is working fine — so a run of obscure tracks
+ * can't disable a fallback that would otherwise work. Any success resets it.
+ */
+let consecutiveTransportFailures = 0;
+let latchedOff = false;
+let maxFailures = 3;
+/** Errors we raise ourselves for a legitimate miss, as opposed to the service failing. */
+const MISS = /^No (song|lyrics) found!$/;
+/** Tune or reset the Musixmatch fallback. */
+const configureMusixmatch = (options = {}) => {
+    if (typeof options.maxFailures === 'number' && options.maxFailures > 0) {
+        maxFailures = Math.floor(options.maxFailures);
+    }
+    if (options.enabled !== undefined) {
+        latchedOff = !options.enabled;
+        if (options.enabled) {
+            consecutiveTransportFailures = 0;
+        }
+    }
+};
+exports.configureMusixmatch = configureMusixmatch;
+/** Whether the fallback is still being attempted, and how close it is to latching off. */
+const musixmatchStatus = () => ({
+    available: !latchedOff,
+    consecutiveFailures: consecutiveTransportFailures,
+    maxFailures,
+});
+exports.musixmatchStatus = musixmatchStatus;
 const getUrlMusixmatch = async (query) => {
     var _a;
     const data = await (0, http_1.getText)(`${baseUrl}/search/${encodeURI(query)}/tracks`, {
@@ -20,7 +57,7 @@ const getUrlMusixmatch = async (query) => {
     }
     throw new Error('No song found!');
 };
-const getLyricsMusixmatch = async (query) => {
+const scrape = async (query) => {
     const url = await getUrlMusixmatch(query);
     const data = await (0, http_1.getText)(url, {
         headers: {
@@ -36,4 +73,25 @@ const getLyricsMusixmatch = async (query) => {
     lyrics = lyrics.replace('"body":"', '').replace('","language"', '');
     return lyrics.split('\\n').join('\n');
 };
+const getLyricsMusixmatch = async (query) => {
+    var _a;
+    if (latchedOff) {
+        throw new Error('Musixmatch fallback is unavailable from this network (latched off)');
+    }
+    try {
+        const lyrics = await scrape(query);
+        consecutiveTransportFailures = 0; // it works — forget any earlier trouble
+        return lyrics;
+    }
+    catch (err) {
+        // a track that simply isn't there says nothing about the service
+        if (!MISS.test((_a = err === null || err === void 0 ? void 0 : err.message) !== null && _a !== void 0 ? _a : '')) {
+            consecutiveTransportFailures += 1;
+            if (consecutiveTransportFailures >= maxFailures) {
+                latchedOff = true;
+            }
+        }
+        throw err;
+    }
+};
 exports.getLyricsMusixmatch = getLyricsMusixmatch;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gerdur-core",
-  "version": "2.18.0",
+  "version": "2.19.0",
   "description": "Deezer API client, cross-service URL resolution, Blowfish track decryption and MP3/FLAC metadata tagging — the engine behind the gerdur CLI.",
   "keywords": [
     "deezer",