fix(telemetry): handle malformed telemetry tokens #3014
Merged
Conversation
This file contains 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
rwaskiewicz
commented
Aug 23, 2021
| @@ -25,7 +30,10 @@ export async function readConfig(): Promise<TelemetryConfig> { | |||
| }; | |||
|
|
|||
| await writeConfig(config); | |||
| } else if (!!config && !config['tokens.telemetry'].match(UUID_REGEX)) { | |||
There was a problem hiding this comment.
This is the line that was failing. If the config file existed, but 'tokens.telemetry' either:
- existed and wasn't a string
- did not exist at all
we would call match() on "something" that didn't have it in it's prototype chain
There was a problem hiding this comment.
It should be safe to do the inverse and call RegExp.test() with "something" as an argument, i.e. !UUID_REGEX.test(config['tokens.telemetry']).
There was a problem hiding this comment.
Ahhh good point - done in fc90181
rwaskiewicz
changed the title
rwaskiewicz
commented
Aug 23, 2021
src/cli/ionic-config.ts
Outdated
| @@ -25,7 +30,10 @@ export async function readConfig(): Promise<TelemetryConfig> { | |||
| }; | |||
|
|
|||
| await writeConfig(config); | |||
| } else if (!!config && !config['tokens.telemetry'].match(UUID_REGEX)) { | |||
| } else if ( | |||
| !!config && | |||
There was a problem hiding this comment.
@splitinfinities is there a reason I can't remove this check? (Just the !!config &&). Per this condition, this should always return true
There was a problem hiding this comment.
I intended this to be a guard clause to protect against accessing config if it ended up not being defined. I think what you changed it to is sensible as well.
ltm
approved these changes
Aug 23, 2021
splitinfinities
approved these changes
Aug 23, 2021
|
|
||
| expect(result.isFile).toBe(true); | ||
|
|
||
| const config = await readConfig(); | ||
|
|
||
| expect(Object.keys(config).join()).toBe('telemetry.stencil,tokens.telemetry'); | ||
| expect(config['telemetry.stencil']).toBe(true); | ||
| expect(!!config['tokens.telemetry'].match(UUID_REGEX)).toBe(true); | ||
| expect(config['tokens.telemetry']).toMatch(UUID_REGEX); |
this fix handles the event that a user has an Ionic configuration file, but does not have a 'tokens.telemetry' field in said file. STENCIL-85: ionic-pwa fails at startup
add a `beforeEach` test setup block to delete the configuration file before each test is run, in order to ensure better separation of tests & attempt to mitigate side effects between tests for this function. this led to a small amount of clean up in pre-existing tests update usage of let->const where appropriate use jest's toMatch() where appropriate update the test for an invalid, but string value for tokens.telemetry to better differentiate it from the test added in the parent commit
rwaskiewicz
force-pushed
the
rwaskiewicz/match_fail
branch
from
fc90181 to
7445e0e
Compare
rwaskiewicz
added a commit
that referenced
this pull request
Aug 27, 2021
handle the scenario that a user has an Ionic configuration file, but does not have a 'tokens.telemetry' field in said file. STENCIL-85: ionic-pwa fails at startup
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.
Fixes: #3013
Summary:
this fix handles the event that a user has an Ionic configuration file,
but does not have a 'tokens.telemetry' field in said file.
Replication:
With
master@HEAD, modify your local~/.ionic/config.jsonin one of two ways'tokens.telemetry'completely'tokens.telemetry'to undefined (or any other valid JSON)Then, spin up a small Stencil project, and attempt to turn telemetry off/on:
Testing:
With the HEAD of this branch, build it and install it in the PWA app you build