remote/navidrome
1
0
Fork 0
mirror of https://github.com/navidrome/navidrome.git synced 2026-11-14 22:28:41 +01:00
Code Issues Projects Releases Packages Wiki Activity

fix(smartplaylist): support isMissing/isPresent operators on ReplayGain fields (#5585)

Browse source 
* fix(smartplaylist): support isMissing/isPresent operators on ReplayGain fields

ReplayGain values are stored in dedicated nullable columns (rg_album_gain,
rg_album_peak, rg_track_gain, rg_track_peak) rather than in the media_file.tags
JSON blob. The isMissing/isPresent operators previously only supported tag and
role fields, causing two failure modes:

1. Using the documented alias names (replaygain_album_gain etc.) from PR #5256:
   these got registered as JSON tags from mappings.yaml, so isMissing queried
   json_tree(media_file.tags, '$.replaygain_album_gain') which is always empty
   -> the playlist matched ALL songs.

2. Using the canonical field names (rgalbumgain etc.): not a tag/role, so SQL
   generation returned an error. Because refreshSmartPlaylist deletes old tracks
   before regenerating, the abort left the playlist empty.

Fix: add Nullable bool to FieldInfo and mark the four ReplayGain fields. Add
static alias entries (replaygain_album_gain -> rgalbumgain etc.) with
Numeric+Nullable set; because AddTagNames skips names already in the field map,
these static entries take precedence over the mappings.yaml tag registration.
missingExpr now emits IS NULL / IS NOT NULL for nullable column fields instead
of the json_tree lookup.

Fixes #5584

* chore(smartplaylist): address code review feedback

- Simplify the isMissing/isPresent unsupported-field error message,
  removing the internal "nullable fields" jargon
- Standardize comments on mappings.yaml (the actual filename)
- Clarify the alias precedence comment in the LookupField test
This commit is contained in:
Deluan Quintão 2026-06-10 21:12:31 -04:00 • committed by GitHub
commit 08fd222791
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
6 changed files with 146 additions and 24 deletions
Download patch file Download diff file Expand all files Collapse all files

18
persistence/criteria_sql.go
View file

@ -218,8 +218,8 @@ func missingExpr(values map[string]any, checkAbsence bool) (squirrel.Sqlizer, er
}
return nil, fmt.Errorf("invalid field in criteria: %s", field)
}
if !info.IsTag && !info.IsRole {
return nil, fmt.Errorf("isMissing/isPresent operator is only supported for tag and role fields, got: %s", field)
if !info.IsTag && !info.IsRole && !info.Nullable {
return nil, fmt.Errorf("isMissing/isPresent operator is not supported for field: %s", field)
}
b, ok := value.(bool)
@ -227,6 +227,20 @@ func missingExpr(values map[string]any, checkAbsence bool) (squirrel.Sqlizer, er
return nil, fmt.Errorf("invalid boolean value for 'missing' expression: %s: %v", field, value)
}
negate := checkAbsence == b
// Nullable column fields (e.g. ReplayGain) are stored in dedicated columns, not in the tags
// JSON, so "missing" maps to a NULL check on the column rather than a json_tree lookup.
if info.Nullable && !info.IsTag && !info.IsRole {
col, ok := fieldExpr(info.Name())
if !ok || col == "" {
return nil, fmt.Errorf("invalid field in criteria: %s", field)
}
if negate {
return squirrel.Eq{col: nil}, nil
}
return squirrel.NotEq{col: nil}, nil
}
return jsonExpr(info, nil, negate), nil
}

20
persistence/criteria_sql_test.go
View file

