Merge pull request #3597 from nichwall/mediatype_uuid_migration

`MediaId` UUID migration
advplyr · Nov 17, 2024 · 46a3c3d · 46a3c3d
2 parents bbe5949 + 2b7e3f0
commit 46a3c3d
Show file tree

Hide file tree

Showing 8 changed files with 105 additions and 6 deletions.
diff --git a/server/migrations/changelog.md b/server/migrations/changelog.md
@@ -7,3 +7,4 @@ Please add a record of every database migration that you create to this file. Th
 | v2.15.0        | v2.15.0-series-column-unique | Series must have unique names in the same library                                    |
 | v2.15.1        | v2.15.1-reindex-nocase       | Fix potential db corruption issues due to bad sqlite extension introduced in v2.12.0 |
 | v2.15.2        | v2.15.2-index-creation       | Creates author, series, and podcast episode indexes                                  |
+| v2.17.0        | v2.17.0-uuid-replacement     | Changes the data type of columns with UUIDv4 to UUID matching the associated model   |
diff --git a/server/migrations/v2.17.0-uuid-replacement.js b/server/migrations/v2.17.0-uuid-replacement.js
@@ -0,0 +1,98 @@
+/**
+ * @typedef MigrationContext
+ * @property {import('sequelize').QueryInterface} queryInterface - a suquelize QueryInterface object.
+ * @property {import('../Logger')} logger - a Logger object.
+ *
+ * @typedef MigrationOptions
+ * @property {MigrationContext} context - an object containing the migration context.
+ */
+
+/**
+ * This upward migration script changes table columns with data type UUIDv4 to UUID to match associated models.
+ *
+ * @param {MigrationOptions} options - an object containing the migration context.
+ * @returns {Promise<void>} - A promise that resolves when the migration is complete.
+ */
+async function up({ context: { queryInterface, logger } }) {
+  // Upwards migration script
+  logger.info('[2.17.0 migration] UPGRADE BEGIN: 2.17.0-uuid-replacement')
+
+  logger.info('[2.17.0 migration] Changing libraryItems.mediaId column to UUID')
+  await queryInterface.changeColumn('libraryItems', 'mediaId', {
+    type: 'UUID'
+  })
+
+  logger.info('[2.17.0 migration] Changing feeds.entityId column to UUID')
+  await queryInterface.changeColumn('feeds', 'entityId', {
+    type: 'UUID'
+  })
+
+  logger.info('[2.17.0 migration] Changing mediaItemShares.mediaItemId column to UUID')
+  await queryInterface.changeColumn('mediaItemShares', 'mediaItemId', {
+    type: 'UUID'
+  })
+
+  logger.info('[2.17.0 migration] Changing playbackSessions.mediaItemId column to UUID')
+  await queryInterface.changeColumn('playbackSessions', 'mediaItemId', {
+    type: 'UUID'
+  })
+
+  logger.info('[2.17.0 migration] Changing playlistMediaItems.mediaItemId column to UUID')
+  await queryInterface.changeColumn('playlistMediaItems', 'mediaItemId', {
+    type: 'UUID'
+  })
+
+  logger.info('[2.17.0 migration] Changing mediaProgresses.mediaItemId column to UUID')
+  await queryInterface.changeColumn('mediaProgresses', 'mediaItemId', {
+    type: 'UUID'
+  })
+
+  // Completed migration
+  logger.info('[2.17.0 migration] UPGRADE END: 2.17.0-uuid-replacement')
+}
+
+/**
+ * This downward migration script changes table columns data type back to UUIDv4.
+ *
+ * @param {MigrationOptions} options - an object containing the migration context.
+ * @returns {Promise<void>} - A promise that resolves when the migration is complete.
+ */
+async function down({ context: { queryInterface, logger } }) {
+  // Downward migration script
+  logger.info('[2.17.0 migration] DOWNGRADE BEGIN: 2.17.0-uuid-replacement')
+
+  logger.info('[2.17.0 migration] Changing libraryItems.mediaId column to UUIDV4')
+  await queryInterface.changeColumn('libraryItems', 'mediaId', {
+    type: 'UUIDV4'
+  })
+
+  logger.info('[2.17.0 migration] Changing feeds.entityId column to UUIDV4')
+  await queryInterface.changeColumn('feeds', 'entityId', {
+    type: 'UUIDV4'
+  })
+
+  logger.info('[2.17.0 migration] Changing mediaItemShares.mediaItemId column to UUIDV4')
+  await queryInterface.changeColumn('mediaItemShares', 'mediaItemId', {
+    type: 'UUIDV4'
+  })
+
+  logger.info('[2.17.0 migration] Changing playbackSessions.mediaItemId column to UUIDV4')
+  await queryInterface.changeColumn('playbackSessions', 'mediaItemId', {
+    type: 'UUIDV4'
+  })
+
+  logger.info('[2.17.0 migration] Changing playlistMediaItems.mediaItemId column to UUIDV4')
+  await queryInterface.changeColumn('playlistMediaItems', 'mediaItemId', {
+    type: 'UUIDV4'
+  })
+
+  logger.info('[2.17.0 migration] Changing mediaProgresses.mediaItemId column to UUIDV4')
+  await queryInterface.changeColumn('mediaProgresses', 'mediaItemId', {
+    type: 'UUIDV4'
+  })
+
+  // Completed migration
+  logger.info('[2.17.0 migration] DOWNGRADE END: 2.17.0-uuid-replacement')
+}
+
+module.exports = { up, down }
diff --git a/server/models/Feed.js b/server/models/Feed.js
@@ -274,7 +274,7 @@ class Feed extends Model {
         },
         slug: DataTypes.STRING,
         entityType: DataTypes.STRING,
