@travetto/model 5.0.0-rc.12 → 5.0.0-rc.13

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/model",
-  "version": "5.0.0-rc.12",
+  "version": "5.0.0-rc.13",
   "description": "Datastore abstraction for core operations.",
   "keywords": [
     "datastore",
@@ -26,14 +26,14 @@
     "directory": "module/model"
   },
   "dependencies": {
-    "@travetto/config": "^5.0.0-rc.12",
-    "@travetto/di": "^5.0.0-rc.11",
-    "@travetto/registry": "^5.0.0-rc.11",
-    "@travetto/schema": "^5.0.0-rc.12"
+    "@travetto/config": "^5.0.0-rc.13",
+    "@travetto/di": "^5.0.0-rc.12",
+    "@travetto/registry": "^5.0.0-rc.12",
+    "@travetto/schema": "^5.0.0-rc.13"
   },
   "peerDependencies": {
-    "@travetto/cli": "^5.0.0-rc.12",
-    "@travetto/test": "^5.0.0-rc.11"
+    "@travetto/cli": "^5.0.0-rc.13",
+    "@travetto/test": "^5.0.0-rc.12"
   },
   "peerDependenciesMeta": {
     "@travetto/cli": {

package/src/internal/service/blob.ts

@@ -1,5 +1,49 @@
-import { Class } from '@travetto/runtime';
+import { Class, AppError, BinaryInput, BinaryUtil, BlobMeta, ByteRange } from '@travetto/runtime';
 import { ModelType } from '../../types/model';
 
 export const ModelBlobNamespace = '__blobs';
-export const MODEL_BLOB: Class<ModelType> = class { id: string; };
+export const MODEL_BLOB: Class<ModelType> = class { id: string; };
+
+import { Readable } from 'node:stream';
+
+
+/**
+ * Utilities for processing assets
+ */
+export class ModelBlobUtil {
+
+  /**
+   * Convert input to a Readable, and get what metadata is available
+   */
+  static async getInput(src: BinaryInput, metadata: BlobMeta = {}): Promise<[Readable, BlobMeta]> {
+    let input: Readable;
+    if (src instanceof Blob) {
+      metadata = { ...BinaryUtil.getBlobMeta(src), ...metadata };
+      metadata.size ??= src.size;
+      input = Readable.fromWeb(src.stream());
+    } else if (typeof src === 'object' && 'pipeThrough' in src) {
+      input = Readable.fromWeb(src);
+    } else if (typeof src === 'object' && 'pipe' in src) {
+      input = src;
+    } else {
+      metadata.size = src.length;
+      input = Readable.from(src);
+    }
+
+    return [input, metadata ?? {}];
+  }
+
+  /**
+   * Enforce byte range for stream stream/file of a certain size
+   */
+  static enforceRange({ start, end }: ByteRange, size: number): Required<ByteRange> {
+    // End is inclusive
+    end = Math.min(end ?? (size - 1), size - 1);
+
+    if (Number.isNaN(start) || Number.isNaN(end) || !Number.isFinite(start) || start >= size || start < 0 || start > end) {
+      throw new AppError('Invalid position, out of range', 'data');
+    }
+
+    return { start, end };
+  }
+}

package/src/service/blob.ts

@@ -1,25 +1,20 @@
 import { BinaryInput, BlobMeta, ByteRange } from '@travetto/runtime';
 
 /**
- * Support for Blobs CRD.  Blob update is not supported.
+ * Support for Blobs CRUD.
  *
  * @concrete ../internal/service/common#ModelBlobSupportTarget
  */
 export interface ModelBlobSupport {
 
-  /**
-   * Insert blob to storage
-   * @param location The location of the blob
-   * @param input The actual blob to write
-   */
-  insertBlob(location: string, input: BinaryInput, meta?: BlobMeta, errorIfExisting?: boolean): Promise<void>;
-
   /**
    * Upsert blob to storage
    * @param location The location of the blob
    * @param input The actual blob to write
+   * @param meta Additional metadata to store with the blob
+   * @param overwrite Should we replace content if already found, defaults to true
    */
-  upsertBlob(location: string, input: BinaryInput, meta?: BlobMeta): Promise<void>;
+  upsertBlob(location: string, input: BinaryInput, meta?: BlobMeta, overwrite?: boolean): Promise<void>;
 
   /**
    * Get blob from storage

package/support/test/blob.ts

@@ -2,10 +2,12 @@ import assert from 'node:assert';
 
 import { Suite, Test, TestFixtures } from '@travetto/test';
 import { BaseModelSuite } from '@travetto/model/support/test/base';
-import { Util } from '@travetto/runtime';
+import { BinaryUtil, Util } from '@travetto/runtime';
 
 import { ModelBlobSupport } from '../../src/service/blob';
-import { ModelBlobUtil } from '../../src/util/blob';
+import { ModelBlobUtil } from '../../src/internal/service/blob';
+
+const meta = BinaryUtil.getBlobMeta;
 
 @Suite()
 export abstract class ModelBlobSuite extends BaseModelSuite<ModelBlobSupport> {
@@ -20,9 +22,26 @@ export abstract class ModelBlobSuite extends BaseModelSuite<ModelBlobSupport> {
     const id = Util.uuid();
 
     await service.upsertBlob(id, buffer);
-    const meta = await service.describeBlob(id);
+    const m = await service.describeBlob(id);
     const retrieved = await service.describeBlob(id);
-    assert.deepStrictEqual(meta, retrieved);
+    assert.deepStrictEqual(m, retrieved);
+  }
+
+  @Test()
+  async upsert(): Promise<void> {
+    const service = await this.service;
+    const buffer = await this.fixture.read('/asset.yml', true);
+
+    const id = Util.uuid();
+
+    await service.upsertBlob(id, buffer, { hash: '10' });
+    assert((await service.describeBlob(id)).hash === '10');
+
+    await service.upsertBlob(id, buffer, { hash: '20' });
+    assert((await service.describeBlob(id)).hash === '20');
+
+    await service.upsertBlob(id, buffer, { hash: '30' }, false);
+    assert((await service.describeBlob(id)).hash === '20');
   }
 
   @Test()
@@ -32,11 +51,11 @@ export abstract class ModelBlobSuite extends BaseModelSuite<ModelBlobSupport> {
 
     const id = Util.uuid();
     await service.upsertBlob(id, buffer);
-    const meta = await service.describeBlob(id);
+    const { hash } = await service.describeBlob(id);
 
     const retrieved = await service.getBlob(id);
-    const retrievedMeta = retrieved.meta!;
-    assert(meta.hash === retrievedMeta.hash);
+    const { hash: received } = meta(retrieved)!;
+    assert(hash === received);
   }
 
   @Test()
@@ -69,7 +88,7 @@ export abstract class ModelBlobSuite extends BaseModelSuite<ModelBlobSupport> {
 
     const partial = await service.getBlob(id, { start: 10, end: 20 });
     assert(partial.size === 11);
-    const partialMeta = partial.meta!;
+    const partialMeta = meta(partial)!;
     const subContent = await partial.text();
     const range = await ModelBlobUtil.enforceRange({ start: 10, end: 20 }, partialMeta.size!);
     assert(subContent.length === (range.end - range.start) + 1);
@@ -79,7 +98,7 @@ export abstract class ModelBlobSuite extends BaseModelSuite<ModelBlobSupport> {
     assert(subContent === og.substring(10, 21));
 
     const partialUnbounded = await service.getBlob(id, { start: 10 });
-    const partialUnboundedMeta = partial.meta!;
+    const partialUnboundedMeta = meta(partial)!;
     const subContent2 = await partialUnbounded.text();
     const range2 = await ModelBlobUtil.enforceRange({ start: 10 }, partialUnboundedMeta.size!);
     assert(subContent2.length === (range2.end - range2.start) + 1);
@@ -107,7 +126,7 @@ export abstract class ModelBlobSuite extends BaseModelSuite<ModelBlobSupport> {
     const buffer = await this.fixture.read('/asset.yml', true);
     await service.upsertBlob('orange', buffer, { contentType: 'text/yaml', filename: 'asset.yml' });
     const saved = await service.getBlob('orange');
-    const savedMeta = saved.meta!;
+    const savedMeta = meta(saved)!;
 
     assert('text/yaml' === savedMeta.contentType);
     assert(buffer.length === savedMeta.size);

package/src/util/blob.ts

@@ -1,60 +0,0 @@
-import { Readable } from 'node:stream';
-import path from 'node:path';
-
-import { AppError, BinaryInput, BlobMeta, ByteRange, Util } from '@travetto/runtime';
-
-/**
- * Utilities for processing assets
- */
-export class ModelBlobUtil {
-
-  /**
-   * Get a hashed location/path for a blob
-   */
-  static getHashedLocation(meta: BlobMeta, prefix = ''): string {
-    const hash = meta.hash ?? Util.uuid();
-
-    let parts = hash.match(/(.{1,4})/g)!.slice();
-    if (parts.length > 4) {
-      parts = [...parts.slice(0, 4), parts.slice(4).join('')];
-    }
-
-    const ext = path.extname(meta.filename ?? '') || '.bin';
-    return `${parts.join('/')}${ext}`;
-  }
-
-  /**
-   * Convert input to a blob, containing all data in memory
-   */
-  static async getInput(src: BinaryInput, metadata: BlobMeta = {}): Promise<[Readable, BlobMeta]> {
-    let input: Readable;
-    if (src instanceof Blob) {
-      metadata = { ...src.meta, ...metadata };
-      metadata.size ??= src.size;
-      input = Readable.fromWeb(src.stream());
-    } else if (typeof src === 'object' && 'pipeThrough' in src) {
-      input = Readable.fromWeb(src);
-    } else if (typeof src === 'object' && 'pipe' in src) {
-      input = src;
-    } else {
-      metadata.size = src.length;
-      input = Readable.from(src);
-    }
-
-    return [input, metadata ?? {}];
-  }
-
-  /**
-   * Enforce byte range for stream stream/file of a certain size
-   */
-  static enforceRange({ start, end }: ByteRange, size: number): Required<ByteRange> {
-    // End is inclusive
-    end = Math.min(end ?? (size - 1), size - 1);
-
-    if (Number.isNaN(start) || Number.isNaN(end) || !Number.isFinite(start) || start >= size || start < 0 || start > end) {
-      throw new AppError('Invalid position, out of range', 'data');
-    }
-
-    return { start, end };
-  }
-}