Add query-param fallback to analytics ignore check - #22
Merged
Conversation
|
Important
This repository does not receive automatic reviews because it has fewer than 10 stars. ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changed
Added
ANALYTICS_IGNORE_QUERY_PARAMalongside the header/values/IP checks.A request whose query string carries this param with a matching value
(from the same
ANALYTICS_IGNORE_VALUESlist) skips analytics logging thesame way - any one of the four checks (header, query param, IP) is enough.
Why
Part of the NESO API-usage-metrics work (neso-nextgen-shared#152). The
admin portal's resource-download buttons render plain
<a href target="_blank">links to/datastore/dump/{resource_id}- a browsernavigation, not a
fetch()call, so no custom header can be attached atall (browsers don't allow it). The admin portal already sends
Request-Source: admin-portalon everyfetch()-based call(datopian/dx-helm-neso#75); this closes the one gap that was flagged but
left open in that PR - the download links can carry the same value as a
query param instead (
?request_source=admin-portal), since that's just aURL, no header machinery needed.
Verified
pytest- 490 passed.ruff check/mypy- clean./datastore/dump/...request with
?request_source=admin-portalis not recorded; the sameURL without the param still is.
Not verified: the admin portal side (building the query param into the
download link) is a separate change in dx-helm-neso, not done yet.