Consolidate util code to src/util/*. (#2489)

This is a follow-up to #2456. I've pulled many of the "util" modules out of src/client/common into a new sibling package to client: utils. This helps us separate the extension-specific code from the generic code we use for the extension.

Author: ericsnowcurrently

src/client/activation/activationService.ts

@@ -5,10 +5,11 @@
 
 import { inject, injectable } from 'inversify';
 import { ConfigurationChangeEvent, Disposable, OutputChannel, Uri } from 'vscode';
+import { OSDistro, OSType } from '../../utils/platform';
 import { IApplicationShell, ICommandManager, IWorkspaceService } from '../common/application/types';
 import { isLanguageServerTest, STANDARD_OUTPUT_CHANNEL } from '../common/constants';
 import '../common/extensions';
-import { IPlatformService, OSDistro, OSType } from '../common/platform/types';
+import { IPlatformService } from '../common/platform/types';
 import { IConfigurationService, IDisposableRegistry, IOutputChannel, IPythonSettings } from '../common/types';
 import { IServiceContainer } from '../ioc/types';
 import { PYTHON_LANGUAGE_SERVER_PLATFORM_NOT_SUPPORTED } from '../telemetry/constants';
@@ -103,7 +104,7 @@ function isLSSupported(services: IServiceContainer): boolean {
     const platform = services.get<IPlatformService>(IPlatformService);
     let minVer = '';
     for (const [osType, distro, ver] of LS_MIN_OS_VERSIONS) {
-        if (platform.os.type === osType && platform.os.distro === distro) {
+        if (platform.info.type === osType && platform.info.distro === distro) {
             minVer = ver;
             break;
         }
@@ -112,7 +113,7 @@ function isLSSupported(services: IServiceContainer): boolean {
         return true;
     }
     minVer = normalizeVersion(minVer);
-    return platform.os.version.compare(minVer) >= 0;
+    return platform.info.version.compare(minVer) >= 0;
 }
 
 function normalizeVersion(ver: string): string {

src/client/activation/downloader.ts

@@ -6,7 +6,7 @@
 import * as path from 'path';
 import * as requestProgress from 'request-progress';
 import { ProgressLocation, window } from 'vscode';
-import { createDeferred } from '../common/helpers';
+import { createDeferred } from '../../utils/async';
 import { IFileSystem } from '../common/platform/types';
 import { IExtensionContext, IOutputChannel } from '../common/types';
 import { PlatformData, PlatformName } from './platformData';

src/client/activation/hashVerifier.ts

@@ -3,7 +3,7 @@
 
 import { createHash } from 'crypto';
 import * as fs from 'fs';
-import { createDeferred } from '../common/helpers';
+import { createDeferred } from '../../utils/async';
 
 export class HashVerifier {
     public async verifyHash(filePath: string, platformString: string, expectedDigest: string): Promise<boolean> {

src/client/activation/interpreterDataService.ts

@@ -5,9 +5,9 @@ import { createHash } from 'crypto';
 import * as fs from 'fs';
 import * as path from 'path';
 import { ExtensionContext, Uri } from 'vscode';
+import { createDeferred } from '../../utils/async';
 import { IApplicationShell } from '../common/application/types';
 import '../common/extensions';
-import { createDeferred } from '../common/helpers';
 import { IPlatformService } from '../common/platform/types';
 import { IPythonExecutionFactory, IPythonExecutionService } from '../common/process/types';
 import { IServiceContainer } from '../ioc/types';

src/client/activation/languageServer.ts

@@ -11,15 +11,15 @@ import {
     Disposable, LanguageClient, LanguageClientOptions,
     ProvideCompletionItemsSignature, ServerOptions
 } from 'vscode-languageclient';
+import { createDeferred, Deferred } from '../../utils/async';
+import { StopWatch } from '../../utils/stopWatch';
 import {
     IApplicationShell, ICommandManager, IWorkspaceService
 } from '../common/application/types';
 import { PythonSettings } from '../common/configSettings';
 // tslint:disable-next-line:ordered-imports
 import { isTestExecution, STANDARD_OUTPUT_CHANNEL } from '../common/constants';
-import { createDeferred, Deferred } from '../common/helpers';
 import { IFileSystem, IPlatformService } from '../common/platform/types';
-import { StopWatch } from '../common/stopWatch';
 import {
     BANNER_NAME_LS_SURVEY, DeprecatedFeatureInfo, IConfigurationService,
     IExtensionContext, IFeatureDeprecationManager, ILogger, IOutputChannel,

src/client/activation/progress.ts

@@ -3,7 +3,7 @@
 
 import { Progress, ProgressLocation, window } from 'vscode';
 import { Disposable, LanguageClient } from 'vscode-languageclient';
-import { createDeferred, Deferred } from '../common/helpers';
+import { createDeferred, Deferred } from '../../utils/async';
 
 export class ProgressReporting {
   private statusBarMessage: Disposable | undefined;

src/client/common/enumUtils.ts

@@ -1,6 +1,9 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+'use strict';
+
 import { ModuleNotInstalledError } from './errors/moduleNotInstalledError';
-// tslint:disable-next-line:no-require-imports no-var-requires
-const tmp = require('tmp');
 
 export function isNotInstalledError(error: Error): boolean {
     const isError = typeof (error) === 'object' && error !== null;
@@ -16,73 +19,3 @@ export function isNotInstalledError(error: Error): boolean {
     const isModuleNoInstalledError = error.message.indexOf('No module named') >= 0;
     return errorObj.code === 'ENOENT' || errorObj.code === 127 || isModuleNoInstalledError;
 }
-
-// tslint:disable-next-line:interface-name
-export interface Deferred<T> {
-    readonly promise: Promise<T>;
-    readonly resolved: boolean;
-    readonly rejected: boolean;
-    readonly completed: boolean;
-    resolve(value?: T | PromiseLike<T>);
-    // tslint:disable-next-line:no-any
-    reject(reason?: any);
-}
-
-class DeferredImpl<T> implements Deferred<T> {
-    private _resolve!: (value?: T | PromiseLike<T>) => void;
-    // tslint:disable-next-line:no-any
-    private _reject!: (reason?: any) => void;
-    private _resolved: boolean = false;
-    private _rejected: boolean = false;
-    private _promise: Promise<T>;
-    // tslint:disable-next-line:no-any
-    constructor(private scope: any = null) {
-        // tslint:disable-next-line:promise-must-complete
-        this._promise = new Promise<T>((res, rej) => {
-            this._resolve = res;
-            this._reject = rej;
-        });
-    }
-    public resolve(value?: T | PromiseLike<T>) {
-        this._resolve.apply(this.scope ? this.scope : this, arguments);
-        this._resolved = true;
-    }
-    // tslint:disable-next-line:no-any
-    public reject(reason?: any) {
-        this._reject.apply(this.scope ? this.scope : this, arguments);
-        this._rejected = true;
-    }
-    get promise(): Promise<T> {
-        return this._promise;
-    }
-    get resolved(): boolean {
-        return this._resolved;
-    }
-    get rejected(): boolean {
-        return this._rejected;
-    }
-    get completed(): boolean {
-        return this._rejected || this._resolved;
-    }
-}
-// tslint:disable-next-line:no-any
-export function createDeferred<T>(scope: any = null): Deferred<T> {
-    return new DeferredImpl<T>(scope);
-}
-
-export function createTemporaryFile(extension: string, temporaryDirectory?: string): Promise<{ filePath: string; cleanupCallback: Function }> {
-    // tslint:disable-next-line:no-any
-    const options: any = { postfix: extension };
-    if (temporaryDirectory) {
-        options.dir = temporaryDirectory;
-    }
-
-    return new Promise<{ filePath: string; cleanupCallback: Function }>((resolve, reject) => {
-        tmp.file(options, (err, tmpFile, fd, cleanupCallback) => {
-            if (err) {
-                return reject(err);
-            }
-            resolve({ filePath: tmpFile, cleanupCallback: cleanupCallback });
-        });
-    });
-}

src/client/common/helpers.ts

@@ -8,10 +8,10 @@ import * as fs from 'fs';
 import { injectable } from 'inversify';
 import * as path from 'path';
 import * as vscode from 'vscode';
+import { noop } from '../../../utils/misc';
 import { IInterpreterService, InterpreterType } from '../../interpreter/contracts';
 import { IServiceContainer } from '../../ioc/types';
 import { STANDARD_OUTPUT_CHANNEL } from '../constants';
-import { noop } from '../core.utils';
 import { ITerminalServiceFactory } from '../terminal/types';
 import { ExecutionInfo, IConfigurationService, IOutputChannel } from '../types';
 

src/client/common/installer/moduleInstaller.ts

@@ -1,8 +1,8 @@
 import { EventEmitter } from 'events';
 import { injectable } from 'inversify';
 import * as net from 'net';
-import { noop } from '../../core.utils';
-import { createDeferred, Deferred } from '../../helpers';
+import { createDeferred, Deferred } from '../../../../utils/async';
+import { noop } from '../../../../utils/misc';
 import { ISocketServer } from '../../types';
 
 @injectable()