fix: include file content in iac analytics CC-743 #1719
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
3 tasks
|
JackuB
approved these changes
Mar 15, 2021
JackuB
reviewed
Mar 15, 2021
test/iac-unit-tests/index.spec.ts
Outdated
Comment on lines
55
to
62
| expect(opts.iacDirFiles).not.toEqual( | ||
| expect.objectContaining([ | ||
| { | ||
| fileContent: 'FAKE_FILE_CONTENT', | ||
| jsonContent: {}, | ||
| }, | ||
| ]), | ||
| ); |
There was a problem hiding this comment.
Nit: Something about this jest syntax feels off to me, it's trying to check if something in an array contains specific keys, right? What about arraycontaining helper here? https://jestjs.io/docs/expect#expectnotarraycontainingarray
There was a problem hiding this comment.
fixed, thanks @JackuB
rontalx
force-pushed
the
fix/file-content-in-iac-analytics
branch
from
07ca639 to
bb63bba
Compare
aron
approved these changes
Mar 15, 2021
This was referenced Mar 15, 2021
ipapast
changed the title
This was referenced Mar 16, 2021
This was referenced Mar 16, 2021
Merged
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.
Original PR closed due to mistakenly messing up commits with a bad rebase.
What does this PR do?
We have a minor bug in our Snyk CLI that when the snyk iac test --experimental command is run with a directory instead of a single file we include the iacDirFiles on the options object. This options object is then logged as part of the analytics flow and sent to Big Query. We do not want to be storing user file content in any part of our system so this needs to be filtered out here.
This PR filters the File content and JSON output from the iacDirFiles property added to the options object in the test command and adds a smoke test and unit test to assert that the content is not present.
This is not a long term strategy for solving this issue but fixes the immediate problem that prevents users from adopting the beta. In future we'll want to decouple the file + parsed content from any metadata and ensure that the file content is only passed where needed and discarded when used. We should also look into using a whitelist for the logger to only allow specific arguments to be logged.
Where should the reviewer start?
Start at the smoke tests then the test() function and finish up with the unit tests. The unit tests are really a temporary measure I think to ensure that the iacDirFiles object is clean, we can remove the tests when the flow has been refactored.
How should this be manually tested?
Run the following and verify that the "args" property under analytics is clean of file content.
node ./dist/cli iac test -d --experimental ./test/fixtures/iac/file-logging