-        entityId: DataTypes.UUIDV4,
+        entityId: DataTypes.UUID,
         entityUpdatedAt: DataTypes.DATE,
         serverAddress: DataTypes.STRING,
         feedURL: DataTypes.STRING,

diff --git a/server/models/LibraryItem.js b/server/models/LibraryItem.js
@@ -1031,7 +1031,7 @@ class LibraryItem extends Model {
         ino: DataTypes.STRING,
         path: DataTypes.STRING,
         relPath: DataTypes.STRING,
-        mediaId: DataTypes.UUIDV4,
+        mediaId: DataTypes.UUID,
         mediaType: DataTypes.STRING,
         isFile: DataTypes.BOOLEAN,
         isMissing: DataTypes.BOOLEAN,

diff --git a/server/models/MediaItemShare.js b/server/models/MediaItemShare.js
@@ -109,7 +109,7 @@ class MediaItemShare extends Model {
           defaultValue: DataTypes.UUIDV4,
           primaryKey: true
         },
-        mediaItemId: DataTypes.UUIDV4,
+        mediaItemId: DataTypes.UUID,
         mediaItemType: DataTypes.STRING,
         slug: DataTypes.STRING,
         pash: DataTypes.STRING,

diff --git a/server/models/MediaProgress.js b/server/models/MediaProgress.js
@@ -93,7 +93,7 @@ class MediaProgress extends Model {
           defaultValue: DataTypes.UUIDV4,
           primaryKey: true
         },
-        mediaItemId: DataTypes.UUIDV4,
+        mediaItemId: DataTypes.UUID,
         mediaItemType: DataTypes.STRING,
         duration: DataTypes.FLOAT,
         currentTime: DataTypes.FLOAT,

diff --git a/server/models/PlaybackSession.js b/server/models/PlaybackSession.js
@@ -179,7 +179,7 @@ class PlaybackSession extends Model {
           defaultValue: DataTypes.UUIDV4,
           primaryKey: true
         },
-        mediaItemId: DataTypes.UUIDV4,
+        mediaItemId: DataTypes.UUID,
         mediaItemType: DataTypes.STRING,
         displayTitle: DataTypes.STRING,
         displayAuthor: DataTypes.STRING,

diff --git a/server/models/PlaylistMediaItem.js b/server/models/PlaylistMediaItem.js
@@ -45,7 +45,7 @@ class PlaylistMediaItem extends Model {
           defaultValue: DataTypes.UUIDV4,
           primaryKey: true
         },
-        mediaItemId: DataTypes.UUIDV4,
+        mediaItemId: DataTypes.UUID,
         mediaItemType: DataTypes.STRING,
         order: DataTypes.INTEGER
       },