@travetto/model-file 7.1.4 → 8.0.0-alpha.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/model-file",
-  "version": "7.1.4",
+  "version": "8.0.0-alpha.1",
   "type": "module",
   "description": "File system backing for the travetto model module.",
   "keywords": [
@@ -26,14 +26,14 @@
     "directory": "module/model-file"
   },
   "dependencies": {
-    "@travetto/config": "^7.1.4",
-    "@travetto/di": "^7.1.4",
-    "@travetto/model": "^7.1.4",
-    "@travetto/schema": "^7.1.4"
+    "@travetto/config": "^8.0.0-alpha.1",
+    "@travetto/di": "^8.0.0-alpha.1",
+    "@travetto/model": "^8.0.0-alpha.1",
+    "@travetto/schema": "^8.0.0-alpha.1"
   },
   "peerDependencies": {
-    "@travetto/cli": "^7.1.4",
-    "@travetto/test": "^7.1.4"
+    "@travetto/cli": "^8.0.0-alpha.1",
+    "@travetto/test": "^8.0.0-alpha.1"
   },
   "peerDependenciesMeta": {
     "@travetto/cli": {

package/src/service.ts

@@ -1,17 +1,18 @@
 import fs from 'node:fs/promises';
 import { createReadStream, createWriteStream } from 'node:fs';
 import os from 'node:os';
-import { pipeline } from 'node:stream/promises';
 import path from 'node:path';
 
-import { type Class, type TimeSpan, Runtime, type BlobMeta, type ByteRange, type BinaryInput, BinaryUtil, JSONUtil } from '@travetto/runtime';
-import { Injectable } from '@travetto/di';
+import {
+  type Class, type TimeSpan, Runtime, type BinaryMetadata, type ByteRange, type BinaryType,
+  BinaryUtil, JSONUtil, BinaryMetadataUtil
+} from '@travetto/runtime';
+import { Injectable, PostConstruct } from '@travetto/di';
 import { Config } from '@travetto/config';
 import { Required } from '@travetto/schema';
 import {
   type ModelCrudSupport, type ModelExpirySupport, type ModelStorageSupport, type ModelType, ModelRegistryIndex,
-  NotFoundError, type OptionalId, ExistsError, type ModelBlobSupport,
-  ModelCrudUtil, ModelExpiryUtil, ModelBlobUtil
+  NotFoundError, type OptionalId, ExistsError, type ModelBlobSupport, ModelCrudUtil, ModelExpiryUtil
 } from '@travetto/model';
 
 type Suffix = '.bin' | '.meta' | '.json' | '.expires';
@@ -29,7 +30,8 @@ export class FileModelConfig {
   modifyStorage?: boolean;
   cullRate?: number | TimeSpan;
 
-  async postConstruct(): Promise<void> {
+  @PostConstruct()
+  async finalizeConfig(): Promise<void> {
     this.folder ??= path.resolve(os.tmpdir(), `trv_file_${Runtime.main.name.replace(/[^a-z]/ig, '_')}`);
   }
 }
@@ -89,7 +91,8 @@ export class FileModelService implements ModelCrudSupport, ModelBlobSupport, Mod
     return file;
   }
 
-  postConstruct(): void {
+  @PostConstruct()
+  initializeClient(): void {
     ModelExpiryUtil.registerCull(this);
   }
 
@@ -138,7 +141,7 @@ export class FileModelService implements ModelCrudSupport, ModelBlobSupport, Mod
     const prepped = await ModelCrudUtil.preStore(cls, item, this);
 
     const file = await this.#resolveName(cls, '.json', item.id);
-    await fs.writeFile(file, JSON.stringify(item), { encoding: 'utf8' });
+    await fs.writeFile(file, BinaryUtil.binaryArrayToUint8Array(JSONUtil.toBinaryArray(item)));
 
     return prepped;
   }
@@ -148,7 +151,7 @@ export class FileModelService implements ModelCrudSupport, ModelBlobSupport, Mod
     const id = item.id;
     const full = await ModelCrudUtil.naivePartialUpdate(cls, () => this.get(cls, id), item, view);
     const file = await this.#resolveName(cls, '.json', full.id);
-    await fs.writeFile(file, JSON.stringify(full), { encoding: 'utf8' });
+    await fs.writeFile(file, BinaryUtil.binaryArrayToUint8Array(JSONUtil.toBinaryArray(full)));
     return full;
   }
 
@@ -170,30 +173,31 @@ export class FileModelService implements ModelCrudSupport, ModelBlobSupport, Mod
   }
 
   // Blob
-  async upsertBlob(location: string, input: BinaryInput, meta?: BlobMeta, overwrite = true): Promise<void> {
-    if (!overwrite && await this.getBlobMeta(location).then(() => true, () => false)) {
+  async upsertBlob(location: string, input: BinaryType, metadata?: BinaryMetadata, overwrite = true): Promise<void> {
+    if (!overwrite && await this.getBlobMetadata(location).then(() => true, () => false)) {
       return;
     }
-
-    const [stream, blobMeta] = await ModelBlobUtil.getInput(input, meta);
+    const resolved = await BinaryMetadataUtil.compute(input, metadata);
     const file = await this.#resolveName(ModelBlobNamespace, BIN, location);
     await Promise.all([
-      await pipeline(stream, createWriteStream(file)),
-      fs.writeFile(file.replace(BIN, META), JSON.stringify(blobMeta), 'utf8')
+      BinaryUtil.pipeline(input, createWriteStream(file)),
+      BinaryUtil.pipeline(
+        JSONUtil.toBinaryArray(resolved),
+        createWriteStream(file.replace(BIN, META)))
     ]);
   }
 
   async getBlob(location: string, range?: ByteRange): Promise<Blob> {
     const file = await this.#find(ModelBlobNamespace, BIN, location);
-    const meta = await this.getBlobMeta(location);
-    const final = range ? ModelBlobUtil.enforceRange(range, meta.size!) : undefined;
-    return BinaryUtil.readableBlob(() => createReadStream(file, { ...range }), { ...meta, range: final });
+    const metadata = await this.getBlobMetadata(location);
+    const final = range ? BinaryMetadataUtil.enforceRange(range, metadata) : undefined;
+    return BinaryMetadataUtil.makeBlob(() => createReadStream(file, final), { ...metadata, range: final });
   }
 
-  async getBlobMeta(location: string): Promise<BlobMeta> {
+  async getBlobMetadata(location: string): Promise<BinaryMetadata> {
     const file = await this.#find(ModelBlobNamespace, META, location);
     const content = await fs.readFile(file);
-    const text: BlobMeta = JSONUtil.parseSafe(content.toString('utf8'));
+    const text: BinaryMetadata = JSONUtil.fromBinaryArray(content);
     return text;
   }
 
@@ -209,9 +213,9 @@ export class FileModelService implements ModelCrudSupport, ModelBlobSupport, Mod
     }
   }
 
-  async updateBlobMeta(location: string, meta: BlobMeta): Promise<void> {
+  async updateBlobMetadata(location: string, metadata: BinaryMetadata): Promise<void> {
     const file = await this.#find(ModelBlobNamespace, META, location);
-    await fs.writeFile(file, JSON.stringify(meta));
+    await BinaryUtil.pipeline(JSONUtil.toBinaryArray(metadata), createWriteStream(file));
   }
 
   // Expiry