Fixes for Language Server sync server

app/gui2/shared/__tests__/yjsModel.test.ts

@@ -0,0 +1,54 @@
+import { rangeEncloses, rangeIntersects, type ContentRange } from 'shared/yjsModel'
+import { expect, test } from 'vitest'
+
+type RangeTest = { a: ContentRange; b: ContentRange }
+
+const equalRanges: RangeTest[] = [
+  { a: [0, 0], b: [0, 0] },
+  { a: [0, 1], b: [0, 1] },
+  { a: [-5, 5], b: [-5, 5] },
+]
+
+const totalOverlap: RangeTest[] = [
+  { a: [0, 1], b: [0, 0] },
+  { a: [0, 2], b: [2, 2] },
+  { a: [-1, 1], b: [1, 1] },
+  { a: [0, 2], b: [0, 1] },
+  { a: [-10, 10], b: [-3, 7] },
+  { a: [0, 5], b: [1, 2] },
+  { a: [3, 5], b: [3, 4] },
+]
+
+const reverseTotalOverlap: RangeTest[] = totalOverlap.map(({ a, b }) => ({ a: b, b: a }))
+
+const noOverlap: RangeTest[] = [
+  { a: [0, 1], b: [2, 3] },
+  { a: [0, 1], b: [-1, -1] },
+  { a: [5, 6], b: [2, 3] },
+  { a: [0, 2], b: [-2, -1] },
+  { a: [-5, -3], b: [9, 10] },
+  { a: [-3, 2], b: [3, 4] },
+]
+
+const partialOverlap: RangeTest[] = [
+  { a: [0, 3], b: [-1, 1] },
+  { a: [0, 1], b: [-1, 0] },
+  { a: [0, 0], b: [-1, 0] },
+  { a: [0, 2], b: [1, 4] },
+  { a: [-8, 0], b: [0, 10] },
+]
+
+test.each([...equalRanges, ...totalOverlap])('Range $a should enclose $b', ({ a, b }) =>
+  expect(rangeEncloses(a, b)).toBe(true),
+)
+test.each([...noOverlap, ...partialOverlap, ...reverseTotalOverlap])(
+  'Range $a should not enclose $b',
+  ({ a, b }) => expect(rangeEncloses(a, b)).toBe(false),
+)
+test.each([...equalRanges, ...totalOverlap, ...reverseTotalOverlap, ...partialOverlap])(
+  'Range $a should intersect $b',
+  ({ a, b }) => expect(rangeIntersects(a, b)).toBe(true),
+)
+test.each([...noOverlap])('Range $a should not intersect $b', ({ a, b }) =>
+  expect(rangeIntersects(a, b)).toBe(false),
+)

app/gui2/shared/languageServer.ts

@@ -131,7 +131,8 @@ export class LanguageServer extends ObservableV2<Notifications> {
         console.log(`LS [${uuid}] ${method}:`)
         console.dir(params)
       }
