fix: force plugin activation order

api plugin must start before any tool VSIX without explicitly updating
the `extensionDependencies` with the API.

Signed-off-by: dankeboy36 <[email protected]>

Author: dankeboy36

Diff for: arduino-ide-extension/src/browser/theia/plugin-ext/hosted-plugin.ts

@@ -1,7 +1,10 @@
-import { Emitter, Event, JsonRpcProxy } from '@theia/core';
+import { DisposableCollection } from '@theia/core/lib/common/disposable';
+import { Emitter, Event } from '@theia/core/lib/common/event';
 import { injectable, interfaces } from '@theia/core/shared/inversify';
-import { HostedPluginServer } from '@theia/plugin-ext/lib/common/plugin-protocol';
-import { HostedPluginSupport as TheiaHostedPluginSupport } from '@theia/plugin-ext/lib/hosted/browser/hosted-plugin';
+import {
+  PluginContributions,
+  HostedPluginSupport as TheiaHostedPluginSupport,
+} from '@theia/plugin-ext/lib/hosted/browser/hosted-plugin';
 
 @injectable()
 export class HostedPluginSupport extends TheiaHostedPluginSupport {
@@ -10,7 +13,7 @@ export class HostedPluginSupport extends TheiaHostedPluginSupport {
 
   override onStart(container: interfaces.Container): void {
     super.onStart(container);
-    this.hostedPluginServer.onDidCloseConnection(() =>
+    this['server'].onDidCloseConnection(() =>
       this.onDidCloseConnectionEmitter.fire()
     );
   }
@@ -28,8 +31,38 @@ export class HostedPluginSupport extends TheiaHostedPluginSupport {
     return this.onDidCloseConnectionEmitter.event;
   }
 
-  private get hostedPluginServer(): JsonRpcProxy<HostedPluginServer> {
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    return (this as any).server;
+  protected override startPlugins(
+    contributionsByHost: Map<string, PluginContributions[]>,
+    toDisconnect: DisposableCollection
+  ): Promise<void> {
+    reorderPlugins(contributionsByHost);
+    return super.startPlugins(contributionsByHost, toDisconnect);
   }
 }
+
+/**
+ * Force the `vscode-arduino-ide` API to activate before any Arduino IDE tool VSIX.
+ *
+ * Arduino IDE tool VISXs are not forced to declare the `vscode-arduino-api` as a `extensionDependencies`,
+ * but the API must activate before any tools. This in place sorting helps to bypass Theia's plugin resolution
+ * without forcing tools developers to add `vscode-arduino-api` to the `extensionDependencies`.
+ */
+function reorderPlugins(
+  contributionsByHost: Map<string, PluginContributions[]>
+): void {
+  for (const [, contributions] of contributionsByHost) {
+    const apiPluginIndex = contributions.findIndex(isArduinoAPI);
+    if (apiPluginIndex >= 0) {
+      const apiPlugin = contributions[apiPluginIndex];
+      contributions.splice(apiPluginIndex, 1);
+      contributions.unshift(apiPlugin);
+    }
+  }
+}
+
+function isArduinoAPI(pluginContribution: PluginContributions): boolean {
+  return (
+    pluginContribution.plugin.metadata.model.id ===
+    'dankeboy36.vscode-arduino-api'
+  );
+}

Diff for: package.json

@@ -43,7 +43,7 @@
     "watch": "lerna run watch --parallel",
     "test": "lerna run test",
     "test:slow": "lerna run test:slow",
-    "download:plugins": "theia download:plugins --ignore-errors",
+    "download:plugins": "theia download:plugins",
     "update:version": "node ./scripts/update-version.js",
     "i18n:generate": "theia nls-extract -e vscode -f \"+(arduino-ide-extension|electron-app|plugins)/**/*.ts?(x)\" -o ./i18n/en.json",
     "i18n:check": "yarn i18n:generate && git add -N ./i18n && git diff --exit-code ./i18n",