feat: new relationships following navidrome 0.55.0 BFR

Author: rombat

lib/handlers/dbManager.js

@@ -4,6 +4,7 @@ const AlbumDefinition = require('../models/Album');
 const AnnotationDefinition = require('../models/Annotation');
 const ArtistDefinition = require('../models/Artist');
 const UserDefinition = require('../models/User');
+const MediaFileArtistDefinition = require('../models/MediaFileArtist');
 
 exports.init = async dbFilePath => {
   const sequelize = new Sequelize({
@@ -28,6 +29,9 @@ const createRelationships = async sequelize => {
   // handling legacy Annotation schema (ann_id removed from navidrome DB schema in this commit: https://github.com/navidrome/navidrome/commit/47378c68828861751b9d1a05d3fc9b29ce8dd9f0)
   const annotationTableSchema = await sequelize.getQueryInterface().describeTable('annotation');
 
+  // Following Big Fucking Refactor (Navidrome >= 0.55.0), many-to-many relationship exists between Track and Artist via MediaFileArtist table.
+  const hasMediaFileArtists = await sequelize.getQueryInterface().tableExists('media_file_artists');
+
   const Track = sequelize.define('Track', TrackDefinition.attributes, TrackDefinition.options);
   const Album = sequelize.define('Album', AlbumDefinition.attributes, AlbumDefinition.options);
   const Annotation = sequelize.define(
@@ -37,12 +41,40 @@ const createRelationships = async sequelize => {
   );
   const Artist = sequelize.define('Artist', ArtistDefinition.attributes, ArtistDefinition.options);
   const User = sequelize.define('User', UserDefinition.attributes, UserDefinition.options);
+  const MediaFileArtist = sequelize.define(
+    'MediaFileArtist',
+    MediaFileArtistDefinition.attributes,
+    MediaFileArtistDefinition.options
+  );
 
   Track.belongsTo(Album, { foreignKey: 'album_id' });
   Track.hasOne(Annotation, { as: 'trackAnnotation', foreignKey: 'item_id' });
   Track.belongsTo(Artist, { as: 'artist', foreignKey: 'artist_id' });
 
-  Artist.hasMany(Track, { as: 'tracks', foreignKey: 'artist_id' });
+  if (!hasMediaFileArtists) {
+    Artist.hasMany(Track, { as: 'tracks', foreignKey: 'artist_id' });
+  } else {
+    Artist.belongsToMany(Track, {
+      through: MediaFileArtist,
+      foreignKey: 'artist_id',
+      otherKey: 'media_file_id',
+      scope: {
+        role: 'artist'
+      },
+      as: 'tracks'
+    });
+
+    Track.belongsToMany(Artist, {
+      through: MediaFileArtist,
+      foreignKey: 'media_file_id',
+      otherKey: 'artist_id',
+      scope: {
+        role: 'artist'
+      },
+      as: 'tracks'
+    });
+  }
+
   Artist.hasOne(Annotation, { as: 'artistAnnotation', foreignKey: 'item_id' });
 
   Album.hasMany(Track, { as: 'tracks', foreignKey: 'album_id' });

lib/models/MediaFileArtist.js

@@ -0,0 +1,18 @@
+const { DataTypes } = require('sequelize');
+
+exports.attributes = {
+  media_file_id: { type: DataTypes.STRING, primaryKey: true, allowNull: false },
+  artist_id: { type: DataTypes.STRING, allowNull: false, defaultValue: '', primaryKey: true },
+  role: { type: DataTypes.STRING, allowNull: false, defaultValue: '', primaryKey: true }
+};
+
+exports.options = {
+  tableName: 'media_file_artist',
+  timestamps: false,
+  indexes: [
+    {
+      fields: ['media_file_id', 'artist_id', 'role'],
+      unique: true
+    }
+  ]
+};