fix: report errors when analyzing extensions

packages/main/src/plugin/extension-loader.spec.ts

@@ -673,6 +673,7 @@ describe('analyze extension and main', async () => {
     const extension = await extensionLoader.analyzeExtension(path.resolve('/', 'fake', 'path'), false);
 
     expect(extension).toBeDefined();
+    expect(extension?.error).toBeDefined();
     expect(extension?.mainPath).toBe(path.resolve('/', 'fake', 'path', 'main-entry.js'));
     expect(extension?.id).toBe('fooPublisher.fooName');
   });
@@ -697,6 +698,7 @@ describe('analyze extension and main', async () => {
     const extension = await extensionLoader.analyzeExtension('/fake/path', false);
 
     expect(extension).toBeDefined();
+    expect(extension?.error).toBeDefined();
     // not set
     expect(extension?.mainPath).toBeUndefined();
     expect(extension?.id).toBe('fooPublisher.fooName');

packages/main/src/plugin/extension-loader.ts

@@ -93,6 +93,8 @@ export interface AnalyzedExtension {
   missingDependencies?: string[];
   circularDependencies?: string[];
 
+  error?: string;
+
   readonly subscriptions: { dispose(): unknown }[];
 
   dispose(): void;
@@ -202,7 +204,7 @@ export class ExtensionLoader {
     zipper.sync.unzip(filePath).save(unpackedDirectory);
 
     const extension = await this.analyzeExtension(unpackedDirectory, true);
-    if (extension) {
+    if (!extension.error) {
       await this.loadExtension(extension);
       this.apiSender.send('extension-started', {});
     }
@@ -293,12 +295,12 @@ export class ExtensionLoader {
 
     const analyzedFoldersExtension = (
       await Promise.all(folders.map(folder => this.analyzeExtension(folder, false)))
-    ).filter(extension => extension !== undefined) as AnalyzedExtension[];
+    ).filter(extension => !extension.error) as AnalyzedExtension[];
     analyzedExtensions.push(...analyzedFoldersExtension);
 
     const analyzedExternalExtensions = (
       await Promise.all(externalExtensions.map(folder => this.analyzeExtension(folder, false)))
-    ).filter(extension => extension !== undefined) as AnalyzedExtension[];
+    ).filter(extension => !extension.error) as AnalyzedExtension[];
     analyzedExtensions.push(...analyzedExternalExtensions);
 
     // also load extensions from the plugins directory
@@ -312,27 +314,47 @@ export class ExtensionLoader {
       // collect all extensions from the pluginDirectory folders
       const analyzedPluginsDirectoryExtensions: AnalyzedExtension[] = (
         await Promise.all(pluginDirectories.map(folder => this.analyzeExtension(folder, true)))
-      ).filter(extension => extension !== undefined) as AnalyzedExtension[];
+      ).filter(extension => !extension.error) as AnalyzedExtension[];
       analyzedExtensions.push(...analyzedPluginsDirectoryExtensions);
     }
 
     // now we have all extensions, we can load them
     await this.loadExtensions(analyzedExtensions);
   }
 
-  async analyzeExtension(extensionPath: string, removable: boolean): Promise<AnalyzedExtension | undefined> {
+  async analyzeExtension(extensionPath: string, removable: boolean): Promise<AnalyzedExtension> {
     // do nothing if there is no package.json file
+    let error = undefined;
+    const disposables: Disposable[] = [];
     if (!fs.existsSync(path.resolve(extensionPath, 'package.json'))) {
-      console.warn(`Ignoring extension ${extensionPath} without package.json file`);
-      return undefined;
+      error = `Ignoring extension ${extensionPath} without package.json file`;
+      console.warn(error);
+      const analyzedExtension: AnalyzedExtension = {
+        id: '<unknown>',
+        name: '<unknown>',
+        path: extensionPath,
+        manifest: undefined,
+        api: <typeof containerDesktopAPI>{},
+        removable,
+        subscriptions: disposables,
+        dispose(): void {
+          disposables.forEach(disposable => disposable.dispose());
+        },
+        error,
+      };
+      return analyzedExtension;
     }
 
+    // log error if the manifest is missing required entries
     const manifest = await this.loadManifest(extensionPath);
+    if (!manifest.name || !manifest.displayName || !manifest.version || !manifest.publisher || !manifest.description) {
+      error = `Extension ${extensionPath} missing required manifest entry in package.json (name, displayName, version, publisher, description)`;
+      console.warn(error);
+    }
 
     // create api object
     const api = this.createApi(extensionPath, manifest);
 
-    const disposables: Disposable[] = [];
     const analyzedExtension: AnalyzedExtension = {
       id: `${manifest.publisher}.${manifest.name}`,
       name: manifest.name,
@@ -345,6 +367,7 @@ export class ExtensionLoader {
       dispose(): void {
         disposables.forEach(disposable => disposable.dispose());
       },
+      error,
     };
 
     return analyzedExtension;
@@ -508,7 +531,7 @@ export class ExtensionLoader {
     try {
       const updatedExtension = await this.analyzeExtension(extension.path, removable);
 
-      if (updatedExtension) {
+      if (!updatedExtension.error) {
         await this.loadExtension(updatedExtension, true);
       }
     } catch (error) {
@@ -1227,7 +1250,7 @@ export class ExtensionLoader {
     if (extension) {
       const analyzedExtension = await this.analyzeExtension(extension.path, extension.removable);
 
-      if (analyzedExtension) {
+      if (!analyzedExtension.error) {
         await this.loadExtension(analyzedExtension, true);
       }
     }

packages/main/src/plugin/install/extension-installer.ts

@@ -166,6 +166,11 @@ export class ExtensionInstaller {
     } catch (error) {
       sendError('Error while analyzing extension: ' + error);
     }
+    if (analyzedExtension?.error) {
+      sendError('Could not load extension: ' + analyzedExtension?.error);
+      return;
+    }
+
     return analyzedExtension;
   }