node_helper.js

/*
 * MMM-OnSpotify
 * MIT license
 *
 * By Fabrizio <3 (Fabrizz) | https://github.com/Fabrizz/MMM-OnSpotify
 */

"use strict";
const NodeHelper = require("node_helper");
const SpotifyFetcher = require("./utils/SpotifyFetcher");

module.exports = NodeHelper.create({
  start: function () {
    console.log(
      "[\x1b[35mMMM-OnSpotify\x1b[0m] by Fabrizz >> Node helper loaded.",
    );
    this.fetcher = undefined;
    // Helps keping track of when the player becomes empty
    this.lastPlayerStatus = undefined;
    // Helps keping track of when the song actually changes
    this.lastMediaUri = undefined;
    // Helps keping track of when the current device target is changed
    this.lastDeviceName = undefined;
    // The times that an available (but empty) player has been returned by the api
    this.isPlayerInTransit = 0;
    // Configuration sent to the helper
    this.preferences = undefined;
    // Use a identifier to filter socket-io retries
    this.appendableId = undefined;
    this.serversideId = Date.now().toString(16);

    // Canvas url and to which item it corresponds to
    this.savedCanvasUrl = false;
    this.savedCanvasUri = "";
  },

  socketNotificationReceived: function (notification, payload) {
    switch (notification) {
      case "SET_CREDENTIALS_REFRESH":
        // Blocks re-requests caused by socket.io implementation
        if (payload.backendExpectId === this.appendableId) break;
        this.fetcher = new SpotifyFetcher(payload);
        this.fetchSpotifyData("PLAYER");
        this.preferences = payload.preferences;
        this.appendableId = payload.backendExpectId;
        if (this.appendableId !== "ABC")
          console.log(
            "[\x1b[35mMMM-OnSpotify\x1b[0m] Session identifier: >> \x1b[44m\x1b[37m %s \x1b[0m",
            `${this.appendableId}`,
          );
        break;
      case "REFRESH_PLAYER":
        if (this.isCorrectIdOrRefresh(payload)) this.fetchSpotifyData("PLAYER");
        break;
      case "REFRESH_USER":
        if (this.isCorrectIdOrRefresh(payload)) this.fetchSpotifyData("USER");
        break;
      case "REFRESH_AFFINITY":
        if (this.isCorrectIdOrRefresh(payload))
          this.fetchSpotifyData("AFFINITY");
        break;

      /* WIP | Non implemented */
      case "REFRESH_QUEUE":
        this.fetchSpotifyData("QUEUE");
        break;
      case "REFRESH_RECENT":
        this.fetchSpotifyData("RECENT");
        break;
    }
  },

  fetchSpotifyData: async function (type) {
    try {
      let data = await this.fetcher.getData(type);
      if (data instanceof Error)
        return this.sendSocketNotification(
          "CONNECTION_ERRONED",
          JSON.stringify(data),
        );
      switch (type) {
        case "PLAYER":
          // CASE S1 The data is OK and the target is a filtered device
          if (
            data &&
            data.device &&
            data.device.name &&
            !this.isAllowedDevice(data.device.name)
          ) {
            this.sendSocketNotification("PLAYER_DATA", {
              statusIsPlayerEmpty: true,
              statusIsNewSong: false,
              statusIsChangeToEmptyPlayer: this.lastPlayerStatus,
              statusIsChangeToMediaPlayer: false,
              statusPlayerUpdating: false,
              statusIsDeviceChange: false,
              notAllowedDevice: data.device.name,
            });
            this.lastMediaUri = "empty";
            this.lastPlayerStatus = false;
            this.lastPlayerStatusCount = 0;
            this.lastDeviceName = "unknown";
            break;
          }
          // CASE S2 The data is OK and the target is in a private session
          if (data && data.device && data.device.is_private_session) {
            let payload = {
              /* Player data */
              playerIsPlaying: true,
              /* Device data (Some are not used yet) */
              deviceName: data.device.name,
              deviceType: data.device.type,
              deviceVolume: data.device.volume_percent,
              deviceIsPrivate: data.device.is_private_session,
              deviceId: data.device.id,
              /* Special status sync */
              statusIsPlayerEmpty: false,
              statusIsNewSong:
                this.lastMediaUri !== "privatesession" ? true : false,
              statusIsChangeToEmptyPlayer: false,
              statusIsChangeToMediaPlayer: this.lastPlayerStatus ? false : true,
              statusPlayerUpdating: false,
              statusIsDeviceChange:
                this.lastDeviceName !== data.device.name ? true : false,
              notAllowedDevice: false,
            };
            this.sendSocketNotification("PLAYER_DATA", payload);
            this.lastMediaUri = "privatesession";
            this.lastDeviceName = data.device.name;
            this.lastPlayerStatus = true;
            this.lastPlayerStatusCount = 0;
            break;
          }

          if (data && data.item) {
            // CASE 1 The data is OK and there is an ITEM in the player
            const isTrack =
              data.currently_playing_type === "track" ? true : false;

            const itemImages =
              this.processImages(
                (isTrack ? data.item.album.images : data.item.show.images) || []);

            // Add a canvas object if enabled
            if (isTrack && this.preferences.useCanvas && (this.lastMediaUri !== data.item.uri))
              this.statelessGetCanvas(data.item.uri, itemImages)
            
            let payload = {
              /* Player data */
              playerIsPlaying: data.is_playing,
              playerProgress: data.progress_ms,
              playerMediaType: data.currently_playing_type,
              playerShuffleState: data.shuffle_state,
              playerRepeatState: data.repeat_state,
              /* Item generics */
              itemId: data.item.id,
              itemUri: data.item.uri,
              itemName: data.item.name,
              itemDuration: data.item.duration_ms,
              itemImages,
              /* Item specifics (Some are not used yet) */
              itemAlbum: isTrack ? data.item.album.name : null,
              itemPublisher: isTrack ? null : data.item.show.publisher,
              itemShowName: isTrack ? null : data.item.show.name,
              itemShowDescription: isTrack ? null : data.item.show.description,
              itemArtist: isTrack ? data.item.artists[0].name : null,
              itemArtists: this.processArtists(
                (isTrack ? data.item.artists : null) || [],
              ),
              /* Device data (Some are not used yet) */
              deviceName: data.device.name,
              deviceType: data.device.type,
              deviceVolume: data.device.volume_percent,
              deviceIsPrivate: data.device.is_private_session,
              deviceId: data.device.id,
              /* Special canvas sync */
              canvas: data.item.uri === this.savedCanvasUri ? this.savedCanvasUrl : false,
              /* Special status sync */
              statusIsPlayerEmpty: false,
              statusIsNewSong:
                this.lastMediaUri !== data.item.uri ? true : false,
              statusIsChangeToEmptyPlayer: false,
              statusIsChangeToMediaPlayer: this.lastPlayerStatus ? false : true,
              statusPlayerUpdating: false,
              statusIsDeviceChange:
                this.lastDeviceName !== data.device.name ? true : false,
              notAllowedDevice: false,
            };
            this.sendSocketNotification("PLAYER_DATA", payload);
            this.lastMediaUri = data.item.uri;
            this.lastPlayerStatus = true;
            this.lastPlayerStatusCount = 0;
            this.lastDeviceName = data.device.name;
          } else if (data && !data.item) {
            // CASE 2 The player in in transit (data OK, no ITEM)
            if (this.lastPlayerStatusCount <= 3) {
              // CASE 2A The player is available but there are no items in it. Wait 3 calls
              // This prevents an empty module when the player is loading or the playlist updating
              this.sendSocketNotification("PLAYER_DATA", {
                statusIsPlayerEmpty: true,
                statusIsNewSong: false,
                statusIsChangeToEmptyPlayer: this.lastPlayerStatus,
                statusIsChangeToMediaPlayer: false,
                statusPlayerUpdating: true,
                statusIsDeviceChange: false,
                notAllowedDevice: false,
              });
              this.lastPlayerStatusCount = this.lastPlayerStatusCount + 1;
              this.lastPlayerStatus = true;
            } else {
              this.sendSocketNotification("PLAYER_DATA", {
                // CASE 2B The player is empty but still available for more than expected. Mark it as empty
                statusIsPlayerEmpty: true,
                statusIsNewSong: false,
                statusIsChangeToEmptyPlayer: this.lastPlayerStatus,
                statusIsChangeToMediaPlayer: false,
                statusPlayerUpdating: false,
                statusIsDeviceChange: false,
                notAllowedDevice: false,
              });
              this.lastMediaUri = "empty";
              this.lastPlayerStatus = false;
              this.lastDeviceName = "unknown";
            }
            // CASE 3 There is nothing playing and there is not a player available
          } else {
            this.sendSocketNotification("PLAYER_DATA", {
              statusIsPlayerEmpty: true,
              statusIsNewSong: false,
              statusIsChangeToEmptyPlayer: this.lastPlayerStatus,
              statusIsChangeToMediaPlayer: false,
              statusPlayerUpdating: false,
              statusIsDeviceChange: false,
              notAllowedDevice: false,
            });
            this.lastMediaUri = "empty";
            this.lastPlayerStatus = false;
            this.lastPlayerStatusCount = 0;
            this.lastDeviceName = "unknown";
          }
          break;
        case "USER":
          if (data) {
            let payload = {
              country: data.country,
              name: data.display_name,
              id: data.id,
              image: data.images
                ? data.images[0]
                  ? data.images[0].url
                  : null
                : null,
              product: data.product,
              filterEnabled: data.explicit_content.filter_enabled,
              filterLocked: data.explicit_content.filter_locked,
              type: data.type,
            };
            this.sendSocketNotification("USER_DATA", payload);
          }
          break;
        case "AFFINITY":
          if (data) {
            let payload = [];
            data.items.forEach((item) =>
              payload.push({
                name: item.name,
                image: (item.type === "track" ? item.album.images : item.images)
                  // Here we use medium sized images || Maybe later even the icon ones, as its just a background
                  .filter((image) =>
                    image.width >= 240 && image.width <= 360
                      ? image.width >= 240 && image.width <= 360
                      : // Fallback to any of the available image sizes.
                        image,
                  )[0].url,
              }),
            );
            this.sendSocketNotification("AFFINITY_DATA", payload);
          }
          break;

        // Future update
        case "QUEUE":
          break;
      }
    } catch (error) {
      console.warn(
        "[\x1b[35mMMM-OnSpotify\x1b[0m] >> \x1b[41m\x1b[37m %s \x1b[0m ",
        "Error fetching data (OOB)",
        error,
      );
    }
  },

  async statelessGetCanvas(uri, itemImages) {
    try {
      // use then to prevent context issue
      this.fetcher.getCanvas(uri).then(canvas => {
        // console.log("[CANVAS DATA]", JSON.stringify(canvas))

        if (canvas.canvasesList.length == 1 && canvas.canvasesList[0].canvasUrl.endsWith('.mp4')) {
          const item = canvas.canvasesList[0];
          this.savedCanvasUrl = item.canvasUrl;
          this.savedCanvasUri = item.trackUri;

          this.sendSocketNotification("UPDATE_CANVAS", {
            itemUri: item.trackUri,
            url: item.canvasUrl,
            itemImages: itemImages
          });
        }
      });
    } catch (error) {
      console.warn(
        "[\x1b[35mMMM-OnSpotify\x1b[0m] >> \x1b[41m\x1b[37m %s \x1b[0m ",
        "Error fetching cover data (OOB)",
        error,
      );
    }
  },
  isCorrectIdOrRefresh(rcvd) {
    if (rcvd !== this.appendableId) {
      if (typeof this.appendableId === "undefined") {
        // Means that the backend was restarted and the frontend was maintained
        this.sendSocketNotification("REQUEST_REAUTH", this.serversideId);
      }
      return false;
    }
    return true;
  },
  isAllowedDevice: function (currentDevice) {
    if (
      !this.preferences.deviceFilter ||
      this.preferences.deviceFilter.length < 1
    )
      return true;
    return this.preferences.deviceFilterExclude
      ? !this.preferences.deviceFilter.includes(currentDevice)
      : this.preferences.deviceFilter.includes(currentDevice);
  },
  processArtists: (artists) => artists.map((artist) => artist.name).join(", "),
  processImages: (images) => {
    return {
      large: images.filter(
        (image) => image.width >= 580 && image.width <= 720,
      )[0].url,
      medium: images.filter(
        (image) => image.width >= 240 && image.width <= 360,
      )[0].url,
      thumb: images.filter(
        (image) => image.width >= 24 && image.width <= 200,
      )[0].url,
    };
  },
});