Update whoIsActive extension to use azdata (#7287)

* Update whoIsActive extension to use azdata * Change path * Update package-lock
2026-01-13 17:22:15 -05:00 · 2019-09-19 11:38:18 -07:00
parent a584aca969
commit 6a136854b0
9 changed files with 820 additions and 478 deletions
--- a/build/gulpfile.hygiene.js
+++ b/build/gulpfile.hygiene.js
@@ -67,6 +67,7 @@ const indentationFilter = [

 	// except multiple specific files
 	'!**/package.json',
+	'!**/package-lock.json', // {{SQL CARBON EDIT}}
 	'!**/yarn.lock',
 	'!**/yarn-error.log',

--- a/samples/sp_whoIsActive/.gitignore
+++ b/samples/sp_whoIsActive/.gitignore
@@ -6,4 +6,4 @@ node_modules
 .DS_Store
 .idea
 test-reports/**
-typings/sqlops.proposed.d.ts
+typings/azdata.d.ts
--- a/samples/sp_whoIsActive/.vscode/launch.json
+++ b/samples/sp_whoIsActive/.vscode/launch.json
@@ -9,7 +9,7 @@
 //    - open Azure Data Studio
 //    - run the command "Install 'azuredatastudio' command in PATH"
 {
-	"version": "0.2.0",
+    "version": "0.2.0",
    "configurations": [

        {
@@ -21,37 +21,37 @@
                "--extensionDevelopmentPath=${workspaceFolder}"
            ]
        },
-		{
-			"type": "node",
-			"request": "attach",
-			"name": "Attach to Ops Studio",
-			"protocol": "inspector",
-			"port": 5870,
-			"restart": true,
+        {
+            "type": "node",
+            "request": "attach",
+            "name": "Attach to Azure Data Studio",
+            "protocol": "inspector",
+            "port": 5870,
+            "restart": true,
            "sourceMaps": true,
-			"outFiles": [
-				"${workspaceRoot}/out/**/*.js"
-			],
+            "outFiles": [
+                "${workspaceRoot}/out/**/*.js"
+            ],
            "preLaunchTask": "",
            "timeout": 25000
-		},
+        },
        {
            "name": "Debug in enlistment",
-            "type": "sqlopsExtensionHost",
+            "type": "azuredatastudioExtensionHost",
            "request": "launch",
-			"windows": {
-				"runtimeExecutable": "${workspaceFolder}/../../scripts/sql.bat"
-			},
-			"osx": {
-				"runtimeExecutable": "${workspaceFolder}/../../scripts/sql.sh"
-			},
-			"linux": {
-				"runtimeExecutable": "${workspaceFolder}/../../scripts/sql.sh"
-			},
+            "windows": {
+                "runtimeExecutable": "${workspaceFolder}/../../scripts/sql.bat"
+            },
+            "osx": {
+                "runtimeExecutable": "${workspaceFolder}/../../scripts/sql.sh"
+            },
+            "linux": {
+                "runtimeExecutable": "${workspaceFolder}/../../scripts/sql.sh"
+            },
            "args": [
                "--extensionDevelopmentPath=${workspaceFolder}"
            ],
            "timeout": 20000
        }
    ]
-}
+}
--- a/samples/sp_whoIsActive/package-lock.json
+++ b/samples/sp_whoIsActive/package-lock.json
--- a/samples/sp_whoIsActive/package.json
+++ b/samples/sp_whoIsActive/package.json
@@ -2,12 +2,12 @@
    "name": "whoisactive",
    "displayName": "whoisactive",
    "description": "sp_whoisactive for Azure Data Studio",
-    "version": "0.1.1",
+    "version": "0.1.2",
    "publisher": "Microsoft",
    "preview": true,
    "engines": {
        "vscode": "^1.26.0",
-        "azdata": "*"
+        "azdata": "^1.11.0"
    },
    "icon": "images/sqlserver.png",
    "license": "SEE LICENSE IN LICENSE.txt",
