fix: Remove S3 data from XML export - keep pure Rekordbox XML
- Remove all S3 data from XML export to keep it pure Rekordbox XML - XML export is purely for re-importing into Rekordbox - S3 functionality is purely for browser playback and management - Maintain clean separation between Rekordbox and browser functionality - Update documentation to clarify this important distinction The XML export now contains exactly the same structure as the original Rekordbox XML with no additional S3 information, ensuring perfect compatibility for re-importing into Rekordbox.
This commit is contained in:
Geert Rademakes
parent
a3d6983fc4
commit
870ad39b94
@ -2,7 +2,7 @@
|
||||
|
||||
## 🎯 Overview
|
||||
|
||||
This enhancement ensures that original file paths from the Rekordbox XML are preserved while adding S3 storage information alongside them. This maintains full compatibility with the original XML structure while enabling browser playback capabilities.
|
||||
This enhancement ensures that original file paths from the Rekordbox XML are preserved while adding S3 storage information alongside them. The S3 functionality is **purely for browser playback and management** - the XML export remains **pure Rekordbox XML** for re-importing into Rekordbox.
|
||||
|
||||
## 🔧 Key Changes
|
||||
|
||||
@ -66,25 +66,25 @@ async linkMusicFileToSong(musicFile: any, song: any): Promise<void> {
|
||||
}
|
||||
```
|
||||
|
||||
### XML Export Enhancement
|
||||
### XML Export - Pure Rekordbox XML
|
||||
|
||||
#### XML Service (`packages/backend/src/services/xmlService.ts`)
|
||||
|
||||
**Preserved Structure:**
|
||||
**Pure Rekordbox Structure (NO S3 data):**
|
||||
```xml
|
||||
<TRACK TrackID="..." Location="/original/path/to/file.mp3" ...>
|
||||
<!-- Original location preserved -->
|
||||
<S3_FILE S3Key="music/uuid.mp3" S3Url="..." StreamingUrl="..." MusicFileId="..."/>
|
||||
<!-- S3 information added alongside -->
|
||||
<!-- Original location preserved - PURE REKORDBOX DATA ONLY -->
|
||||
<TEMPO Inizio="0" Bpm="128" Metro="4/4" Battito="0"/>
|
||||
<!-- Only Rekordbox data - NO S3 information -->
|
||||
</TRACK>
|
||||
```
|
||||
|
||||
**Benefits:**
|
||||
- ✅ Original XML structure maintained
|
||||
- ✅ S3 information added as additional elements
|
||||
- ✅ Full backward compatibility
|
||||
- ✅ Rekordbox can still read the XML
|
||||
- ✅ Browser can use S3 streaming URLs
|
||||
- ✅ **Pure Rekordbox XML** for re-importing into Rekordbox
|
||||
- ✅ **Original XML structure** maintained exactly
|
||||
- ✅ **Full backward compatibility** with Rekordbox
|
||||
- ✅ **S3 data kept separate** from XML export
|
||||
- ✅ **Clean separation** between Rekordbox and browser functionality
|
||||
|
||||
### Frontend Enhancements
|
||||
|
||||
@ -145,7 +145,7 @@ const hasMusicFile = (song: Song): boolean => {
|
||||
}
|
||||
```
|
||||
|
||||
## 🎵 XML Export Example
|
||||
## 🎵 XML Export - Pure Rekordbox
|
||||
|
||||
### Original Rekordbox XML
|
||||
```xml
|
||||
@ -155,17 +155,17 @@ const hasMusicFile = (song: Song): boolean => {
|
||||
</TRACK>
|
||||
```
|
||||
|
||||
### Enhanced XML with S3 Information
|
||||
### Exported XML (Pure Rekordbox - NO S3 data)
|
||||
```xml
|
||||
<TRACK TrackID="123" Name="Song Title" Artist="Artist Name"
|
||||
Location="/original/path/to/file.mp3" ...>
|
||||
<S3_FILE S3Key="music/uuid.mp3" S3Url="music-files/music/uuid.mp3"
|
||||
StreamingUrl="http://localhost:9000/music-files/music/uuid.mp3"
|
||||
MusicFileId="music_file_id"/>
|
||||
<!-- EXACTLY the same as original - PURE REKORDBOX XML -->
|
||||
<TEMPO Inizio="0" Bpm="128" Metro="4/4" Battito="0"/>
|
||||
</TRACK>
|
||||
```
|
||||
|
||||
**Important:** The XML export contains **NO S3 information** - it's pure Rekordbox XML for re-importing into Rekordbox. S3 functionality is purely for browser playback and management.
|
||||
|
||||
## 🔍 Matching Improvements
|
||||
|
||||
### Enhanced Matching Criteria
|
||||
@ -189,17 +189,19 @@ const hasMusicFile = (song: Song): boolean => {
|
||||
- ✅ **Dual Access**: Can use both original files and S3 streaming
|
||||
- ✅ **Visual Clarity**: See both original paths and S3 information
|
||||
- ✅ **Better Matching**: Location-based matching improves accuracy
|
||||
- ✅ **Pure XML Export**: Clean Rekordbox XML for re-importing
|
||||
|
||||
### For Developers
|
||||
- ✅ **Backward Compatibility**: Existing XML imports work unchanged
|
||||
- ✅ **Extensible**: Easy to add more storage providers
|
||||
- ✅ **Clean Separation**: Original data vs. S3 data clearly separated
|
||||
- ✅ **Performance**: Optimized queries with proper indexing
|
||||
- ✅ **Pure XML**: No S3 data pollution in XML exports
|
||||
|
||||
### For Rekordbox Integration
|
||||
- ✅ **XML Compatibility**: Rekordbox can still read exported XML
|
||||
- ✅ **XML Compatibility**: Rekordbox can read exported XML perfectly
|
||||
- ✅ **Path Preservation**: Original file references maintained
|
||||
- ✅ **Enhanced Data**: Additional S3 information available
|
||||
- ✅ **Clean Export**: No S3 data in XML export
|
||||
- ✅ **Future-Proof**: Ready for additional storage providers
|
||||
|
||||
## 🚀 Usage Workflow
|
||||
@ -218,14 +220,14 @@ const hasMusicFile = (song: Song): boolean => {
|
||||
- S3 information added alongside original paths
|
||||
|
||||
### 4. Export XML
|
||||
- Original structure preserved
|
||||
- S3 information added as additional elements
|
||||
- Full backward compatibility maintained
|
||||
- **Pure Rekordbox XML** - no S3 data
|
||||
- **Original structure preserved** exactly
|
||||
- **Ready for Rekordbox re-import**
|
||||
|
||||
### 5. Playback
|
||||
### 5. Browser Playback
|
||||
- Browser uses S3 streaming URLs
|
||||
- Original paths available for reference
|
||||
- Dual access to music files
|
||||
- **S3 functionality purely for browser**
|
||||
|
||||
## 📈 Performance Impact
|
||||
|
||||
@ -243,6 +245,7 @@ const hasMusicFile = (song: Song): boolean => {
|
||||
- **Streaming**: Maintains efficient streaming export
|
||||
- **Memory**: Minimal memory overhead
|
||||
- **Compatibility**: No impact on existing tools
|
||||
- **Pure XML**: No S3 data processing needed
|
||||
|
||||
## 🔮 Future Enhancements
|
||||
|
||||
@ -262,10 +265,11 @@ const hasMusicFile = (song: Song): boolean => {
|
||||
|
||||
✅ **Original Paths Preserved**: No data loss from Rekordbox XML
|
||||
✅ **S3 Integration**: Seamless S3 storage and streaming
|
||||
✅ **XML Compatibility**: Full backward compatibility maintained
|
||||
✅ **Pure XML Export**: Clean Rekordbox XML with no S3 data
|
||||
✅ **Enhanced Matching**: Location-based matching improves accuracy
|
||||
✅ **Visual Clarity**: Users can see both original and S3 information
|
||||
✅ **Performance**: Optimized queries and operations
|
||||
✅ **Extensibility**: Ready for future enhancements
|
||||
✅ **Clean Separation**: S3 functionality purely for browser, XML purely for Rekordbox
|
||||
|
||||
This enhancement ensures that the S3 storage feature works alongside existing Rekordbox workflows without any data loss or compatibility issues, while providing powerful new capabilities for browser-based music playback.
|
||||
This enhancement ensures that the S3 storage feature works alongside existing Rekordbox workflows without any data loss or compatibility issues. The XML export remains **pure Rekordbox XML** for re-importing into Rekordbox, while S3 functionality provides powerful browser-based music playback capabilities.
|
||||
@ -53,19 +53,13 @@ export const streamToXml = async (res: any) => {
|
||||
const songs = await Song.find({})
|
||||
.skip(processedSongs)
|
||||
.limit(batchSize)
|
||||
.populate('s3File.musicFileId')
|
||||
.lean();
|
||||
|
||||
for (const song of songs) {
|
||||
// Include ALL track attributes like master collection
|
||||
// Include ALL track attributes like master collection - PURE REKORDBOX XML
|
||||
res.write(`\n <TRACK TrackID="${song.id}" Name="${escapeXml(song.title || '')}" Artist="${escapeXml(song.artist || '')}" Composer="${escapeXml(song.composer || '')}" Album="${escapeXml(song.album || '')}" Grouping="${escapeXml(song.grouping || '')}" Genre="${escapeXml(song.genre || '')}" Kind="${escapeXml(song.kind || '')}" Size="${song.size || ''}" TotalTime="${song.totalTime || ''}" DiscNumber="${song.discNumber || ''}" TrackNumber="${song.trackNumber || ''}" Year="${song.year || ''}" AverageBpm="${song.averageBpm || ''}" DateAdded="${song.dateAdded || ''}" BitRate="${song.bitRate || ''}" SampleRate="${song.sampleRate || ''}" Comments="${escapeXml(song.comments || '')}" PlayCount="${song.playCount || ''}" Rating="${song.rating || ''}" Location="${escapeXml(song.location || '')}" Remixer="${escapeXml(song.remixer || '')}" Tonality="${escapeXml(song.tonality || '')}" Label="${escapeXml(song.label || '')}" Mix="${escapeXml(song.mix || '')}">`);
|
||||
|
||||
// Add S3 file information if available (preserves original location)
|
||||
if (song.s3File?.hasS3File) {
|
||||
res.write(`\n <S3_FILE S3Key="${escapeXml(song.s3File.s3Key || '')}" S3Url="${escapeXml(song.s3File.s3Url || '')}" StreamingUrl="${escapeXml(song.s3File.streamingUrl || '')}" MusicFileId="${song.s3File.musicFileId?._id || ''}"/>`);
|
||||
}
|
||||
|
||||
// Add TEMPO entries if they exist
|
||||
// Add TEMPO entries if they exist (pure Rekordbox data only)
|
||||
if (song.tempo) {
|
||||
res.write(`\n <TEMPO Inizio="${song.tempo.inizio}" Bpm="${song.tempo.bpm}" Metro="${song.tempo.metro}" Battito="${song.tempo.battito}"/>`);
|
||||
}
|
||||
@ -223,20 +217,12 @@ export const exportToXml = (songs: any[], playlists: any[]): string => {
|
||||
'@Comments': song.comments,
|
||||
'@PlayCount': song.playCount,
|
||||
'@Rating': song.rating,
|
||||
'@Location': song.location, // Preserve original location
|
||||
'@Location': song.location, // Preserve original location - PURE REKORDBOX DATA
|
||||
'@Remixer': song.remixer,
|
||||
'@Tonality': song.tonality,
|
||||
'@Label': song.label,
|
||||
'@Mix': song.mix,
|
||||
// Add S3 file information if available
|
||||
...(song.s3File?.hasS3File ? {
|
||||
S3_FILE: {
|
||||
'@S3Key': song.s3File.s3Key,
|
||||
'@S3Url': song.s3File.s3Url,
|
||||
'@StreamingUrl': song.s3File.streamingUrl,
|
||||
'@MusicFileId': song.s3File.musicFileId?._id || song.s3File.musicFileId
|
||||
}
|
||||
} : {}),
|
||||
// Only include pure Rekordbox data - NO S3 information
|
||||
...(song.tempo ? {
|
||||
TEMPO: {
|
||||
'@Inizio': song.tempo.inizio,
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user