Skip to content

Be consistent about choice of TTLCache keys in Director stat utilities#3171

Merged
jhiemstrawisc merged 4 commits intoPelicanPlatform:mainfrom
jhiemstrawisc:quick-stat-fix
Mar 2, 2026
Merged

Be consistent about choice of TTLCache keys in Director stat utilities#3171
jhiemstrawisc merged 4 commits intoPelicanPlatform:mainfrom
jhiemstrawisc:quick-stat-fix

Conversation

@jhiemstrawisc
Copy link
Member

How did I discover this subtle issue? I asked Claude "Please explain the stat utility's TTLCache model as though it were being whiteboarded out amongst colleagues" and its response was "I confirmed your bug!" and then spat out this issue.

The bug is that we use a different values for keys to instantiate TTLCache entries than we do to access the values we've stored. Compare how we (previously) set these TTLCache keys with where we use the keys for lookups:

avail, ok := availMap[ad.Name]

Not at all what I asked the AI to do, but helpful none the less.

P.S. I'll note that I don't love the unit tests here --> they're narrow in scope and don't actually test that multiple pieces of code are correctly strung together (they merely assert we're using a specific key in the TTLCache). However, they're better than nothing and I wanted to have something since we're hoping to test this stat future in the coming week. As @patrickbrophy noted, this bug is actually a solid argument for a strong type system in this area of code, but I'm okay with the quick-and-dirty fix for now.

If you'd like check that these tests would have failed with the previous bug, I recommend:

# Stage but do not commit the revert in your index (i.e. don't modify HEAD)
git revert --no-commit 13968f0a8996e55e40900efce3c499e06f0e3a6f

# Run the tests, observe failure

# Wipe the index to point back at HEAD
git reset --hard

@jhiemstrawisc jhiemstrawisc added bug Something isn't working director Issue relating to the director component create-patch labels Feb 27, 2026
Copy link
Contributor

@patrickbrophy patrickbrophy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

I came to this decision testing locally, where changing the server name was getting tricky because of persistence in some database. Ultimately it's the URL we query against, so this feels more appropriate anyway.
@jhiemstrawisc
Copy link
Member Author

Closes #3173

@jhiemstrawisc jhiemstrawisc linked an issue Mar 2, 2026 that may be closed by this pull request
@jhiemstrawisc jhiemstrawisc merged commit 873e149 into PelicanPlatform:main Mar 2, 2026
28 of 30 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working create-patch director Issue relating to the director component

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Director stat TTLCache is set/accessed with inconsistent keys

2 participants