@bgord/bun 1.2.1 → 1.2.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bgord/bun",
-  "version": "1.2.1",
+  "version": "1.2.2",
   "license": "MIT",
   "type": "module",
   "author": "Bartosz Gordon",
@@ -20,7 +20,7 @@
     "preinstall": "bunx only-allow bun"
   },
   "devDependencies": {
-    "@biomejs/biome": "2.3.3",
+    "@biomejs/biome": "2.3.4",
     "@commitlint/cli": "20.1.0",
     "@commitlint/config-conventional": "20.0.0",
     "@types/bun": "1.3.1",
@@ -28,7 +28,7 @@
     "@types/mime-types": "3.0.1",
     "@types/nodemailer": "7.0.3",
     "@types/yazl": "3.3.0",
-    "cspell": "9.2.2",
+    "cspell": "9.3.0",
     "knip": "5.67.1",
     "lefthook": "2.0.2",
     "only-allow": "1.2.1",

package/readme.md

@@ -188,6 +188,7 @@ src/
 │   ├── mailer.ts
 │   ├── memory.ts
 │   ├── node.ts
+│   ├── os.ts
 │   ├── outside-connectivity.ts
 │   ├── port.ts
 │   ├── ram.ts

package/src/prerequisites/external-api.ts

@@ -1,19 +1,27 @@
 import * as tools from "@bgord/tools";
 import type { ClockPort } from "../clock.port";
 import * as prereqs from "../prerequisites.service";
+import { Timeout } from "../timeout.service";
 
 export class PrerequisiteExternalApi implements prereqs.Prerequisite {
   readonly kind = "external-api";
   readonly label: prereqs.PrerequisiteLabelType;
   readonly enabled?: boolean = true;
 
-  private readonly request: () => Promise<Response>;
+  private readonly request: (signal: AbortSignal) => Promise<Response>;
+  readonly timeout: tools.Duration;
 
-  constructor(config: prereqs.PrerequisiteConfigType & { request: () => Promise<Response> }) {
+  constructor(
+    config: prereqs.PrerequisiteConfigType & {
+      request: (signal: AbortSignal) => Promise<Response>;
+      timeout?: tools.Duration;
+    },
+  ) {
     this.label = config.label;
     this.enabled = config.enabled === undefined ? true : config.enabled;
 
     this.request = config.request;
+    this.timeout = config.timeout ?? tools.Duration.Seconds(2);
   }
 
   async verify(clock: ClockPort): Promise<prereqs.VerifyOutcome> {
@@ -22,7 +30,7 @@ export class PrerequisiteExternalApi implements prereqs.Prerequisite {
     if (!this.enabled) return prereqs.Verification.undetermined(stopwatch.stop());
 
     try {
-      const response = await this.request();
+      const response = await Timeout.cancellable((signal: AbortSignal) => this.request(signal), this.timeout);
 
       if (response.ok) return prereqs.Verification.success(stopwatch.stop());
       return prereqs.Verification.failure(stopwatch.stop(), { message: `HTTP ${response.status}` });

package/src/prerequisites/index.ts

@@ -9,6 +9,7 @@ export * from "./log-file";
 export * from "./mailer";
 export * from "./memory";
 export * from "./node";
+export * from "./os";
 export * from "./outside-connectivity";
 export * from "./port";
 export * from "./ram";

package/src/prerequisites/os.ts

@@ -0,0 +1,33 @@
+import os from "node:os";
+import * as tools from "@bgord/tools";
+import type { ClockPort } from "../clock.port";
+import * as prereqs from "../prerequisites.service";
+
+export class PrerequisiteOs implements prereqs.Prerequisite {
+  readonly kind = "os";
+  readonly label: prereqs.PrerequisiteLabelType;
+  readonly enabled?: boolean = true;
+
+  private readonly accepted: string[];
+
+  constructor(config: prereqs.PrerequisiteConfigType & { accepted: string[] }) {
+    this.label = config.label;
+    this.enabled = config.enabled === undefined ? true : config.enabled;
+    this.accepted = config.accepted;
+  }
+
+  async verify(clock: ClockPort): Promise<prereqs.VerifyOutcome> {
+    const stopwatch = new tools.Stopwatch(clock.now());
+
+    if (!this.enabled) return prereqs.Verification.undetermined(stopwatch.stop());
+
+    const type = os.type();
+
+    if (this.accepted.map((type) => type.toLowerCase()).includes(type.toLowerCase())) {
+      return prereqs.Verification.success(stopwatch.stop());
+    }
+    return prereqs.Verification.failure(stopwatch.stop(), {
+      message: `Unacceptable os: ${this.accepted.join(", ")}`,
+    });
+  }
+}