bob

.devcontainer/Dockerfile

@@ -1,4 +1,4 @@
-FROM node:16-bullseye
+FROM node:20-bullseye
 
 LABEL maintainer=simojenki
 

.devcontainer/devcontainer.json

@@ -10,8 +10,9 @@
         "BNB_DEV_SUBSONIC_URL": "${localEnv:BNB_DEV_SUBSONIC_URL}"
     },
     "remoteUser": "node",
+    "forwardPorts": [4534],
     "features": {
-        "ghcr.io/devcontainers/features/docker-in-docker:1": {
+        "ghcr.io/devcontainers/features/docker-in-docker:2": {
             "version": "latest",
             "moby": true
         }

.github/workflows/ci.yml

@@ -21,11 +21,11 @@ jobs:
       -
         uses: actions/setup-node@v3
         with:
-          node-version: '16'
+          node-version: 20
       -
-        run: yarn install
+        run: npm install
       -
-        run: yarn test
+        run: npm test
 
 
   push_to_registry:

.npmrc

@@ -0,0 +1 @@
+fetch-timeout=60000

.nvmrc

@@ -1 +0,0 @@
-16.6.2

.yarnrc.yml

@@ -1,3 +0,0 @@
-nodeLinker: node-modules
-
-yarnPath: .yarn/releases/yarn-1.22.19.cjs

Dockerfile

@@ -1,4 +1,4 @@
-FROM node:16-bullseye-slim as build
+FROM node:20-bullseye-slim as build
 
 WORKDIR /bonob
 
@@ -9,12 +9,11 @@ COPY typings ./typings
 COPY web ./web
 COPY tests ./tests
 COPY jest.config.js .
-COPY package.json .
 COPY register.js .
+COPY .npmrc .
 COPY tsconfig.json .
-COPY yarn.lock .
-COPY .yarnrc.yml .
-COPY .yarn/releases ./.yarn/releases
+COPY package.json .
+COPY package-lock.json .
 
 ENV JEST_TIMEOUT=60000
 ENV DEBIAN_FRONTEND=noninteractive
@@ -29,24 +28,15 @@ RUN apt-get update && \
         g++ && \
     apt-get clean && \
     rm -rf /var/lib/apt/lists/* && \
-    yarn config set network-timeout 600000 -g && \
-    yarn install \
-        --prefer-offline \
-        --frozen-lockfile \
-        --non-interactive \
-        --production=false && \
-    yarn test --no-cache && \
-    yarn gitinfo && \
-    yarn build && \
+    npm install && \
+    npm test && \
+    npm run gitinfo && \
+    npm run build && \
     rm -Rf node_modules && \
-    NODE_ENV=production yarn install \
-        --prefer-offline \
-        --pure-lockfile \
-        --non-interactive \
-        --production=true
+    NODE_ENV=production npm install --omit=dev
 
 
-FROM node:16-bullseye-slim
+FROM node:20-bullseye-slim
 
 LABEL   maintainer="simojenki" \
         org.opencontainers.image.source="https://github.com/simojenki/bonob" \
@@ -62,7 +52,7 @@ EXPOSE $BNB_PORT
 WORKDIR /bonob
 
 COPY package.json .
-COPY yarn.lock .
+COPY package-lock.json .
 
 COPY --from=build /bonob/build/src ./src
 COPY --from=build /bonob/node_modules ./node_modules
@@ -75,7 +65,7 @@ RUN apt-get update && \
     apt-get -y install --no-install-recommends \
         libvips \
         tzdata \
-				wget && \
+        wget && \
     apt-get clean && \
     rm -rf /var/lib/apt/lists/*
 

README.md

@@ -16,7 +16,7 @@ Support for Subsonic API clones (tested against Navidrome and Gonic).
 - Search by Album, Artist, Track
 - Playlist editing through sonos app.
 - Marking of songs as favourites and with ratings through the sonos app.
-- Localization (only en-US, da-DK & nl-NL supported currently, require translations for other languages).  [Sonos localization and supported languages](https://developer.sonos.com/build/content-service-add-features/strings-and-localization/)
+- Localization (only en-US, da-DK & nl-NL supported currently, require translations for other languages).  [Sonos localization and supported languages](https://docs.sonos.com/docs/localization)
 - Auto discovery of sonos devices
 - Discovery of sonos devices using seed IP address
 - Auto registration with sonos on start
@@ -218,17 +218,11 @@ Afterwards the Sonos app displays a dropdown underneath the service, allowing to
 - Implement the MusicService/MusicLibrary interface
 - Startup bonob with your new implementation.
 
-## A note on transcoding
-
-tldr; Transcoding to mp3/m4a is not supported as sonos devices will not play the track.  However transcoding to flac does work, use BNB_SUBSONIC_CUSTOM_CLIENTS=audio/flac if you want to transcode flac->flac ie. to downsample HD flacs (see below).
-
-Sonos devices are very particular about how audio streams are presented to them, see [streaming basics](https://developer.sonos.com/build/content-service-add-features/streaming-basics/).  When using transcoding both Navidrome and Gonic report no 'content-length', nor do they support range queries, this will cause the sonos device to fail to play the track.
-
 ### Audio File type specific transcoding options within Subsonic
 
-In some situations you may wish to have different 'Players' within you Subsonic server so that you can configure different transcoding options depending on the file type.  For example if you have flacs with a mixture of frequency formats where not all are supported by sonos [See issue #52](https://github.com/simojenki/bonob/issues/52) & [Sonos supported audio formats](https://developer.sonos.com/build/content-service-add-features/supported-audio-formats/)
+In some situations you may wish to have different 'Players' within your Subsonic server so that you can configure different transcoding options depending on the file type.  For example if you have flacs with a mixture of frequency formats where not all are supported by sonos [See issue #52](https://github.com/simojenki/bonob/issues/52) & [Sonos supported audio formats](https://docs.sonos.com/docs/supported-audio-formats)
 
-In this case you could set;
+If you simple wish to have a custom client that transcodes from audio/flac->audio/flac then you could set;
 
 ```bash
 BNB_SUBSONIC_CUSTOM_CLIENTS="audio/flac"

package.json

@@ -7,66 +7,72 @@
   "license": "GPL-3.0-only",
   "dependencies": {
     "@svrooij/sonos": "^2.5.0",
-    "@types/express": "^4.17.17",
-    "@types/fs-extra": "^11.0.1",
-    "@types/jsonwebtoken": "^9.0.1",
-    "@types/jws": "^3.2.5",
-    "@types/morgan": "^1.9.4",
-    "@types/node": "^16.11.7",
-    "@types/randomstring": "^1.1.8",
-    "@types/sharp": "^0.31.1",
-    "@types/underscore": "^1.11.4",
-    "@types/uuid": "^9.0.1",
-    "@types/xmldom": "0.1.31",
-    "axios": "^1.3.4",
-    "dayjs": "^1.11.7",
-    "eta": "^2.0.1",
+    "@types/express": "^4.17.21",
+    "@types/fs-extra": "^11.0.4",
+    "@types/jsonwebtoken": "^9.0.5",
+    "@types/jws": "^3.2.9",
+    "@types/morgan": "^1.9.9",
+    "@types/node": "^20.11.5",
+    "@types/randomstring": "^1.1.11",
+    "@types/underscore": "^1.11.15",
+    "@types/uuid": "^9.0.7",
+    "@types/xmldom": "0.1.34",
+    "axios": "^1.6.5",
+    "dayjs": "^1.11.10",
+    "eta": "^2.2.0",
     "express": "^4.18.2",
-    "fp-ts": "^2.13.1",
-    "fs-extra": "^11.1.0",
-    "jsonwebtoken": "^9.0.0",
+    "fp-ts": "^2.16.2",
+    "fs-extra": "^11.2.0",
+    "jsonwebtoken": "^9.0.2",
     "jws": "^4.0.0",
-    "libxmljs2": "^0.31.0",
+    "libxmljs2": "^0.33.0",
     "morgan": "^1.10.0",
-    "node-html-parser": "^6.1.5",
-    "randomstring": "^1.2.3",
-    "sharp": "^0.31.3",
+    "node-html-parser": "^6.1.12",
+    "randomstring": "^1.3.0",
+    "sharp": "^0.33.2",
     "soap": "^1.0.0",
     "ts-md5": "^1.3.1",
-    "typescript": "^4.9.5",
+    "typescript": "^5.3.3",
     "underscore": "^1.13.6",
     "urn-lib": "^2.0.0",
-    "uuid": "^9.0.0",
-    "winston": "^3.8.2",
+    "uuid": "^9.0.1",
+    "winston": "^3.11.0",
     "xmldom-ts": "^0.3.1"
   },
   "devDependencies": {
-    "@types/chai": "^4.3.4",
-    "@types/jest": "^29.4.0",
-    "@types/mocha": "^10.0.1",
-    "@types/supertest": "^2.0.12",
-    "@types/tmp": "^0.2.3",
-    "chai": "^4.3.7",
-    "get-port": "^6.1.2",
-    "image-js": "^0.35.3",
-    "jest": "^29.4.3",
-    "nodemon": "^2.0.21",
-    "supertest": "^6.3.3",
+    "@types/chai": "^4.3.11",
+    "@types/jest": "^29.5.11",
+    "@types/mocha": "^10.0.6",
+    "@types/supertest": "^6.0.2",
+    "@types/tmp": "^0.2.6",
+    "chai": "^5.0.0",
+    "get-port": "^7.0.0",
+    "image-js": "^0.35.5",
+    "jest": "^29.7.0",
+    "nodemon": "^3.0.3",
+    "supertest": "^6.3.4",
     "tmp": "^0.2.1",
-    "ts-jest": "^29.0.5",
+    "ts-jest": "^29.1.2",
     "ts-mockito": "^2.6.1",
-    "ts-node": "^10.9.1",
+    "ts-node": "^10.9.2",
     "xmldom-ts": "^0.3.1",
     "xpath-ts": "^1.3.13"
   },
+  "overrides": {
+    "axios-ntlm": "npm:dry-uninstall",
+    "axios": "$axios",
+    "@svrooij/sonos": {
+      "fast-xml-parser": "^3.21.1"
+    }
+  },
   "scripts": {
     "clean": "rm -Rf build node_modules",
     "build": "tsc",
     "dev": "BNB_LOG_LEVEL=debug BNB_DEBUG=true BNB_SCROBBLE_TRACKS=false BNB_REPORT_NOW_PLAYING=false BNB_SONOS_SEED_HOST=$BNB_DEV_SONOS_DEVICE_IP BNB_SONOS_SERVICE_NAME=z_bonobDev BNB_URL=\"http://${BNB_DEV_HOST_IP}:4534\" BNB_SUBSONIC_URL=\"${BNB_DEV_SUBSONIC_URL}\" nodemon -V ./src/app.ts",
-    "devr": "BNB_DISABLE_PLAYLIST_ART=true BNB_LOG_LEVEL=debug BNB_DEBUG=true BNB_SCROBBLE_TRACKS=false BNB_REPORT_NOW_PLAYING=false BNB_ICON_FOREGROUND_COLOR=white BNB_ICON_BACKGROUND_COLOR=darkgrey BNB_SONOS_SEED_HOST=$BNB_DEV_SONOS_DEVICE_IP BNB_SONOS_SERVICE_NAME=z_bonobDev BNB_SONOS_DEVICE_DISCOVERY=true BNB_SONOS_AUTO_REGISTER=true BNB_URL=\"http://${BNB_DEV_HOST_IP}:4534\" BNB_SUBSONIC_URL=\"${BNB_DEV_SUBSONIC_URL}\" nodemon -V ./src/app.ts",
+    "devr": "BNB_DISABLE_PLAYLIST_ART=true BNB_LOG_LEVEL=debug BNB_DEBUG=true BNB_SCROBBLE_TRACKS=false BNB_REPORT_NOW_PLAYING=false BNB_SONOS_SEED_HOST=$BNB_DEV_SONOS_DEVICE_IP BNB_SONOS_SERVICE_NAME=z_bonobDev BNB_SONOS_DEVICE_DISCOVERY=true BNB_SONOS_AUTO_REGISTER=true BNB_URL=\"http://${BNB_DEV_HOST_IP}:4534\" BNB_SUBSONIC_URL=\"${BNB_DEV_SUBSONIC_URL}\" nodemon -V ./src/app.ts",
     "register-dev": "ts-node ./src/register.ts http://${BNB_DEV_HOST_IP}:4534",
     "test": "jest",
+    "testw": "jest --watch",
     "gitinfo": "git describe --tags > .gitinfo"
-  },
-  "packageManager": "yarn@1.22.19"
+  }
 }

src/sonos.ts

@@ -176,7 +176,7 @@ export function autoDiscoverySonos(sonosSeedHost?: string): Sonos {
         }
       })
       .catch((e) => {
-        logger.error(`Failed looking for sonos devices`, { cause: e });
+        logger.error(`Failed looking for sonos devices - ${e}`, { cause: e });
         return [];
       });
   };

src/subsonic.ts

@@ -163,6 +163,7 @@ export type song = {
   bitRate: number | undefined;
   suffix: string | undefined;
   contentType: string | undefined;
+  transcodedContentType: string | undefined;
   type: string | undefined;
   userRating: number | undefined;
   starred: string | undefined;
@@ -273,7 +274,7 @@ export const artistImageURN = (
 export const asTrack = (album: Album, song: song): Track => ({
   id: song.id,
   name: song.title,
-  mimeType: song.contentType!,
+  mimeType: song.transcodedContentType ? song.transcodedContentType : song.contentType!,
   duration: song.duration || 0,
   number: song.track || 0,
   genre: maybeAsGenre(song.genre),
@@ -956,6 +957,7 @@ export class Subsonic implements MusicService {
     };
 
     if (credentials.type == "navidrome") {
+      // todo: there does not seem to be a test for this??
       return Promise.resolve({
         ...genericSubsonic,
         flavour: () => "navidrome",
@@ -964,7 +966,7 @@ export class Subsonic implements MusicService {
             TE.tryCatch(
               () =>
                 axios.post(
-                  `${this.url}/auth/login`,
+                  this.url.append({ pathname: '/auth/login' }).href(),
                   _.pick(credentials, "username", "password")
                 ),
               () => new AuthFailure("Failed to get bearerToken")

tests/subsonic.test.ts

@@ -322,6 +322,7 @@ const asSongJson = (track: Track) => ({
   size: "5624132",
   suffix: "mp3",
   contentType: track.mimeType,
+  transcodedContentType: undefined,
   isVideo: "false",
   path: "ACDC/High voltage/ACDC - The Jack.mp3",
   albumId: track.album.id,
@@ -686,8 +687,31 @@ describe("asTrack", () => {
       });
     });
   });
+
+  describe("when the song has a transcodedContentType", () => {
+    const album = anAlbum();
+
+    describe("with an undefined value", () => {
+      const track = aTrack({ mimeType: "sourced-from/mimeType" });
+
+      it("should fall back on the default mime", () => {
+        const result = asTrack(album, { ...asSongJson(track), transcodedContentType: undefined });
+        expect(result.mimeType).toEqual("sourced-from/mimeType")
+      });
+    });
+      
+    describe("with a value", () => {
+      const track = aTrack({ mimeType: "sourced-from/mimeType" });
+
+      it("should use the transcoded value", () => {
+        const result = asTrack(album, { ...asSongJson(track), transcodedContentType: "sourced-from/transcodedContentType" });
+        expect(result.mimeType).toEqual("sourced-from/transcodedContentType")
+      });
+    });
+  });
 });
 
+
 describe("Subsonic", () => {
   const url = new URLBuilder("http://127.0.0.22:4567/some-context-path");
   const username = `user1-${uuid()}`;
@@ -928,6 +952,34 @@ describe("Subsonic", () => {
     });
   });
 
+  describe("bearerToken", () => {
+    describe("when flavour is generic subsonic", () => {
+      it("should return undefined", async () => {
+        const credentials = { username: "foo", password: "bar" };
+        const token = { ...credentials, type: "subsonic", bearer: undefined  }
+        const client = await subsonic.login(asToken(token));
+        
+        const bearerToken = await pipe(client.bearerToken(credentials))();
+        expect(bearerToken).toStrictEqual(E.right(undefined));
+      });
+    });
+
+    describe("when flavour is navidrome", () => {
+      it("should get a bearerToken from navidrome", async () => {
+        const credentials = { username: "foo", password: "bar" };
+        const token = { ...credentials, type: "navidrome", bearer: undefined  }
+        const client = await subsonic.login(asToken(token));
+
+        mockPOST.mockImplementationOnce(() => Promise.resolve(ok({ token: 'theBearerToken' })))
+        
+        const bearerToken = await pipe(client.bearerToken(credentials))();
+        expect(bearerToken).toStrictEqual(E.right('theBearerToken'));
+
+        expect(axios.post).toHaveBeenCalledWith(url.append({ pathname: '/auth/login' }).href(), credentials)
+      });
+    });
+  });
+
   describe("getting genres", () => {
     describe("when there are none", () => {
       beforeEach(() => {

tsconfig.json

@@ -50,7 +50,7 @@
     // "rootDirs": [],                        /* List of root folders whose combined content represents the structure of the project at runtime. */
     "typeRoots": [
       "./typings",
-      "node_modules/@types"
+      "./node_modules/@types"
     ]
      /* List of folders to include type definitions from. */,
     // "types": ["src/customTypes/scale-that-svg.d.ts"],                           /* Type declaration files to be included in compilation. */