Ability to disable album art for playlists (#159)

* ci: Push image to GHCR

* ci: Update build actions

.devcontainer/Dockerfile

@@ -3,6 +3,7 @@ FROM node:16-bullseye
 LABEL maintainer=simojenki
 
 ENV JEST_TIMEOUT=60000
+EXPOSE 4534
 
 RUN apt-get update && \
     apt-get -y upgrade && \

.devcontainer/devcontainer.json

@@ -3,6 +3,12 @@
     "build": { 
         "dockerfile": "Dockerfile" 
     },
+    "containerEnv": {
+        // these env vars need to be configured appropriately for your local dev env
+        "BNB_DEV_SONOS_DEVICE_IP": "${localEnv:BNB_DEV_SONOS_DEVICE_IP}",
+        "BNB_DEV_HOST_IP": "${localEnv:BNB_DEV_HOST_IP}",
+        "BNB_DEV_SUBSONIC_URL": "${localEnv:BNB_DEV_SUBSONIC_URL}"
+    },
     "remoteUser": "node",
     "features": {
         "ghcr.io/devcontainers/features/docker-in-docker:1": {

.github/workflows/ci.yml

@@ -17,9 +17,9 @@ jobs:
     steps:
       -
         name: Check out the repo
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
       -
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v3
         with:
           node-version: '16'
       -
@@ -29,37 +29,47 @@ jobs:
 
 
   push_to_registry:
-    name: Push Docker image to Docker Hub
+    name: Push Docker image to Docker registries
     needs: build_and_test
     runs-on: ubuntu-latest
     steps:
       -
         name: Check out the repo
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
           fetch-depth: 0
       -
         name: Set up QEMU
-        uses: docker/setup-qemu-action@v1
+        uses: docker/setup-qemu-action@v2
       -
         name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v1
+        uses: docker/setup-buildx-action@v2
       -
         name: Docker meta
         id: meta
-        uses: docker/metadata-action@v3
+        uses: docker/metadata-action@v4
         with:
-          images: simojenki/bonob
+          images: |
+            simojenki/bonob
+            ghcr.io/simojenki/bonob
       -
         name: Login to DockerHub
         if: github.event_name != 'pull_request'
-        uses: docker/login-action@v1
+        uses: docker/login-action@v2
         with:
           username: ${{ secrets.DOCKERHUB_USERNAME }}
           password: ${{ secrets.DOCKERHUB_TOKEN }}
       -
-        name: Push to Docker Hub
+        name: Log in to GitHub Container registry
-        uses: docker/build-push-action@v2
+        if: github.event_name != 'pull_request'
+        uses: docker/login-action@v2
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+      -
+        name: Push image
+        uses: docker/build-push-action@v4
         with:
           context: .
           platforms: linux/amd64,linux/arm/v7,linux/arm64

Dockerfile

@@ -48,7 +48,10 @@ RUN apt-get update && \
 
 FROM node:16-bullseye-slim
 
-LABEL maintainer=simojenki
+LABEL   maintainer="simojenki" \
+        org.opencontainers.image.source="https://github.com/simojenki/bonob" \
+        org.opencontainers.image.description="bonob SONOS SMAPI implementation" \
+        org.opencontainers.image.licenses="GPLv3"
 
 ENV BNB_PORT=4534
 ENV DEBIAN_FRONTEND=noninteractive

README.md

@@ -25,7 +25,23 @@ Support for Subsonic API clones (tested against Navidrome and Gonic).
 
 ## Running
 
-bonob is distributed via docker and can be run in a number of ways
+bonob is packaged as an OCI image to both the docker hub registry and github registry.
+
+ie. 
+```bash
+docker pull docker.io/simojenki/bonob
+```
+or
+```bash
+docker pull ghcr.io/simojenki/bonob
+```
+
+tag | description
+--- | ---
+latest | Latest release, intended to be stable
+master | Laster build from master, probably works, however is currently under test in
+vX.Y.Z | Fixed release versions from tags, for those that want to pin to specific release
+
 
 ### Full sonos device auto-discovery and auto-registration using docker --network host
 
@@ -146,6 +162,9 @@ BNB_PORT | 4534 | Default http port for bonob to listen on
 BNB_URL | http://$(hostname):4534 | URL (including path) for bonob so that sonos devices can communicate. **This must be either the public IP or DNS entry of the bonob instance so that the sonos devices can communicate with it.**
 BNB_SECRET | bonob | secret used for encrypting credentials
 BNB_AUTH_TIMEOUT | 1h | Timeout for the sonos auth token, described in the format [ms](https://github.com/vercel/ms), ie. '5s' == 5 seconds, '11h' == 11 hours.  In the case of using Navidrome this should be less than the value for ND_SESSIONTIMEOUT
+BNB_LOG_LEVEL | info | Log level. One of ['debug', 'info', 'warn', 'error']
+BNB_DISABLE_PLAYLIST_ART | undefined | Disables playlist art generation, ie. when there are many playlists and art generation takes too long
+BNB_SERVER_LOG_REQUESTS | false | Whether or not to log http requests
 BNB_SONOS_AUTO_REGISTER | false | Whether or not to try and auto-register on startup
 BNB_SONOS_DEVICE_DISCOVERY | true | Enable/Disable sonos device discovery entirely.  Setting this to 'false' will disable sonos device search, regardless of whether a seed host is specified.
 BNB_SONOS_SEED_HOST | undefined | sonos device seed host for discovery, or ommitted for for auto-discovery

package.json

@@ -62,9 +62,9 @@
   "scripts": {
     "clean": "rm -Rf build node_modules",
     "build": "tsc",
-    "dev": "BNB_DEBUG=true BNB_SCROBBLE_TRACKS=false BNB_REPORT_NOW_PLAYING=false BNB_ICON_FOREGROUND_COLOR=white BNB_ICON_BACKGROUND_COLOR=darkgrey BNB_SONOS_SERVICE_NAME=bonobDev BNB_SONOS_DEVICE_DISCOVERY=true nodemon -V ./src/app.ts",
+    "dev": "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_URL=\"http://${BNB_DEV_HOST_IP}:4534\" BNB_SUBSONIC_URL=\"${BNB_DEV_SUBSONIC_URL}\" nodemon -V ./src/app.ts",
-    "devr": "BNB_DEBUG=true BNB_SCROBBLE_TRACKS=false BNB_REPORT_NOW_PLAYING=false BNB_ICON_FOREGROUND_COLOR=white BNB_ICON_BACKGROUND_COLOR=darkgrey BNB_SONOS_SERVICE_NAME=bonobDev BNB_SONOS_DEVICE_DISCOVERY=true BNB_SONOS_AUTO_REGISTER=true 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",
-    "register-dev": "ts-node ./src/register.ts http://$(hostname):4534",
+    "register-dev": "ts-node ./src/register.ts http://${BNB_DEV_HOST_IP}:4534",
     "test": "jest",
     "gitinfo": "git describe --tags > .gitinfo"
   },

src/app.ts

@@ -88,7 +88,7 @@ const app = server(
     clock,
     iconColors: config.icons,
     applyContextPath: true,
-    logRequests: true,
+    logRequests: config.logRequests,
     version,
     smapiAuthTokens: new JWTSmapiLoginTokens(clock, config.secret, config.authTimeout),
     externalImageResolver: artistImageFetcher

src/config.ts

@@ -85,6 +85,7 @@ export default function () {
         validationPattern: COLOR,
       }),
     },
+    logRequests: bnbEnvVar<boolean>("SERVER_LOG_REQUESTS", { default: false, parser: asBoolean }),
     sonos: {
       serviceName: bnbEnvVar<string>("SONOS_SERVICE_NAME", { default: "bonob" })!,
       discovery: {

src/logger.ts

@@ -6,7 +6,7 @@ export function debugIt<T>(thing: T): T {
 }
 
 const logger = createLogger({
-    level: 'debug',
+    level: process.env["BNB_LOG_LEVEL"] || 'info',
     format: format.combine(
       format.timestamp({
         format: 'YYYY-MM-DD HH:mm:ss'

src/server.ts

@@ -374,7 +374,7 @@ function server(
     const id = req.params["id"]!;
     const trace = uuid();
 
-    logger.info(
+    logger.debug(
       `${trace} bnb<- ${req.method} ${req.path}?${JSON.stringify(
         req.query
       )}, headers=${JSON.stringify({ ...req.headers, "bnbt": "*****", "bnbk": "*****" })}`
@@ -409,7 +409,7 @@ function server(
             .then((stream) => ({ musicLibrary: it, stream }))
         )
         .then(({ musicLibrary, stream }) => {
-          logger.info(
+          logger.debug(
             `${trace} bnb<- stream response from music service for ${id}, status=${
               stream.status
             }, headers=(${JSON.stringify(stream.headers)})`
@@ -435,7 +435,7 @@ function server(
             sendStream: boolean;
             nowPlaying: boolean;
           }) => {
-            logger.info(
+            logger.debug(
               `${trace} bnb-> ${
                 req.path
               }, status=${status}, headers=${JSON.stringify(headers)}`

src/smapi.ts

@@ -266,6 +266,9 @@ export const playlistAlbumArtURL = (
   bonobUrl: URLBuilder,
   playlist: Playlist
 ) => {
+  // todo: this should be put into config, or even just removed for the ND music source
+  if(process.env["BNB_DISABLE_PLAYLIST_ART"]) return iconArtURI(bonobUrl, "music");
+
   const burns: BUrn[] = uniq(
     playlist.entries.filter((it) => it.coverArt != undefined),
     (it) => it.album.id
@@ -1066,8 +1069,9 @@ function bindSmapiSoapServiceToExpress(
 
   soapyService.log = (type, data) => {
     switch (type) {
+      // routing all soap info messages to debug so less noisy
       case "info":
-        logger.info({ level: "info", data });
+        logger.debug({ level: "info", data });
         break;
       case "warn":
         logger.warn({ level: "warn", data });

tests/config.test.ts

@@ -271,6 +271,15 @@ describe("config", () => {
     });
   });
   
+  describe("logRequests", () => {
+    describeBooleanConfigValue(
+      "logRequests",
+      "BNB_SERVER_LOG_REQUESTS",
+      false,
+      (config) => config.logRequests
+    );
+  });
+
   describe("sonos", () => {
     describe("serviceName", () => {
       it("should default to bonob", () => {

tests/smapi.test.ts

@@ -519,30 +519,30 @@ describe("playlistAlbumArtURL", () => {
   });
 
   describe("when the playlist has external ids", () => {
+    const bonobUrl = url("http://localhost:1234/context-path?search=yes");
+    const externalArt1 = {
+      system: "external",
+      resource: "http://example.com/image1.jpg",
+    };
+    const externalArt2 = {
+      system: "external",
+      resource: "http://example.com/image2.jpg",
+    };
+
+    const playlist = aPlaylist({
+      entries: [
+        aTrack({
+          coverArt: externalArt1,
+          album: anAlbumSummary({ id: "album1" }),
+        }),
+        aTrack({
+          coverArt: externalArt2,
+          album: anAlbumSummary({ id: "album2" }),
+        }),
+      ],
+    });
+
     it("should format the url with encrypted urn", () => {
-      const bonobUrl = url("http://localhost:1234/context-path?search=yes");
-      const externalArt1 = {
-        system: "external",
-        resource: "http://example.com/image1.jpg",
-      };
-      const externalArt2 = {
-        system: "external",
-        resource: "http://example.com/image2.jpg",
-      };
-
-      const playlist = aPlaylist({
-        entries: [
-          aTrack({
-            coverArt: externalArt1,
-            album: anAlbumSummary({ id: "album1" }),
-          }),
-          aTrack({
-            coverArt: externalArt2,
-            album: anAlbumSummary({ id: "album2" }),
-          }),
-        ],
-      });
-
       expect(playlistAlbumArtURL(bonobUrl, playlist).href()).toEqual(
         `http://localhost:1234/context-path/art/${encodeURIComponent(
           formatForURL(externalArt1)
@@ -551,6 +551,26 @@ describe("playlistAlbumArtURL", () => {
         )}/size/180?search=yes`
       );
     }); 
+
+    describe("when BNB_NO_PLAYLIST_ART is set", () => {
+      const OLD_ENV = process.env;
+
+      beforeEach(() => {
+        process.env = { ...OLD_ENV };
+    
+        process.env["BNB_DISABLE_PLAYLIST_ART"] = "true";
+      });
+    
+      afterEach(() => {
+        process.env = OLD_ENV;
+      });
+    
+      it("should return an icon", () => {
+        expect(playlistAlbumArtURL(bonobUrl, playlist).href()).toEqual(
+          `http://localhost:1234/context-path/icon/music/size/legacy?search=yes`
+        );
+      });
+    });
   });
 
   describe("when the playlist has 4 tracks from 2 different albums, including some tracks that are missing coverArt urns", () => {