test(provider): Validate entity type mapping and ID serialization logic

Author: kellnerd

providers/Beatport/mod.ts

@@ -27,6 +27,7 @@ export default class BeatportProvider extends MetadataProvider {
 		artist: 'artist',
 		label: 'label',
 		release: 'release',
+		recording: 'track',
 	};
 
 	readonly releaseLookup = BeatportReleaseLookup;

providers/Deezer/mod.ts

@@ -54,6 +54,7 @@ export default class DeezerProvider extends MetadataApiProvider {
 	readonly entityTypeMap = {
 		artist: 'artist',
 		release: 'album',
+		recording: 'track',
 	};
 
 	override readonly availableRegions = new Set(availableRegions);

providers/Spotify/mod.ts

@@ -61,6 +61,7 @@ export default class SpotifyProvider extends MetadataApiProvider {
 	readonly entityTypeMap = {
 		artist: 'artist',
 		release: 'album',
+		recording: 'track',
 	};
 
 	override readonly availableRegions = new Set(availableRegions);

providers/Tidal/mod.ts

@@ -63,6 +63,7 @@ export default class TidalProvider extends MetadataApiProvider {
 	readonly entityTypeMap = {
 		artist: 'artist',
 		release: ['album', 'video'],
+		recording: 'track',
 	};
 
 	readonly defaultRegion: CountryCode = 'US';

providers/iTunes/mod.ts

@@ -38,6 +38,7 @@ export default class iTunesProvider extends MetadataApiProvider {
 	readonly entityTypeMap = {
 		artist: 'artist',
 		release: 'album',
+		recording: 'song', // ['song', 'music-video'],
 	};
 
 	override readonly availableRegions = new Set(availableRegions);

providers/test_spec.ts

@@ -1,11 +1,19 @@
 import type { MetadataProvider, ProviderOptions } from './base.ts';
-import type { EntityId, HarmonyRelease, ReleaseOptions, ReleaseSpecifier } from '@/harmonizer/types.ts';
+import type {
+	EntityId,
+	HarmonyEntityType,
+	HarmonyRelease,
+	ReleaseOptions,
+	ReleaseSpecifier,
+} from '@/harmonizer/types.ts';
 import { downloadMode } from '@/utils/fetch_stub.ts';
 import { isDefined } from '@/utils/predicate.ts';
 
+import { assert } from 'std/assert/assert.ts';
 import { assertEquals } from 'std/assert/assert_equals.ts';
 import { filterValues } from '@std/collections/filter-values';
 import { describe, it } from '@std/testing/bdd';
+import { preferArray } from 'utils/array/scalar.js';
 
 /** Specification which describes the expected behavior of a {@linkcode MetadataProvider}. */
 export interface ProviderSpecification {
@@ -51,6 +59,19 @@ export interface EntityUrlTest {
 
 function describeEntityUrlExtraction(provider: MetadataProvider, tests: EntityUrlTest[]) {
 	describe('extraction of entity type and ID from an URL', () => {
+		// Construct the inverse entity type mapping.
+		const inverseEntityTypeMap: Record<string, HarmonyEntityType> = {};
+		for (const [harmonyType, providerTypes] of Object.entries(provider.entityTypeMap)) {
+			for (const providerType of preferArray(providerTypes)) {
+				const mappedHarmonyType = inverseEntityTypeMap[providerType];
+				assert(
+					!mappedHarmonyType,
+					`Entity type "${providerType}" has an ambiguous mapping, it can be ${mappedHarmonyType} or ${harmonyType}`,
+				);
+				inverseEntityTypeMap[providerType] = harmonyType as HarmonyEntityType;
+			}
+		}
+
 		for (const test of tests) {
 			it(`${test.id ? 'supports' : 'ignores'} ${test.description ?? test.url}`, () => {
 				let actualId = provider.extractEntityFromUrl(test.url);
@@ -62,6 +83,19 @@ function describeEntityUrlExtraction(provider: MetadataProvider, tests: EntityUr
 				const serializedId = test.serializedId ?? test.id?.id;
 				if (serializedId && actualId) {
 					assertEquals(provider.serializeProviderId(actualId), serializedId, 'Serialized entity ID is wrong');
+					const harmonyType = inverseEntityTypeMap[actualId.type];
+					assert(harmonyType, `Type "${actualId.type}" is missing from the provider's entity type mapping`);
+					if (harmonyType === 'release') {
+						// ID deserialization is only needed for releases so far.
+						// We should not yet force providers to implement it for other ambiguous entity types.
+						const deserializedId = provider.parseProviderId(serializedId, harmonyType);
+						assertEquals(deserializedId.id, actualId.id, 'Failed to parse serialized provider ID');
+						assertEquals(
+							deserializedId.type,
+							actualId.type,
+							'Failed to extract entity type from serialized provider ID',
+						);
+					}
 				}
 			});
 		}