refactor(workspace-tree): Future proof icon path resolution for minif…

…ied pakcage

Current resource path resolution is using the source file as the base
directory, this would fail if we minify the package into single js.

Use extension path as the base directory is more reliable: it is also
working for the current packaging, and we just have to make sure the
resource layout of the minified package remains the same.

An enum is provided with a test looping through all value and checking
the existance of the icon files in extension.

src/extension/extension.ts

@@ -41,7 +41,8 @@ import { activateWrapperCommands } from "./bazel_wrapper_commands";
  * @param context The extension context.
  */
 export async function activate(context: vscode.ExtensionContext) {
-  const workspaceTreeProvider = new BazelWorkspaceTreeProvider();
+  const workspaceTreeProvider =
+    BazelWorkspaceTreeProvider.fromExtensionContext(context);
   context.subscriptions.push(workspaceTreeProvider);
 
   const codeLensProvider = new BazelBuildCodeLensProvider(context);

src/extension/resources.ts

@@ -0,0 +1,58 @@
+// Copyright 2024 The Bazel Authors. All rights reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//    http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+import * as path from "path";
+import * as vscode from "vscode";
+
+export enum IconName {
+  ANDROID_BINARY = "android_binary",
+  APPLE_APPLICATION = "apple_application",
+  APPLE_EXECUTABLE_BUNDLE = "apple_executable_bundle",
+  APPLE_FRAMEWORK = "apple_framework",
+  BINARY = "binary",
+  CONFIG_SETTING = "config_setting",
+  FILEGROUP = "filegroup",
+  GENRULE = "genrule",
+  LIBRARY = "library",
+  PROTO = "proto",
+  RESOURCE_BUNDLE = "resource_bundle",
+  TEST = "test",
+  TEST_SUITE = "test_suite",
+}
+
+/**
+ * Helper functions for getting the resource bundled inside this extension.
+ */
+export class Resources {
+  public static fromExtensionContext(
+    context: vscode.ExtensionContext,
+  ): Resources {
+    return new Resources(context.extensionPath);
+  }
+
+  /**
+   * @param extensionPath The extension path, usually from the extension
+   * context.
+   */
+  constructor(private readonly extensionPath: string) {}
+
+  /**
+   * Returns the icon path in string.
+   *
+   * @param name The icon file name.
+   */
+  public getIconPath(name: IconName): string {
+    return path.join(this.extensionPath, "icons", `${name}.svg`);
+  }
+}

src/workspace-tree/bazel_package_tree_item.ts

@@ -78,8 +78,8 @@ export class BazelPackageTreeItem
     return this.packagePath.substring(this.parentPackagePath.length + 1);
   }
 
