poku 4.3.2 → 4.3.3-canary.2648bb03

package/README.md

@@ -168,7 +168,7 @@ deno run npm:poku
     <td>🌐 Run package.json scripts and files in background</td>
   </tr>
   <tr>
-    <td><a href="https://poku.io/docs/documentation/helpers/containers">docker</a></td>
+    <td><a href="https://poku.io/docs/documentation/plugins/official/containers">docker</a></td>
     <td>🐳 Build, start, compose, stop, remove, and test containers</td>
   </tr>
   <tr>
@@ -197,7 +197,7 @@ deno run npm:poku
 
 <table>
   <tr>
-    <td><a href="https://poku.io/docs/documentation/helpers/coverage">coverage</a></td>
+    <td><a href="https://poku.io/docs/documentation/plugins/official/coverage">coverage</a></td>
     <td>☔️ Enable coverage collection using a coverage plugin</td>
   </tr>
   <tr>

package/lib/modules/_shared.cjs

@@ -243,6 +243,20 @@ ${preIdentation}  ${format(`${options?.expected ?? "Expected"}:`).dim()}`
     const indent = getIndent();
     log$1(`${indent}${format(`\u25CF ${message}`).cyan().bold()}`);
   },
+  onRetryStart({ attempt, total }) {
+    const indent = indentation.test.repeat(
+      indentation.describeDepth + indentation.itDepth
+    );
+    log$1(`${indent}${format(`\u21BB Retry ${attempt}/${total}`).dim()}`);
+  },
+  onRetryEnd({ attempt, success }) {
+    if (success && attempt > 1) {
+      const indent = indentation.test.repeat(
+        indentation.describeDepth + indentation.itDepth
+      );
+      log$1(`${indent}${format("\u2714 Retry succeeded").success().dim()}`);
+    }
+  },
   onFileResult({ status, path, duration, output }) {
     process$1.stdout.write(`
 `), status ? (log$1(
@@ -264,15 +278,14 @@ ${preIdentation}  ${format(`${options?.expected ?? "Expected"}:`).dim()}`
         `${format(String(errors.length)).fail().bold()} ${format("test file(s) failed:").bold()}
 `
       );
-      for (const i in errors)
-        if (Object.prototype.hasOwnProperty.call(errors, i)) {
-          const { file, output } = errors[i], index = +i;
-          index > 0 && process$1.stdout.write(`
+      for (const i in errors) {
+        const { file, output } = errors[i], index = +i;
+        index > 0 && process$1.stdout.write(`
 `), log$1(
-            `${format(`${index + 1})`).dim().bold()} ${format(file).underline()}`
-          ), output && log$1(`
+          `${format(`${index + 1})`).dim().bold()} ${format(file).underline()}`
+        ), output && log$1(`
 ${output}`);
-        }
+      }
     }
   },
   onExit({ results: results2, timespan: timespan2 }) {
@@ -356,6 +369,10 @@ ${message}
     },
     onTodoModifier() {
     },
