Installed @deephaven/jsapi-types, improved DhService base types, and …

…tweaked download tmp caching (#79-3)

package.json

@@ -147,6 +147,7 @@
     }
   },
   "devDependencies": {
+    "@deephaven/jsapi-types": "^1.0.0-dev0.35.3",
     "@types/node": "20.14.10",
     "@types/vscode": "^1.91.0",
     "@types/ws": "^8.5.10",

src/dh/dhc.ts

@@ -1,11 +1,12 @@
 import * as fs from 'node:fs';
 import * as path from 'node:path';
-import type { dh as DhType } from './dhc-types';
+import type { dh as DhType } from '@deephaven/jsapi-types';
 import {
   downloadFromURL,
   getTempDir,
   NoConsoleTypesError,
   polyfillDh,
+  urlToDirectoryName,
 } from '../util';
 import { ConnectionAndSession } from '../common';
 
@@ -32,12 +33,7 @@ export function getEmbedWidgetUrl(
 
 export async function initDhcApi(serverUrl: string): Promise<typeof DhType> {
   polyfillDh();
-
-  const tempDir = getTempDir();
-
-  const dhc = await getDhc(serverUrl, tempDir, true);
-
-  return dhc;
+  return getDhc(serverUrl, true);
 }
 
 export async function initDhcSession(
@@ -71,16 +67,17 @@ export async function initDhcSession(
  */
 async function getDhc(
   serverUrl: string,
-  outDir: string,
   download: boolean
 ): Promise<typeof DhType> {
+  const tmpDir = getTempDir(false, urlToDirectoryName(serverUrl));
+
   if (download) {
     const dhInternal = await downloadFromURL(
       path.join(serverUrl, 'jsapi/dh-internal.js')
     );
     // Convert to .cjs
     fs.writeFileSync(
-      path.join(outDir, 'dh-internal.cjs'),
+      path.join(tmpDir, 'dh-internal.cjs'),
       dhInternal.replace(
         `export{__webpack_exports__dhinternal as dhinternal};`,
         `module.exports={dhinternal:__webpack_exports__dhinternal};`
@@ -91,7 +88,7 @@ async function getDhc(
       path.join(serverUrl, 'jsapi/dh-core.js')
     );
     fs.writeFileSync(
-      path.join(outDir, 'dh-core.cjs'),
+      path.join(tmpDir, 'dh-core.cjs'),
       // Convert to .cjs
       dhCore
         .replace(
@@ -102,5 +99,5 @@ async function getDhc(
     );
   }
 
-  return require(path.join(outDir, 'dh-core.cjs'));
+  return require(path.join(tmpDir, 'dh-core.cjs'));
 }

src/services/DhService.ts

@@ -1,5 +1,5 @@
 import * as vscode from 'vscode';
-import type { dh as DhcType } from '../dh/dhc-types';
+import type { dh as DhcType } from '@deephaven/jsapi-types';
 import { hasErrorCode } from '../util/typeUtils';
 import { ConnectionAndSession, Disposable } from '../common';
 import {
@@ -36,7 +36,23 @@ type CommandResultBase = {
   error: string;
 };
 
-export abstract class DhService<TDH, TClient>
+/**
+ * Helper type to make it easier to use `DhService` derived classes as newable
+ * factory functions. This type should mirror the constructor of `DhService`.
+ */
+export type DhServiceConstructor<
+  T extends DhService<TDH, TClient>,
+  TDH = unknown,
+  TClient = unknown,
+> = new (
+  serverUrl: string,
+  panelRegistry: ExtendedMap<string, vscode.WebviewPanel>,
+  diagnosticsCollection: vscode.DiagnosticCollection,
+  outputChannel: vscode.OutputChannel,
+  toaster: Toaster
+) => T;
+
+export abstract class DhService<TDH = unknown, TClient = unknown>
   extends EventDispatcher<'disconnect'>
   implements Disposable
 {

src/services/DhServiceRegistry.ts

@@ -1,14 +1,15 @@
 import * as vscode from 'vscode';
 import { CacheService } from './CacheService';
-import { DhcService, DhcServiceConstructor } from './DhcService';
+import { type DhServiceConstructor } from './DhService';
+import { DhcService } from './DhcService';
 import { ensureHasTrailingSlash, ExtendedMap, Toaster } from '../util';
 
 export class DhServiceRegistry<T extends DhcService> extends CacheService<
   T,
   'disconnect'
 > {
   constructor(
-    serviceFactory: DhcServiceConstructor<T>,
+    serviceFactory: DhServiceConstructor<T>,
     panelRegistry: ExtendedMap<string, vscode.WebviewPanel>,
     diagnosticsCollection: vscode.DiagnosticCollection,
     outputChannel: vscode.OutputChannel,

src/services/DhcService.ts

@@ -1,5 +1,5 @@
 import * as vscode from 'vscode';
-import type { dh as DhcType } from '../dh/dhc-types';
+import type { dh as DhcType } from '@deephaven/jsapi-types';
 import DhService from './DhService';
 import {
   AUTH_HANDLER_TYPE_ANONYMOUS,
@@ -8,19 +8,11 @@ import {
   initDhcApi,
   initDhcSession,
 } from '../dh/dhc';
-import { ExtendedMap, getPanelHtml, Logger, Toaster } from '../util';
+import { getPanelHtml, Logger } from '../util';
 import { ConnectionAndSession } from '../common';
 
 const logger = new Logger('DhcService');
 
-export type DhcServiceConstructor<T extends DhcService> = new (
-  serverUrl: string,
-  panelRegistry: ExtendedMap<string, vscode.WebviewPanel>,
-  diagnosticsCollection: vscode.DiagnosticCollection,
-  outputChannel: vscode.OutputChannel,
-  toaster: Toaster
-) => T;
-
 export class DhcService extends DhService<typeof DhcType, DhcType.CoreClient> {
   private psk?: string;
 

src/types/global.d.ts

@@ -0,0 +1,3 @@
+declare module dhinternal.io.deephaven.proto.ticket_pb {
+  export type TypedTicket = unknown;
+}

src/util/downloadUtils.ts

@@ -6,8 +6,11 @@ import { Logger } from './Logger';
 
 const logger = new Logger('downloadUtils');
 
-export function getTempDir(recreate = false) {
-  const tempDir = path.join(__dirname, 'tmp');
+export function getTempDir(recreate: boolean, subDirectory?: string) {
+  let tempDir = path.join(__dirname, '..', 'tmp');
+  if (subDirectory != null) {
+    tempDir = path.join(tempDir, subDirectory);
+  }
 
   if (recreate) {
     try {

src/util/urlUtils.spec.ts

@@ -0,0 +1,13 @@
+import { describe, expect, it } from 'vitest';
+import { urlToDirectoryName } from './urlUtils';
+
+describe('urlUtils', () => {
+  it.each([
+    ['http://localhost:4000', 'localhost_4000'],
+    ['https://localhost:5000', 'localhost_5000'],
+    ['http://www.acme.com:6000', 'www_acme_com_6000'],
+    ['https://www.acme.com:7000', 'www_acme_com_7000'],
+  ])('should convert url to host_port string: %s, %s', (given, expected) => {
+    expect(urlToDirectoryName(given)).toBe(expected);
+  });
+});

src/util/urlUtils.ts

@@ -33,3 +33,15 @@ export function getServerUrlAndPath(uri: vscode.Uri) {
     path,
   };
 }
+
+/**
+ * Converts url to `${hostname}_${port}` replacing `.` with `_`
+ * @param url The URL to convert
+ */
+export function urlToDirectoryName(url: string | URL): string {
+  if (typeof url === 'string') {
+    url = new URL(url);
+  }
+
+  return url.host.replace(/[:.]/g, '_');
+}