-      return await this.client.request({ method, params }, RPC_TIMEOUT_MS)
+      const ret = await this.client.request({ method, params }, RPC_TIMEOUT_MS)
+      return ret
     } catch (e) {
       const remoteError = RemoteRpcErrorSchema.safeParse(e)
       if (remoteError.success) {
@@ -167,8 +168,8 @@ export class LanguageServer extends ObservableV2<Notifications> {
   }
 
   /** [Documentation](https://github.com/enso-org/enso/blob/develop/docs/language-server/protocol-language-server.md#textopenfile) */
-  openTextFile(path: Path): Promise<response.OpenTextFile> {
-    return this.request('text/openFile', { path })
+  openTextFile(path: Path, meta?: string): Promise<response.OpenTextFile> {
+    return this.request('text/openFile', { path, meta })
   }
 
   /** [Documentation](https://github.com/enso-org/enso/blob/develop/docs/language-server/protocol-language-server.md#textclosefile) */
@@ -402,27 +403,30 @@ export class LanguageServer extends ObservableV2<Notifications> {
     retry: <T>(cb: () => Promise<T>) => Promise<T> = (f) => f(),
   ) {
     let running = true
-    ;(async () => {
-      this.on('file/event', callback)
-      walkFs(this, { rootId, segments }, (type, path) => {
-        if (
-          !running ||
-          type !== 'File' ||
-          path.segments.length < segments.length ||
-          segments.some((seg, i) => seg !== path.segments[i])
-        )
-          return
-        callback({
-          path: { rootId: path.rootId, segments: path.segments.slice(segments.length) },
-          kind: 'Added',
+    const self = this
+    return {
+      promise: (async () => {
+        self.on('file/event', callback)
+        await retry(() => self.acquireReceivesTreeUpdates({ rootId, segments }))
+        await walkFs(self, { rootId, segments }, (type, path) => {
+          if (
+            !running ||
+            type !== 'File' ||
+            path.segments.length < segments.length ||
+            segments.some((segment, i) => segment !== path.segments[i])
+          )
+            return
+          callback({
+            path: { rootId: path.rootId, segments: path.segments.slice(segments.length) },
+            kind: 'Added',
+          })
         })
-      })
-      await retry(() => this.acquireReceivesTreeUpdates({ rootId, segments }))
-      if (!running) return
-    })()
-    return () => {
-      running = false
-      this.off('file/event', callback)
+        if (!running) return
+      })(),
+      unsubscribe() {
+        running = false
+        self.off('file/event', callback)
+      },
     }
   }
 

app/gui2/shared/languageServerTypes.ts

@@ -386,9 +386,7 @@ export namespace response {
     contentRoots: ContentRoot[]
   }
 
-  export interface FileContents {
-    contents: TextFileContents
-  }
+  export interface FileContents extends TextFileContents {}
 
   export interface FileExists {
     exists: boolean

app/gui2/shared/retry.ts

@@ -0,0 +1,114 @@
+import { wait } from 'lib0/promise'
+
+export interface BackoffOptions<E> {
+  maxRetries?: number
+  retryDelay?: number
+  retryDelayMultiplier?: number
+  retryDelayMax?: number
+  /**
+   * Called when the promise return an error result, and the next retry is about to be attempted.
+   * When this function returns `false`, the backoff is immediately aborted. When this function is
+   * not provided, the backoff will always continue until the maximum number of retries is reached.
+   */
+  onBeforeRetry?: (
+    error: E,
+    retryCount: number,
+    maxRetries: number,
+    delay: number,
+  ) => boolean | void
+  /** Called right before returning. */
+  onSuccess?: (retryCount: number) => void
+  /** Called right before throwing an error. Note that `onBeforeRetry` is called for all tries
+   * before the last one. */
+  onFailure?: (error: E, retryCount: number) => void
+}
+
+const defaultBackoffOptions: Required<BackoffOptions<unknown>> = {
+  maxRetries: 3,
+  retryDelay: 1000,
+  retryDelayMultiplier: 2,
+  retryDelayMax: 10000,
+  onBeforeRetry: () => {},
+  onSuccess: () => {},
+  onFailure: () => {},
+}
+
+/** Retry a failing promise function with exponential backoff. */
+export async function exponentialBackoff<T, E>(
+  f: () => Promise<T>,
+  backoffOptions?: BackoffOptions<E>,
+): Promise<T> {
+  const {
+    maxRetries,
+    retryDelay,
+    retryDelayMultiplier,
+    retryDelayMax,
+    onBeforeRetry,
+    onSuccess,
+    onFailure,
+  } = {
+    ...defaultBackoffOptions,
+    ...backoffOptions,
+  }
+  for (
+    let retries = 0, delay = retryDelay;
+    ;
+    retries += 1, delay = Math.min(retryDelayMax, delay * retryDelayMultiplier)
+  ) {
+    try {
+      const result = await f()
+      onSuccess(retries)
+      return result
+    } catch (error) {
+      if (retries >= maxRetries) {
+        onFailure(error as E, retries)
+        throw error
+      }
+      if (onBeforeRetry(error as E, retries, maxRetries, delay) === false) throw error
+      await wait(delay)
+    }
+  }
+}
+
+export function onBeforeRetry(
+  description: string,
+): NonNullable<BackoffOptions<any>['onBeforeRetry']> {
+  return (error, retryCount, maxRetries, delay) => {
+    console.error(
+      'Could not ' +
+        description +
+        ` (${retryCount}/${maxRetries} retries), retrying after ${delay}ms...`,
+    )
+    console.error(error)
+  }
+}
+
+export function onFailure(description: string): NonNullable<BackoffOptions<any>['onFailure']> {
+  return (error, retryCount) => {
+    console.error(
+      'Could not ' + description + ` (${retryCount}/${retryCount} retries), throwing error.`,
+    )
+    console.error(error)
+  }
+}
+
+export function onSuccess(description: string): NonNullable<BackoffOptions<any>['onSuccess']> {
+  return (retryCount) => {
+    if (retryCount === 0) return
+    console.info(
+      'Successfully ' +
+        description +
+        ` after ${retryCount} ${retryCount === 1 ? 'failure' : 'failures'}.`,
+    )
+  }
+}
+
+/** @param successDescription Should be in past tense, without an initial capital letter.
+ * @param successDescription Should be in present tense, without an initial capital letter. */
+export function exponentialBackoffMessages(successDescription: string, errorDescription: string) {
+  return {
+    onBeforeRetry: onBeforeRetry(errorDescription),
+    onSuccess: onSuccess(successDescription),
+    onFailure: onFailure(errorDescription),
+  } satisfies BackoffOptions<unknown>
+}