Skip to Content
SDK & Pluginstest() APIControl Flow

Control Flow

These APIs help when real systems are asynchronous, environment-specific, or occasionally flaky.

Use this page for raw test() control flow. If the lifecycle is a durable API promise that should project into Specifications and agent context, model it with workflow() instead.

The examples assume a shared HTTP client:

import { configure, test } from "@glubean/sdk";
 
const { http: api } = configure({
  http: { prefixUrl: "{{BASE_URL}}" },
});

ctx.pollUntil()

Use pollUntil() when an action is eventually consistent and a fixed sleep would be wasteful or brittle.

export const asyncJob = test("async-job", async (ctx) => {
  const job = await api.post("jobs/export").json<{ id: string }>();
 
  await ctx.pollUntil({ timeoutMs: 30000, intervalMs: 2000 }, async () => {
    const status = await api.get(`jobs/${job.id}/status`).json<{ state: string }>();
    return status.state === "completed";
  });
 
  const file = await api.get(`jobs/${job.id}/download`);
  ctx.expect(file).toHaveStatus(200);
});

ctx.skip()

Use skip() when the current environment should not run a test.

export const betaFeature = test("beta-feature", async (ctx) => {
  if (ctx.vars.get("ENV") === "production") {
    ctx.skip("Beta features are not enabled in production");
  }
});

ctx.fail()

Use fail() when further execution would be misleading or dangerous.

export const checkAuth = test("auth-check", async (ctx) => {
  const res = await api.delete("admin/database", {
    throwHttpErrors: false,
  });
  if (res.status !== 403) {
    ctx.fail("CRITICAL: Unauthenticated request to delete database was not rejected!");
  }
  ctx.expect(res).toHaveStatus(403);
});

ctx.setTimeout()

Use setTimeout() when one test legitimately needs more time than the default 30s:

export const slowQuery = test("slow-query", async (ctx) => {
  ctx.setTimeout(60000);
  await api.get("analytics/heavy-report");
});

You can also set timeout via metadata:

export const slow = test({
  id: "slow-query",
  timeout: 60000,
}, async (ctx) => {
  await api.get("analytics/heavy-report");
});

Next

Last updated on
Shared StateLogs, Traces, Metrics