Don't add database source archive folders by default by shati-patel · Pull Request #3047 · github/vscode-codeql

shati-patel · 2023-11-01T16:00:03Z

No longer add the database source folder to the workspace by default (since this caused bugs in single-folder workspaces). If users want to keep the old behaviour of auto-adding DB source folders, they can set the addDatabaseSourceToWorkspace setting to true.

See internal linked issue for more details.

Checklist

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.
- VS Code extension docs: Changes to database downloads codeql#14668

shati-patel · 2023-11-01T16:30:28Z

extensions/ql-vscode/src/model-editor/model-editor-view.ts

      makeSelected,
-      false,
    );
    if (!addedDatabase) {


I assume we no longer need to treat the model editor as a special case, so I've removed the argument here.

I'm not sure about this change: if you are in the model editor and have the setting enabled, we would now suddenly reload when you try to model a dependency. I think this may be unexpected because the user might not know that the database gets added as a normal database.

You're right that this might be unexpected. Since it's less explicit that you're adding a database in this case, I'll keep the hard-coded "don't add source archive" setting! 👍🏽

extensions/ql-vscode/test/vscode-tests/minimal-workspace/local-queries/local-databases.test.ts

koesie10 · 2023-11-03T12:52:54Z

extensions/ql-vscode/src/config.ts


+const ADD_DATABASE_SOURCE_TO_WORKSPACE_SETTING = new Setting(
+  "addDatabaseSourceToWorkspace",
+  DATABASE_DOWNLOAD_SETTING,


Is this correct to be under databaseDownload? This also applies to database manually added by adding a folder or adding an archive, so it does apply to non-downloaded databases as well.

Good point! I can rename the overall setting to something like "Adding databases" (instead of "Downloading databases")

koesie10 · 2023-11-03T12:55:26Z

extensions/ql-vscode/src/model-editor/model-editor-view.ts

      makeSelected,
-      false,
    );
    if (!addedDatabase) {


I'm not sure about this change: if you are in the model editor and have the setting enabled, we would now suddenly reload when you try to model a dependency. I think this may be unexpected because the user might not know that the database gets added as a normal database.

shati-patel · 2023-11-07T13:43:25Z

(Converting back to draft while we wait for docs to be published and for merging to be unlocked)

This reverts commit 56025d1.

I updated the user-facing name for this setting, but forgot about the internal variable

shati-patel · 2023-11-13T11:22:58Z

Docs are in place, and I've had confirmation that this is good to merge! (Apologies for all the commit spam, I had a few conflicts to resolve...)

shati-patel · 2023-11-13T15:15:45Z

extensions/ql-vscode/package.json

          "codeQL.databaseDownload.allowHttp": {
+            "type": "boolean",
+            "markdownDeprecationMessage": "**Deprecated**: Please use `#codeQL.addingDatabases.allowHttp#` instead.",
+            "deprecationMessage": "Deprecated: Please use codeQL.addingDatabases.allowHttp instead."
+          },


As mentioned offline, users who still use this old setting name will get a deprecation message:

For the record: we will no longer support the old setting name. This isn't the "formal" way of deprecating a setting, but this is a sufficiently niche/insecure setting that it shouldn't have much user impact.

In the case where a user did have this setting enabled: If they try to download a DB from an http location, they'll get the error message "Must use https for downloading a database.", which should point them to check their settings.

Discussed offline as well, but this should be fine. As said it's not the full proper way of renaming a setting, and we could aim to support both for a transition period, but we expect this setting to be almost (if not completely) unused. And as Shati points out, if someone is using this the error should point them towards checking their settings and seeing the deprecation notice. This along with a changelog entry should mean that anyone who is using it sees it and updates their settings.

robertbrignull

LGTM

Thanks @shati-patel for adding the changelog / deprecation notice.

shati-patel commented Nov 1, 2023

View reviewed changes

extensions/ql-vscode/test/vscode-tests/minimal-workspace/local-queries/local-databases.test.ts Outdated Show resolved Hide resolved

shati-patel marked this pull request as ready for review November 2, 2023 16:35

shati-patel requested review from a team as code owners November 2, 2023 16:35

shati-patel mentioned this pull request Nov 2, 2023

VS Code extension docs: Changes to database downloads github/codeql#14668

Merged

koesie10 reviewed Nov 3, 2023

View reviewed changes

shati-patel mentioned this pull request Nov 6, 2023

Minor tidy-up for local-databases tests #3058

Merged

3 tasks

shati-patel marked this pull request as draft November 7, 2023 13:42

shati-patel added 6 commits November 13, 2023 10:32

Don't add database source archive folders by default

3288572

Use the same setting for the model editor

2bf264a

Fix tests

528af4a

Rename global "databases" setting

de10640

Revert "Use the same setting for the model editor"

bb548ee

This reverts commit 56025d1.

Rename variable

c771c05

I updated the user-facing name for this setting, but forgot about the internal variable

shati-patel force-pushed the shati-patel/db-src-archive branch from 2294d8c to 5b1f528 Compare November 13, 2023 10:36

Update changelog

c111a74

shati-patel force-pushed the shati-patel/db-src-archive branch from 5b1f528 to c111a74 Compare November 13, 2023 10:37

shati-patel marked this pull request as ready for review November 13, 2023 11:22

Add deprecation message for old setting

080fb9d

shati-patel commented Nov 13, 2023

View reviewed changes

Update changelog

1c79737

robertbrignull approved these changes Nov 13, 2023

View reviewed changes

shati-patel enabled auto-merge (squash) November 13, 2023 15:52

shati-patel merged commit 9e914c9 into main Nov 13, 2023

shati-patel deleted the shati-patel/db-src-archive branch November 13, 2023 16:04

shati-patel mentioned this pull request Nov 14, 2023

Rename "allowHttp" setting #3069

Merged

3 tasks

shati-patel mentioned this pull request Jan 15, 2024

Send telemetry for addDatabaseSourceToWorkspace setting #3238

Merged

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Don't add database source archive folders by default#3047

Don't add database source archive folders by default#3047
shati-patel merged 9 commits intomainfrom
shati-patel/db-src-archive

shati-patel commented Nov 1, 2023 •

edited

Loading

Uh oh!

shati-patel Nov 1, 2023

Uh oh!

koesie10 Nov 3, 2023

Uh oh!

shati-patel Nov 6, 2023

Uh oh!

Uh oh!

koesie10 Nov 3, 2023

Uh oh!

shati-patel Nov 6, 2023

Uh oh!

koesie10 Nov 3, 2023

Uh oh!

shati-patel commented Nov 7, 2023

Uh oh!

shati-patel commented Nov 13, 2023 •

edited

Loading

Uh oh!

shati-patel Nov 13, 2023

Uh oh!

shati-patel Nov 13, 2023

Uh oh!

robertbrignull Nov 13, 2023 •

edited

Loading

Uh oh!

robertbrignull left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

shati-patel commented Nov 1, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Checklist

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

shati-patel commented Nov 7, 2023

Uh oh!

shati-patel commented Nov 13, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

robertbrignull Nov 13, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

robertbrignull left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

shati-patel commented Nov 1, 2023 •

edited

Loading

shati-patel commented Nov 13, 2023 •

edited

Loading

robertbrignull Nov 13, 2023 •

edited

Loading