@travetto/model-s3 3.0.0-rc.2 → 3.0.0-rc.21

package/README.md

@@ -1,5 +1,5 @@
 <!-- This file was generated by @travetto/doc and should not be modified directly -->
-<!-- Please modify https://github.com/travetto/travetto/tree/main/module/model-s3/doc.ts and execute "npx trv doc" to rebuild -->
+<!-- Please modify https://github.com/travetto/travetto/tree/main/module/model-s3/DOC.ts and execute "npx trv doc" to rebuild -->
 # S3 Model Support
 ## S3 backing for the travetto model module.
 
@@ -29,16 +29,15 @@ export class Init {
 }
 ```
 
-  where the [S3ModelConfig](https://github.com/travetto/travetto/tree/main/module/model-s3/src/config.ts#L12) is defined by:
+  where the [S3ModelConfig](https://github.com/travetto/travetto/tree/main/module/model-s3/src/config.ts#L11) is defined by:
 
   
 **Code: Structure of S3ModelConfig**
 ```typescript
 import { fromIni } from '@aws-sdk/credential-provider-ini';
-import * as S3 from '@aws-sdk/client-s3';
+import type s3 from '@aws-sdk/client-s3';
 
-import { EnvUtil } from '@travetto/boot';
-import { Config } from '@travetto/config';
+import { Config, EnvVar } from '@travetto/config';
 import { Field, Required } from '@travetto/schema';
 
 /**
@@ -51,12 +50,16 @@ export class S3ModelConfig {
   bucket = ''; // S3 bucket
   endpoint = ''; // Endpoint url
 
-  accessKeyId: string = EnvUtil.get('AWS_ACCESS_KEY_ID', '');
-  secretAccessKey: string = EnvUtil.get('AWS_SECRET_ACCESS_KEY', '');
+  @EnvVar('AWS_ACCESS_KEY_ID')
+  accessKeyId: string = '';
+  @EnvVar('AWS_SECRET_ACCESS_KEY')
+  secretAccessKey: string = '';
+  @EnvVar('AWS_PROFILE')
+  profile?: string;
 
   @Field(Object)
   @Required(false)
-  config: S3.S3ClientConfig; // Additional s3 config
+  config: s3.S3ClientConfig; // Additional s3 config
 
   chunkSize = 5 * 2 ** 20; // Chunk size in bytes
 
@@ -74,7 +77,7 @@ export class S3ModelConfig {
    */
   async postConstruct(): Promise<void> {
     if (!this.accessKeyId && !this.secretAccessKey) {
-      const creds = await fromIni({ profile: EnvUtil.get('AWS_PROFILE') })();
+      const creds = await fromIni({ profile: this.profile })();
       this.accessKeyId = creds.accessKeyId;
       this.secretAccessKey = creds.secretAccessKey;
     }
@@ -92,8 +95,8 @@ export class S3ModelConfig {
 }
 ```
 
-  Additionally, you can see that the class is registered with the [@Config](https://github.com/travetto/travetto/tree/main/module/config/src/decorator.ts#L9) annotation, and so these values can be overridden using the 
-  standard [Configuration](https://github.com/travetto/travetto/tree/main/module/config#readme "Environment-aware config management using yaml files")resolution paths. 
+  Additionally, you can see that the class is registered with the [@Config](https://github.com/travetto/travetto/tree/main/module/config/src/decorator.ts#L13) annotation, and so these values can be overridden using the 
+  standard [Configuration](https://github.com/travetto/travetto/tree/main/module/config#readme "Configuration support")resolution paths. 
   
 
 **Note**: Do not commit your `accessKeyId` or `secretAccessKey` values to your source repository, especially if it is public facing.  Not only is it a security risk, but Amazon will scan public repos, looking for keys, and if found will react swiftly.

package/package.json

@@ -1,7 +1,6 @@
 {
   "name": "@travetto/model-s3",
-  "displayName": "S3 Model Support",
-  "version": "3.0.0-rc.2",
+  "version": "3.0.0-rc.21",
   "description": "S3 backing for the travetto model module.",
   "keywords": [
     "s3",
@@ -16,19 +15,31 @@
     "name": "Travetto Framework"
   },
   "files": [
-    "index.ts",
+    "__index__.ts",
+    "support",
     "src"
   ],
-  "main": "index.ts",
+  "main": "__index__.ts",
   "repository": {
     "url": "https://github.com/travetto/travetto.git",
     "directory": "module/model-s3"
   },
   "dependencies": {
-    "@aws-sdk/client-s3": "^3.160.0",
-    "@aws-sdk/credential-provider-ini": "^3.160.0",
-    "@travetto/config": "^3.0.0-rc.2",
-    "@travetto/model": "^3.0.0-rc.2"
+    "@aws-sdk/client-s3": "^3.272.0",
+    "@aws-sdk/credential-provider-ini": "^3.218.0",
+    "@travetto/config": "^3.0.0-rc.20",
+    "@travetto/model": "^3.0.0-rc.20"
+  },
+  "peerDependencies": {
+    "@travetto/command": "^3.0.0-rc.16"
+  },
+  "peerDependenciesMeta": {
+    "@travetto/command": {
+      "optional": true
+    }
+  },
+  "travetto": {
+    "displayName": "S3 Model Support"
   },
   "publishConfig": {
     "access": "public"

package/src/config.ts

@@ -1,8 +1,7 @@
 import { fromIni } from '@aws-sdk/credential-provider-ini';
-import * as S3 from '@aws-sdk/client-s3';
+import type s3 from '@aws-sdk/client-s3';
 
-import { EnvUtil } from '@travetto/boot';
-import { Config } from '@travetto/config';
+import { Config, EnvVar } from '@travetto/config';
 import { Field, Required } from '@travetto/schema';
 
 /**
@@ -15,12 +14,16 @@ export class S3ModelConfig {
   bucket = ''; // S3 bucket
   endpoint = ''; // Endpoint url
 
-  accessKeyId: string = EnvUtil.get('AWS_ACCESS_KEY_ID', '');
-  secretAccessKey: string = EnvUtil.get('AWS_SECRET_ACCESS_KEY', '');
+  @EnvVar('AWS_ACCESS_KEY_ID')
+  accessKeyId: string = '';
+  @EnvVar('AWS_SECRET_ACCESS_KEY')
+  secretAccessKey: string = '';
+  @EnvVar('AWS_PROFILE')
+  profile?: string;
 
   @Field(Object)
   @Required(false)
-  config: S3.S3ClientConfig; // Additional s3 config
+  config: s3.S3ClientConfig; // Additional s3 config
 
   chunkSize = 5 * 2 ** 20; // Chunk size in bytes
 
@@ -38,7 +41,7 @@ export class S3ModelConfig {
    */
   async postConstruct(): Promise<void> {
     if (!this.accessKeyId && !this.secretAccessKey) {
-      const creds = await fromIni({ profile: EnvUtil.get('AWS_PROFILE') })();
+      const creds = await fromIni({ profile: this.profile })();
       this.accessKeyId = creds.accessKeyId;
       this.secretAccessKey = creds.secretAccessKey;
     }

package/src/service.ts

@@ -3,17 +3,18 @@ import { Readable } from 'stream';
 import * as s3 from '@aws-sdk/client-s3';
 import type { MetadataBearer } from '@aws-sdk/types';
 
-import { StreamUtil } from '@travetto/boot';
 import {
   ModelCrudSupport, ModelStreamSupport, ModelStorageSupport, StreamMeta,
   ModelType, ModelRegistry, ExistsError, NotFoundError, OptionalId
 } from '@travetto/model';
 import { Injectable } from '@travetto/di';
-import { Class, AppError, Util } from '@travetto/base';
+import { StreamUtil, Class, AppError } from '@travetto/base';
 
 import { ModelCrudUtil } from '@travetto/model/src/internal/service/crud';
 import { ModelExpirySupport } from '@travetto/model/src/service/expiry';
 import { ModelExpiryUtil } from '@travetto/model/src/internal/service/expiry';
+import { ModelStorageUtil } from '@travetto/model/src/internal/service/storage';
+import { ModelUtil } from '@travetto/model/src/internal/util';
 
 import { S3ModelConfig } from './config';
 
@@ -22,10 +23,10 @@ function isMetadataBearer(o: unknown): o is MetadataBearer {
 }
 
 function hasContentType<T>(o: T): o is T & { contenttype?: string } {
-  return o && 'contenttype' in o;
+  return o !== undefined && o !== null && Object.hasOwn(o, 'contenttype');
 }
 
-const STREAM_SPACE = '@trv:stream';
+const STREAM_SPACE = '@travetto/model-s3:stream';
 
 /**
  * Asset source backed by S3
@@ -147,11 +148,12 @@ export class S3ModelService implements ModelCrudSupport, ModelStreamSupport, Mod
   }
 
   uuid(): string {
-    return Util.uuid(32);
+    return ModelUtil.uuid(32);
   }
 
   async postConstruct(): Promise<void> {
     this.client = new s3.S3(this.config.config);
+    ModelStorageUtil.registerModelChangeListener(this);
   }
 
   async head<T extends ModelType>(cls: Class<T>, id: string): Promise<boolean> {
@@ -176,7 +178,8 @@ export class S3ModelService implements ModelCrudSupport, ModelStreamSupport, Mod
     try {
       const result = await this.client.getObject(this.#q(cls, id));
       if (result.Body) {
-        const body = (await StreamUtil.streamToBuffer(result.Body)).toString('utf8');
+        // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
+        const body = (await StreamUtil.streamToBuffer(result.Body as Readable)).toString('utf8');
         const output = await ModelCrudUtil.load(cls, body);
         if (output) {
           const { expiresAt } = ModelRegistry.get(cls);

package/support/service.s3.ts

@@ -0,0 +1,28 @@
+import { mkdirSync } from 'fs';
+import os from 'os';
+
+import type { CommandService } from '@travetto/command';
+
+const temp = `${os.tmpdir()}/local-stack`;
+try {
+  mkdirSync(temp);
+} catch { }
+
+const version = 'latest';
+
+export const service: CommandService = {
+  name: 's3',
+  version,
+  privileged: true,
+  env: {
+    TEST_AWS_ACCOUNT_ID: '000000000000',
+    LOCALSTACK_HOSTNAME: 'localhost',
+    DEFAULT_REGION: 'us-east-1',
+    HOST_TMP_FOLDER: temp
+  },
+  volumes: {
+    [temp]: '/tmp/localstack'
+  },
+  ports: { 4566: 4566, 4571: 4571, 8080: 8080, 8081: 8081 },
+  image: `localstack/localstack:${version}`
+};