Report more granular dependency installation results

Author: JoeRobich

src/installRuntimeDependencies.ts

@@ -8,7 +8,7 @@ import { PackageInstallation, LogPlatformInfo, InstallationSuccess } from './sha
 import { EventStream } from './eventStream';
 import { getRuntimeDependenciesPackages } from './tools/runtimeDependencyPackageUtils';
 import { getAbsolutePathPackagesToInstall } from './packageManager/getAbsolutePathPackagesToInstall';
-import IInstallDependencies from './packageManager/IInstallDependencies';
+import { DependencyInstallationResults, IInstallDependencies } from './packageManager/IInstallDependencies';
 import { AbsolutePathPackage } from './packageManager/absolutePathPackage';
 
 export async function installRuntimeDependencies(
@@ -19,7 +19,7 @@ export async function installRuntimeDependencies(
     platformInfo: PlatformInformation,
     useFramework: boolean,
     requiredPackageIds: string[]
-): Promise<boolean> {
+): Promise<DependencyInstallationResults> {
     const runTimeDependencies = getRuntimeDependenciesPackages(packageJSON);
     const packagesToInstall = await getAbsolutePathPackagesToInstall(runTimeDependencies, platformInfo, extensionPath);
     const filteredPackages = filterOmniSharpPackage(packagesToInstall, useFramework);
@@ -30,15 +30,20 @@ export async function installRuntimeDependencies(
         // Display platform information and RID
         eventStream.post(new LogPlatformInfo(platformInfo));
 
-        if (await installDependencies(filteredRequiredPackages)) {
+        const installationResults = await installDependencies(filteredRequiredPackages);
+
+        const failedPackages = Object.entries(installationResults)
+            .filter(([, installed]) => !installed)
+            .map(([name]) => name);
+        if (failedPackages.length === 0) {
             eventStream.post(new InstallationSuccess());
-        } else {
-            return false;
         }
+
+        return installationResults;
     }
 
-    //All the required packages are already downloaded and installed
-    return true;
+    // There was nothing to install
+    return {};
 }
 
 function filterOmniSharpPackage(packages: AbsolutePathPackage[], useFramework: boolean) {

src/main.ts

@@ -119,7 +119,7 @@ export async function activate(
     } else {
         const getCoreClrDebugPromise = async (languageServerStartedPromise: Promise<void>) => {
             let coreClrDebugPromise = Promise.resolve();
-            if (runtimeDependenciesExist) {
+            if (runtimeDependenciesExist['Debugger']) {
                 // activate coreclr-debug
                 coreClrDebugPromise = coreclrdebug.activate(
                     context.extension,

src/packageManager/IInstallDependencies.ts

@@ -5,6 +5,8 @@
 
 import { AbsolutePathPackage } from './absolutePathPackage';
 
-export default interface IInstallDependencies {
-    (packages: AbsolutePathPackage[]): Promise<boolean>;
+export type DependencyInstallationResults = { [name: string]: boolean };
+
+export interface IInstallDependencies {
+    (packages: AbsolutePathPackage[]): Promise<DependencyInstallationResults>;
 }

src/packageManager/downloadAndInstallPackages.ts

@@ -17,6 +17,7 @@ import { PackageInstallStart } from '../shared/loggingEvents';
 import { DownloadValidator } from './isValidDownload';
 import { CancellationToken } from 'vscode';
 import { ITelemetryReporter } from '../shared/telemetryReporter';
+import { DependencyInstallationResults } from './IInstallDependencies';
 
 export async function downloadAndInstallPackages(
     packages: AbsolutePathPackage[],
@@ -25,9 +26,9 @@ export async function downloadAndInstallPackages(
     downloadValidator: DownloadValidator,
     telemetryReporter?: ITelemetryReporter,
     token?: CancellationToken
-): Promise<boolean> {
-    let downloadFailed = false;
+): Promise<DependencyInstallationResults> {
     eventStream.post(new PackageInstallStart());
+    const results: DependencyInstallationResults = {};
     for (const pkg of packages) {
         let installationStage = 'touchBeginFile';
         try {
@@ -51,12 +52,16 @@ export async function downloadAndInstallPackages(
                     await InstallZip(buffer, pkg.description, pkg.installPath, pkg.binaries, eventStream);
                     installationStage = 'touchLockFile';
                     await touchInstallFile(pkg.installPath, InstallFileType.Lock);
+                    results[pkg.id] = true;
                     break;
                 } else {
                     eventStream.post(new IntegrityCheckFailure(pkg.description, pkg.url, willTryInstallingPackage()));
+                    results[pkg.id] = false;
                 }
             }
         } catch (error) {
+            results[pkg.id] = false;
+
             if (error instanceof NestedError) {
                 const packageError = new PackageError(error.message, pkg, error.err);
                 eventStream.post(new InstallationFailure(installationStage, packageError));
@@ -66,8 +71,6 @@ export async function downloadAndInstallPackages(
 
             // Send telemetry for the failure
             sendInstallationFailureTelemetry(pkg, installationStage, error);
-
-            downloadFailed = true;
         } finally {
             try {
                 if (await installFileExists(pkg.installPath, InstallFileType.Begin)) {
@@ -79,7 +82,7 @@ export async function downloadAndInstallPackages(
         }
     }
 
-    return !downloadFailed;
+    return results;
 
     function sendInstallationFailureTelemetry(pkg: AbsolutePathPackage, installationStage: string, error: any): void {
         if (!telemetryReporter) {

test/omnisharp/omnisharpUnitTests/installRuntimeDependencies.test.ts

@@ -5,7 +5,7 @@
 
 import { describe, test, expect, beforeEach } from '@jest/globals';
 import { installRuntimeDependencies } from '../../../src/installRuntimeDependencies';
-import IInstallDependencies from '../../../src/packageManager/IInstallDependencies';
+import { IInstallDependencies } from '../../../src/packageManager/IInstallDependencies';
 import { EventStream } from '../../../src/eventStream';
 import { PlatformInformation } from '../../../src/shared/platform';
 import TestEventBus from './testAssets/testEventBus';
@@ -28,7 +28,8 @@ describe(`${installRuntimeDependencies.name}`, () => {
     beforeEach(() => {
         eventStream = new EventStream();
         eventBus = new TestEventBus(eventStream);
-        installDependencies = async () => Promise.resolve(true);
+        installDependencies = async (packages) =>
+            Promise.resolve(packages.reduce((acc, pkg) => ({ ...acc, [pkg.id]: true }), {}));
     });
 
     describe('When all the dependencies already exist', () => {
@@ -90,7 +91,7 @@ describe(`${installRuntimeDependencies.name}`, () => {
             let inputPackage: AbsolutePathPackage[];
             installDependencies = async (packages) => {
                 inputPackage = packages;
-                return Promise.resolve(true);
+                return Promise.resolve(packages.reduce((acc, pkg) => ({ ...acc, [pkg.id]: true }), {}));
             };
 
             const installed = await installRuntimeDependencies(
@@ -111,7 +112,8 @@ describe(`${installRuntimeDependencies.name}`, () => {
         });
 
         test('Returns false when installDependencies returns false', async () => {
-            installDependencies = async () => Promise.resolve(false);
+            installDependencies = async (packages) =>
+                Promise.resolve(packages.reduce((acc, pkg) => ({ ...acc, [pkg.id]: false }), {}));
             const installed = await installRuntimeDependencies(
                 packageJSON,
                 extensionPath,
@@ -121,7 +123,7 @@ describe(`${installRuntimeDependencies.name}`, () => {
                 useFramework,
                 ['myPackage']
             );
-            expect(installed).toBe(false);
+            expect(installed['myPackage']).toBe(false);
         });
     });
 });