Handle rewriting of submodule cloner's out-of-tree clone (hand-wavingly)

Author: andy0130tw

commands.ts

@@ -1,4 +1,4 @@
-import { fetchServerRefInfo, gitClone, RefEntry } from '$gitops'
+import { fetchServerRefInfo, gitClone, maybeRewriteGitSubmodulePath, RefEntry } from '$gitops'
 import {
   type ExtensionContext,
   FileType,
@@ -149,6 +149,8 @@ async function pickAndInstallFromLibraryCatalog(context: ExtensionContext) {
 
     qp.busy = false
     qp.items = [...tags, ...branches]
+    // the user might be interrupted to install the missing the extension dependency
+    qp.show()
 
     const def = tags.find(it => it.label === libPicked.descriptor.defaultRef)
     if (def) qp.activeItems = [def]
@@ -318,11 +320,11 @@ async function _listInstalledLibraries(context: ExtensionContext) {
   }
 }
 
-export async function listConfiguredLibraries(): Promise<ConfiguredLibraryEntry[]> {
+function probeLibraryConfig() {
   const CONFIG_SECTION = 'alsWasmLoader'
   const CONFIG_KEY = 'libraryFilePaths'
 
-  const configsFound: ConfiguredLibraryEntry[] = []
+  const configsFound: (ConfiguredLibraryEntry & { base: string, prefix?: Uri })[] = []
 
   const unscopedConfig = workspace.getConfiguration(CONFIG_SECTION)
   const unscopedConfigSources = unscopedConfig.inspect<string[]>(CONFIG_KEY)
@@ -347,6 +349,7 @@ export async function listConfiguredLibraries(): Promise<ConfiguredLibraryEntry[
       configsFound.push({
         source: 'workspace',
         base: '/workspace',
+        prefix: folders[0].uri,
         paths: wsPaths,
       })
     }
@@ -367,6 +370,7 @@ export async function listConfiguredLibraries(): Promise<ConfiguredLibraryEntry[
         configsFound.push({
           source: 'workspaceFolder',
           base: `/workspaces/${wsf.name}`,
+          prefix: wsf.uri,
           paths: wsfPaths,
         })
       }
@@ -382,6 +386,24 @@ export async function listConfiguredLibraries(): Promise<ConfiguredLibraryEntry[
   return configsFound.reverse()
 }
 
+export async function listConfiguredLibraries(): Promise<ConfiguredLibraryEntry[]> {
+
+  async function resolvePath(p: string, base: string, prefix: Uri | undefined) {
+    const resolved = p[0] === '/' ? p :  base + '/' + p
+    if (prefix?.scheme === 'github-vfs') {
+      return maybeRewriteGitSubmodulePath(resolved, prefix)
+    }
+    return resolved
+  }
+
+  function mapAsync<A, B>(arr: A[], mapper: (a: A) => Promise<B>): Promise<B[]> {
+    return Promise.all(arr.map(mapper))
+  }
+
+  return mapAsync(probeLibraryConfig(), async ({source, base, prefix, paths}) => (
+      { source, paths: await mapAsync(paths, p => resolvePath(p, base, prefix)) }))
+}
+
 async function _manageLibraries(context: ExtensionContext, ..._args: any[]) {
   let showInvalid = false
   let items: InstalledLibraryQuickPickItem[] = []

extension.ts

@@ -121,6 +121,13 @@ export async function activate(context: ExtensionContext): Promise<ALSWasmLoader
           )
         }
 
+        const submodClonerStorageUri = Uri.joinPath(context.globalStorageUri, '../qbane.vscode-git-submodule-cloner')
+        if (await workspace.fs.stat(submodClonerStorageUri)) {
+          presetMountPoints.push(
+            { kind: 'vscodeFileSystem', uri: submodClonerStorageUri, mountPoint: '/submodules' }
+          )
+        }
+
         await options.presetupCallback?.({ memfsTempDir, memfsHome })
       }
 

gitops/lib-common.d.ts

@@ -18,8 +18,10 @@ interface GitCloneOptions {
 
 export function fetchServerRefInfo(url: string): Promise<ServerRefInfo>
 export function gitClone(url: string, dest: Uri, ref?: string, options?: GitCloneOptions): Promise<void>
+export function maybeRewriteGitSubmodulePath(path: string, wsuri: Uri): Promise<string>
 
 type LibAPI = {
   fetchServerRefInfo: typeof fetchServerRefInfo,
   gitClone: typeof gitClone,
+  maybeRewriteGitSubmodulePath: typeof maybeRewriteGitSubmodulePath,
 }

gitops/lib-desktop.ts

@@ -103,7 +103,12 @@ export async function gitClone(url: string, dest: Uri, ref?: string, options?: G
   await commands.executeCommand('git.close', dest)
 }
 
+function maybeRewriteGitSubmodulePath(): never {
+  throw new Error('Not supported on desktop version')
+}
+
 ;({
   fetchServerRefInfo,
   gitClone,
+  maybeRewriteGitSubmodulePath,
 } satisfies LibAPI)

gitops/lib-web.ts

@@ -1,12 +1,16 @@
-import { commands, extensions, Uri, window } from 'vscode'
+import { commands, env, extensions, UIKind, Uri, window } from 'vscode'
 import type { LibAPI, ServerRefInfo, GitCloneOptions } from '$gitops'
 
+type GitSubmoduleClonerAPI = LibAPI & {
+  getWorkspaceId(uri: Uri): string
+  listSubmodules(uri: Uri): { name: string, path: string, url: string }[]
+}
 
 async function ensureExtensionCommon(extensionID: string, extensionName: string = extensionID) {
   const openExtensionPage = () => commands.executeCommand('extension.open', `${extensionID}`)
 
   do {
-    const ext = extensions.getExtension<LibAPI>(extensionID)
+    const ext = extensions.getExtension<GitSubmoduleClonerAPI>(extensionID)
     if (ext != null) {
       if (!ext.isActive) {
         await ext.activate()
@@ -77,7 +81,26 @@ export async function gitClone(url: string, dest: Uri, ref?: string, options?: G
   return gitCloner.gitClone(url, dest, ref, options)
 }
 
+async function maybeRewriteGitSubmodulePath(path: string, wsuri: Uri) {
+  if (env.uiKind !== UIKind.Web) {
+    // bail out rather than return path silently
+    throw new Error('can only rewrite submodule URI on web')
+  }
+  const gitCloner = await ensureExtension()
+  const submodules = gitCloner.listSubmodules(wsuri)
+
+  for (let {name, path: submodPath} of submodules) {
+    const prefix = '/workspace/' + submodPath + '/'
+    if (path.startsWith(prefix)) {
+      return `/submodules/${gitCloner.getWorkspaceId(wsuri)}/${name}/` + path.slice(prefix.length)
+    }
+  }
+
+  return path
+}
+
 ;({
   fetchServerRefInfo,
   gitClone,
+  maybeRewriteGitSubmodulePath,
 } satisfies LibAPI)

package.json

@@ -65,7 +65,9 @@
 			"properties": {
 				"alsWasmLoader.libraryFilePaths": {
 					"type": "array",
-					"items": { "type": "string" },
+					"items": {
+						"type": "string"
+					},
 					"default": [],
 					"scope": "resource",
 					"markdownDescription": "Paths to [library files](https://agda.readthedocs.io/en/latest/tools/package-system.html#library-files) to be loaded by ALS-WASM inside its VFS. Each member will be inserted as a line after resolution in the `libraries` file.\n\nA path *not* beginning with `/` is interpreted as a relative path, resolved according to the scope it is defined. In user settings it is resolved against `/`, while in workspace (when single-rooted) or workspace-folder (when multi-rooted) settings, relative paths are resolved against the corresponding workspace folder.\n\nNote that the lists from all scopes will be combined per window."

types.d.ts

@@ -89,7 +89,6 @@ interface LibraryEntry {
 
 export interface ConfiguredLibraryEntry {
   source: 'global' | 'workspace' | 'workspaceFolder'
-  base: string
   paths: string[]
 }