-  public getIcon(): vscode.ThemeIcon {
-    return vscode.ThemeIcon.Folder;
+  public getIconName(): undefined {
+    return undefined;
   }
 
   public getTooltip(): string {

src/workspace-tree/bazel_target_tree_item.ts

@@ -18,6 +18,7 @@ import { IBazelCommandAdapter, IBazelCommandOptions } from "../bazel";
 import { blaze_query } from "../protos";
 import { IBazelTreeItem } from "./bazel_tree_item";
 import { getBazelRuleIcon } from "./icons";
+import { IconName } from "../extension/resources";
 
 /** A tree item representing a build target. */
 export class BazelTargetTreeItem
@@ -50,7 +51,7 @@ export class BazelTargetTreeItem
     return `${targetName}  (${this.target.rule.ruleClass})`;
   }
 
-  public getIcon(): vscode.ThemeIcon | string {
+  public getIconName(): IconName | undefined {
     return getBazelRuleIcon(this.target);
   }
 

src/workspace-tree/bazel_tree_item.ts

@@ -13,6 +13,7 @@
 // limitations under the License.
 
 import * as vscode from "vscode";
+import { IconName } from "../extension/resources";
 
 /** An interface implemented by items in the Bazel tree provider. */
 export interface IBazelTreeItem {
@@ -36,8 +37,8 @@ export interface IBazelTreeItem {
   /** Returns the text label of the tree item. */
   getLabel(): string;
 
-  /** Returns the icon that should be shown next to the tree item. */
-  getIcon(): vscode.ThemeIcon | string | undefined;
+  /** Returns the icon name that should be shown next to the tree item. */
+  getIconName(): IconName | undefined;
 
   /**
    * Returns the tooltip that should be displayed when the user hovers over the

src/workspace-tree/bazel_workspace_folder_tree_item.ts

@@ -13,8 +13,7 @@
 // limitations under the License.
 
 import * as vscode from "vscode";
-import { BazelWorkspaceInfo } from "../bazel";
-import { BazelQuery } from "../bazel";
+import { BazelWorkspaceInfo, BazelQuery } from "../bazel";
 import { getDefaultBazelExecutablePath } from "../extension/configuration";
 import { blaze_query } from "../protos";
 import { BazelPackageTreeItem } from "./bazel_package_tree_item";
@@ -42,8 +41,8 @@ export class BazelWorkspaceFolderTreeItem implements IBazelTreeItem {
     return this.workspaceInfo.workspaceFolder.name;
   }
 
-  public getIcon(): vscode.ThemeIcon {
-    return vscode.ThemeIcon.Folder;
+  public getIconName(): undefined {
+    return undefined;
   }
 
   public getTooltip(): string {

src/workspace-tree/bazel_workspace_tree_provider.ts

@@ -16,6 +16,7 @@ import * as vscode from "vscode";
 import { BazelWorkspaceInfo } from "../bazel";
 import { IBazelTreeItem } from "./bazel_tree_item";
 import { BazelWorkspaceFolderTreeItem } from "./bazel_workspace_folder_tree_item";
+import { Resources } from "../extension/resources";
 
 /**
  * Provides a tree of Bazel build packages and targets for the VS Code explorer
@@ -34,12 +35,20 @@ export class BazelWorkspaceTreeProvider
 
   private disposables: vscode.Disposable[] = [];
 
+  public static fromExtensionContext(
+    context: vscode.ExtensionContext,
+  ): BazelWorkspaceTreeProvider {
+    return new BazelWorkspaceTreeProvider(
+      Resources.fromExtensionContext(context),
+    );
+  }
+
   /**
    * Initializes a new tree provider with the given extension context.
    *
    * @param context The VS Code extension context.
    */
-  constructor() {
+  constructor(private readonly resources: Resources) {
     const buildFilesWatcher = vscode.workspace.createFileSystemWatcher(
       "**/{BUILD,BUILD.bazel}",
       false,
@@ -87,6 +96,18 @@ export class BazelWorkspaceTreeProvider
     return Promise.resolve([]);
   }
 
+  private getIcon(element: IBazelTreeItem): string | vscode.ThemeIcon {
+    const iconName = element.getIconName();
+    if (iconName === undefined) {
+      if (element.mightHaveChildren()) {
+        return vscode.ThemeIcon.Folder;
+      } else {
+        return vscode.ThemeIcon.File;
+      }
+    }
+    return this.resources.getIconPath(iconName);
+  }
+
   public getTreeItem(element: IBazelTreeItem): vscode.TreeItem {
     const label = element.getLabel();
     const collapsibleState = element.mightHaveChildren()
@@ -95,7 +116,7 @@ export class BazelWorkspaceTreeProvider
 
     const treeItem = new vscode.TreeItem(label, collapsibleState);
     treeItem.contextValue = element.getContextValue();
-    treeItem.iconPath = element.getIcon();
+    treeItem.iconPath = this.getIcon(element);
     treeItem.tooltip = element.getTooltip();
     treeItem.command = element.getCommand();
     return treeItem;

src/workspace-tree/icons.ts

@@ -12,8 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-import * as path from "path";
-import * as vscode from "vscode";
+import { IconName } from "../extension/resources";
 import { blaze_query } from "../protos";
 
 /**
@@ -25,31 +24,31 @@ import { blaze_query } from "../protos";
  * application/extension/framework targets are shown with folder-like icons
  * because those bundles are conceptually folders.
  */
-const SPECIFIC_RULE_CLASS_ICONS: Record<string, string> = {
-  android_binary: "android_binary",
-  apple_bundle_import: "resource_bundle",
-  apple_resource_bundle: "resource_bundle",
-  config_setting: "config_setting",
-  filegroup: "filegroup",
-  genrule: "genrule",
-  ios_application: "apple_application",
-  ios_extension: "apple_executable_bundle",
-  ios_framework: "apple_framework",
-  macos_application: "apple_application",
-  macos_bundle: "apple_executable_bundle",
-  macos_extension: "apple_executable_bundle",
-  objc_bundle: "resource_bundle",
-  objc_bundle_library: "resource_bundle",
-  objc_framework: "apple_framework",
-  objc_import: "library",
-  proto_library: "proto",
-  swift_c_module: "library",
-  swift_import: "library",
-  test_suite: "test_suite",
-  tvos_application: "apple_application",
-  tvos_extension: "apple_executable_bundle",
-  watchos_application: "apple_application",
-  watchos_extension: "apple_executable_bundle",
+const SPECIFIC_RULE_CLASS_ICONS: Record<string, IconName> = {
+  android_binary: IconName.ANDROID_BINARY,
+  apple_bundle_import: IconName.RESOURCE_BUNDLE,
+  apple_resource_bundle: IconName.RESOURCE_BUNDLE,
+  config_setting: IconName.CONFIG_SETTING,
+  filegroup: IconName.FILEGROUP,
+  genrule: IconName.GENRULE,
+  ios_application: IconName.APPLE_APPLICATION,
+  ios_extension: IconName.APPLE_EXECUTABLE_BUNDLE,
+  ios_framework: IconName.APPLE_FRAMEWORK,
+  macos_application: IconName.APPLE_APPLICATION,
+  macos_bundle: IconName.APPLE_EXECUTABLE_BUNDLE,
+  macos_extension: IconName.APPLE_EXECUTABLE_BUNDLE,
+  objc_bundle: IconName.RESOURCE_BUNDLE,
+  objc_bundle_library: IconName.RESOURCE_BUNDLE,
+  objc_framework: IconName.APPLE_FRAMEWORK,
+  objc_import: IconName.LIBRARY,
+  proto_library: IconName.PROTO,
+  swift_c_module: IconName.LIBRARY,
+  swift_import: IconName.LIBRARY,
+  test_suite: IconName.TEST_SUITE,
+  tvos_application: IconName.APPLE_APPLICATION,
+  tvos_extension: IconName.APPLE_EXECUTABLE_BUNDLE,
+  watchos_application: IconName.APPLE_APPLICATION,
+  watchos_extension: IconName.APPLE_EXECUTABLE_BUNDLE,
 };
 
 /**
@@ -60,23 +59,19 @@ const SPECIFIC_RULE_CLASS_ICONS: Record<string, string> = {
  */
 export function getBazelRuleIcon(
   target: blaze_query.ITarget,
-): string | vscode.ThemeIcon {
+): IconName | undefined {
   const ruleClass = target.rule.ruleClass;
   let iconName = SPECIFIC_RULE_CLASS_ICONS[ruleClass];
   if (!iconName) {
     if (ruleClass.endsWith("_binary")) {
-      iconName = "binary";
+      iconName = IconName.BINARY;
     } else if (ruleClass.endsWith("_proto_library")) {
-      iconName = "proto";
+      iconName = IconName.PROTO;
     } else if (ruleClass.endsWith("_library")) {
-      iconName = "library";
+      iconName = IconName.LIBRARY;
     } else if (ruleClass.endsWith("_test")) {
-      iconName = "test";
+      iconName = IconName.TEST;
     }
   }
-  if (iconName) {
-    return path.join(__dirname, "../../../icons", `${iconName}.svg`);
-  } else {
-    return vscode.ThemeIcon.File;
-  }
+  return iconName;
 }

test/resources.test.ts

@@ -0,0 +1,17 @@
+import assert = require("assert");
+import { IconName, Resources } from "../src/extension/resources";
+import * as fs from "fs/promises";
+import * as vscode from "vscode";
+
+describe("The resources", () => {
+  const resources = new Resources(
+    vscode.extensions.getExtension("BazelBuild.vscode-bazel").extensionPath,
+  );
+  it("provides valid icon paths", () => {
+    for (const name of Object.values(IconName)) {
+      assert.doesNotThrow(async () => {
+        await fs.stat(resources.getIconPath(name));
+      }, "invalid icon path");
+    }
+  });
+});