@btravstack/storage 0.14.0 → 0.15.0

package/dist/index.cjs

@@ -49,8 +49,6 @@ const memoryStorage = () => (0, _btravstack_di.Module)("MemoryStorage")({
 //#endregion
 //#region src/instrument.ts
 /**
-* One operation, handed to every observer the graph composed.
-*
 * **A missing object settles `ok` with `result: "not_found"`, not `error`.**
 * Asking for something that is not there is an ordinary answer, and a dashboard
 * that treats it as a fault teaches its readers to ignore the fault line.
@@ -59,53 +57,62 @@ const memoryStorage = () => (0, _btravstack_di.Module)("MemoryStorage")({
 * `reason`, so an operator is not left hunting an object sitting where they put
 * it.
 */
-const observed = (call, observers, operation, key) => {
-	const settle = (0, _btravstack_core.observe)(observers, {
-		component: "storage",
-		name: operation,
-		attributes: { operation },
-		details: { "btravstack.storage.key": key }
-	});
-	return call().tap(() => settle({
+const failed = (failure) => {
+	const cause = failure.tag === "Err" ? failure.error : failure.cause;
+	const ordinary = failure.tag !== "Err" ? void 0 : failure.error._tag === "ObjectNotFound" ? "the object was not there" : failure.error._tag === "PresignNotSupported" ? "this store cannot mint a url" : void 0;
+	return ordinary === void 0 ? {
+		outcome: "error",
+		attributes: { result: "error" },
+		cause
+	} : {
 		outcome: "ok",
-		attributes: { result: "ok" }
-	})).tapFailure((failure) => {
-		const cause = failure.tag === "Err" ? failure.error : failure.cause;
-		const ordinary = failure.tag !== "Err" ? void 0 : failure.error._tag === "ObjectNotFound" ? "the object was not there" : failure.error._tag === "PresignNotSupported" ? "this store cannot mint a url" : void 0;
-		settle(ordinary === void 0 ? {
-			outcome: "error",
-			attributes: { result: "error" },
-			cause
-		} : {
-			outcome: "ok",
-			attributes: {
-				result: "not_found",
-				reason: ordinary
-			}
-		});
-	});
+		attributes: {
+			result: "not_found",
+			reason: ordinary
+		}
+	};
 };
-const instrument = (backend, observers) => ({
-	put: (key, bytes, options) => observed(() => backend.put(key, bytes, options), observers, "put", key),
-	get: (key) => observed(() => backend.get(key), observers, "get", key),
-	delete: (key) => observed(() => backend.delete(key), observers, "delete", key),
-	presignedUrl: (key, options) => observed(() => backend.presignedUrl(key, options), observers, "presigned_url", key),
-	presignedUpload: (key, options) => observed(() => backend.presignedUpload(key, options), observers, "presigned_upload", key)
+/** The KEY is a detail, not a dimension: on the span and the line, never on an instrument. */
+const through = (observers) => (operation, key, call) => (0, _btravstack_core.observed)(observers, {
+	component: "storage",
+	name: operation,
+	attributes: { operation },
+	details: { "btravstack.storage.key": key }
+}, call, {
+	ok: () => ({
+		outcome: "ok",
+		attributes: { result: "ok" }
+	}),
+	failure: failed
 });
+/** Every operation handed to the observers the graph composed, transparent to the `Result`. */
+const instrument = (backend, observers) => {
+	const observe = through(observers);
+	return {
+		put: (key, bytes, options) => observe("put", key, () => backend.put(key, bytes, options)),
+		get: (key) => observe("get", key, () => backend.get(key)),
+		delete: (key) => observe("delete", key, () => backend.delete(key)),
+		presignedUrl: (key, options) => observe("presigned_url", key, () => backend.presignedUrl(key, options)),
+		presignedUpload: (key, options) => observe("presigned_upload", key, () => backend.presignedUpload(key, options))
+	};
+};
 //#endregion
 //#region src/module.ts
 /**
-* The storage starter: an adapter, and `Storage` provided from it —
-* instrumented or not, decided here at the composition root.
+* The storage starter: an adapter, and `Storage` provided from it.
 *
 * ```ts
-* storage({ adapter: s3Storage() });                      // spans, counts, log lines
-* storage({ adapter: s3Storage(), instrumented: false }); // just a store
+* storage({ adapter: s3Storage() });
 * ```
 *
 * **Two ports, because di allows one provider per port per graph**: the port an
-* application depends on must not be the one an adapter provides, which is also
-* why instrumentation is a flag on the composition rather than a wrapper.
+* application depends on must not be the one an adapter provides, which is what
+* lets this function be the seam.
+*
+* **There is no `instrumented` flag.** Every operation is handed to whatever
+* contributed to `Observers`; a graph that composed no observability has only
+* this module's own no-op member, so it costs one call per operation and nothing
+* else.
 */
 const storage = ({ adapter }) => {
 	const healthCheck = _btravstack_di.Provider.member(_btravstack_core.HealthChecks)({

package/dist/index.d.cts

@@ -30,17 +30,20 @@ type StorageOptions<E, N> = {
   readonly adapter: Module<StorageBackend, E, N>;
 };
 /**
- * The storage starter: an adapter, and `Storage` provided from it —
- * instrumented or not, decided here at the composition root.
+ * The storage starter: an adapter, and `Storage` provided from it.
  *
  * ```ts
- * storage({ adapter: s3Storage() });                      // spans, counts, log lines
- * storage({ adapter: s3Storage(), instrumented: false }); // just a store
+ * storage({ adapter: s3Storage() });
  * ```
  *
  * **Two ports, because di allows one provider per port per graph**: the port an
- * application depends on must not be the one an adapter provides, which is also
- * why instrumentation is a flag on the composition rather than a wrapper.
+ * application depends on must not be the one an adapter provides, which is what
+ * lets this function be the seam.
+ *
+ * **There is no `instrumented` flag.** Every operation is handed to whatever
+ * contributed to `Observers`; a graph that composed no observability has only
+ * this module's own no-op member, so it costs one call per operation and nothing
+ * else.
  */
 export declare const storage: <E, N>({ adapter }: StorageOptions<E, N>) => Module<Storage | HealthChecks, E, N>;
 //#endregion

package/dist/index.d.mts

@@ -30,17 +30,20 @@ type StorageOptions<E, N> = {
   readonly adapter: Module<StorageBackend, E, N>;
 };
 /**
- * The storage starter: an adapter, and `Storage` provided from it —
- * instrumented or not, decided here at the composition root.
+ * The storage starter: an adapter, and `Storage` provided from it.
  *
  * ```ts
- * storage({ adapter: s3Storage() });                      // spans, counts, log lines
- * storage({ adapter: s3Storage(), instrumented: false }); // just a store
+ * storage({ adapter: s3Storage() });
  * ```
  *
  * **Two ports, because di allows one provider per port per graph**: the port an
- * application depends on must not be the one an adapter provides, which is also
- * why instrumentation is a flag on the composition rather than a wrapper.
+ * application depends on must not be the one an adapter provides, which is what
+ * lets this function be the seam.
+ *
+ * **There is no `instrumented` flag.** Every operation is handed to whatever
+ * contributed to `Observers`; a graph that composed no observability has only
+ * this module's own no-op member, so it costs one call per operation and nothing
+ * else.
  */
 export declare const storage: <E, N>({ adapter }: StorageOptions<E, N>) => Module<Storage | HealthChecks, E, N>;
 //#endregion

package/dist/index.mjs

@@ -1,7 +1,7 @@
 import { a as StorageUnavailable, i as StorageBackend, n as PresignNotSupported, r as Storage, t as ObjectNotFound } from "./storage-CRkwIhac.mjs";
 import { Module, Provider } from "@btravstack/di";
 import { Err, ErrAsync, Ok, OkAsync, P } from "unthrown";
-import { HealthCheckFailed, HealthChecks, Observers, noObserver, observe } from "@btravstack/core";
+import { HealthCheckFailed, HealthChecks, Observers, noObserver, observed } from "@btravstack/core";
 //#region src/memory.ts
 /**
 * The in-process adapter: a `Map`, and an honest refusal to presign.
@@ -48,8 +48,6 @@ const memoryStorage = () => Module("MemoryStorage")({
 //#endregion
 //#region src/instrument.ts
 /**
-* One operation, handed to every observer the graph composed.
-*
 * **A missing object settles `ok` with `result: "not_found"`, not `error`.**
 * Asking for something that is not there is an ordinary answer, and a dashboard
 * that treats it as a fault teaches its readers to ignore the fault line.
@@ -58,53 +56,62 @@ const memoryStorage = () => Module("MemoryStorage")({
 * `reason`, so an operator is not left hunting an object sitting where they put
 * it.
 */
-const observed = (call, observers, operation, key) => {
-	const settle = observe(observers, {
-		component: "storage",
-		name: operation,
-		attributes: { operation },
-		details: { "btravstack.storage.key": key }
-	});
-	return call().tap(() => settle({
+const failed = (failure) => {
+	const cause = failure.tag === "Err" ? failure.error : failure.cause;
+	const ordinary = failure.tag !== "Err" ? void 0 : failure.error._tag === "ObjectNotFound" ? "the object was not there" : failure.error._tag === "PresignNotSupported" ? "this store cannot mint a url" : void 0;
+	return ordinary === void 0 ? {
+		outcome: "error",
+		attributes: { result: "error" },
+		cause
+	} : {
 		outcome: "ok",
-		attributes: { result: "ok" }
-	})).tapFailure((failure) => {
-		const cause = failure.tag === "Err" ? failure.error : failure.cause;
-		const ordinary = failure.tag !== "Err" ? void 0 : failure.error._tag === "ObjectNotFound" ? "the object was not there" : failure.error._tag === "PresignNotSupported" ? "this store cannot mint a url" : void 0;
-		settle(ordinary === void 0 ? {
-			outcome: "error",
-			attributes: { result: "error" },
-			cause
-		} : {
-			outcome: "ok",
-			attributes: {
-				result: "not_found",
-				reason: ordinary
-			}
-		});
-	});
+		attributes: {
+			result: "not_found",
+			reason: ordinary
+		}
+	};
 };
-const instrument = (backend, observers) => ({
-	put: (key, bytes, options) => observed(() => backend.put(key, bytes, options), observers, "put", key),
-	get: (key) => observed(() => backend.get(key), observers, "get", key),
-	delete: (key) => observed(() => backend.delete(key), observers, "delete", key),
-	presignedUrl: (key, options) => observed(() => backend.presignedUrl(key, options), observers, "presigned_url", key),
-	presignedUpload: (key, options) => observed(() => backend.presignedUpload(key, options), observers, "presigned_upload", key)
+/** The KEY is a detail, not a dimension: on the span and the line, never on an instrument. */
+const through = (observers) => (operation, key, call) => observed(observers, {
+	component: "storage",
+	name: operation,
+	attributes: { operation },
+	details: { "btravstack.storage.key": key }
+}, call, {
+	ok: () => ({
+		outcome: "ok",
+		attributes: { result: "ok" }
+	}),
+	failure: failed
 });
+/** Every operation handed to the observers the graph composed, transparent to the `Result`. */
+const instrument = (backend, observers) => {
+	const observe = through(observers);
+	return {
+		put: (key, bytes, options) => observe("put", key, () => backend.put(key, bytes, options)),
+		get: (key) => observe("get", key, () => backend.get(key)),
+		delete: (key) => observe("delete", key, () => backend.delete(key)),
+		presignedUrl: (key, options) => observe("presigned_url", key, () => backend.presignedUrl(key, options)),
+		presignedUpload: (key, options) => observe("presigned_upload", key, () => backend.presignedUpload(key, options))
+	};
+};
 //#endregion
 //#region src/module.ts
 /**
-* The storage starter: an adapter, and `Storage` provided from it —
-* instrumented or not, decided here at the composition root.
+* The storage starter: an adapter, and `Storage` provided from it.
 *
 * ```ts
-* storage({ adapter: s3Storage() });                      // spans, counts, log lines
-* storage({ adapter: s3Storage(), instrumented: false }); // just a store
+* storage({ adapter: s3Storage() });
 * ```
 *
 * **Two ports, because di allows one provider per port per graph**: the port an
-* application depends on must not be the one an adapter provides, which is also
-* why instrumentation is a flag on the composition rather than a wrapper.
+* application depends on must not be the one an adapter provides, which is what
+* lets this function be the seam.
+*
+* **There is no `instrumented` flag.** Every operation is handed to whatever
+* contributed to `Observers`; a graph that composed no observability has only
+* this module's own no-op member, so it costs one call per operation and nothing
+* else.
 */
 const storage = ({ adapter }) => {
 	const healthCheck = Provider.member(HealthChecks)({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@btravstack/storage",
-  "version": "0.14.0",
+  "version": "0.15.0",
   "description": "A Storage port for @btravstack/core: an in-memory adapter, an S3-compatible adapter with presigned reads, and a composition that spans, counts and logs every operation",
   "keywords": [
     "dependency-injection",
@@ -55,6 +55,11 @@
   "devDependencies": {
     "@aws-sdk/client-s3": "3.1127.0",
     "@aws-sdk/s3-request-presigner": "3.1127.0",
+    "@btravstack/config": "0.15.0",
+    "@btravstack/core": "0.15.0",
+    "@btravstack/di": "0.15.0",
+    "@btravstack/internal-test-infra": "0.0.0",
+    "@btravstack/observability": "0.15.0",
     "@btravstack/tsconfig": "0.4.0",
     "@opentelemetry/api": "1.9.1",
     "@opentelemetry/sdk-metrics": "2.11.0",
@@ -66,20 +71,15 @@
     "tsdown": "0.23.0",
     "typescript": "7.0.2",
     "unthrown": "5.8.0",
-    "vitest": "4.1.11",
-    "@btravstack/config": "0.14.0",
-    "@btravstack/core": "0.14.0",
-    "@btravstack/di": "0.14.0",
-    "@btravstack/internal-test-infra": "0.0.0",
-    "@btravstack/observability": "0.14.0"
+    "vitest": "4.1.11"
   },
   "peerDependencies": {
     "@aws-sdk/client-s3": "^3.1000.0",
     "@aws-sdk/s3-request-presigner": "^3.1000.0",
-    "unthrown": "^5.0.0",
-    "@btravstack/config": "^0.14.0",
-    "@btravstack/core": "^0.14.0",
-    "@btravstack/di": "^0.14.0"
+    "@btravstack/config": "^0.15.0",
+    "@btravstack/core": "^0.15.0",
+    "@btravstack/di": "^0.15.0",
+    "unthrown": "^5.0.0"
   },
   "peerDependenciesMeta": {
     "@aws-sdk/client-s3": {
@@ -96,7 +96,6 @@
     "build": "tsdown src/index.ts src/s3.ts --format cjs,esm --dts --clean",
     "dev": "tsdown src/index.ts src/s3.ts --format cjs,esm --dts --watch",
     "test": "vitest run --coverage",
-    "test:types": "tsc -p tsconfig.test-d.json --noEmit",
-    "typecheck": "tsc --noEmit"
+    "typecheck": "tsc --noEmit && tsc --noEmit -p tsconfig.test-d.json"
   }
 }