Skip to content

Preemptively add a version number to the query history json file#1168

Merged
aeisenberg merged 2 commits intomainfrom
aeisenberg/query-history-version
Feb 25, 2022
Merged

Preemptively add a version number to the query history json file#1168
aeisenberg merged 2 commits intomainfrom
aeisenberg/query-history-version

Conversation

@aeisenberg
Copy link
Copy Markdown
Contributor

Since we are now storing query history on disk, we will need to handle
situations where versions change. For now, there is only version 1. In
the future, we may need to make breaking changes to this format and we
need the flexibility to detect and possibly handle different versions.

In this case, users don't often downgrade their vscode versions, so
most likely, we only need to be forward compatible. Ie- we need to
handle moving from v1 to v2, but not the other way around.

Checklist

  • [n/a] CHANGELOG.md has been updated to incorporate all user visible changes made by this pull request.
  • Issues have been created for any UI or other user-facing changes made by this pull request.
  • [Maintainers only] If this pull request makes user-facing changes that require documentation changes, open a corresponding docs pull request in the github/codeql repo and add the ready-for-doc-review label there.

Since we are now storing query history on disk, we will need to handle
situations where versions change. For now, there is only version 1. In
the future, we may need to make breaking changes to this format and we
need the flexibility to detect and possibly handle different versions.

In this case, users don't often downgrade their vscode versions, so
most likely, we only need to be forward compatible. Ie- we need to
handle moving from v1 to v2, but not the other way around.
@aeisenberg aeisenberg requested a review from a team as a code owner February 24, 2022 19:52
@aeisenberg aeisenberg requested a review from charisk February 24, 2022 19:52
Copy link
Copy Markdown
Contributor

@charisk charisk left a comment

Choose a reason for hiding this comment

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

Good stuff! Just need to revert a small change that has crept in.

Comment thread extensions/ql-vscode/src/vscode-tests/no-workspace/query-results.test.ts Outdated
Co-authored-by: Charis Kyriakou <charisk@users.noreply.github.com>
@aeisenberg aeisenberg enabled auto-merge February 25, 2022 16:00
@aeisenberg aeisenberg merged commit 7196c26 into main Feb 25, 2022
@aeisenberg aeisenberg deleted the aeisenberg/query-history-version branch February 25, 2022 16:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants