Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding Group by schema to OE #17543

Merged
merged 16 commits into from
Feb 21, 2023
Merged

Adding Group by schema to OE #17543

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
418b2f9
Adding group by schema
aasimkhan30 Feb 14, 2023
5454211
Adding group by schema
aasimkhan30 Feb 14, 2023
441a5cf
Adding strings
aasimkhan30 Feb 14, 2023
f842f74
Merge branch 'aasim/feat/groupBySchema' of github.com:microsoft/vscod…
aasimkhan30 Feb 14, 2023
d26599e
removing local config
aasimkhan30 Feb 14, 2023
9fa37da
Fixing formatting
aasimkhan30 Feb 14, 2023
cc214c8
Adding enable and disable group by schema menu item
aasimkhan30 Feb 14, 2023
bb6f904
Fixing node refresh logic
aasimkhan30 Feb 15, 2023
7d1e43c
Fixing lint
aasimkhan30 Feb 15, 2023
1f1a678
changing default
aasimkhan30 Feb 15, 2023
e667242
Adding error message
aasimkhan30 Feb 15, 2023
2a9b974
Fixing stuff
aasimkhan30 Feb 15, 2023
844ca70
Fixing error message
aasimkhan30 Feb 17, 2023
3d46875
fixing error message
aasimkhan30 Feb 17, 2023
0753e88
Update localization/xliff/enu/constants/localizedConstants.enu.xlf
aasimkhan30 Feb 17, 2023
639bab2
Pushing new sts version
aasimkhan30 Feb 21, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions localization/xliff/enu/constants/localizedConstants.enu.xlf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -587,6 +587,12 @@
<trans-unit id="columnWidthMustBePositiveError">
<source xml:lang="en">Width cannot be 0 or negative</source>
</trans-unit>
<trans-unit id="objectExplorerNodeRefreshError">
<source xml:lang="en">An error occurred refreshing nodes. See the MSSQL output channel for more details.</source>
</trans-unit>
<trans-unit id="showOutputChannelActionButtonText">
<source xml:lang="en">Show MSSQL output</source>
</trans-unit>
</body>
</file>
</xliff>
9 changes: 9 additions & 0 deletions localization/xliff/enu/localizedPackage.json.enu.xlf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -392,6 +392,15 @@
<trans-unit id="mssql.deviceCode.description">
<source xml:lang="en">Allows users to sign in to input-constrained devices.</source>
</trans-unit>
<trans-unit id="mssql.objectExplorer.groupBySchema">
<source xml:lang="en">When enabled, the database objects in Object Explorer will be categorized by schema.</source>
</trans-unit>
<trans-unit id="mssql.objectExplorer.enableGroupBySchema">
<source xml:lang="en">Enable Group By Schema</source>
</trans-unit>
<trans-unit id="mssql.objectExplorer.disableGroupBySchema">
<source xml:lang="en">Disable Group By Schema</source>
</trans-unit>
</body>
</file>
</xliff>
27 changes: 27 additions & 0 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -247,6 +247,18 @@
"when": "view == queryHistory",
"title": "%mssql.clearAllQueryHistory%",
"group": "secondary"
},
{
"command": "mssql.objectExplorer.enableGroupBySchema",
"when": "view == objectExplorer && !config.mssql.objectExplorer.groupBySchema",
"title": "%mssql.objectExplorer.enableGroupBySchema%",
"group": "secondary"
Copy link
Contributor

Choose a reason for hiding this comment

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

For VS Code MSSQL seems like it'd be better to have it as a navigation item so it shows up on the title bar. That's a lot easier to see and work with - the secondary menu is still a bit too hidden IMO.

@erinstellato-ms thoughts on this?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

IMO I don't think people will toggle this setting a lot. Therefore, I am not sure about making it visible all the time. They will either stick with schema tree or regular tree. We can enable this setting by default in the next version and let users disable it if they want to.

Copy link
Contributor

Choose a reason for hiding this comment

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

It's not like there isn't plenty of room there. And I just think that hiding it in the secondary menu means that most people aren't going to know it exists unless they're really diligent about reading the release notes.

Just seems a shame to put all the work into this feature and then make it difficult for people to discover it. We can always hide the action later if people don't like it there.

},
{
"command": "mssql.objectExplorer.disableGroupBySchema",
"when": "view == objectExplorer && config.mssql.objectExplorer.groupBySchema",
"title": "%mssql.objectExplorer.disableGroupBySchema%",
"group": "secondary"
}
],
"view/item/context": [
Expand Down Expand Up @@ -439,6 +451,16 @@
"category": "MS SQL",
"icon": "$(add)"
},
{
"command": "mssql.objectExplorer.enableGroupBySchema",
"title": "%mssql.objectExplorer.enableGroupBySchema%",
"category": "MS SQL"
},
{
"command": "mssql.objectExplorer.disableGroupBySchema",
"title": "%mssql.objectExplorer.disableGroupBySchema%",
"category": "MS SQL"
},
{
"command": "mssql.objectExplorerNewQuery",
"title": "%mssql.objectExplorerNewQuery%",
Expand Down Expand Up @@ -1137,6 +1159,11 @@
"type": "boolean",
"description": "%mssql.ignorePlatformWarning%",
"default": false
},
"mssql.objectExplorer.groupBySchema": {
"type": "boolean",
"description": "%mssql.objectExplorer.groupBySchema%",
"default": false
}
}
}
Expand Down
5 changes: 4 additions & 1 deletion package.nls.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,5 +128,8 @@
"mssql.Configuration":"MSSQL configuration",
"mssql.chooseAuthMethod":"Chooses which Authentication method to use",
"mssql.authCodeGrant.description":"Prompts users to sign in using their browser.",
"mssql.deviceCode.description":"Allows users to sign in to input-constrained devices."
"mssql.deviceCode.description":"Allows users to sign in to input-constrained devices.",
"mssql.objectExplorer.groupBySchema":"When enabled, the database objects in Object Explorer will be categorized by schema.",
"mssql.objectExplorer.enableGroupBySchema":"Enable Group By Schema",
"mssql.objectExplorer.disableGroupBySchema":"Disable Group By Schema"
}
24 changes: 12 additions & 12 deletions src/configurations/config.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
{
"service": {
"downloadUrl": "https://github.com/Microsoft/sqltoolsservice/releases/download/{#version#}/microsoft.sqltools.servicelayer-{#fileName#}",
"version": "4.5.0.8",
"version": "4.5.0.26",
"downloadFileNames": {
"Windows_86": "win-x86-net6.0.zip",
"Windows_64": "win-x64-net6.0.zip",
"OSX_10_11_64": "osx-x64-net6.0.tar.gz",
"CentOS_7": "rhel-x64-net6.0.tar.gz",
"Debian_8": "rhel-x64-net6.0.tar.gz",
"Fedora_23": "rhel-x64-net6.0.tar.gz",
"OpenSUSE_13_2": "rhel-x64-net6.0.tar.gz",
"SLES_12_2": "rhel-x64-net6.0.tar.gz",
"RHEL_7": "rhel-x64-net6.0.tar.gz",
"Ubuntu_14": "rhel-x64-net6.0.tar.gz",
"Ubuntu_16": "rhel-x64-net6.0.tar.gz"
"Windows_86": "win-x86-net7.0.zip",
"Windows_64": "win-x64-net7.0.zip",
"OSX_10_11_64": "osx-x64-net7.0.tar.gz",
"CentOS_7": "rhel-x64-net7.0.tar.gz",
"Debian_8": "rhel-x64-net7.0.tar.gz",
"Fedora_23": "rhel-x64-net7.0.tar.gz",
"OpenSUSE_13_2": "rhel-x64-net7.0.tar.gz",
"SLES_12_2": "rhel-x64-net7.0.tar.gz",
"RHEL_7": "rhel-x64-net7.0.tar.gz",
"Ubuntu_14": "rhel-x64-net7.0.tar.gz",
"Ubuntu_16": "rhel-x64-net7.0.tar.gz"
},
"installDir": "../sqltoolsservice/{#version#}/{#platform#}",
"executableFiles": [
Expand Down
3 changes: 3 additions & 0 deletions src/constants/constants.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,9 @@ export const cmdObjectExplorerNodeSignIn = 'mssql.objectExplorerNodeSignIn';
export const cmdConnectObjectExplorerNode = 'mssql.connectObjectExplorerNode';
export const cmdConnectObjectExplorerProfile = 'mssql.connectObjectExplorerProfile';
export const cmdOpenObjectExplorerCommand = 'workbench.view.extension.objectExplorer';
export const cmdObjectExplorerGroupBySchemaFlagName = 'mssql.objectExplorer.groupBySchema';
export const cmdObjectExplorerEnableGroupBySchemaCommand = 'mssql.objectExplorer.enableGroupBySchema';
export const cmdObjectExplorerDisableGroupBySchemaCommand = 'mssql.objectExplorer.disableGroupBySchema';
export const cmdScriptSelect = 'mssql.scriptSelect';
export const cmdScriptCreate = 'mssql.scriptCreate';
export const cmdScriptDelete = 'mssql.scriptDelete';
Expand Down
24 changes: 24 additions & 0 deletions src/controllers/mainController.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,6 +163,15 @@ export default class MainController implements vscode.Disposable {
});
});

