@sanity/runtime-cli 17.15.0-next.ge190195 → 17.16.0-app-functions.ge0a25ea

package/dist/utils/functions/child-runtime/durable.js

@@ -1,5 +1,6 @@
 import {performance} from 'node:perf_hooks'
 import {inspect} from 'node:util'
+import {createStepHistory} from './step-history.js'
 
 /**
  *
@@ -26,7 +27,9 @@ const formatArgs = (args) =>
  * @param io
  */
 export async function runDurable(handler, {context, event}, io) {
+  const history = createStepHistory()
   let currentStep = null
+
   const streamLog = (level, args) => {
     const date = new Date()
     const timestamp = `${date.toLocaleDateString()} ${date.toLocaleTimeString()}`
@@ -41,7 +44,6 @@ export async function runDurable(handler, {context, event}, io) {
     })
   }
 
-  // @todo: need to throw error for use of `console.log` in a durable function
   const logger = {
     log: (...a) => streamLog('info', a),
     info: (...a) => streamLog('info', a),
@@ -49,24 +51,57 @@ export async function runDurable(handler, {context, event}, io) {
     error: (...a) => streamLog('error', a),
   }
 
-  const track = async (name, kind, produce) => {
-    io.emit({name, kind, phase: 'start'})
-    const startedAt = performance.now()
+  const emitFailure = (pending) => {
+    history.settle(pending)
+    io.emit(pending.event)
+  }
+
+  const settleUnretried = () => {
+    const pending = history.getPending()
+    if (pending !== null) {
+      emitFailure(pending)
+    }
+  }
+
+  const track = async (name, kind, produce, retry) => {
+    settleUnretried()
+    const {index, saved} = history.nextStep()
+
+    if (saved?.phase === 'complete') {
+      return saved.output
+    }
+
+    const maxAttempts = retry?.maxAttempts ?? 1
+    const retries = Math.max((retry?.maxAttempts ?? 1) - 1, 0)
+    const waitingOnRetry = typeof saved?.retryDelayMs === 'number'
+
+    if (saved?.phase === 'error' && !waitingOnRetry) {
+      throw saved.output
+    }
+
+    const attempt = (saved?.attempt ?? 0) + 1
     const prev = currentStep
     currentStep = name
 
+    io.emit({name, kind, phase: 'start'})
+    const startedAt = performance.now()
+
     try {
-      const value = await produce()
-      io.emit({
+      const value = await produce(attempt)
+      const completeEvent = {
         name,
         kind,
         phase: 'complete',
         output: value,
         durationMs: performance.now() - startedAt,
-      })
+      }
+
+      history.recordSuccess(index, completeEvent)
+      io.emit(completeEvent)
+
       return value
     } catch (err) {
-      io.emit({
+      const errorEvent = {
         name,
         kind,
         phase: 'error',
@@ -76,7 +111,21 @@ export async function runDurable(handler, {context, event}, io) {
           stack: err?.stack ?? '',
         },
         durationMs: performance.now() - startedAt,
+        attempt,
+        retries,
+        maxAttempts,
+      }
+
+      const retryPending = history.recordFailure(index, {
+        event: errorEvent,
+        error: err,
+        delayMs: retry?.delay ? durationToMs(retry.delay) : 0,
       })
+
+      if (!retryPending) {
+        io.emit(errorEvent)
+      }
+
       throw err
     } finally {
       currentStep = prev
@@ -84,12 +133,21 @@ export async function runDurable(handler, {context, event}, io) {
   }
 
   const step = {
-    run: ({name, handler: fn}) => track(name || '', 'run', () => fn({logger, attempt: 1})),
-    wait: ({name, duration}) =>
-      track(name || '', 'wait', async () => {
-        await io.wait(durationToMs(duration))
-        return undefined
-      }),
+    run: ({name, handler: fn, retry}) =>
+      track(name || '', 'run', (attempt) => fn({logger, attempt}), retry),
+    delegate: ({name, handler, event, retry}) =>
+      track(
+        name || '',
+        'delegate',
+        () => {
+          const fn = typeof handler === 'string' ? handler : handler?.name
+          if (!fn) {
+            throw new Error('No function name provided for delegation')
+          }
+          return io.invoke(fn, event?.data ?? {})
+        },
+        retry,
+      ),
     waitForCondition: ({name, initial, poller, next}) =>
       track(name || '', 'wait-for-condition', async () => {
         let state = initial
@@ -107,15 +165,34 @@ export async function runDurable(handler, {context, event}, io) {
         }
         return state
       }),
-    delegate: ({name, handler, event}) =>
-      track(name || '', 'delegate', () => {
-        const fn = typeof handler === 'string' ? handler : handler?.name
-        if (!fn) {
-          throw new Error('No function name provided for delegation')
-        }
-        return io.invoke(fn, event)
+    wait: ({name, duration}) =>
+      track(name || '', 'wait', async () => {
+        await io.wait(durationToMs(duration))
+        return undefined
       }),
   }
 
-  return handler({context, event, step, logger})
+  let result
+  let done = false
+  while (!done) {
+    history.startRun()
+    try {
+      result = await handler({context, event, step, logger})
+      settleUnretried()
+      done = true
+    } catch (err) {
+      const pending = history.getPending()
+      if (pending === null) {
+        throw err
+      }
+      if (err?.name === 'UnrecoverableError') {
+        emitFailure(pending)
+        throw err
+      }
+      io.emit({...pending.event, retryDelayMs: pending.delayMs})
+      await io.wait(pending.delayMs)
+    }
+  }
+
+  return result
 }

package/dist/utils/functions/child-runtime/step-history.d.ts

@@ -0,0 +1,15 @@
+import type {DurableStepEvent} from './types'
+
+type PendingRetry = {index: number; event: DurableStepEvent; delayMs: number}
+
+export function createStepHistory(): {
+  startRun: () => void
+  nextStep: () => {index: number; saved: DurableStepEvent | undefined}
+  recordSuccess: (index: number, event: DurableStepEvent) => void
+  recordFailure: (
+    index: number,
+    failure: {event: DurableStepEvent; error: unknown; delayMs: number},
+  ) => boolean
+  getPending: () => PendingRetry | null
+  settle: (pending: PendingRetry) => void
+}

package/dist/utils/functions/child-runtime/step-history.js

@@ -0,0 +1,52 @@
+const createStepHistory = () => {
+  const history = new Map([])
+  let cursor = 0
+  let pending = null
+
+  const startRun = () => {
+    cursor = 0
+  }
+
+  const nextStep = () => {
+    const index = cursor
+    cursor++
+    return {index, saved: history.get(index)}
+  }
+
+  const recordSuccess = (index, event) => {
+    history.set(index, event)
+  }
+
+  const recordFailure = (index, {event, error, delayMs}) => {
+    const retryable = event.attempt <= event.retries && error?.name !== 'UnrecoverableError'
+
+    if (retryable) {
+      history.set(index, {...event, output: error, retryDelayMs: delayMs})
+      pending = {index, event, delayMs}
+    } else {
+      history.set(index, {...event, output: error})
+    }
+    return retryable
+  }
+
+  const getPending = () => {
+    const item = pending
+    pending = null
+    return item
+  }
+
+  const settle = ({index, event}) => {
+    history.set(index, {...event, output: history.get(index).output})
+  }
+
+  return {
+    startRun,
+    nextStep,
+    recordSuccess,
+    recordFailure,
+    getPending,
+    settle,
+  }
+}
+
+export {createStepHistory}

package/dist/utils/functions/invoke/local.js

@@ -64,10 +64,11 @@ export default async function invoke(resource, payload, context, options) {
     // Apply the GROQ rule before preparing a build so a filtered-out event skips
     // the (potentially expensive) transpile entirely.
     if (isGroqInvocation(resource)) {
-        if (!isGroqContextOptions(context)) {
+        if (!('clientOptions' in context)) {
             throw new Error('GROQ-based functions require a context with clientOptions');
         }
-        const { projectId, dataset } = context.clientOptions;
+        const projectId = 'projectId' in context.clientOptions ? context.clientOptions.projectId : undefined;
+        const dataset = 'dataset' in context.clientOptions ? context.clientOptions.dataset : undefined;
         if ('before' in payload) {
             filteredData = await applyGroqRule(resource, payload, projectId, dataset);
             const filter = resource.event && 'filter' in resource.event ? resource.event.filter : '';
@@ -173,12 +174,22 @@ export default async function invoke(resource, payload, context, options) {
                 // of `nested.error`. The error isn't lost: it travels back in the returned
                 // result and is logged/streamed to the UI by the caller (app/test core).
                 if (child && !child.killed) {
-                    const response = {
-                        type: 'invoke-response',
-                        id,
-                        ok: true,
-                        result: { json: nested.json },
-                    };
+                    // step.delegate errors need to be surfaced to the caller for retry behavior and for the durable step to be marked as failed.
+                    const origin = metadata?.origin || undefined;
+                    const error = nested.error || undefined;
+                    const response = origin === 'step.delegate' && error
+                        ? {
+                            type: 'invoke-response',
+                            id,
+                            ok: false,
+                            error,
+                        }
+                        : {
+                            type: 'invoke-response',
+                            id,
+                            ok: true,
+                            result: { json: nested.json },
+                        };
                     child.send(JSON.stringify(response));
                 }
             }

package/dist/utils/functions/invoke/resolve-invoke-type.d.ts

@@ -1,6 +1,6 @@
 import type { BlueprintResource } from '@sanity/blueprints';
 import type { Logger } from '../../logger.js';
-import type { EventType, FunctionGroqResource, FunctionResource, FunctionTestFlags, InvokeContextOptions, InvokePayloadOptions } from '../../types.js';
+import type { EventType, FunctionGroqResource, FunctionResource, FunctionTestFlags, InvokeContextOptions, InvokePayloadOptions, ResolvedResource } from '../../types.js';
 import buildPayload from '../build-payload.js';
 import { fetchAsset, fetchDocument } from '../fetch-document.js';
 export type InvocationPlan = {
@@ -23,7 +23,7 @@ export type InputContext = {
     apiHost: string;
     token?: string;
     withUserToken?: boolean;
-    resources: BlueprintResource[];
+    resolvedResources: ResolvedResource<BlueprintResource>[];
     blueprintFileDir: string;
     log: Logger;
 };

package/dist/utils/functions/invoke/resolve-invoke-type.js

@@ -51,7 +51,7 @@ export const buildContext = (plan, input) => {
     if (plan.kind === 'plain') {
         return {
             clientOptions: { ...withToken },
-            resources: input.resources,
+            resources: input.resolvedResources,
             blueprintFileDir: input.blueprintFileDir,
         };
     }
@@ -69,7 +69,7 @@ export const buildContext = (plan, input) => {
             '',
         functionResourceType: 'project',
         functionResourceId: input.projectId || '',
-        resources: input.resources,
+        resources: input.resolvedResources,
         blueprintFileDir: input.blueprintFileDir,
     };
 };

package/dist/utils/functions/transpile/function.d.ts

@@ -1,10 +1,16 @@
+import type { Plugin } from 'vite';
 import type { FunctionResource, InstallerType } from '../../types.js';
 export declare const resolveViteRoot: (entry: string) => string;
-export declare function transpileFunction({ resource, functionPath, entryPoint, installer, }: {
+export declare function transpileFunction({ resource, functionPath, entryPoint, installer, workDir, outDir, outputFileName, bundle: bundleDependencies, plugins: extraPlugins, }: {
     resource: FunctionResource;
     functionPath: string;
     entryPoint: string;
     installer?: InstallerType;
+    workDir?: string;
+    outDir?: string;
+    outputFileName?: string;
+    bundle?: boolean;
+    plugins?: Plugin[];
 }): Promise<{
     type: string;
     outputDir: string;

package/dist/utils/functions/transpile/function.js

@@ -13,7 +13,7 @@ export const resolveViteRoot = (entry) => {
     const nodeModulesDir = find.dir('node_modules', { cwd: entry });
     return nodeModulesDir ? path.dirname(nodeModulesDir) : entry;
 };
-export async function transpileFunction({ resource, functionPath, entryPoint, installer, }) {
+export async function transpileFunction({ resource, functionPath, entryPoint, installer, workDir = cwd(), outDir, outputFileName = getOutputFilename(entryPoint), bundle: bundleDependencies, plugins: extraPlugins = [], }) {
     if (!resource.src)
         throw new Error('Resource src is required');
     if (!resource.name)
@@ -23,8 +23,8 @@ export async function transpileFunction({ resource, functionPath, entryPoint, in
     const stats = await stat(functionPath);
     const entryDir = stats.isFile() ? path.dirname(functionPath) : functionPath;
     const outputPathStart = performance.now();
-    const outputDir = await getTranspileOutputPath(entryDir, resource.name);
-    const outputFile = path.join(outputDir, getOutputFilename(entryPoint));
+    const outputDir = await getTranspileOutputPath(entryDir, resource.name, outDir);
+    const outputFile = path.join(outputDir, outputFileName);
     const fnRootDir = resolveViteRoot(entryDir);
     timings['transpile:setupOutput'] = performance.now() - outputPathStart;
     async function cleanupTmpDir() {
@@ -34,7 +34,8 @@ export async function transpileFunction({ resource, functionPath, entryPoint, in
     try {
         const viteStart = performance.now();
         // Always bundle the code if pnpm usage is detected or specified by the user
-        const bundle = !!find.file('pnpm-workspace.yaml') || installer === 'pnpm';
+        const bundle = bundleDependencies ??
+            (!!find.file('pnpm-workspace.yaml', { cwd: workDir }) || installer === 'pnpm');
         const result = await viteBuild({
             root: fnRootDir,
             logLevel: 'silent',
@@ -49,7 +50,7 @@ export async function transpileFunction({ resource, functionPath, entryPoint, in
                     input: entryPoint,
                     output: {
                         format: 'esm',
-                        entryFileNames: getOutputFilename(entryPoint),
+                        entryFileNames: outputFileName,
                         ...(bundle
                             ? {}
                             : {
@@ -71,7 +72,10 @@ export async function transpileFunction({ resource, functionPath, entryPoint, in
                     conditions: ['node'],
                 },
             },
-            plugins: bundle ? [detectNativeModulesPlugin(), pnpmResolvePlugin(cwd())] : [],
+            plugins: [
+                ...(bundle ? [detectNativeModulesPlugin(), pnpmResolvePlugin(workDir)] : []),
+                ...extraPlugins,
+            ],
         });
         timings['transpile:build'] = performance.now() - viteStart;
         const verifyStart = performance.now();
@@ -81,7 +85,7 @@ export async function transpileFunction({ resource, functionPath, entryPoint, in
         await writeTranspiledPackageJson(entryDir, outputFile);
         timings['transpile:writePackage'] = performance.now() - pkgStart;
         const cleanupStart = performance.now();
-        await cleanupSourceMaps(functionPath, outputDir);
+        await cleanupSourceMaps(entryDir, outputDir);
         timings['transpile:cleanupMaps'] = performance.now() - cleanupStart;
         timings.bundle = performance.now() - transpileStart;
         return {
@@ -148,8 +152,10 @@ async function writeTranspiledPackageJson(inputDir, outputFilePath) {
     const pkgJsonOutputPath = path.join(path.dirname(outputFilePath), 'package.json');
     await writeFile(pkgJsonOutputPath, JSON.stringify(bundled, null, 2));
 }
-async function getTranspileOutputPath(entryDir, fnName) {
-    const tmpPath = path.resolve(entryDir, '.build', `function-${fnName}`);
+async function getTranspileOutputPath(entryDir, fnName, outDir) {
+    const tmpPath = outDir
+        ? path.resolve(outDir)
+        : path.resolve(entryDir, '.build', `function-${fnName}`);
     await rm(tmpPath, { recursive: true, force: true }).catch(logCleanupFailure);
     await mkdir(tmpPath, { recursive: true });
     return tmpPath;

package/dist/utils/types.d.ts

@@ -40,6 +40,11 @@ export interface BlueprintResourceRecord extends BlueprintResource {
 export interface DeployedResource extends BlueprintResourceRecord {
     externalId: string;
 }
+/** Wrap a resource and its externalId if it has one. */
+export interface ResolvedResource<R extends BlueprintResource> {
+    resource: R;
+    externalId?: string;
+}
 export declare function isLocalFunctionResource(r: BlueprintResource): r is FunctionResource;
 export declare function hasEventSource(r: FunctionResource): r is EventFunctionResource;
 export declare function isScheduleEvent(e: unknown): e is BlueprintScheduledFunctionResource['event'];
@@ -134,8 +139,14 @@ export type InvokePayloadMetadata = Pick<InvokeGroqPayloadOptions, 'event' | 'be
 export type EventType = 'create' | 'update' | 'delete';
 export type NonGroqEventType = 'plain' | 'nested' | 'durable';
 export declare function isEventType(arg: string): arg is EventType;
+interface BaseContextOptions {
+    /** All resources declared by the blueprint, used to populate `context.resources` at invoke time. */
+    resources?: ResolvedResource<BlueprintResource>[];
+    /** The directory where the blueprint manifest is located. */
+    blueprintFileDir: string;
+}
 /** @internal */
-export interface InvokeGroqContextOptions {
+export interface InvokeGroqContextOptions extends BaseContextOptions {
     clientOptions: {
         apiVersion?: string;
         dataset?: string;
@@ -151,20 +162,12 @@ export interface InvokeGroqContextOptions {
     functionResourceType: string;
     /** The resource ID of the function container; resource ID that houses the function. */
     functionResourceId: string;
-    /** All resources declared by the blueprint, used to populate `context.resources` at invoke time. */
-    resources?: BlueprintResource[];
-    /** The directory where the blueprint manifest is located. */
-    blueprintFileDir: string;
 }
 /** @internal */
-export interface InvokeScheduleContextOptions {
+export interface InvokeScheduleContextOptions extends BaseContextOptions {
     clientOptions: {
         token?: string;
     };
-    /** All resources declared by the blueprint, used to populate `context.resources` at invoke time. */
-    resources?: BlueprintResource[];
-    /** The directory where the blueprint manifest is located. */
-    blueprintFileDir: string;
 }
 export type InvokeContextOptions = InvokeGroqContextOptions | InvokeScheduleContextOptions;
 export declare function isGroqContextOptions(context: InvokeContextOptions): context is InvokeGroqContextOptions;
@@ -338,7 +341,7 @@ export type AssetPrepResult = {
     error: string;
 };
 export type PrepAssetFn<R extends BlueprintResource> = (options: {
-    resource: R;
+    resolvedResource: ResolvedResource<R>;
     blueprintFileDir: string;
     installer?: InstallerType;
 }) => Promise<AssetPrepResult>;
@@ -355,7 +358,7 @@ export type PreDeployConfig = {
     prepareResource?: PrepResourceFn<BlueprintResource>;
 };
 export type AssetResource<R extends BlueprintResource> = {
-    resource: R;
+    resource: ResolvedResource<R>;
     prepareAsset: PrepAssetFn<R>;
 };
 export type Warning = {
@@ -376,6 +379,10 @@ export interface DurableStepEvent {
     output?: unknown;
     error?: InvocationError;
     durationMs?: number;
+    retryDelayMs?: number;
+    attempt?: number;
+    retries?: number;
+    maxAttempts?: number;
 }
 export interface DurableLogEvent {
     kind: 'log';

package/dist/utils/types.js

@@ -38,7 +38,7 @@ export function isEventType(arg) {
     return ['create', 'update', 'delete'].includes(arg);
 }
 export function isGroqContextOptions(context) {
-    return 'clientOptions' in context;
+    return 'eventResourceType' in context;
 }
 /** @internal */
 export var BlueprintParserErrorType;

package/oclif.manifest.json

@@ -3148,5 +3148,5 @@
       ]
     }
   },
-  "version": "17.15.0-next.ge190195"
+  "version": "17.16.0-app-functions.ge0a25ea"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sanity/runtime-cli",
   "description": "Sanity's Runtime CLI for Blueprints and Functions",
-  "version": "17.15.0-next.ge190195",
+  "version": "17.16.0-app-functions.ge0a25ea",
   "author": "Sanity Runtime Team",
   "type": "module",
   "license": "MIT",
@@ -14,6 +14,26 @@
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "exports": {
+    "./functions/stack": {
+      "types": "./dist/functions/stack.d.ts",
+      "import": "./dist/functions/stack.js",
+      "require": "./dist/functions/stack.js"
+    },
+    "./functions/contracts": {
+      "types": "./dist/functions/contracts.d.ts",
+      "import": "./dist/functions/contracts.js",
+      "require": "./dist/functions/contracts.js"
+    },
+    "./functions/deploy": {
+      "types": "./dist/functions/deploy.d.ts",
+      "import": "./dist/functions/deploy.js",
+      "require": "./dist/functions/deploy.js"
+    },
+    "./functions/build": {
+      "types": "./dist/functions/build.d.ts",
+      "import": "./dist/functions/build.js",
+      "require": "./dist/functions/build.js"
+    },
     ".": {
       "types": "./dist/index.d.ts",
       "import": "./dist/index.js",
@@ -86,6 +106,7 @@
     "strip-ansi": "^7.2.0",
     "tar-fs": "^3.1.3",
     "tar-stream": "^3.2.1",
+    "typescript-compiler": "npm:typescript@^6.0.3",
     "vite": "^8.3.0",
     "ws": "^8.21.3",
     "xdg-basedir": "^5.1.0"
@@ -100,7 +121,7 @@
     "@oclif/test": "^4.2.0",
     "@playwright/test": "^1.63.0",
     "@sanity-labs/design-tokens": "^0.0.2-alpha.2",
-    "@sanity/functions": "^1.7.2",
+    "@sanity/functions": "^1.8.1",
     "@types/cardinal": "^2.1.1",
     "@types/mime-types": "^3.0.1",
     "@types/node": "^22",