Improve: Restrict environment metadata collection to verified agent fields#8163
Open
austinjump-sec wants to merge 1 commit into
Open
Improve: Restrict environment metadata collection to verified agent fields#8163austinjump-sec wants to merge 1 commit into
austinjump-sec wants to merge 1 commit into
Conversation
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.
WHY are these changes introduced?
Currently,
getShopifyEnvironmentVariables()uses a broad prefix matching pattern (key.startsWith('SHOPIFY_')) to collect system diagnostic metrics. This loose filter inadvertently captures non-telemetry operational configurations—including active local workspace state flags and temporary environment keys—into the core outbound tracking payload object.Following the definitive architecture roadmap explicitly outlined in the module's code comments, this introduces unnecessary data bloat and noise to our analytics pipelines. Enforcing a strict, precise mapping ensures we align with clean data minimization principles.
WHAT is this pull request doing?
This PR refactors
getShopifyEnvironmentVariables()insidepackages/cli-kit/src/private/node/analytics.ts.ALLOWED_ANALYTICS_KEYSlookup array.SHOPIFY_CLI_AGENT,SHOPIFY_CLI_AGENT_VERSION,SHOPIFY_CLI_AGENT_RUN_ID,SHOPIFY_CLI_AGENT_SESSION_ID, andSHOPIFY_CLI_AGENT_PROVIDER).How to test your changes?
getSensitiveEnvironmentData()."SHOPIFY_CLI_AGENT"value, while completely omitting the unmapped"SHOPIFY_CLI_IDENTITY_TOKEN"key.Checklist
patchfor bug fixes ·minorfor new features ·majorfor breaking changes) and added a changeset withpnpm changeset add