ckaczor/azuredatastudio
1
0
Fork 0
mirror of https://github.com/ckaczor/azuredatastudio.git synced 2026-02-16 10:58:30 -05:00
Code Issues Packages Projects Releases Wiki Activity

Even more robust handling of extension tree loading (#9007)

Browse Source 
* Even more robust handling of extension tree loading

* Fix initial loading and add new test for CMS

* Fix compile errors

* Fix logic

* Remove debug log statements
This commit is contained in:
Charles Gagnon
2020-02-04 08:03:34 -08:00
committed by GitHub
parent 5a2bbc0375
commit 62df5359e2
4 changed files with 89 additions and 48 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
extensions/cms/src/cmsResource/tree/treeProvider.ts
View File

@@ -17,6 +17,7 @@ import { CmsResourceTreeNode } from './cmsResourceTreeNode';
export class CmsResourceTreeProvider implements TreeDataProvider<TreeNode>, ICmsResourceTreeChangeHandler {
private _appContext: AppContext;
private _children: TreeNode[] = [CmsResourceMessageTreeNode.create(CmsResourceTreeProvider.loadingLabel, undefined)];
public constructor(
public readonly appContext: AppContext
@@ -31,16 +32,14 @@ export class CmsResourceTreeProvider implements TreeDataProvider<TreeNode>, ICms
}
if (!this.isSystemInitialized) {
// Kick off loading the saved servers but then immediately return the loading node so
// the user isn't left with an empty tree while we load the nodes
this.loadSavedServers().catch(err => this._appContext.apiWrapper.showErrorMessage(localize('cms.resource.tree.treeProvider.loadError', "Unexpected error occured while loading saved servers {0}", err)));
return [CmsResourceMessageTreeNode.create(CmsResourceTreeProvider.loadingLabel, undefined)];
this.loadSavedServers().catch(err => this._appContext.apiWrapper.showErrorMessage(localize('cms.resource.tree.treeProvider.loadError', "Unexpected error occurred while loading saved servers {0}", err)));
return this._children;
}
try {
let registeredCmsServers = this.appContext.cmsUtils.registeredCmsServers;
if (registeredCmsServers && registeredCmsServers.length > 0) {
this.isSystemInitialized = true;
return registeredCmsServers.map((server) => {
this._children = registeredCmsServers.map((server) => {
return new CmsResourceTreeNode(
server.name,
server.description,
@@ -49,11 +48,12 @@ export class CmsResourceTreeProvider implements TreeDataProvider<TreeNode>, ICms
this._appContext, this, null);
}).sort((a, b) => a.name.localeCompare(b.name));
} else {
return [new CmsResourceEmptyTreeNode()];
this._children = [new CmsResourceEmptyTreeNode()];
}
} catch (error) {
return [new CmsResourceEmptyTreeNode()];
this._children = [new CmsResourceEmptyTreeNode()];
}
return this._children;
}
public get onDidChangeTreeData(): Event<TreeNode> {
@@ -93,6 +93,10 @@ export class CmsResourceTreeProvider implements TreeDataProvider<TreeNode>, ICms
await this.appContext.cmsUtils.cacheRegisteredCmsServer(server.name, server.description,
server.ownerUri, server.connection);
}
this._children = servers;
} else {
// No saved servers so just show the Add Server node since we're done loading
this._children = [new CmsResourceEmptyTreeNode()];
}
this._onDidChangeTreeData.fire(undefined);
} catch (error) {

37
extensions/cms/src/test/cmsResource/tree/treeProvider.test.ts
View File

@@ -13,6 +13,7 @@ import { CmsResourceTreeProvider } from '../../../cmsResource/tree/treeProvider'
import { CmsResourceMessageTreeNode } from '../../../cmsResource/messageTreeNode';
import { CmsResourceEmptyTreeNode } from '../../../cmsResource/tree/cmsResourceEmptyTreeNode';
import { CmsUtils } from '../../../cmsUtils';
import { sleep } from '../../utils';
// Mock services
let mockAppContext: AppContext;
@@ -29,22 +30,42 @@ describe('CmsResourceTreeProvider.getChildren', function (): void {
mockAppContext = new AppContext(mockExtensionContext.object, mockApiWrapper.object, mockCmsUtils.object);
});
it('Should not be initialized.', async function (): Promise<void> {
it('Should be loading while waiting for saved servers to load', async function (): Promise<void> {
const treeProvider = new CmsResourceTreeProvider(mockAppContext);
should.notEqual(treeProvider.isSystemInitialized, true);
// We need to return at least one node so the async loading part is hit
mockCmsUtils.setup(x => x.getSavedServers).returns(() => {
return () => [{name: 'name',
description: 'desc',
ownerUri: 'uri',
connection: undefined}];
});
// Set up so loading the servers doesn't return immediately - thus we'll still have the Loading node
mockCmsUtils.setup(x => x.cacheRegisteredCmsServer).returns(() => {
return async () => { await sleep(600000); return undefined; };
});
should.notEqual(treeProvider.isSystemInitialized, true, 'Expected isSystemInitialized not to be true');
const children = await treeProvider.getChildren(undefined);
should.equal(children.length, 1);
should.equal(children[0].parent, undefined);
should.equal(children[0] instanceof CmsResourceMessageTreeNode, true);
should.equal(children.length, 1, 'Expected exactly one child node');
should.equal(children[0].parent, undefined, 'Expected node to not have a parent');
should.equal(children[0] instanceof CmsResourceMessageTreeNode, true, 'Expected node to be a CmsResourceMessageTreeNode');
});
it('Should be empty resource node when no servers to load', async function (): Promise<void> {
const treeProvider = new CmsResourceTreeProvider(mockAppContext);
should.notEqual(treeProvider.isSystemInitialized, true, 'Expected isSystemInitialized not to be true');
const children = await treeProvider.getChildren(undefined);
should.equal(children.length, 1, 'Expected exactly one child node');
should.equal(children[0].parent, undefined, 'Expected node to not have a parent');
should.equal(children[0] instanceof CmsResourceEmptyTreeNode, true, 'Expected node to be a CmsResourceEmptyTreeNode');
});
it('Should not be loading after initialized.', async function (): Promise<void> {
const treeProvider = new CmsResourceTreeProvider(mockAppContext);
treeProvider.isSystemInitialized = true;
should.equal(true, treeProvider.isSystemInitialized);
should.equal(true, treeProvider.isSystemInitialized, 'Expected isSystemInitialized to be true');
mockCmsUtils.setup(x => x.registeredCmsServers).returns(() => []);
const children = await treeProvider.getChildren(undefined);
should.equal(children[0] instanceof CmsResourceEmptyTreeNode, true);
should.equal(children[0] instanceof CmsResourceEmptyTreeNode, true, 'Expected child node to be CmsResourceEmptyTreeNode');
});
it('Should show CMS nodes if there are cached servers', async function (): Promise<void> {
@@ -59,6 +80,6 @@ describe('CmsResourceTreeProvider.getChildren', function (): void {
}];
});
const children = await treeProvider.getChildren(undefined);
should.equal(children[0] !== null, true);
should.exist(children[0], 'Child node did not exist');
});
});

8
extensions/cms/src/test/utils.ts Normal file
View File

@@ -0,0 +1,8 @@
/*---------------------------------------------------------------------------------------------
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the Source EULA. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/
export async function sleep(ms: number): Promise<{}> {
return new Promise(resolve => setTimeout(resolve, ms));
}