Support web editors

Author: cschleiden

package-lock.json

@@ -13,13 +13,10 @@
     "vscode": "^1.53.0"
   },
   "extensionKind": [
-    "workspace",
-    "web"
+    "web",
+    "workspace"
   ],
   "capabilities": {
-    "untrustedWorkspaces": {
-      "supported": true
-    },
     "virtualWorkspaces": true
   },
   "categories": [
@@ -30,7 +27,8 @@
     "onView:settings",
     "workspaceContains:**/.github/workflows/**"
   ],
-  "main": "./dist/extension",
+  "main": "./dist/extension-node.js",
+  "browser": "./dist/extension-web.js",
   "contributes": {
     "configuration": {
       "title": "GitHub Actions",
@@ -364,8 +362,7 @@
   },
   "dependencies": {
     "@octokit/rest": "18.6.7",
-    "atob": "^2.1.2",
-    "btoa": "^1.2.1",
+    "abab": "^2.0.5",
     "github-actions-parser": "0.22.0",
     "js-yaml": "^3.14.0",
     "ssh-config": "^3.0.0",

package.json

@@ -1,7 +1,4 @@
 import { parse as parseConfig } from "ssh-config";
-import { readFileSync } from "fs";
-import { join } from "path";
-import { homedir } from "os";
 
 const SSH_URL_RE = /^(?:([^@:]+)@)?([^:/]+):?(.+)$/;
 const URL_SCHEME_RE = /^([a-z-]+):\/\//;
@@ -55,7 +52,7 @@ export const resolve = (url: string, resolveConfig = Resolvers.current) => {
 };
 
 export class Resolvers {
-  static default = chainResolvers(baseResolver, resolverFromConfigFile());
+  static default = chainResolvers(baseResolver /*, resolverFromConfigFile()*/);
 
   static fromConfig(conf: string) {
     return chainResolvers(baseResolver, resolverFromConfig(conf));
@@ -89,16 +86,17 @@ function baseResolver(config: Config) {
   };
 }
 
-function resolverFromConfigFile(
-  configPath = join(homedir(), ".ssh", "config")
-): ConfigResolver | undefined {
-  try {
-    const config = readFileSync(configPath).toString();
-    return resolverFromConfig(config);
-  } catch (error) {
-    // Logger.appendLine(`${configPath}: ${error.message}`);
-  }
-}
+// Temporarily disable this to remove `fs` dependency
+// function resolverFromConfigFile(
+//   configPath = join(homedir(), ".ssh", "config")
+// ): ConfigResolver | undefined {
+//   try {
+//     const config = readFileSync(configPath).toString();
+//     return resolverFromConfig(config);
+//   } catch (error) {
+//     // Logger.appendLine(`${configPath}: ${error.message}`);
+//   }
+// }
 
 export function resolverFromConfig(text: string): ConfigResolver {
   const config = parseConfig(text);

src/external/ssh.ts

@@ -1,11 +1,9 @@
-import * as vscode from "vscode";
-
-import { API, GitExtension, RefType } from "../typings/git";
-
 import { Octokit } from "@octokit/rest";
-import { Protocol } from "../external/protocol";
+import * as vscode from "vscode";
 import { getClient } from "../api/api";
 import { getSession } from "../auth/auth";
+import { Protocol } from "../external/protocol";
+import { API, GitExtension, RefType } from "../typings/git";
 
 async function getGitExtension(): Promise<API | undefined> {
   const gitExtension =
@@ -45,7 +43,6 @@ export async function getGitHead(): Promise<string | undefined> {
     }
   }
 }
-
 export async function getGitHubUrls(): Promise<
   | {
       workspaceUri: vscode.Uri;
@@ -55,7 +52,6 @@ export async function getGitHubUrls(): Promise<
   | null
 > {
   const git = await getGitExtension();
-
   if (git && git.repositories.length > 0) {
     return git.repositories
       .map((r) => {
@@ -82,6 +78,32 @@ export async function getGitHubUrls(): Promise<
       .filter((x) => !!x) as any;
   }
 
+  // If we cannot find the git extension, assume for now that we are running a web context,
+  // for instance, github.dev. I think ideally we'd check the workspace URIs first, but this
+  // works for now. We'll revisit later.
+  if (!git) {
+    // Support for virtual workspaces
+    const isVirtualWorkspace =
+      vscode.workspace.workspaceFolders &&
+      vscode.workspace.workspaceFolders.every((f) => f.uri.scheme !== "file");
+    if (isVirtualWorkspace) {
+      const ghFolder = vscode.workspace.workspaceFolders?.find(
+        (x) => x.uri.scheme === "vscode-vfs" && x.uri.authority === "github"
+      );
+      if (ghFolder) {
+        const url = `https://github.com/${ghFolder.uri.path}`;
+
+        return [
+          {
+            workspaceUri: ghFolder.uri,
+            url: url,
+            protocol: new Protocol(url),
+          },
+        ];
+      }
+    }
+  }
+
   return null;
 }
 

src/git/repository.ts

@@ -1,5 +1,6 @@
-import { extname } from "path";
 import * as vscode from "vscode";
+
+import { extname } from "path";
 import { getContextStringForWorkflow } from "../workflow/workflow";
 
 export function initWorkflowDocumentTracking(context: vscode.ExtensionContext) {
@@ -11,7 +12,7 @@ export function initWorkflowDocumentTracking(context: vscode.ExtensionContext) {
   onDidChangeActiveTextEditor(vscode.window.activeTextEditor);
 }
 
-function onDidChangeActiveTextEditor(editor?: vscode.TextEditor) {
+async function onDidChangeActiveTextEditor(editor?: vscode.TextEditor) {
   if (!editor || !isTextEditor(editor)) {
     return;
   }
@@ -30,7 +31,7 @@ function onDidChangeActiveTextEditor(editor?: vscode.TextEditor) {
   vscode.commands.executeCommand(
     "setContext",
     "githubActions:activeFile",
-    getContextStringForWorkflow(editor.document.fileName)
+    await getContextStringForWorkflow(editor.document.fileName)
   );
 }
 

src/tracker/workflowDocumentTracker.ts

@@ -4,7 +4,6 @@ import { GitHubRepoContext } from "../git/repository";
 import { Workflow } from "github-actions-parser/dist/lib/workflow";
 import { basename } from "path";
 import { parse } from "github-actions-parser";
-import { readFileSync } from "fs";
 import { safeLoad } from "js-yaml";
 
 interface On {
@@ -51,9 +50,13 @@ function getEvents(doc: any): On[] {
   return on;
 }
 
-export function getContextStringForWorkflow(path: string): string {
+export async function getContextStringForWorkflow(
+  path: string
+): Promise<string> {
   try {
-    const doc = safeLoad(readFileSync(path, "utf8"));
+    const content = await vscode.workspace.fs.readFile(vscode.Uri.file(path));
+    const file = Buffer.from(content).toString("utf8");
+    const doc = safeLoad(file);
     if (doc) {
       let context = "";
 
@@ -75,22 +78,6 @@ export function getContextStringForWorkflow(path: string): string {
   return "";
 }
 
-export function getRepositoryDispatchTypes(path: string): string[] {
-  try {
-    const doc = safeLoad(readFileSync(path, "utf8"));
-    if (doc) {
-      const rdispatch = getEvents(doc).find(
-        (t) => t.event.toLowerCase() == "repository_dispatch"
-      );
-      return rdispatch?.types || [];
-    }
-  } catch (e) {
-    // Ignore
-  }
-
-  return [];
-}
-
 /**
  * Try to get Uri to workflow in currently open workspace folders
  *

src/workflow/workflow.ts

@@ -3,9 +3,7 @@
 		"module": "commonjs",
 		"target": "es6",
 		"outDir": "dist",
-		"lib": [
-			"es6"
-		],
+		"lib": ["ES2019", "DOM"],
 		"sourceMap": true,
 		"rootDir": "src",
 		"typeRoots": [

tsconfig.json

@@ -6,22 +6,12 @@ const path = require("path");
 
 /**@type {import('webpack').Configuration}*/
 const config = {
-  target: "node", // vscode extensions run in a Node.js-context 📖 -> https://webpack.js.org/configuration/node/
-
   entry: "./src/extension.ts", // the entry point of this extension, 📖 -> https://webpack.js.org/configuration/entry-context/
-  output: {
-    // the bundle is stored in the 'dist' folder (check package.json), 📖 -> https://webpack.js.org/configuration/output/
-    path: path.resolve(__dirname, "dist"),
-    filename: "extension.js",
-    libraryTarget: "commonjs2",
-    devtoolModuleFilenameTemplate: "../[resource-path]"
-  },
   devtool: "source-map",
   externals: {
-    vscode: "commonjs vscode", // the vscode-module is created on-the-fly and must be excluded. Add other modules that cannot be webpack'ed, 📖 -> https://webpack.js.org/configuration/externals/
+    vscode: "commonjs vscode",
   },
   resolve: {
-    // support reading TypeScript and JavaScript files, 📖 -> https://github.com/TypeStrong/ts-loader
     extensions: [".ts", ".js"],
     alias: {
       "universal-user-agent$": "universal-user-agent/dist-node/index.js"
@@ -45,4 +35,27 @@ const config = {
     ]
   }
 };
-module.exports = config;
+
+const nodeConfig = {
+  ...config,
+  target: "node",
+  output: {
+    path: path.resolve(__dirname, "dist"),
+    filename: "extension-node.js",
+    libraryTarget: "commonjs2",
+    devtoolModuleFilenameTemplate: "../[resource-path]",
+  },
+};
+
+const webConfig = {
+  ...config,
+  target: "webworker",
+  output: {
+    path: path.resolve(__dirname, "dist"),
+    filename: "extension-web.js",
+    libraryTarget: "commonjs2",
+    devtoolModuleFilenameTemplate: "../[resource-path]",
+  },
+};
+
+module.exports = [nodeConfig, webConfig];