+    onRetryStart() {
+    },
+    onRetryEnd() {
+    },
     onFileResult({ status, path, output }) {
       log$1(`${status ? BADGE_PASS : BADGE_FAIL} ${path.relative}`), status || (countFails++, errors.push({
         file: path.relative,
@@ -378,6 +395,10 @@ ${message}
   },
   onSkipFile() {
   },
+  onRetryStart() {
+  },
+  onRetryEnd() {
+  },
   onFileResult({ path, status, output }) {
     process$1.stdout.write(status ? DOT_PASS : DOT_FAIL), status || errors.push({
       file: path.relative,
@@ -401,6 +422,10 @@ ${message}
     },
     onSkipFile() {
     },
+    onRetryStart() {
+    },
+    onRetryEnd() {
+    },
     onFileResult({ status, output }) {
       status || (countFails++, output && log$1(output));
     },
@@ -425,7 +450,7 @@ const states = getSharedState("states", {
 }), errorHoist = getSharedState("errorHoist", {
   depth: 0,
   failed: !1
-}), VERSION = "4.3.2", deepOptions = getSharedState("deepOptions", []), GLOBAL = getSharedState("GLOBAL", {
+}), VERSION = "4.3.3-canary.2648bb03", deepOptions = getSharedState("deepOptions", []), GLOBAL = getSharedState("GLOBAL", {
   cwd: cwd$1,
   configs: {
     filter: void 0,
@@ -679,11 +704,14 @@ const poku = (async (targetPaths, configs) => {
     for (const plugin2 of plugins)
       plugin2.teardown && await plugin2.teardown(pluginContext);
   if (GLOBAL.configs.noExit) return code;
+}), retryContext = getSharedState("retryContext", {
+  stack: null
 }), assertProcessor = () => {
   const { reporter: reporter2 } = GLOBAL, handleSuccess = ({ message }) => {
     typeof message == "string" && reporter2.onAssertionSuccess({ message });
   }, handleError = (error, options) => {
-    throw process$1.exitCode = 1, error instanceof nodeAssert.AssertionError && reporter2.onAssertionFailure({ assertOptions: options, error }), error;
+    const ctx = retryContext.stack?.[retryContext.stack.length - 1];
+    throw ctx ? ctx.failed = !0 : process$1.exitCode = 1, error instanceof nodeAssert.AssertionError && reporter2.onAssertionFailure({ assertOptions: options, error }), error;
   };
   return { processAssert: (cb, options) => {
     try {
@@ -854,7 +882,8 @@ const poku = (async (targetPaths, configs) => {
     const insideDescribe = errorHoist.depth > 0;
     let onError;
     insideDescribe ? errorHoist.failed = !1 : (onError = (error) => {
-      process$1.exitCode = 1, success = !1, error instanceof nodeAssert.AssertionError || console.error(error);
+      const ctx = retryContext.stack?.[retryContext.stack.length - 1];
+      ctx ? ctx.failed = !0 : (process$1.exitCode = 1, success = !1, error instanceof nodeAssert.AssertionError || console.error(error));
     }, process$1.once("uncaughtException", onError), process$1.once("unhandledRejection", onError)), start = process$1.hrtime();
     try {
       const hooks = getScopeHook();
@@ -866,9 +895,15 @@ const poku = (async (targetPaths, configs) => {
         resultCb instanceof Promise && await resultCb;
       }
     } catch (error) {
-      process$1.exitCode = 1, success = !1, error instanceof nodeAssert.AssertionError || console.error(error);
+      const ctx = retryContext.stack?.[retryContext.stack.length - 1];
+      ctx ? ctx.failed = !0 : (process$1.exitCode = 1, success = !1, error instanceof nodeAssert.AssertionError || console.error(error));
     } finally {
-      end = process$1.hrtime(start), onError ? (process$1.removeListener("uncaughtException", onError), process$1.removeListener("unhandledRejection", onError)) : errorHoist.failed && (success = !1, errorHoist.failed = !1);
+      if (end = process$1.hrtime(start), onError)
+        process$1.removeListener("uncaughtException", onError), process$1.removeListener("unhandledRejection", onError);
+      else if (errorHoist.failed) {
+        const ctx = retryContext.stack?.[retryContext.stack.length - 1];
+        ctx ? ctx.failed = !0 : success = !1, errorHoist.failed = !1;
+      }
     }
     if (typeof each.after.cb == "function") {
       const afterResult = each.after.cb();
@@ -907,7 +942,10 @@ const poku = (async (targetPaths, configs) => {
   } catch (error) {
     onError(error);
   } finally {
-    end = process$1.hrtime(start), process$1.removeListener("uncaughtException", onError), process$1.removeListener("unhandledRejection", onError), errorHoist.depth--, process$1.exitCode !== initialExitCode && (success = !1);
+    if (end = process$1.hrtime(start), process$1.removeListener("uncaughtException", onError), process$1.removeListener("unhandledRejection", onError), errorHoist.depth--, process$1.exitCode !== initialExitCode && (success = !1), !success) {
+      const ctx = retryContext.stack?.[retryContext.stack.length - 1];
+      ctx && (ctx.failed = !0);
+    }
   }
   if (!title) return;
   const duration = end[0] * 1e3 + end[1] / 1e6;
@@ -985,7 +1023,36 @@ const poku = (async (targetPaths, configs) => {
   each.after.status = !0;
 }, reset: () => {
   each.after.cb = void 0;
-} }), regex = {
+} });
+async function retry(config, callback) {
+  const attempts = typeof config == "number" ? config : config.attempts, delay = typeof config == "number" ? 0 : config.delay ?? 0;
+  retryContext.stack || (retryContext.stack = []);
+  const stack = retryContext.stack;
+  for (let attempt = 1; attempt <= attempts; attempt++) {
+    const context = {
+      attempts,
+      currentAttempt: attempt,
+      delay,
+      failed: !1
+    };
+    stack.push(context), GLOBAL.reporter.onRetryStart?.({ attempt, total: attempts });
+    try {
+      const result = callback();
+      if (result instanceof Promise && await result, !context.failed) {
+        stack.pop(), GLOBAL.reporter.onRetryEnd?.({
+          attempt,
+          total: attempts,
+          success: !0
+        }), stack.length === 0 && (retryContext.stack = null);
+        return;
+      }
+    } catch {
+    }
+    stack.pop(), GLOBAL.reporter.onRetryEnd?.({ attempt, total: attempts, success: !1 }), attempt < attempts && delay > 0 && await new Promise((resolve) => setTimeout(resolve, delay));
+  }
+  stack.length === 0 && (retryContext.stack = null), process.exitCode = 1;
+}
+const regex = {
   sequentialSpaces: /\s+/
 }, setPortsAndPIDs = (portOrPID) => Array.isArray(portOrPID) ? portOrPID : [portOrPID].map((p) => Number(p)).filter((p) => !Number.isNaN(p)), populateRange = (startsAt, endsAt) => {
   const first = Number(startsAt), last = Number(endsAt);
@@ -1206,6 +1273,7 @@ exports.onSigint = onSigint;
 exports.parserOutput = parserOutput;
 exports.poku = poku;
 exports.reporter = reporter;
+exports.retry = retry;
 exports.runner = runner;
 exports.skip = skip;
 exports.sleep = sleep;

package/lib/modules/_shared.d.cts

@@ -151,6 +151,15 @@ type ReporterPlugin = (configs?: Configs) => {
     onTodoModifier: (options: {
         message: string;
     }) => void;
+    onRetryStart: (options: {
+        attempt: number;
+        total: number;
+    }) => void;
+    onRetryEnd: (options: {
+        attempt: number;
+        total: number;
+        success: boolean;
+    }) => void;
     onFileStart: (options: {
         path: Path;
     }) => void;

package/lib/modules/_shared.d.ts

@@ -151,6 +151,15 @@ type ReporterPlugin = (configs?: Configs) => {
     onTodoModifier: (options: {
         message: string;
     }) => void;
+    onRetryStart: (options: {
+        attempt: number;
+        total: number;
+    }) => void;
+    onRetryEnd: (options: {
+        attempt: number;
+        total: number;
+        success: boolean;
+    }) => void;
     onFileStart: (options: {
         path: Path;
     }) => void;

package/lib/modules/_shared.js

@@ -237,6 +237,20 @@ ${preIdentation}  ${format(`${options?.expected ?? "Expected"}:`).dim()}`
     const indent = getIndent();
     log$1(`${indent}${format(`\u25CF ${message}`).cyan().bold()}`);
   },
+  onRetryStart({ attempt, total }) {
+    const indent = indentation.test.repeat(
+      indentation.describeDepth + indentation.itDepth
+    );
+    log$1(`${indent}${format(`\u21BB Retry ${attempt}/${total}`).dim()}`);
+  },
+  onRetryEnd({ attempt, success }) {
+    if (success && attempt > 1) {
+      const indent = indentation.test.repeat(
+        indentation.describeDepth + indentation.itDepth
+      );
+      log$1(`${indent}${format("\u2714 Retry succeeded").success().dim()}`);
+    }
+  },
   onFileResult({ status, path, duration, output }) {
     stdout.write(`
 `), status ? (log$1(
@@ -258,15 +272,14 @@ ${preIdentation}  ${format(`${options?.expected ?? "Expected"}:`).dim()}`
         `${format(String(errors.length)).fail().bold()} ${format("test file(s) failed:").bold()}
 `
       );
-      for (const i in errors)
-        if (Object.prototype.hasOwnProperty.call(errors, i)) {
-          const { file, output } = errors[i], index = +i;
-          index > 0 && stdout.write(`
+      for (const i in errors) {
+        const { file, output } = errors[i], index = +i;
+        index > 0 && stdout.write(`
 `), log$1(
-            `${format(`${index + 1})`).dim().bold()} ${format(file).underline()}`
-          ), output && log$1(`
+          `${format(`${index + 1})`).dim().bold()} ${format(file).underline()}`
+        ), output && log$1(`
 ${output}`);
-        }
+      }
     }
   },
   onExit({ results: results2, timespan: timespan2 }) {
@@ -350,6 +363,10 @@ ${message}
     },
     onTodoModifier() {
     },
+    onRetryStart() {
+    },
+    onRetryEnd() {
+    },
     onFileResult({ status, path, output }) {
       log$1(`${status ? BADGE_PASS : BADGE_FAIL} ${path.relative}`), status || (countFails++, errors.push({
         file: path.relative,
@@ -372,6 +389,10 @@ ${message}
   },
   onSkipFile() {
   },
+  onRetryStart() {
+  },
+  onRetryEnd() {
+  },
   onFileResult({ path, status, output }) {
     stdout.write(status ? DOT_PASS : DOT_FAIL), status || errors.push({
       file: path.relative,
@@ -395,6 +416,10 @@ ${message}
     },
     onSkipFile() {
     },
+    onRetryStart() {
+    },
+    onRetryEnd() {
+    },
     onFileResult({ status, output }) {
       status || (countFails++, output && log$1(output));
     },
@@ -419,7 +444,7 @@ const states = getSharedState("states", {
 }), errorHoist = getSharedState("errorHoist", {
   depth: 0,
   failed: !1
-}), VERSION = "4.3.2", deepOptions = getSharedState("deepOptions", []), GLOBAL = getSharedState("GLOBAL", {
+}), VERSION = "4.3.3-canary.2648bb03", deepOptions = getSharedState("deepOptions", []), GLOBAL = getSharedState("GLOBAL", {
   cwd: cwd$1,
   configs: {
     filter: void 0,
@@ -687,11 +712,14 @@ const poku = (async (targetPaths, configs) => {
     for (const plugin2 of plugins)
       plugin2.teardown && await plugin2.teardown(pluginContext);
   if (GLOBAL.configs.noExit) return code;
+}), retryContext = getSharedState("retryContext", {
+  stack: null
 }), assertProcessor = () => {
   const { reporter: reporter2 } = GLOBAL, handleSuccess = ({ message }) => {
     typeof message == "string" && reporter2.onAssertionSuccess({ message });
   }, handleError = (error, options) => {
-    throw process$1.exitCode = 1, error instanceof AssertionError && reporter2.onAssertionFailure({ assertOptions: options, error }), error;
+    const ctx = retryContext.stack?.[retryContext.stack.length - 1];
+    throw ctx ? ctx.failed = !0 : process$1.exitCode = 1, error instanceof AssertionError && reporter2.onAssertionFailure({ assertOptions: options, error }), error;
   };
   return { processAssert: (cb, options) => {
     try {
@@ -862,7 +890,8 @@ const poku = (async (targetPaths, configs) => {
     const insideDescribe = errorHoist.depth > 0;
     let onError;
     insideDescribe ? errorHoist.failed = !1 : (onError = (error) => {
-      process$1.exitCode = 1, success = !1, error instanceof AssertionError || console.error(error);
+      const ctx = retryContext.stack?.[retryContext.stack.length - 1];
+      ctx ? ctx.failed = !0 : (process$1.exitCode = 1, success = !1, error instanceof AssertionError || console.error(error));
     }, process$1.once("uncaughtException", onError), process$1.once("unhandledRejection", onError)), start = process$1.hrtime();
     try {
       const hooks = getScopeHook();
@@ -874,9 +903,15 @@ const poku = (async (targetPaths, configs) => {
         resultCb instanceof Promise && await resultCb;
       }
     } catch (error) {
-      process$1.exitCode = 1, success = !1, error instanceof AssertionError || console.error(error);
+      const ctx = retryContext.stack?.[retryContext.stack.length - 1];
+      ctx ? ctx.failed = !0 : (process$1.exitCode = 1, success = !1, error instanceof AssertionError || console.error(error));
     } finally {
-      end = process$1.hrtime(start), onError ? (process$1.removeListener("uncaughtException", onError), process$1.removeListener("unhandledRejection", onError)) : errorHoist.failed && (success = !1, errorHoist.failed = !1);
+      if (end = process$1.hrtime(start), onError)
+        process$1.removeListener("uncaughtException", onError), process$1.removeListener("unhandledRejection", onError);
+      else if (errorHoist.failed) {
+        const ctx = retryContext.stack?.[retryContext.stack.length - 1];
+        ctx ? ctx.failed = !0 : success = !1, errorHoist.failed = !1;
+      }
     }
     if (typeof each.after.cb == "function") {
       const afterResult = each.after.cb();
@@ -915,7 +950,10 @@ const poku = (async (targetPaths, configs) => {
   } catch (error) {
     onError(error);
   } finally {
-    end = process$1.hrtime(start), process$1.removeListener("uncaughtException", onError), process$1.removeListener("unhandledRejection", onError), errorHoist.depth--, process$1.exitCode !== initialExitCode && (success = !1);
+    if (end = process$1.hrtime(start), process$1.removeListener("uncaughtException", onError), process$1.removeListener("unhandledRejection", onError), errorHoist.depth--, process$1.exitCode !== initialExitCode && (success = !1), !success) {
+      const ctx = retryContext.stack?.[retryContext.stack.length - 1];
+      ctx && (ctx.failed = !0);
+    }
   }
   if (!title) return;
   const duration = end[0] * 1e3 + end[1] / 1e6;
@@ -993,7 +1031,36 @@ const poku = (async (targetPaths, configs) => {
   each.after.status = !0;
 }, reset: () => {
   each.after.cb = void 0;
-} }), regex = {
+} });
+async function retry(config, callback) {
+  const attempts = typeof config == "number" ? config : config.attempts, delay = typeof config == "number" ? 0 : config.delay ?? 0;
+  retryContext.stack || (retryContext.stack = []);
+  const stack = retryContext.stack;
+  for (let attempt = 1; attempt <= attempts; attempt++) {
+    const context = {
+      attempts,
+      currentAttempt: attempt,
+      delay,
+      failed: !1
+    };
+    stack.push(context), GLOBAL.reporter.onRetryStart?.({ attempt, total: attempts });
+    try {
+      const result = callback();
+      if (result instanceof Promise && await result, !context.failed) {
+        stack.pop(), GLOBAL.reporter.onRetryEnd?.({
+          attempt,
+          total: attempts,
+          success: !0
+        }), stack.length === 0 && (retryContext.stack = null);
+        return;
+      }
+    } catch {
+    }
+    stack.pop(), GLOBAL.reporter.onRetryEnd?.({ attempt, total: attempts, success: !1 }), attempt < attempts && delay > 0 && await new Promise((resolve2) => setTimeout(resolve2, delay));
+  }
+  stack.length === 0 && (retryContext.stack = null), process.exitCode = 1;
+}
+const regex = {
   sequentialSpaces: /\s+/
 }, setPortsAndPIDs = (portOrPID) => Array.isArray(portOrPID) ? portOrPID : [portOrPID].map((p) => Number(p)).filter((p) => !Number.isNaN(p)), populateRange = (startsAt, endsAt) => {
   const first = Number(startsAt), last = Number(endsAt);
@@ -1228,6 +1295,7 @@ export {
   poku,
   reporter,
   results,
+  retry,
   runner,
   skip,
   sleep,

package/lib/modules/index.cjs

@@ -14,6 +14,7 @@ exports.kill = _shared.kill;
 exports.listFiles = _shared.listFiles;
 exports.log = _shared.log;
 exports.poku = _shared.poku;
+exports.retry = _shared.retry;
 exports.skip = _shared.skip;
 exports.sleep = _shared.sleep;
 exports.startScript = _shared.startScript;

package/lib/modules/index.d.cts

@@ -131,6 +131,13 @@ declare const beforeEach: (callback: () => unknown, options?: EachOptions) => Co
  */
 declare const afterEach: (callback: () => unknown) => Control;
 
+type RetryConfig = {
+    attempts: number;
+    delay?: number;
+};
+
+declare function retry(config: number | RetryConfig, callback: () => unknown | Promise<unknown>): Promise<void>;
+
 type Runner = 'npm' | 'bun' | 'deno' | 'yarn' | 'pnpm';
 
 type BackgroundProcessOptions = {
@@ -250,5 +257,5 @@ declare const listFiles: (targetDir: string, configs?: Configs) => Promise<strin
 /** 🐷 Auxiliary function to define the `poku` configurations */
 declare const defineConfig: (options: ConfigFile) => ConfigFile;
 
-export { Code, ConfigFile, Configs as ListFilesConfigs, afterEach, assert, beforeEach, defineConfig, describe, envFile, exit, getPIDs, it, kill, listFiles, log, skip, sleep, startScript, startService, strict, test, waitForExpectedResult, waitForPort };
-export type { StartScriptOptions, StartServiceOptions, WaitForExpectedResultOptions, WaitForPortOptions };
+export { Code, ConfigFile, Configs as ListFilesConfigs, afterEach, assert, beforeEach, defineConfig, describe, envFile, exit, getPIDs, it, kill, listFiles, log, retry, skip, sleep, startScript, startService, strict, test, waitForExpectedResult, waitForPort };
+export type { RetryConfig, StartScriptOptions, StartServiceOptions, WaitForExpectedResultOptions, WaitForPortOptions };

package/lib/modules/index.d.ts

@@ -131,6 +131,13 @@ declare const beforeEach: (callback: () => unknown, options?: EachOptions) => Co
  */
 declare const afterEach: (callback: () => unknown) => Control;
 
+type RetryConfig = {
+    attempts: number;
+    delay?: number;
+};
+
+declare function retry(config: number | RetryConfig, callback: () => unknown | Promise<unknown>): Promise<void>;
+
 type Runner = 'npm' | 'bun' | 'deno' | 'yarn' | 'pnpm';
 
 type BackgroundProcessOptions = {
@@ -250,5 +257,5 @@ declare const listFiles: (targetDir: string, configs?: Configs) => Promise<strin
 /** 🐷 Auxiliary function to define the `poku` configurations */
 declare const defineConfig: (options: ConfigFile) => ConfigFile;
 
-export { Code, ConfigFile, Configs as ListFilesConfigs, afterEach, assert, beforeEach, defineConfig, describe, envFile, exit, getPIDs, it, kill, listFiles, log, skip, sleep, startScript, startService, strict, test, waitForExpectedResult, waitForPort };
-export type { StartScriptOptions, StartServiceOptions, WaitForExpectedResultOptions, WaitForPortOptions };
+export { Code, ConfigFile, Configs as ListFilesConfigs, afterEach, assert, beforeEach, defineConfig, describe, envFile, exit, getPIDs, it, kill, listFiles, log, retry, skip, sleep, startScript, startService, strict, test, waitForExpectedResult, waitForPort };
+export type { RetryConfig, StartScriptOptions, StartServiceOptions, WaitForExpectedResultOptions, WaitForPortOptions };

package/lib/modules/index.js

@@ -1,4 +1,4 @@
-import { afterEach$1, assert, beforeEach$1, describe, envFile, exit, getPIDs, it, kill, listFiles, log, poku, skip, sleep, startScript, startService, strict, test, VERSION, waitForExpectedResult, waitForPort } from "./_shared.js";
+import { afterEach$1, assert, beforeEach$1, describe, envFile, exit, getPIDs, it, kill, listFiles, log, poku, retry, skip, sleep, startScript, startService, strict, test, VERSION, waitForExpectedResult, waitForPort } from "./_shared.js";
 import "node:path";
 import "node:process";
 import "node:os";
@@ -22,6 +22,7 @@ export {
   listFiles,
   log,
   poku,
+  retry,
   skip,
   sleep,
   startScript,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "poku",
-  "version": "4.3.2",
+  "version": "4.3.3-canary.2648bb03",
   "description": "🐷 Poku makes testing easy for Node.js, Bun, Deno, and you at the same time.",
   "license": "MIT",
   "type": "module",
@@ -52,7 +52,7 @@
     "build": "bash scripts/build.sh",
     "lint": "bash scripts/lint.sh",
     "lint:fix": "bash scripts/lint-fix.sh",
-    "lint:types": "bash scripts/lint-types.sh",
+    "typecheck": "bash scripts/typecheck.sh",
     "update": "bash scripts/update.sh",
     "benchmark": "npm --prefix benchmark start"
   },