Link resolved for lib/boards manager.

Akos Kitta · Akos Kitta · commit 19a57e9c9ce4 · 2022-09-21T21:02:19.000+02:00
Closes #1442 Signed-off-by: Akos Kitta <a.kitta@arduino.cc>
diff --git a/arduino-ide-extension/src/browser/arduino-ide-frontend-module.ts b/arduino-ide-extension/src/browser/arduino-ide-frontend-module.ts
@@ -338,6 +338,7 @@ import { OutputEditorFactory } from './theia/output/output-editor-factory';
 import { StartupTaskProvider } from '../electron-common/startup-task';
 import { DeleteSketch } from './contributions/delete-sketch';
 import { UserFields } from './contributions/user-fields';
+import { OpenHandler } from '@theia/core/lib/browser/opener-service';
 
 const registerArduinoThemes = () => {
   const themes: MonacoThemeJson[] = [
@@ -402,6 +403,7 @@ export default new ContainerModule((bind, unbind, isBound, rebind) => {
   bind(FrontendApplicationContribution).toService(
     LibraryListWidgetFrontendContribution
   );
+  bind(OpenHandler).toService(LibraryListWidgetFrontendContribution);
 
   // Sketch list service
   bind(SketchesService)
@@ -468,6 +470,7 @@ export default new ContainerModule((bind, unbind, isBound, rebind) => {
   bind(FrontendApplicationContribution).toService(
     BoardsListWidgetFrontendContribution
   );
+  bind(OpenHandler).toService(BoardsListWidgetFrontendContribution);
 
   // Board select dialog
   bind(BoardsConfigDialogWidget).toSelf().inSingletonScope();
diff --git a/arduino-ide-extension/src/browser/boards/boards-widget-frontend-contribution.ts b/arduino-ide-extension/src/browser/boards/boards-widget-frontend-contribution.ts
@@ -1,6 +1,6 @@
 import { injectable } from '@theia/core/shared/inversify';
 import { BoardsListWidget } from './boards-list-widget';
-import type {
+import {
   BoardSearch,
   BoardsPackage,
 } from '../../common/protocol/boards-service';
@@ -11,6 +11,8 @@ export class BoardsListWidgetFrontendContribution extends ListWidgetFrontendCont
   BoardsPackage,
   BoardSearch
 > {
+  protected readonly openerAuthority = 'boardsmanager';
+
   constructor() {
     super({
       widgetId: BoardsListWidget.WIDGET_ID,
@@ -24,7 +26,22 @@ export class BoardsListWidgetFrontendContribution extends ListWidgetFrontendCont
     });
   }
 
-  override async initializeLayout(): Promise<void> {
-    this.openView();
+  protected parsePath(path: string): Omit<BoardSearch, 'query'> | undefined {
+    const segments = this.normalizedSegmentsOf(path);
+    if (segments.length !== 1) {
+      return undefined;
+    }
+    const [type] = segments;
+    if (!type) {
+      return {
+        type: 'All',
+      };
+    }
+    if (BoardSearch.Type.is(type)) {
+      return {
+        type,
+      };
+    }
+    return undefined;
   }
 }
diff --git a/arduino-ide-extension/src/browser/library/library-widget-frontend-contribution.ts b/arduino-ide-extension/src/browser/library/library-widget-frontend-contribution.ts
@@ -1,16 +1,18 @@
+import { nls } from '@theia/core/lib/common';
+import { MenuModelRegistry } from '@theia/core/lib/common/menu';
 import { injectable } from '@theia/core/shared/inversify';
-import { FrontendApplicationContribution } from '@theia/core/lib/browser/frontend-application';
-import { AbstractViewContribution } from '@theia/core/lib/browser/shell/view-contribution';
-import { MenuModelRegistry } from '@theia/core';
-import { LibraryListWidget } from './library-list-widget';
+import { LibraryPackage, LibrarySearch } from '../../common/protocol';
 import { ArduinoMenus } from '../menu/arduino-menus';
-import { nls } from '@theia/core/lib/common';
+import { ListWidgetFrontendContribution } from '../widgets/component-list/list-widget-frontend-contribution';
+import { LibraryListWidget } from './library-list-widget';
 
 @injectable()
-export class LibraryListWidgetFrontendContribution
-  extends AbstractViewContribution<LibraryListWidget>
-  implements FrontendApplicationContribution
-{
+export class LibraryListWidgetFrontendContribution extends ListWidgetFrontendContribution<
+  LibraryPackage,
+  LibrarySearch
+> {
+  protected readonly openerAuthority = 'librarymanager';
+
   constructor() {
     super({
       widgetId: LibraryListWidget.WIDGET_ID,
@@ -24,10 +26,6 @@ export class LibraryListWidgetFrontendContribution
     });
   }
 
-  async initializeLayout(): Promise<void> {
-    this.openView();
-  }
-
   override registerMenus(menus: MenuModelRegistry): void {
     if (this.toggleCommand) {
       menus.registerMenuAction(ArduinoMenus.TOOLS__MAIN_GROUP, {
@@ -40,4 +38,46 @@ export class LibraryListWidgetFrontendContribution
       });
     }
   }
+
+  protected parsePath(path: string): Omit<LibrarySearch, 'query'> | undefined {
+    const segments = this.normalizedSegmentsOf(path);
+    // Special magic handling for `Signal Input/Output`.
+    // TODO: IDE2 deserves better lib/boards URL spec
+    // https://github.com/arduino/arduino-ide/issues/1442#issuecomment-1252136377
+    if (segments.length === 3) {
+      const [type, topicHead, topicTail] = segments;
+      const maybeTopic = `${topicHead}/${topicTail}`;
+      if (
+        LibrarySearch.Topic.is(maybeTopic) &&
+        maybeTopic === 'Signal Input/Output' &&
+        LibrarySearch.Type.is(type)
+      ) {
+        return {
+          type,
+          topic: maybeTopic,
+        };
+      }
+    }
+    const [type, topic] = segments;
+    if (!type && !topic) {
+      return {
+        type: 'All',
+        topic: 'All',
+      };
+    }
+    if (LibrarySearch.Type.is(type)) {
+      if (!topic) {
+        return {
+          type,
+        };
+      }
+      if (LibrarySearch.Topic.is(topic)) {
+        return {
+          type,
+          topic,
+        };
+      }
+    }
+    return undefined;
+  }
 }
diff --git a/arduino-ide-extension/src/browser/widgets/component-list/list-widget-frontend-contribution.ts b/arduino-ide-extension/src/browser/widgets/component-list/list-widget-frontend-contribution.ts
@@ -1,24 +1,85 @@
-import { injectable } from '@theia/core/shared/inversify';
 import { FrontendApplicationContribution } from '@theia/core/lib/browser/frontend-application';
+import {
+  OpenerOptions,
+  OpenHandler,
+} from '@theia/core/lib/browser/opener-service';
 import { AbstractViewContribution } from '@theia/core/lib/browser/shell/view-contribution';
+import { MenuModelRegistry } from '@theia/core/lib/common/menu';
+import { URI } from '@theia/core/lib/common/uri';
+import { injectable } from '@theia/core/shared/inversify';
+import { Searchable } from '../../../common/protocol';
 import { ArduinoComponent } from '../../../common/protocol/arduino-component';
 import { ListWidget } from './list-widget';
-import { Searchable } from '../../../common/protocol';
 
 @injectable()
 export abstract class ListWidgetFrontendContribution<
     T extends ArduinoComponent,
     S extends Searchable.Options
   >
   extends AbstractViewContribution<ListWidget<T, S>>
-  implements FrontendApplicationContribution
+  implements FrontendApplicationContribution, OpenHandler
 {
+  protected abstract readonly openerAuthority: string;
+  readonly id: string = `http-opener-${this.viewId}`;
+
   async initializeLayout(): Promise<void> {
-    // TS requires at least one method from `FrontendApplicationContribution`.
-    // Expected to be empty.
+    this.openView();
   }
 
-  override registerMenus(): void {
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  override registerMenus(_: MenuModelRegistry): void {
     // NOOP
   }
+
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  canHandle(uri: URI, _?: OpenerOptions): number {
+    // `500` is the default HTTP opener in Theia. IDE2 has higher priority.
+    // https://github.com/eclipse-theia/theia/blob/b75b6144b0ffea06a549294903c374fa642135e4/packages/core/src/browser/http-open-handler.ts#L39
+    return uri.scheme === 'http' && uri.authority === this.openerAuthority
+      ? 501
+      : 0;
+  }
+
+  async open(
+    uri: URI,
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    _?: OpenerOptions | undefined
+  ): Promise<void> {
+    const searchOptions = this.parse(uri);
+    if (!searchOptions) {
+      console.warn(
+        `Failed to parse URI into a search options. URI: ${uri.toString()}`
+      );
+      return;
+    }
+
+    const widget = await this.openView({
+      activate: true,
+      reveal: true,
+    });
+    if (!widget) {
+      console.warn(`Failed to open view for URI: ${uri.toString()}`);
+      return;
+    }
+
+    widget.refresh(searchOptions);
+  }
+
+  protected parse(uri: URI): S | undefined {
+    const refinements = this.parsePath(new URL(uri.toString()).pathname);
+    if (!refinements) {
+      return undefined;
+    }
+    return { ...refinements, query: uri.fragment } as S;
+  }
+
+  protected normalizedSegmentsOf(path: string): string[] {
+    // /
+    // /All
+    // /All/Device%20Control
+    // /All/Display
+    return path.split('/').slice(1).map(decodeURIComponent);
+  }
+
+  protected abstract parsePath(path: string): Omit<S, 'query'> | undefined;
 }
diff --git a/arduino-ide-extension/src/common/protocol/boards-service.ts b/arduino-ide-extension/src/common/protocol/boards-service.ts
@@ -3,7 +3,13 @@ import { Searchable } from './searchable';
 import { Installable } from './installable';
 import { ArduinoComponent } from './arduino-component';
 import { nls } from '@theia/core/lib/common/nls';
-import { All, Contributed, Partner, Type, Updatable } from '../nls';
+import {
+  All,
+  Contributed,
+  Partner,
+  Type as TypeLabel,
+  Updatable,
+} from '../nls';
 
 export type AvailablePorts = Record<string, [Port, Array<Board>]>;
 export namespace AvailablePorts {
@@ -161,6 +167,11 @@ export namespace BoardSearch {
     'Arduino@Heart',
   ] as const;
   export type Type = typeof TypeLiterals[number];
+  export namespace Type {
+    export function is(arg: unknown): arg is Type {
+      return typeof arg === 'string' && TypeLiterals.includes(arg as Type);
+    }
+  }
   export const TypeLabels: Record<Type, string> = {
     All: All,
     Updatable: Updatable,
@@ -177,7 +188,7 @@ export namespace BoardSearch {
     keyof Omit<BoardSearch, 'query'>,
     string
   > = {
-    type: Type,
+    type: TypeLabel,
   };
 }
 
diff --git a/arduino-ide-extension/src/common/protocol/library-service.ts b/arduino-ide-extension/src/common/protocol/library-service.ts
@@ -8,7 +8,7 @@ import {
   Partner,
   Recommended,
   Retired,
-  Type,
+  Type as TypeLabel,
   Updatable,
 } from '../nls';
 
@@ -66,6 +66,11 @@ export namespace LibrarySearch {
     'Retired',
   ] as const;
   export type Type = typeof TypeLiterals[number];
+  export namespace Type {
+    export function is(arg: unknown): arg is Type {
+      return typeof arg === 'string' && TypeLiterals.includes(arg as Type);
+    }
+  }
   export const TypeLabels: Record<Type, string> = {
     All: All,
     Updatable: Updatable,
@@ -90,6 +95,11 @@ export namespace LibrarySearch {
     'Uncategorized',
   ] as const;
   export type Topic = typeof TopicLiterals[number];
+  export namespace Topic {
+    export function is(arg: unknown): arg is Topic {
+      return typeof arg === 'string' && TopicLiterals.includes(arg as Topic);
+    }
+  }
   export const TopicLabels: Record<Topic, string> = {
     All: All,
     Communication: nls.localize(
@@ -126,7 +136,7 @@ export namespace LibrarySearch {
     string
   > = {
     topic: nls.localize('arduino/librarySearchProperty/topic', 'Topic'),
-    type: Type,
+    type: TypeLabel,
   };
 }
 
