Fix controller crash Scripting

agent/hooks/post-build/000-run-build

@@ -4,8 +4,8 @@ nvm install v18
 
 # Environment variables are not passed to our run-build hook/script. Hard code them in the script
 export NODE_ENV=production
-export LoggingLevel=info
-export LoggingLevelConsole=warn
+export LOGGING_LEVEL=info
+export LOGGING_LEVEL_CONSOLE=warn
 
 # Now run whatever node or npm commands you need to run
 npm run build

agent/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fs/ppaas-agent",
-  "version": "3.3.5",
+  "version": "3.3.6",
   "description": "Agent Service for running pewpew tests",
   "main": "dist/src/app.js",
   "scripts": {

common/integration/s3.spec.ts

@@ -114,7 +114,7 @@ describe("S3Util Integration", () => {
 
   before (async () => {
     // This test was failing until we reset everything. I don't know why and it bothers me.
-    s3Config.s3Client = undefined as any;
+    s3Config.s3Client = undefined;
     initS3();
     defaultTagKey = initTags();
     expect(defaultTagKey, "defaultTagKey").to.not.equal(undefined);

common/integration/sqs.spec.ts

@@ -96,7 +96,7 @@ describe("SqsUtil Integration", () => {
 
   before(async () => {
     // reset everything in case the mocks ran.
-    sqsConfig.sqsClient = undefined as any;
+    sqsConfig.sqsClient = undefined;
     initSqs();
     log("QUEUE_URL_TEST=" + [...QUEUE_URL_TEST], LogLevel.DEBUG);
     log("QUEUE_URL_SCALE=" + [...QUEUE_URL_SCALE_IN], LogLevel.DEBUG);

common/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fs/ppaas-common",
-  "version": "3.3.5",
+  "version": "3.3.6",
   "description": "Common Code for the PewPewController and PewPewAgent",
   "main": "dist/src/index.js",
   "types": "dist/src/index.d.ts",
@@ -15,7 +15,7 @@
     "testonly": "nyc mocha ./dist/test --timeout 30000 -r dotenv-flow/config",
     "integration": "npm run build && nyc mocha ./dist/integration --timeout 300000 -r dotenv-flow/config",
     "coverage": "npm run build && nyc mocha ./dist/test ./dist/integration --timeout 300000 -r dotenv-flow/config",
-    "prepare": "npm run buildonly",
+    "prepare": "tsc --project tsconfig.lib.json",
     "clean": "rimraf dist/"
   },
   "repository": {
@@ -35,6 +35,7 @@
   "dependencies": {
     "@aws-sdk/client-s3": "^3.363.0",
     "@aws-sdk/client-sqs": "^3.363.0",
+    "@aws-sdk/credential-providers": "^3.363.0",
     "@aws-sdk/ec2-metadata-service": "^3.363.0",
     "@aws-sdk/lib-storage": "^3.363.0",
     "bunyan": "~1.8.0",

common/src/util/s3.ts

@@ -26,13 +26,14 @@ import {
   S3ServiceException,
   Tag as S3Tag
 } from "@aws-sdk/client-s3";
+import { IS_RUNNING_IN_AWS, getPrefix } from "./util";
 import { LogLevel, log } from "./log";
 import { createGzip, gunzip as zlibGunzip} from "zlib";
 import { createReadStream, writeFile as fsWriteFile } from "fs";
 import { S3File } from "../../types";
 import { Upload } from "@aws-sdk/lib-storage";
 import { constants as bufferConstants } from "node:buffer";
-import { getPrefix } from "./util";
+import { fromIni } from "@aws-sdk/credential-providers";
 import { promisify } from "util";
 import stream from "stream";
 const { MAX_STRING_LENGTH } = bufferConstants;
@@ -47,8 +48,8 @@ export let BUCKET_URL: string;
 export let KEYSPACE_PREFIX: string;
 // let REGION_ENDPOINT: string | undefined;
 // Export for testing so we can reset s3
-export const config: { s3Client: S3Client } = {
-  s3Client: undefined as unknown as S3Client
+export const config: { s3Client: (() => S3Client) | undefined } = {
+  s3Client: undefined
 };
 /**
  * ADDITIONAL_TAGS_ON_ALL if set via environment variable is expected to be a comma delimited list of key=value pairs
@@ -69,10 +70,10 @@ export const defaultTestExtraFileTags = (): Map<string, string> => new Map(TEST_
 /**
  * Initializes the S3 object using environment variables. Runs later so it doesn't throw on start-up
  */
-export function init (): void {
+export function init (): S3Client {
   if (BUCKET_NAME && config.s3Client) {
     // If we've already set the BUCKET_NAME then we've done this already.
-    return;
+    return config.s3Client();
   }
   // Where <prefix> is your application name, system name, and service name concatenated with underscores, capitalized, and all dashes replaced with underscores.
   // The s3 service name is s3 in the application which is then capitalized to _S3_ below
@@ -101,12 +102,6 @@ export function init (): void {
   // Since we don't have a private s3 bucket. This will be populated. If we ever move to a private we don't want to tack on the trailing /
   KEYSPACE_PREFIX = keyspacePrefix.length > 0 && !keyspacePrefix.endsWith("/") ? (keyspacePrefix + "/") : keyspacePrefix;
 
-  // Create an S3 service object
-  config.s3Client = new S3Client({
-    // params: { Bucket: BUCKET_NAME },
-    region: "us-east-1"
-  });
-
   if (process.env.ADDITIONAL_TAGS_ON_ALL && ADDITIONAL_TAGS_ON_ALL.size === 0) {
     try {
       for (const keyPair of process.env.ADDITIONAL_TAGS_ON_ALL.split(",")) {
@@ -124,6 +119,26 @@ export function init (): void {
       throw error;
     }
   }
+
+  // Create an S3 service object
+  if (IS_RUNNING_IN_AWS) {
+    // Create a fixed client that will be returned every time.
+    const s3Client = new S3Client({
+      // params: { Bucket: BUCKET_NAME },
+      region: "us-east-1"
+    });
+    config.s3Client = () => s3Client;
+  } else {
+    // https://github.com/aws/aws-sdk-js-v3/issues/3396
+    // When not running in AWS, use the fromIni rather than automatic configuration, don't cache the credentials,
+    // and create a new instance every time
+    config.s3Client = () => new S3Client({
+      // params: { Bucket: BUCKET_NAME },
+      credentials: fromIni({ ignoreCache: true }),
+      region: "us-east-1"
+    });
+  }
+  return config.s3Client();
 }
 
 let accessCallback: (date: Date) => void | undefined;
@@ -459,7 +474,7 @@ export async function listObjects (options?: string | ListObjectsOptions): Promi
     ({ prefix, maxKeys, continuationToken } = options || {});
   }
   log(`listObjects(${prefix}, ${maxKeys}, ${continuationToken})`, LogLevel.DEBUG);
-  init();
+  const s3Client = init();
   if (!prefix || !prefix.startsWith(KEYSPACE_PREFIX)) {
     prefix = KEYSPACE_PREFIX + (prefix || "");
   }
@@ -471,7 +486,7 @@ export async function listObjects (options?: string | ListObjectsOptions): Promi
   };
   try {
     log("listObjects request", LogLevel.DEBUG, params);
-    const result: ListObjectsV2CommandOutput = await config.s3Client.send(new ListObjectsV2Command(params));
+    const result: ListObjectsV2CommandOutput = await s3Client.send(new ListObjectsV2Command(params));
     log("listObjects succeeded", LogLevel.DEBUG, result);
     callAccessCallback(new Date()); // Update the last timestamp
     return result;
@@ -483,7 +498,7 @@ export async function listObjects (options?: string | ListObjectsOptions): Promi
 
 // export for testing
 export async function getObject (key: string, lastModified?: Date): Promise<GetObjectCommandOutput> {
-  init();
+  const s3Client = init();
   if (!key || !key.startsWith(KEYSPACE_PREFIX)) {
     key = KEYSPACE_PREFIX + (key || "");
   }
@@ -494,7 +509,7 @@ export async function getObject (key: string, lastModified?: Date): Promise<GetO
   };
   try {
     log("getObject request", LogLevel.DEBUG, params);
-    const result: GetObjectCommandOutput = await config.s3Client.send(new GetObjectCommand(params));
+    const result: GetObjectCommandOutput = await s3Client.send(new GetObjectCommand(params));
     log("getObject succeeded", LogLevel.DEBUG, Object.assign({}, result, { Body: undefined })); // Log it without the body
     callAccessCallback(new Date()); // Update the last timestamp
     return result;
@@ -512,7 +527,7 @@ export async function getObject (key: string, lastModified?: Date): Promise<GetO
 
 // export for testing
 export async function uploadObject (file: S3File): Promise<CompleteMultipartUploadCommandOutput> {
-  init();
+  const s3Client = init();
   if (!file.key || !file.key.startsWith(KEYSPACE_PREFIX)) {
     file.key = KEYSPACE_PREFIX + (file.key || "");
   }
@@ -548,7 +563,7 @@ export async function uploadObject (file: S3File): Promise<CompleteMultipartUplo
   try {
     log("uploadObject request", LogLevel.DEBUG, Object.assign({}, params, { Body: undefined })); // Log it without the body
     const upload = new Upload({
-      client: config.s3Client,
+      client: s3Client,
       // tags: file.tags && [...file.tags].map(([Key, Value]) => ({ Key, Value })),
       params
     });
@@ -582,7 +597,7 @@ export interface CopyObjectOptions {
  * @returns {CopyObjectCommandOutput}
  */
 export async function copyObject ({ sourceFile, destinationFile, tags }: CopyObjectOptions): Promise<CopyObjectCommandOutput> {
-  init();
+  const s3Client = init();
   if (!sourceFile.key || !sourceFile.key.startsWith(KEYSPACE_PREFIX)) {
     sourceFile.key = KEYSPACE_PREFIX + (sourceFile.key || "");
   }
@@ -614,7 +629,7 @@ export async function copyObject ({ sourceFile, destinationFile, tags }: CopyObj
   };
   try {
     log("copyObject request", LogLevel.DEBUG, Object.assign({}, params, { Body: undefined })); // Log it without the body
-    const result: CopyObjectCommandOutput = await config.s3Client.send(new CopyObjectCommand(params));
+    const result: CopyObjectCommandOutput = await s3Client.send(new CopyObjectCommand(params));
     log("copyObject succeeded", LogLevel.DEBUG, result);
     callAccessCallback(new Date()); // Update the last timestamp
     return result;
@@ -626,7 +641,7 @@ export async function copyObject ({ sourceFile, destinationFile, tags }: CopyObj
 
 // export for testing
 export async function deleteObject (s3FileKey: string): Promise<DeleteObjectCommandOutput> {
-  init();
+  const s3Client = init();
   if (!s3FileKey || !s3FileKey.startsWith(KEYSPACE_PREFIX)) {
     s3FileKey = KEYSPACE_PREFIX + (s3FileKey || "");
   }
@@ -636,7 +651,7 @@ export async function deleteObject (s3FileKey: string): Promise<DeleteObjectComm
   };
   try {
     log("deleteObject request", LogLevel.DEBUG, params);
-    const result: DeleteObjectCommandOutput = await config.s3Client.send(new DeleteObjectCommand(params));
+    const result: DeleteObjectCommandOutput = await s3Client.send(new DeleteObjectCommand(params));
     log(`deleteObject ${s3FileKey} succeeded`, LogLevel.DEBUG, result);
     callAccessCallback(new Date()); // Update the last timestamp
     return result;
@@ -647,7 +662,7 @@ export async function deleteObject (s3FileKey: string): Promise<DeleteObjectComm
 }
 
 export async function getObjectTagging (s3FileKey: string): Promise<GetObjectTaggingCommandOutput> {
-  init();
+  const s3Client = init();
   if (!s3FileKey || !s3FileKey.startsWith(KEYSPACE_PREFIX)) {
     s3FileKey = KEYSPACE_PREFIX + (s3FileKey || "");
   }
@@ -657,7 +672,7 @@ export async function getObjectTagging (s3FileKey: string): Promise<GetObjectTag
   };
   try {
     log("getObjectTagging request", LogLevel.DEBUG, params);
-    const result: GetObjectTaggingCommandOutput = await config.s3Client.send(new GetObjectTaggingCommand(params));
+    const result: GetObjectTaggingCommandOutput = await s3Client.send(new GetObjectTaggingCommand(params));
     log(`getObjectTagging ${s3FileKey} succeeded`, LogLevel.DEBUG, result);
     callAccessCallback(new Date()); // Update the last timestamp
     return result;
@@ -673,7 +688,7 @@ export interface PutObjectTaggingOptions {
 }
 
 export async function putObjectTagging ({ key, tags }: PutObjectTaggingOptions): Promise<PutObjectTaggingCommandOutput> {
-  init();
+  const s3Client = init();
   if (!key || !key.startsWith(KEYSPACE_PREFIX)) {
     key = KEYSPACE_PREFIX + (key || "");
   }
@@ -694,7 +709,7 @@ export async function putObjectTagging ({ key, tags }: PutObjectTaggingOptions):
   };
   try {
     log("putObjectTagging request", LogLevel.DEBUG, params);
-    const result: PutObjectTaggingCommandOutput = await config.s3Client.send(new PutObjectTaggingCommand(params));
+    const result: PutObjectTaggingCommandOutput = await s3Client.send(new PutObjectTaggingCommand(params));
     log(`putObjectTagging ${key} succeeded`, LogLevel.DEBUG, result);
     callAccessCallback(new Date()); // Update the last timestamp
     return result;