@@ -241,17 +241,17 @@
        "compile": "gulp compile",
        "watch": "gulp watch",
        "typings": "gulp copytypings",
-        "postinstall": "node ./node_modules/vscode/bin/install && node ./node_modules/sqlops/bin/install && gulp copytypings"
+        "postinstall": "node ./node_modules/vscode/bin/install && node ./node_modules/azdata/bin/install && gulp copytypings"
    },
    "dependencies": {
        "fs-extra": "^5.0.0",
        "handlebars": "^4.0.11",
-        "openurl": "^1.1.1",
-        "sqlops": "github:anthonydresser/sqlops-extension-sqlops"
+        "openurl": "^1.1.1"
    },
    "devDependencies": {
        "@types/mocha": "^2.2.42",
        "@types/node": "^7.0.43",
+        "azdata": "github:microsoft/azdata-extension-azdata",
        "child-process-promise": "^2.2.1",
        "del": "^3.0.0",
        "gulp": "^4.0.0",
--- a/samples/sp_whoIsActive/src/controllers/controllerBase.ts
+++ b/samples/sp_whoIsActive/src/controllers/controllerBase.ts
@@ -1,4 +1,3 @@
-
 /*---------------------------------------------------------------------------------------------
 *  Copyright (c) Microsoft Corporation. All rights reserved.
 *  Licensed under the Source EULA. See License.txt in the project root for license information.
@@ -9,18 +8,18 @@
 import * as vscode from 'vscode';

 export default abstract class ControllerBase implements vscode.Disposable {
-    protected _context: vscode.ExtensionContext;
+	protected _context: vscode.ExtensionContext;

-    public constructor(context: vscode.ExtensionContext) {
-        this._context = context;
-    }
+	public constructor(context: vscode.ExtensionContext) {
+		this._context = context;
+	}

-    abstract activate(): Promise<boolean>;
+	abstract activate(): Promise<boolean>;

-    abstract deactivate(): void;
+	abstract deactivate(): void;

-    public dispose(): void {
-        this.deactivate();
-    }
+	public dispose(): void {
+		this.deactivate();
+	}
 }

--- a/samples/sp_whoIsActive/src/controllers/mainController.ts
+++ b/samples/sp_whoIsActive/src/controllers/mainController.ts
@@ -5,7 +5,7 @@

 'use strict';

-import * as sqlops from 'sqlops';
+import * as azdata from 'azdata';
 import * as Utils from '../utils';
 import ControllerBase from './controllerBase';
 import * as fs from 'fs';
@@ -19,35 +19,35 @@ import * as openurl from 'openurl';
 */
 export default class MainController extends ControllerBase {

-    public apiWrapper;
-    // PUBLIC METHODS //////////////////////////////////////////////////////
-    /**
-     * Deactivates the extension
-     */
-    public deactivate(): void {
-        Utils.logDebug('Main controller deactivated');
-    }
+	public apiWrapper;
+	// PUBLIC METHODS //////////////////////////////////////////////////////
+	/**
+	 * Deactivates the extension
+	 */
+	public deactivate(): void {
+		Utils.logDebug('Main controller deactivated');
+	}

-    public activate(): Promise<boolean> {
-        sqlops.tasks.registerTask('sp_whoisactive.install', e => this.openurl('http://whoisactive.com/downloads/'));
-        sqlops.tasks.registerTask('sp_whoisactive.documentation', e => this.openurl('http://whoisactive.com/docs/'));
-        sqlops.tasks.registerTask('sp_whoisactive.findBlockLeaders', e => this.onExecute(e, 'findBlockLeaders.sql'));
-        sqlops.tasks.registerTask('sp_whoisactive.getPlans', e => this.onExecute(e, 'getPlans.sql'));
+	public activate(): Promise<boolean> {
+		azdata.tasks.registerTask('sp_whoisactive.install', e => this.openurl('http://whoisactive.com/downloads/'));
+		azdata.tasks.registerTask('sp_whoisactive.documentation', e => this.openurl('http://whoisactive.com/docs/'));
+		azdata.tasks.registerTask('sp_whoisactive.findBlockLeaders', e => this.onExecute(e, 'findBlockLeaders.sql'));
+		azdata.tasks.registerTask('sp_whoisactive.getPlans', e => this.onExecute(e, 'getPlans.sql'));

-        return Promise.resolve(true);
-    }
+		return Promise.resolve(true);
+	}

-    private openurl(link: string): void {
-        openurl.open(link);
-    }
+	private openurl(link: string): void {
+		openurl.open(link);
+	}

-    private onExecute(connection: sqlops.IConnectionProfile, fileName: string): void {
-        let sqlContent = fs.readFileSync(path.join(__dirname, '..', 'sql', fileName)).toString();
-        vscode.workspace.openTextDocument({language: 'sql', content: sqlContent}).then(doc => {
-            vscode.window.showTextDocument(doc, vscode.ViewColumn.Active, false).then(() => {
-                let filePath = doc.uri.toString();
-                sqlops.queryeditor.connect(filePath, connection.id).then(() => sqlops.queryeditor.runQuery(filePath));
-            });
-        });
-    }
+	private onExecute(connection: azdata.IConnectionProfile, fileName: string): void {
+		let sqlContent = fs.readFileSync(path.join(__dirname, '..', 'sql', fileName)).toString();
+		vscode.workspace.openTextDocument({language: 'sql', content: sqlContent}).then(doc => {
+			vscode.window.showTextDocument(doc, vscode.ViewColumn.Active, false).then(() => {
+				let filePath = doc.uri.toString();
+				azdata.queryeditor.connect(filePath, connection.id).then(() => azdata.queryeditor.runQuery(filePath));
+			});
+		});
+	}
 }
--- a/samples/sp_whoIsActive/tasks/buildtasks.js
+++ b/samples/sp_whoIsActive/tasks/buildtasks.js
@@ -12,6 +12,7 @@ let tslint = require('gulp-tslint');
 let ts = require('gulp-typescript');
 let cproc = require('child_process');
 let os = require('os');
+let path = require('path');

 let config = require('./config');
 let tsProject = ts.createProject('tsconfig.json');
@@ -19,66 +20,66 @@ let tsProject = ts.createProject('tsconfig.json');

 // GULP TASKS //////////////////////////////////////////////////////////////
 gulp.task('clean', function(done) {
-    return del('out', done);
+	return del('out', done);
 });

 gulp.task('lint', () => {
-    return gulp.src([
-        config.paths.project.root + '/src/**/*.ts',
-        config.paths.project.root + '/test/**/*.ts'
-    ])
-    .pipe((tslint({
-        formatter: "verbose"
-    })))
-    .pipe(tslint.report());
+	return gulp.src([
+		config.paths.project.root + '/src/**/*.ts',
+		config.paths.project.root + '/test/**/*.ts'
+	])
+	.pipe((tslint({
+		formatter: "verbose"
+	})))
+	.pipe(tslint.report());
 });

 gulp.task('compile:src', function(done) {
-    gulp.src([
-        config.paths.project.root + '/src/**/*.sql',
-        config.paths.project.root + '/src/**/*.svg',
-        config.paths.project.root + '/src/**/*.html'
-    ]).pipe(gulp.dest('out/src/'));
+	gulp.src([
+		config.paths.project.root + '/src/**/*.sql',
+		config.paths.project.root + '/src/**/*.svg',
+		config.paths.project.root + '/src/**/*.html'
+	]).pipe(gulp.dest('out/src/'));

-    let srcFiles = [
-        config.paths.project.root + '/src/**/*.ts',
-        config.paths.project.root + '/src/**/*.js',
-        config.paths.project.root + '/typings/**/*.ts'
-    ];
+	let srcFiles = [
+		config.paths.project.root + '/src/**/*.ts',
+		config.paths.project.root + '/src/**/*.js',
+		config.paths.project.root + '/typings/**/*.ts'
+	];

-    return gulp.src(srcFiles)
-        .pipe(srcmap.init())
-        .pipe(tsProject())
-        .on('error', function() {
-            if(process.env.BUILDMACHINE) {
-                done('Failed to compile extension source, see above.');
-                process.exit(1);
-            }
-        })
-        // TODO: Reinstate localization code
-        // .pipe(nls.rewriteLocalizeCalls())
-        // .pipe(nls.createAdditionalLanguageFiles(nls.coreLanguages, config.paths.project.root + '/localization/i18n', undefined, false))
-        .pipe(srcmap.write('.', { sourceRoot: function(file) { return file.cwd + '/src'; }}))
-        .pipe(gulp.dest('out/src/'));
+	return gulp.src(srcFiles)
+		.pipe(srcmap.init())
+		.pipe(tsProject())
+		.on('error', function() {
+			if(process.env.BUILDMACHINE) {
+				done('Failed to compile extension source, see above.');
+				process.exit(1);
+			}
+		})
+		// TODO: Reinstate localization code
+		// .pipe(nls.rewriteLocalizeCalls())
+		// .pipe(nls.createAdditionalLanguageFiles(nls.coreLanguages, config.paths.project.root + '/localization/i18n', undefined, false))
+		.pipe(srcmap.write('.', { sourceRoot: function(file) { return file.cwd + '/src'; }}))
+		.pipe(gulp.dest('out/src/'));
 });

 gulp.task('compile:test', function(done) {
-    let srcFiles = [
-        config.paths.project.root + '/test/**/*.ts',
-        config.paths.project.root + '/typings/**/*.ts'
-    ];
+	let srcFiles = [
+		config.paths.project.root + '/test/**/*.ts',
+		config.paths.project.root + '/typings/**/*.ts'
+	];

-    return gulp.src(srcFiles)
-        .pipe(srcmap.init())
-        .pipe(tsProject())
-        .on('error', function() {
-            if(process.env.BUILDMACHINE) {
-                done('Failed to compile test source, see above.');
-                process.exit(1);
-            }
-        })
-        .pipe(srcmap.write('.', {sourceRoot: function(file) { return file.cwd + '/test'; }}))
-        .pipe(gulp.dest('out/test/'));
+	return gulp.src(srcFiles)
+		.pipe(srcmap.init())
+		.pipe(tsProject())
+		.on('error', function() {
+			if(process.env.BUILDMACHINE) {
+				done('Failed to compile test source, see above.');
+				process.exit(1);
+			}
+		})
+		.pipe(srcmap.write('.', {sourceRoot: function(file) { return file.cwd + '/test'; }}))
+		.pipe(gulp.dest('out/test/'));
 });

 // COMPOSED GULP TASKS /////////////////////////////////////////////////////
@@ -87,37 +88,37 @@ gulp.task("compile", gulp.series("compile:src", "compile:test"));
 gulp.task("build", gulp.series("clean", "lint", "compile"));

 gulp.task("watch", function() {
-    gulp.watch([config.paths.project.root + '/src/**/*',
-                config.paths.project.root + '/test/**/*.ts'],
-        gulp.series('build'))
+	gulp.watch([config.paths.project.root + '/src/**/*',
+				config.paths.project.root + '/test/**/*.ts'],
+		gulp.series('build'));
 });

 gulp.task('test', (done) => {
-    let workspace = process.env['WORKSPACE'];
-    if (!workspace) {
-        workspace = process.cwd();
-    }
-    process.env.JUNIT_REPORT_PATH = workspace + '/test-reports/ext_xunit.xml';
+	let workspace = process.env['WORKSPACE'];
+	if (!workspace) {
+		workspace = process.cwd();
+	}
+	process.env.JUNIT_REPORT_PATH = workspace + '/test-reports/ext_xunit.xml';

-    let azuredatastudioPath = 'azuredatastudio';
-    if (process.env['SQLOPS_DEV']) {
-        let suffix = os.platform === 'win32' ? 'bat' : 'sh';
-        azuredatastudioPath = `${process.env['SQLOPS_DEV']}/scripts/sql-cli.${suffix}`;
-    }
-    console.log(`Using SQLOPS Path of ${azuredatastudioPath}`);
+	let azuredatastudioPath = 'azuredatastudio';
+	if (process.env['VSCODE_DEV']) {
+		let suffix = os.platform === 'win32' ? 'bat' : 'sh';
+		azuredatastudioPath = `${process.env['VSCODE_DEV']}/scripts/sql-cli.${suffix}`;
+	}
+	console.log(`Using ADS Path of ${azuredatastudioPath}`);

-    cproc.exec(`${azuredatastudioPath} --extensionDevelopmentPath="${workspace}" --extensionTestsPath="${workspace}/out/test" --verbose`, (error, stdout, stderr) => {
-        if (error) {
-            console.error(`exec error: ${error}`);
-            process.exit(1);
-        }
-        console.log(`stdout: ${stdout}`);
-        console.log(`stderr: ${stderr}`);
-        done();
-    });
+	cproc.exec(`${azuredatastudioPath} --extensionDevelopmentPath="${workspace}" --extensionTestsPath="${workspace}/out/test" --verbose`, (error, stdout, stderr) => {
+		if (error) {
+			console.error(`exec error: ${error}`);
+			process.exit(1);
+		}
+		console.log(`stdout: ${stdout}`);
+		console.log(`stderr: ${stderr}`);
+		done();
+	});
 });

 gulp.task('copytypings', function() {
-    return gulp.src(config.paths.project.root + '/../../src/sql/sqlops.proposed.d.ts')
-    .pipe(gulp.dest('typings/'));
+	return gulp.src(config.paths.project.root + '/../../src/sql/azdata.d.ts')
+	.pipe(gulp.dest('typings/'));
 });
--- a/samples/sp_whoIsActive/tslint.json
+++ b/samples/sp_whoIsActive/tslint.json
@@ -1,123 +1,123 @@
 {
-  "rules": {
-    "align": [
-      true,
-      "parameters",
-      "statements"
-    ],
-    "ban": false,
-    "class-name": true,
-    "comment-format": [
-      true,
-      "check-space"
-    ],
-    "curly": true,
-    "eofline": true,
-    "forin": true,
-    "indent": [
-      true,
-      "spaces"
-    ],
-    "interface-name": true,
-    "jsdoc-format": true,
-    "label-position": true,
-    "label-undefined": true,
-    "max-line-length": [
-      true,
-      160
-    ],
-    "member-access": false,
-    "member-ordering": false,
-    "no-any": false,
-    "no-arg": true,
-    "no-bitwise": true,
-    "no-conditional-assignment": true,
-    "no-consecutive-blank-lines": false,
-    "no-console": [
-      true,
-      "debug",
-      "info",
-      "time",
-      "timeEnd",
-      "trace"
-    ],
-    "no-construct": true,
-    "no-constructor-vars": false,
-    "no-debugger": true,
-    "no-duplicate-key": true,
-    "no-duplicate-variable": true,
-    "no-empty": true,
-    "no-eval": true,
-    "no-inferrable-types": false,
-    "no-internal-module": true,
-    "no-null-keyword": true,
-    "no-require-imports": false,
-    "no-shadowed-variable": true,
-    "no-string-literal": false,
-    "no-switch-case-fall-through": false,
-    "no-trailing-whitespace": true,
-    "no-unreachable": true,
-    "no-unused-expression": false,
-    "no-unused-variable": true,
-    "no-use-before-declare": true,
-    "no-var-keyword": true,
-    "no-var-requires": false,
-    "object-literal-sort-keys": false,
-    "one-line": [
-      true,
-      "check-open-brace",
-      "check-catch",
-      "check-else",
-      "check-finally",
-      "check-whitespace"
-    ],
-    "quotemark": [
-      true,
-      "single",
-      "avoid-escape"
-    ],
-    "radix": true,
-    "semicolon": true,
-    "switch-default": true,
-    "trailing-comma": [
-      true,
-      {
-        "multiline": "never",
-        "singleline": "never"
-      }
-    ],
-    "triple-equals": [
-      true,
-      "allow-null-check"
-    ],
-    "typedef": [
-      true,
-      "call-signature",
-      "property-declaration"
-    ],
-    "typedef-whitespace": [
-      true,
-      {
-        "call-signature": "nospace",
-        "index-signature": "nospace",
-        "parameter": "nospace",
-        "property-declaration": "nospace",
-        "variable-declaration": "nospace"
-      }
-    ],
-    "use-strict": false,
-    "variable-name": [
-      true,
-      "allow-leading-underscore",
-      "ban-keywords"
-    ],
-    "whitespace": [
-      true,
-      "check-branch",
-      "check-decl",
-      "check-operator",
-      "check-separator",
-      "check-type"
-    ]
-  }
-}
+	"rules": {
+		"align": [
+			true,
+			"parameters",
+			"statements"
+		],
+		"ban": false,
+		"class-name": true,
+		"comment-format": [
+			true,
+			"check-space"
+		],
+		"curly": true,
+		"eofline": true,
+		"forin": true,
+		"indent": [
+			true,
+			"tabs"
+		],
+		"interface-name": true,
+		"jsdoc-format": true,
+		"label-position": true,
+		"label-undefined": true,
+		"max-line-length": [
+			true,
+			160
+		],
+		"member-access": false,
+		"member-ordering": false,
+		"no-any": false,
+		"no-arg": true,
+		"no-bitwise": true,
+		"no-conditional-assignment": true,
+		"no-consecutive-blank-lines": false,
+		"no-console": [
+			true,
+			"debug",
+			"info",
+			"time",
+			"timeEnd",
+			"trace"
+		],
+		"no-construct": true,
+		"no-constructor-vars": false,
+		"no-debugger": true,
+		"no-duplicate-key": true,
+		"no-duplicate-variable": true,
+		"no-empty": true,
+		"no-eval": true,
+		"no-inferrable-types": false,
+		"no-internal-module": true,
+		"no-null-keyword": true,
+		"no-require-imports": false,
+		"no-shadowed-variable": true,
+		"no-string-literal": false,
+		"no-switch-case-fall-through": false,
+		"no-trailing-whitespace": true,
+		"no-unreachable": true,
+		"no-unused-expression": false,
+		"no-unused-variable": true,
+		"no-use-before-declare": true,
+		"no-var-keyword": true,
+		"no-var-requires": false,
+		"object-literal-sort-keys": false,
+		"one-line": [
+			true,
+			"check-open-brace",
+			"check-catch",
+			"check-else",
+			"check-finally",
+			"check-whitespace"
+		],
+		"quotemark": [
+			true,
+			"single",
+			"avoid-escape"
+		],
+		"radix": true,
+		"semicolon": true,
+		"switch-default": true,
+		"trailing-comma": [
+			true,
+			{
+				"multiline": "never",
+				"singleline": "never"
+			}
+		],
+		"triple-equals": [
+			true,
+			"allow-null-check"
+		],
+		"typedef": [
+			true,
+			"call-signature",
+			"property-declaration"
+		],
+		"typedef-whitespace": [
+			true,
+			{
+				"call-signature": "nospace",
+				"index-signature": "nospace",
+				"parameter": "nospace",
+				"property-declaration": "nospace",
+				"variable-declaration": "nospace"
+			}
+		],
+		"use-strict": false,
+		"variable-name": [
+			true,
+			"allow-leading-underscore",
+			"ban-keywords"
+		],
+		"whitespace": [
+			true,
+			"check-branch",
+			"check-decl",
+			"check-operator",
+			"check-separator",
+			"check-type"
+		]
+	}
+}