this.registerCommand(Constants.cmdObjectExplorerEnableGroupBySchemaCommand);
this._event.on(Constants.cmdObjectExplorerEnableGroupBySchemaCommand, () => {
vscode.workspace.getConfiguration().update(Constants.cmdObjectExplorerGroupBySchemaFlagName, true, true);
});
this.registerCommand(Constants.cmdObjectExplorerDisableGroupBySchemaCommand);
this._event.on(Constants.cmdObjectExplorerDisableGroupBySchemaCommand, () => {
vscode.workspace.getConfiguration().update(Constants.cmdObjectExplorerGroupBySchemaFlagName, false, true);
});

this.initializeQueryHistory();

this.sqlTasksService = new SqlTasksService(SqlToolsServerClient.instance, this._untitledSqlDocumentService);
Expand Down Expand Up @@ -1178,6 +1187,21 @@ export default class MainController implements vscode.Disposable {

await this.sanitizeConnectionProfiles();

if (e.affectsConfiguration(Constants.cmdObjectExplorerGroupBySchemaFlagName)) {
let errorFoundWhileRefreshing = false;
(await this._objectExplorerProvider.getChildren()).forEach((n: TreeNodeInfo) => {
try {
this._objectExplorerProvider.refreshNode(n);
} catch (e) {
errorFoundWhileRefreshing = true;
Utils.logToOutputChannel(e.toString());
}
});
if (errorFoundWhileRefreshing) {
Utils.showErrorMsg(LocalizedConstants.objectExplorerNodeRefreshError);
}
}

if (needsRefresh) {
this._objectExplorerProvider.refresh(undefined);
}
Expand Down
17 changes: 15 additions & 2 deletions src/models/utils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ const configTracingLevel = 'tracingLevel';
const configLogRetentionMinutes = 'logRetentionMinutes';
const configLogFilesRemovalLimit = 'logFilesRemovalLimit';

const outputChannel = vscode.window.createOutputChannel(Constants.outputChannelName);

// INTERFACES /////////////////////////////////////////////////////////////////////////////////////

// Interface for package.json information
Expand Down Expand Up @@ -110,8 +112,6 @@ export function getActiveTextEditorUri(): string {

// Helper to log messages to "MSSQL" output channel
export function logToOutputChannel(msg: any): void {
let outputChannel = vscode.window.createOutputChannel(Constants.outputChannelName);
outputChannel.show();
if (msg instanceof Array) {
msg.forEach(element => {
outputChannel.appendLine(element.toString());
Expand All @@ -121,6 +121,10 @@ export function logToOutputChannel(msg: any): void {
}
}

export function openOutputChannel(): void {
outputChannel.show();
}

// Helper to log debug messages
export function logDebug(msg: any): void {
let config = vscode.workspace.getConfiguration(Constants.extensionConfigSectionName);
Expand All @@ -147,6 +151,15 @@ export function showErrorMsg(msg: string): void {
vscode.window.showErrorMessage(Constants.extensionName + ': ' + msg);
}

// Helper to show an error message with an option to open the output channel
export function showOutputChannelErrorMsg(msg: string): void {
vscode.window.showErrorMessage(msg, LocalizedConstants.showOutputChannelActionButtonText).then((result) => {
if (result === LocalizedConstants.showOutputChannelActionButtonText) {
openOutputChannel();
}
});
}

export function isEmpty(str: any): boolean {
return (!str || '' === str);
}
Expand Down
59 changes: 35 additions & 24 deletions src/objectExplorer/objectTypes/Schema.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.