@ -14,7 +14,7 @@ import (
var _ = Describe("Smart playlist criteria SQL", func() {
BeforeEach(func() {
criteria.AddRoles([]string{"artist", "composer", "producer"})
criteria.AddTagNames([]string{"genre", "mood", "releasetype", "recordingdate"})
criteria.AddTagNames([]string{"genre", "mood", "releasetype", "recordingdate", "replaygain_album_gain"})
criteria.AddNumericTags([]string{"rate"})
})
@ -85,6 +85,20 @@ var _ = Describe("Smart playlist criteria SQL", func() {
"exists (select 1 from media_file_artists mfa where mfa.media_file_id = media_file.id and mfa.role = ?)", "composer"),
Entry("isPresent role [false]", criteria.IsPresent{"composer": false},
"not exists (select 1 from media_file_artists mfa where mfa.media_file_id = media_file.id and mfa.role = ?)", "composer"),
// isMissing/isPresent — nullable column fields (ReplayGain)
Entry("isMissing rgAlbumGain [true]", criteria.IsMissing{"rgAlbumGain": true},
"media_file.rg_album_gain IS NULL"),
Entry("isMissing rgAlbumGain [false]", criteria.IsMissing{"rgAlbumGain": false},
"media_file.rg_album_gain IS NOT NULL"),
Entry("isPresent rgTrackPeak [true]", criteria.IsPresent{"rgTrackPeak": true},
"media_file.rg_track_peak IS NOT NULL"),
Entry("isPresent rgTrackPeak [false]", criteria.IsPresent{"rgTrackPeak": false},
"media_file.rg_track_peak IS NULL"),
// isMissing — replaygain_* tag-name alias resolves to the nullable column (issue #5584)
Entry("isMissing replaygain_album_gain alias [true]", criteria.IsMissing{"replaygain_album_gain": true},
"media_file.rg_album_gain IS NULL"),
Entry("isPresent replaygain_album_gain alias [true]", criteria.IsPresent{"replaygain_album_gain": true},
"media_file.rg_album_gain IS NOT NULL"),
)
Describe("playlist permissions", func() {
@ -143,12 +157,12 @@ var _ = Describe("Smart playlist criteria SQL", func() {
It("returns an error when isMissing is used with a regular field", func() {
_, err := newSmartPlaylistCriteria(criteria.Criteria{Expression: criteria.IsMissing{"year": true}}).Where()
Expect(err).To(MatchError(ContainSubstring("isMissing/isPresent operator is only supported for tag and role fields")))
Expect(err).To(MatchError(ContainSubstring("isMissing/isPresent operator is not supported for field")))
})
It("returns an error when isPresent is used with a regular field", func() {
_, err := newSmartPlaylistCriteria(criteria.Criteria{Expression: criteria.IsPresent{"title": true}}).Where()
Expect(err).To(MatchError(ContainSubstring("isMissing/isPresent operator is only supported for tag and role fields")))
Expect(err).To(MatchError(ContainSubstring("isMissing/isPresent operator is not supported for field")))
})
It("returns an error when isMissing has a non-boolean value", func() {

22
persistence/e2e/e2e_suite_test.go
View file

@ -70,11 +70,13 @@ var (
func buildTestFS() {
abbeyRoad := template(_t{
"albumartist": "The Beatles",
"artist": "The Beatles",
"album": "Abbey Road",
"year": 1969,
"genre": "Rock;Blues",
"albumartist": "The Beatles",
"artist": "The Beatles",
"album": "Abbey Road",
"year": 1969,
"genre": "Rock;Blues",
"replaygain_album_gain": "-6.5 dB",
"replaygain_album_peak": "0.98",
})
ledZepIV := template(_t{
"albumartist": "Led Zeppelin",
@ -116,12 +118,16 @@ func buildTestFS() {
fs := storagetest.FakeFS{}
fs.SetFiles(fstest.MapFS{
"Rock/The Beatles/Abbey Road/01 - Come Together.mp3": abbeyRoad(track(1, "Come Together",
_t{"genre": "Rock;Blues", "composer": "Lennon/McCartney", "bpm": 120, "grouping": "Beatles Tracks"})),
_t{"genre": "Rock;Blues", "composer": "Lennon/McCartney", "bpm": 120, "grouping": "Beatles Tracks",
"replaygain_track_gain": "-7.1 dB", "replaygain_track_peak": "0.95"})),
"Rock/The Beatles/Abbey Road/02 - Something.mp3": abbeyRoad(track(2, "Something",
_t{"genre": "Rock", "composer": "Harrison", "bpm": 100, "grouping": "Beatles Tracks"})),
_t{"genre": "Rock", "composer": "Harrison", "bpm": 100, "grouping": "Beatles Tracks",
"replaygain_track_gain": "-6.0 dB", "replaygain_track_peak": "0.92"})),
// Stairway To Heaven has track gain but no album gain, to distinguish the two fields
"Rock/Led Zeppelin/IV/01 - Stairway To Heaven.flac": ledZepIV(track(1, "Stairway To Heaven",
_t{"genre": "Rock;Folk", "composer": "Page/Plant", "bpm": 82, "suffix": "flac",
"bitrate": 900, "samplerate": 44100, "bitdepth": 16})),
"bitrate": 900, "samplerate": 44100, "bitdepth": 16,
"replaygain_track_gain": "-8.25 dB", "replaygain_track_peak": "0.99"})),
"Rock/Led Zeppelin/IV/02 - Black Dog.flac": ledZepIV(track(2, "Black Dog",
_t{"genre": "Rock;Blues", "composer": "Page/Plant/Jones", "bpm": 150, "suffix": "flac",
"bitrate": 900, "samplerate": 44100, "bitdepth": 16})),

57
persistence/e2e/smartplaylist_test.go
View file

@ -371,4 +371,61 @@ var _ = Describe("Smart Playlists", func() {
Expect(results).To(ConsistOf("Black Dog", "All Along the Watchtower"))
})
})
// ReplayGain values are stored in nullable media_file columns (not in the tags JSON), so
// isMissing/isPresent translate to IS [NOT] NULL checks on those columns (issue #5584).
Describe("isMissing/isPresent on ReplayGain fields", func() {
It("isMissing finds tracks without album gain", func() {
results := evaluateRule(`{"all":[{"isMissing":{"rgalbumgain":true}}]}`)
Expect(results).To(ConsistOf("Stairway To Heaven", "Black Dog", "So What",
"Bohemian Rhapsody", "All Along the Watchtower", "We Are the Champions"))
})
It("isMissing false finds tracks with album gain", func() {
results := evaluateRule(`{"all":[{"isMissing":{"rgalbumgain":false}}]}`)
Expect(results).To(ConsistOf("Come Together", "Something"))
})
It("isPresent finds tracks with album gain", func() {
results := evaluateRule(`{"all":[{"isPresent":{"rgalbumgain":true}}]}`)
Expect(results).To(ConsistOf("Come Together", "Something"))
})
It("isPresent finds tracks with album peak", func() {
results := evaluateRule(`{"all":[{"isPresent":{"rgalbumpeak":true}}]}`)
Expect(results).To(ConsistOf("Come Together", "Something"))
})
It("isMissing distinguishes track gain from album gain", func() {
results := evaluateRule(`{"all":[{"isMissing":{"rgtrackgain":true}}]}`)
Expect(results).To(ConsistOf("Black Dog", "So What", "Bohemian Rhapsody",
"All Along the Watchtower", "We Are the Champions"))
})
It("isPresent finds tracks with track gain", func() {
results := evaluateRule(`{"all":[{"isPresent":{"rgtrackgain":true}}]}`)
Expect(results).To(ConsistOf("Come Together", "Something", "Stairway To Heaven"))
})
It("resolves the replaygain_album_gain alias to the rgalbumgain column", func() {
results := evaluateRule(`{"all":[{"isMissing":{"replaygain_album_gain":true}}]}`)
Expect(results).To(ConsistOf("Stairway To Heaven", "Black Dog", "So What",
"Bohemian Rhapsody", "All Along the Watchtower", "We Are the Champions"))
})
It("resolves the replaygain_track_gain alias to the rgtrackgain column", func() {
results := evaluateRule(`{"all":[{"isPresent":{"replaygain_track_gain":true}}]}`)
Expect(results).To(ConsistOf("Come Together", "Something", "Stairway To Heaven"))
})
It("supports numeric comparisons through the replaygain_* alias", func() {
results := evaluateRule(`{"all":[{"gt":{"replaygain_track_gain":-7.5}}]}`)
Expect(results).To(ConsistOf("Come Together", "Something"))
})
It("combines isMissing on ReplayGain with other operators", func() {
results := evaluateRule(`{"all":[{"isMissing":{"rgalbumgain":true}},{"is":{"genre":"Blues"}}]}`)
Expect(results).To(ConsistOf("Black Dog", "All Along the Watchtower"))
})
})
})