@helmr/sdk 0.1.1-rc.3 → 0.1.1-rc.4

package/dist/compile.d.ts

@@ -5,5 +5,5 @@ export interface CompileOptions {
     readonly modulePath: string;
     readonly exportName?: string;
 }
-export declare const IMAGE_FORMAT_VERSION = 1;
+export declare const IMAGE_FORMAT_VERSION = 0;
 export declare function compile(opts: CompileOptions): Bundle;

package/dist/compile.js

@@ -97,8 +97,8 @@ function hasBrand(value, brand) {
 }
 
 // sdk/typescript/src/compile.ts
-var IMAGE_FORMAT_VERSION = 1;
-var IMAGE_KEY_DOMAIN = `helmr.image.v1
+var IMAGE_FORMAT_VERSION = 0;
+var IMAGE_KEY_DOMAIN = `helmr.image.v0
 `;
 function compile(opts) {
   const task = opts.task;

package/dist/config.d.ts

@@ -1,6 +1,6 @@
 import { type HelmrConfig } from "./internal.js";
 export interface HelmrConfigInput {
-    readonly project?: string;
+    readonly project: string;
     readonly dirs: readonly string[];
     readonly ignorePatterns?: readonly string[];
 }

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { ApprovalTimeoutError, ConcurrentWaitError, MessageTimeoutError, validateSecretName, type CacheBuilder, type CacheMount, type CacheMountBinding, type EmitContent, type EmitEvent, type ImageBuilder, type ImageRunOptions, type Placement, type SandboxBuilder, type SecretDecls, type SecretMountBinding, type SourceCapabilities, type SourceDirRef, type SourceDirectoryOptions, type SourceFileRef, type TaskContext, type TaskOutput, type TaskPayload, type WorkspaceCapabilities, type WorkspaceSpec } from "./internal.js";
+import { ApprovalTimeoutError, ConcurrentWaitError, MessageTimeoutError, validateSecretName, type CacheBuilder, type CacheMount, type CacheMountBinding, type EmitContent, type EmitEvent, type ImageBuilder, type ImageRunOptions, type Placement, type SandboxBuilder, type SecretDecls, type SecretMountBinding, type SourceCapabilities, type SourceDirRef, type SourceDirectoryOptions, type SourceFileRef, type TaskContext, type TaskSource, type TaskWorkspace, type GitHubRefKind, type GitHubPullRequestMetadata, type GitHubTaskSource, type TaskOutput, type TaskPayload, type WorkspaceCapabilities, type WorkspaceSpec } from "./internal.js";
 import { HelmrClient } from "./runtime/client.js";
 export type { WaitpointResponseToken, WaitpointTokenAction, WaitpointTokenCompleteOptions, WaitpointTokenCreateOptions, } from "./runtime/client.js";
 import { sandbox } from "./sandbox.js";
@@ -31,4 +31,4 @@ export declare const runs: {
     };
 };
 export declare const waitpoints: import("./runtime/client.js").WaitpointsApi;
-export type { CacheBuilder, CacheMount, CacheMountBinding, EmitContent, EmitEvent, ImageBuilder, ImageRunOptions, SandboxBuilder, SecretMountBinding, SourceCapabilities, SourceDirRef, SourceDirectoryOptions, SourceFileRef, WorkspaceCapabilities, WorkspaceSpec, TaskContext, };
+export type { CacheBuilder, CacheMount, CacheMountBinding, EmitContent, EmitEvent, ImageBuilder, ImageRunOptions, SandboxBuilder, SecretMountBinding, SourceCapabilities, SourceDirRef, SourceDirectoryOptions, SourceFileRef, WorkspaceCapabilities, WorkspaceSpec, TaskContext, TaskSource, TaskWorkspace, GitHubRefKind, GitHubPullRequestMetadata, GitHubTaskSource, };

package/dist/index.js

@@ -192,7 +192,7 @@ function stackFrameFile(line) {
   return match[1].startsWith("file://") ? decodeURIComponent(new URL(match[1]).pathname) : match[1];
 }
 function isSdkInternalFrame(file) {
-  return file.includes("/sdk/typescript/src/internal.ts") || file.includes("/sdk/typescript/src/task.ts") || file.includes("/sdk/typescript/src/index.ts") || file.includes("/runtime/typescript/src/");
+  return file.includes("/sdk/typescript/src/internal") || file.includes("/sdk/typescript/src/task") || file.includes("/sdk/typescript/src/index") || file.includes("/runtime/typescript/src/");
 }
 
 class ImageBuilderImpl {
@@ -412,6 +412,8 @@ function runWorkspaceFromSpec(spec) {
 }
 
 // sdk/typescript/src/runtime/client.ts
+var MAX_SSE_BUFFER_CHARS = 1024 * 1024;
+
 class HelmrClient {
   #baseUrl;
   #apiKey;
@@ -471,16 +473,21 @@ class HelmrClient {
       const timeoutMs = opts.timeoutMs;
       const intervalMs = opts.intervalMs ?? 1000;
       const started = Date.now();
-      for (;; ) {
-        throwIfAborted(opts.signal);
-        const run = await this.runs.retrieve(id, retrieveOptions(opts.signal));
-        if (isTerminalRunStatus(run.status)) {
-          return run;
-        }
-        if (timeoutMs !== undefined && Date.now() - started > timeoutMs) {
-          throw new TimeoutError(`run ${id} did not finish within ${timeoutMs}ms`);
+      const wait = waitSignal(opts.signal, timeoutMs, () => new TimeoutError(`run ${id} did not finish within ${timeoutMs}ms`));
+      try {
+        for (;; ) {
+          throwIfAborted(wait.signal);
+          const run = await this.runs.retrieve(id, retrieveOptions(wait.signal));
+          if (isTerminalRunStatus(run.status)) {
+            return run;
+          }
+          if (timeoutMs !== undefined && Date.now() - started > timeoutMs) {
+            throw new TimeoutError(`run ${id} did not finish within ${timeoutMs}ms`);
+          }
+          await delay(intervalMs, wait.signal);
         }
-        await delay(intervalMs, opts.signal);
+      } finally {
+        wait.cleanup();
       }
     },
     list: async (opts = {}) => {
@@ -730,6 +737,28 @@ function retrieveOptions(signal) {
 function requestSignal(signal) {
   return signal === undefined ? {} : { signal };
 }
+function waitSignal(signal, timeoutMs, timeoutError) {
+  if (timeoutMs === undefined) {
+    return { signal, cleanup: () => {} };
+  }
+  const controller = new AbortController;
+  const abortFromParent = () => {
+    controller.abort(signal?.reason);
+  };
+  if (signal?.aborted === true) {
+    abortFromParent();
+  } else {
+    signal?.addEventListener("abort", abortFromParent, { once: true });
+  }
+  const timeout = setTimeout(() => controller.abort(timeoutError()), timeoutMs);
+  return {
+    signal: controller.signal,
+    cleanup: () => {
+      clearTimeout(timeout);
+      signal?.removeEventListener("abort", abortFromParent);
+    }
+  };
+}
 function throwIfAborted(signal) {
   if (signal?.aborted !== true)
     return;
@@ -763,30 +792,46 @@ async function* parseSse(response) {
   }
   const decoder = new TextDecoder;
   let buffer = "";
-  for (;; ) {
-    const { value, done } = await reader.read();
-    if (done) {
-      return;
-    }
-    buffer += decoder.decode(value, { stream: true });
-    let boundary = findSseBoundary(buffer);
-    while (boundary !== -1) {
-      const delimiter = buffer.startsWith(`\r
+  try {
+    for (;; ) {
+      const { value, done } = await reader.read();
+      if (done) {
+        buffer += decoder.decode();
+        const finalEvent = parseSseFrame(buffer);
+        if (finalEvent !== undefined) {
+          yield finalEvent;
+        }
+        return;
+      }
+      buffer += decoder.decode(value, { stream: true });
+      let boundary = findSseBoundary(buffer);
+      while (boundary !== -1) {
+        const delimiter = buffer.startsWith(`\r
 \r
 `, boundary) ? 4 : 2;
-      const raw = buffer.slice(0, boundary);
-      buffer = buffer.slice(boundary + delimiter);
-      const data = raw.split(/\r?\n/).filter((line) => line.startsWith("data:")).map((line) => line.slice(5).trimStart()).join(`
-`);
-      if (data !== "") {
-        const event = runEventRecordToRunEvent(JSON.parse(data));
+        const raw = buffer.slice(0, boundary);
+        buffer = buffer.slice(boundary + delimiter);
+        const event = parseSseFrame(raw);
         if (event !== undefined) {
           yield event;
         }
+        boundary = findSseBoundary(buffer);
+      }
+      if (buffer.length > MAX_SSE_BUFFER_CHARS) {
+        throw new Error("SSE event exceeded the maximum buffer size");
       }
-      boundary = findSseBoundary(buffer);
     }
+  } finally {
+    reader.releaseLock();
+  }
+}
+function parseSseFrame(raw) {
+  const data = raw.split(/\r?\n/).filter((line) => line.startsWith("data:")).map((line) => line.slice(5).trimStart()).join(`
+`);
+  if (data === "") {
+    return;
   }
+  return runEventRecordToRunEvent(JSON.parse(data));
 }
 function findSseBoundary(buffer) {
   const lf = buffer.indexOf(`
@@ -951,20 +996,21 @@ function defineConfig(config) {
   if (config === null || typeof config !== "object") {
     throw new Error("defineConfig() requires an object");
   }
+  if (!("project" in config)) {
+    throw new Error("defineConfig({ project }) requires a non-empty string");
+  }
+  if (typeof config.project !== "string" || config.project.trim() === "") {
+    throw new Error("defineConfig({ project }) must be a non-empty string");
+  }
+  if (config.project.includes("\x00")) {
+    throw new Error("defineConfig({ project }) must not contain NUL");
+  }
   if (!("dirs" in config)) {
     throw new Error("defineConfig({ dirs }) requires a non-empty dirs array");
   }
   if (!Array.isArray(config.dirs) || config.dirs.length === 0) {
     throw new Error("defineConfig({ dirs }) requires a non-empty dirs array");
   }
-  if (config.project !== undefined) {
-    if (typeof config.project !== "string" || config.project.trim() === "") {
-      throw new Error("defineConfig({ project }) must be a non-empty string");
-    }
-    if (config.project.includes("\x00")) {
-      throw new Error("defineConfig({ project }) must not contain NUL");
-    }
-  }
   for (const dir of config.dirs) {
     if (typeof dir !== "string" || dir.trim() === "") {
       throw new Error("defineConfig({ dirs }) entries must be non-empty strings");
@@ -987,7 +1033,7 @@ function defineConfig(config) {
     }
   }
   return markConfig({
-    ...config.project === undefined ? {} : { project: config.project },
+    project: config.project,
     dirs: [...config.dirs],
     ...config.ignorePatterns === undefined ? {} : { ignorePatterns: [...config.ignorePatterns] }
   });

package/dist/internal.d.ts

@@ -19,6 +19,31 @@ export interface WorkspaceSpec {
     readonly ref: string;
     readonly subpath?: string;
 }
+export type GitHubRefKind = "branch" | "tag" | "sha" | "pull_request" | "unknown";
+export interface GitHubPullRequestMetadata {
+    readonly number: number;
+    readonly baseRef: string;
+    readonly baseSha: string;
+    readonly headRef: string;
+    readonly headSha: string;
+}
+export interface GitHubTaskSource {
+    readonly kind: "github";
+    readonly repository: string;
+    readonly requestedRef: string;
+    readonly resolvedSha: string;
+    readonly refKind?: GitHubRefKind;
+    readonly refName?: string;
+    readonly fullRef?: string;
+    readonly subpath?: string;
+    readonly defaultBranch?: string;
+    readonly pullRequest?: GitHubPullRequestMetadata;
+}
+export type TaskSource = GitHubTaskSource;
+export interface TaskWorkspace {
+    readonly path: string;
+    readonly projectPath: string;
+}
 export interface SourceFileRef {
     readonly path: string;
 }
@@ -91,6 +116,11 @@ export interface TaskContext {
     readonly run: {
         readonly id: string;
     };
+    readonly task: {
+        readonly id: string;
+    };
+    readonly source: TaskSource;
+    readonly workspace: TaskWorkspace;
 }
 export type EmitContent = {
     readonly type: "text";
@@ -193,7 +223,7 @@ export declare function isTaskDefinition(value: unknown): value is AnyTask & {
 };
 export declare function taskOriginFile(value: unknown): string | null;
 export interface HelmrConfig {
-    readonly project?: string;
+    readonly project: string;
     readonly dirs: readonly string[];
     readonly ignorePatterns?: readonly string[];
 }

package/dist/internal.js

@@ -205,7 +205,7 @@ function stackFrameFile(line) {
   return match[1].startsWith("file://") ? decodeURIComponent(new URL(match[1]).pathname) : match[1];
 }
 function isSdkInternalFrame(file) {
-  return file.includes("/sdk/typescript/src/internal.ts") || file.includes("/sdk/typescript/src/task.ts") || file.includes("/sdk/typescript/src/index.ts") || file.includes("/runtime/typescript/src/");
+  return file.includes("/sdk/typescript/src/internal") || file.includes("/sdk/typescript/src/task") || file.includes("/sdk/typescript/src/index") || file.includes("/runtime/typescript/src/");
 }
 
 class ImageBuilderImpl {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@helmr/sdk",
-  "version": "0.1.1-rc.3",
+  "version": "0.1.1-rc.4",
   "description": "TypeScript SDK for authoring and triggering Helmr tasks.",
   "type": "module",
   "license": "Apache-2.0",
@@ -43,6 +43,6 @@
   ],
   "dependencies": {
     "@bufbuild/protobuf": "^2.11.0",
-    "@helmr/proto": "0.1.1-rc.3"
+    "@helmr/proto": "0.1.1-rc.4"
   }
 }