FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

Log digest file name when updating trust by joyceerhl · Pull Request #12812 · microsoft/vscode-python · GitHub

Log digest file name when updating trust - #12812

Merged
Joyce Er (joyceerhl) merged 2 commits into
microsoft:masterfrom
joyceerhl:trusted-notebooks-logging
Jul 13, 2020
Merged

Log digest file name when updating trust#12812
Joyce Er (joyceerhl) merged 2 commits into
microsoft:masterfrom
joyceerhl:trusted-notebooks-logging

Conversation

Copy link
Copy Markdown
  • Pull request represents a single change (i.e. not fixing disparate/unrelated things in a single PR).
  • Title summarizes what is changing.
  • Has a news entry file (remember to thank yourself!).
  • Appropriate comments and documentation strings in the code.
  • Has sufficient logging.
  • Has telemetry for enhancements.
  • Unit tests & system/integration tests are added/updated.
  • Test plan is updated as appropriate.
  • package-lock.json has been regenerated by running npm install (if dependencies have changed).
  • The wiki is updated with any design decisions/details.

const fileLocation = await this.getFileLocation(uri);
// Since the signature is a hex digest, the character 'z' is being used to delimit the start and end of a single digest
await this.fs.appendFile(fileLocation, `z${signature}z\n`);
traceInfo(`Wrote trust for ${uri.toString()} to ${fileLocation}`);

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

I'd add a property to track whether we've logged this or not, else we could end up with a lot of unnecessary messages being logged, when we only need the first such log entry.

e.g.

if not loggedd earlier:
	traceInfo...

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Then we'd need to remember which files we've seen before, since multiple notebook files could be edited simultaneously and we'd want to log each ipynb's corresponding digest file location at least once. Does your review still apply?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

I think that we would have to do this logging check per file then. Don is right in that this would be so noisy with autosave on that it might not be a useful message if it logs every save.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

I think I would just debounce it. Logging every save isn't that noisy. It's once a second.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Debouncing won't work as its possible we save a new file and that can get swallowed.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Debounce will not work, as you loose updates from other files.

Don Jayamanne (DonJayamanne) Jul 9, 2020
edited
Loading

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Personally i don't see the point of logging every update, the assumption is that something will go wrong and we will end up looking at the log and the file to look for a specific hash.
I find that to be an unlikely scenario.
Nope, re-read richs comments, it about tracking the last update to the file.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Not sure we need that either, anyways.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Jim Griesmer (@greazer) suggested, and I agree, that we should log this info at least once for users. It seems plausible that something might go wrong and we won't have a way of recovering that info (short of them giving us the URI to their file and us hashing it to figure out which digest file is relevant).

This info dominates the log, so we shouldn't log on each save either. And as Don mentioned, debouncing won't work. Therefore, anyone have any strong objections to me implementing this? #12812 (comment)

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Sure sounds fine.

Copy link
Copy Markdown

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities (and 0 Security Hotspots to review)
0 Code Smells

No Coverage information
0.0% Duplication

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

Labels

no-changelog No news entry required

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants


Back | FazBrowse Home | New Git URL