@onivoro/server-aws-redshift 22.11.0 → 24.0.0

package/{dist/cjs/index.d.ts → index.ts}

@@ -1,3 +1,5 @@
 export * from './lib/classes/server-aws-redshift-config.class';
+
 export * from './lib/services/redshift.service';
+
 export * from './lib/server-aws-redshift.module';

package/jest.config.ts

@@ -0,0 +1,11 @@
+/* eslint-disable */
+export default {
+  displayName: 'lib-server-aws-redshift',
+  preset: '../../../jest.preset.js',
+  testEnvironment: 'node',
+  transform: {
+    '^.+\\.[tj]s$': ['ts-jest', { tsconfig: '<rootDir>/tsconfig.spec.json' }],
+  },
+  moduleFileExtensions: ['ts', 'js', 'html'],
+  coverageDirectory: '../../../coverage/libs/server/aws-redshift',
+};

package/package.json

@@ -1,49 +1,12 @@
 {
-    "name": "@onivoro/server-aws-redshift",
-    "version": "22.11.0",
-    "repository": {
-        "url": "git+https://github.com/onivoro/server-aws-redshift.git"
-    },
-    "main": "dist/cjs/index.js",
-    "module": "dist/esm/index.js",
-    "types": "dist/types/index.d.ts",
-    "files": [
-        "dist/*"
-    ],
-    "scripts": {
-        "onx": "onx",
-        "build": "onx Build",
-        "deploy": "onx Publish",
-        "test": "onx Test",
-        "update": "onx Update"
-    },
-    "exports": {
-        ".": {
-            "types": "./dist/types/index.d.ts",
-            "require": "./dist/cjs/index.js",
-            "import": "./dist/esm/index.js",
-            "default": "./dist/esm/lib.js"
-        }
-    },
-    "onx": {
-        "platform": "server",
-        "module": "commonjs"
-    },
-    "devDependencies": {
-        "@onivoro/cli": "^22.0.8",
-        "@types/jest": "*",
-        "@types/node": "22.10.7",
-        "typescript": "*"
-    },
-    "engines": {
-        "node": "22.10.0",
-        "npm": "10.9.0"
-    },
-    "dependencies": {
-        "@aws-sdk/client-redshift": "^3.731.1",
-        "@aws-sdk/client-redshift-data": "^3.731.1",
-        "@aws-sdk/client-redshift-serverless": "^3.731.1",
-        "@nestjs/common": "^11.0.1",
-        "@onivoro/server-common": "^22.11.0"
-    }
+  "name": "@onivoro/server-aws-redshift",
+  "version": "24.0.0",
+  "type": "commonjs",
+  "main": "./src/index.js",
+  "types": "./src/index.d.ts",
+  "dependencies": {
+    "@onivoro/server-aws-credential-providers": "24.0.0",
+    "@onivoro/server-common": "24.0.0",
+    "tslib": "^2.3.0"
+  }
 }

package/project.json

@@ -0,0 +1,23 @@
+{
+  "name": "lib-server-aws-redshift",
+  "$schema": "../../../node_modules/nx/schemas/project-schema.json",
+  "sourceRoot": "libs/server/aws-redshift/src",
+  "projectType": "library",
+  "targets": {
+    "build": {
+      "executor": "@nx/js:tsc",
+      "outputs": ["{options.outputPath}"],
+      "options": {
+        "outputPath": "dist/libs/server/aws-redshift",
+        "main": "libs/server/aws-redshift/src/index.ts",
+        "tsConfig": "libs/server/aws-redshift/tsconfig.lib.json",
+        "assets": [
+          "libs/server/aws-redshift/README.md",
+          "libs/server/aws-redshift/package.json"
+        ],
+        "declaration": true
+      }
+    }
+  },
+  "tags": []
+}

package/{dist/esm/index.d.ts → src/index.ts}

@@ -1,3 +1,5 @@
 export * from './lib/classes/server-aws-redshift-config.class';
+
 export * from './lib/services/redshift.service';
+
 export * from './lib/server-aws-redshift.module';

package/src/lib/classes/server-aws-redshift-config.class.ts

@@ -0,0 +1,4 @@
+export class ServerAwsRedshiftDataConfig {
+    AWS_PROFILE?: string;
+    AWS_REGION: string;
+}

package/src/lib/server-aws-redshift.module.ts

@@ -0,0 +1,56 @@
+import { Module } from '@nestjs/common';
+import { moduleFactory } from '@onivoro/server-common';
+import { RedshiftDataClient, RedshiftDataClientConfig } from '@aws-sdk/client-redshift-data';
+import { RedshiftDataService } from './services/redshift.service';
+import { ServerAwsRedshiftDataConfig } from './classes/server-aws-redshift-config.class';
+import { RedshiftServerlessClient } from '@aws-sdk/client-redshift-serverless';
+import { RedshiftClient } from '@aws-sdk/client-redshift';
+import { AwsCredentials, ServerAwsCredentialProvidersModule } from '@onivoro/server-aws-credential-providers';
+
+let redshiftClient: RedshiftClient | null = null;
+let redshiftDataClient: RedshiftDataClient | null = null;
+let redshiftServerlessClient: RedshiftServerlessClient | null = null;
+
+
+@Module({})
+export class ServerAwsRedshiftDataModule {
+  static configure(config: ServerAwsRedshiftDataConfig) {
+    return moduleFactory({
+      module: ServerAwsRedshiftDataModule,
+      imports: [ServerAwsCredentialProvidersModule.configure(config)],
+      providers: [
+        {
+          provide: RedshiftDataClient,
+          useFactory: (credentials: AwsCredentials) => redshiftDataClient
+            ? redshiftDataClient
+            : redshiftDataClient = new RedshiftDataClient(from(config, credentials)),
+          inject: [AwsCredentials]
+        },
+        {
+          provide: RedshiftServerlessClient,
+          useFactory: (credentials: AwsCredentials) => redshiftServerlessClient
+            ? redshiftServerlessClient
+            : redshiftServerlessClient = new RedshiftServerlessClient(from(config, credentials)),
+          inject: [AwsCredentials]
+        },
+        {
+          provide: RedshiftClient,
+          useFactory: (credentials: AwsCredentials) => redshiftClient
+            ? redshiftClient
+            : redshiftClient = new RedshiftClient(from(config, credentials)),
+          inject: [AwsCredentials]
+        },
+        { provide: ServerAwsRedshiftDataConfig, useValue: config },
+        RedshiftDataService
+      ]
+    })
+  }
+}
+
+function from(config: ServerAwsRedshiftDataConfig, credentials: AwsCredentials): RedshiftDataClientConfig {
+  return {
+    region: config.AWS_REGION,
+    logger: console,
+    credentials
+  };
+}

package/{dist/cjs/lib/services/redshift.service.js → src/lib/services/redshift.service.ts}

@@ -1,204 +1,234 @@
-"use strict";
-var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
-    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
-    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
-    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
-    return c > 3 && r && Object.defineProperty(target, key, r), r;
-};
-var __metadata = (this && this.__metadata) || function (k, v) {
-    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.RedshiftDataService = void 0;
-const common_1 = require("@nestjs/common");
-const client_redshift_data_1 = require("@aws-sdk/client-redshift-data");
-const client_redshift_serverless_1 = require("@aws-sdk/client-redshift-serverless");
-const crypto_1 = require("crypto");
-let RedshiftDataService = class RedshiftDataService {
-    redshiftDataClient;
-    redshiftServerlessClient;
-    constructor(redshiftDataClient, redshiftServerlessClient) {
-        this.redshiftDataClient = redshiftDataClient;
-        this.redshiftServerlessClient = redshiftServerlessClient;
-    }
-    async waitForStatement(statementId, maxAttempts = 10, delay = 1000) {
+import { Injectable } from '@nestjs/common';
+import { DescribeStatementCommand, ExecuteStatementCommand, GetStatementResultCommand, RedshiftDataClient } from "@aws-sdk/client-redshift-data";
+import { GetWorkgroupCommand, GetWorkgroupCommandInput, RedshiftServerlessClient } from '@aws-sdk/client-redshift-serverless';
+import { randomUUID } from 'crypto';
+
+@Injectable()
+export class RedshiftDataService {
+    constructor(
+        private redshiftDataClient: RedshiftDataClient,
+        private redshiftServerlessClient: RedshiftServerlessClient,
+    ) { }
+
+    async waitForStatement(statementId: string, maxAttempts = 10, delay = 1000) {
         let attempts = 0;
+
         while (attempts < maxAttempts) {
-            const describeStatementCommand = new client_redshift_data_1.DescribeStatementCommand({
+            const describeStatementCommand = new DescribeStatementCommand({
                 Id: statementId
             });
+
             const status = await this.redshiftDataClient.send(describeStatementCommand);
+
             if (status.Status === 'FINISHED') {
                 return status.ResultRows;
             }
+
             if (status.Status === 'FAILED') {
                 throw new Error(`SQL statement failed: ${status.Error}`);
             }
+
             attempts++;
             await new Promise(resolve => setTimeout(resolve, delay));
         }
+
         throw new Error('Timeout waiting for SQL statement to complete');
     }
-    async verifyEndpointAccess(workgroupName) {
-        const workgroupResponse = await this.redshiftServerlessClient.send(new client_redshift_serverless_1.GetWorkgroupCommand({ workgroupName }));
+
+    async verifyEndpointAccess(workgroupName: string) {
+        const workgroupResponse = await this.redshiftServerlessClient.send(
+            new GetWorkgroupCommand({ workgroupName })
+        );
+
         if (!workgroupResponse?.workgroup?.endpoint?.address) {
             console.error(`Could not retrieve endpoint for workgroupName "${workgroupName}"`);
+
             return;
         }
+
         return workgroupResponse;
     }
-    async addIamUserToDatabaseGroup(_) {
+
+    async addIamUserToDatabaseGroup(_: { database: string, workgroupName: string, user: string, group: string }) {
         try {
-            const groupResult = await this.redshiftDataClient.send(new client_redshift_data_1.ExecuteStatementCommand({
+            const groupResult = await this.redshiftDataClient.send(new ExecuteStatementCommand({
                 Database: _.database,
                 Sql: `ALTER GROUP ${_.group} ADD USER "${_.user}";`,
                 WorkgroupName: _.workgroupName
             }));
-            await this.waitForStatement(groupResult.Id);
+
+            await this.waitForStatement(groupResult.Id!);
+
             console.log(`Added user "${_.user}" to group "${_.group}`);
-        }
-        catch (error) {
+        } catch (error: any) {
             console.warn({ detail: `Warning adding ${_.user} to group:`, error });
         }
     }
-    async createDatabaseUser(_) {
+
+    async createDatabaseUser(_: { database: string, workgroupName: string, user: string }): Promise<string> {
         try {
-            const checkResult = await this.redshiftDataClient.send(new client_redshift_data_1.ExecuteStatementCommand({
+
+            const checkResult = await this.redshiftDataClient.send(new ExecuteStatementCommand({
                 Database: _.database,
                 Sql: `SELECT u.usename as username FROM pg_user u;`,
                 WorkgroupName: _.workgroupName
             }));
-            await this.waitForStatement(checkResult.Id);
-            const describeCommand = new client_redshift_data_1.DescribeStatementCommand({ Id: checkResult.Id });
+
+            await this.waitForStatement(checkResult.Id!);
+
+            const describeCommand = new DescribeStatementCommand({ Id: checkResult.Id });
             const checkStatus = await this.redshiftDataClient.send(describeCommand);
+
             if (!checkStatus.ResultRows) {
-                const placeholderPassword = `IAM_${(0, crypto_1.randomUUID)().replace(/-/g, '_')}`;
-                const createUserCommand = new client_redshift_data_1.ExecuteStatementCommand({
+                const placeholderPassword = `IAM_${randomUUID().replace(/-/g, '_')}`;
+
+                const createUserCommand = new ExecuteStatementCommand({
                     Database: _.database,
                     Sql: `CREATE USER ${_.user} PASSWORD '${placeholderPassword}';`,
                     WorkgroupName: _.workgroupName
                 });
+
                 const createResult = await this.redshiftDataClient.send(createUserCommand);
-                await this.waitForStatement(createResult.Id);
+
+                await this.waitForStatement(createResult.Id!);
+
                 console.log(`Created user: ${_.user}`);
+
                 return placeholderPassword;
-            }
-            else {
+            } else {
                 console.log(`User "${_.user} already exists`);
+
                 return '';
             }
-        }
-        catch (error) {
+
+        } catch (error: any) {
             console.warn({ detail: `Warning creating user ${_.user}`, error });
             throw error;
         }
     }
-    async grantUsageOnSchema(_) {
+
+    async grantUsageOnSchema(_: { database: string, workgroupName: string, schema: string, group: string }) {
+
         try {
             const setupStatements = [
                 `GRANT USAGE ON SCHEMA ${_.schema} TO GROUP ${_.group};`,
                 `GRANT SELECT ON ALL TABLES IN SCHEMA ${_.schema} TO GROUP ${_.group};`,
                 `ALTER DEFAULT PRIVILEGES IN SCHEMA ${_.schema} GRANT SELECT ON TABLES TO GROUP ${_.group};`,
             ];
+
             for (const Sql of setupStatements) {
-                const executeStatementCommand = new client_redshift_data_1.ExecuteStatementCommand({
+                const executeStatementCommand = new ExecuteStatementCommand({
                     Database: _.database,
                     Sql,
                     WorkgroupName: _.workgroupName
                 });
+
                 try {
                     const result = await this.redshiftDataClient.send(executeStatementCommand);
-                    await this.waitForStatement(result.Id);
-                    console.log(Sql);
-                }
-                catch (error) {
+                    await this.waitForStatement(result.Id!);
+                } catch (error: any) {
                     console.warn({ Sql, error });
                 }
             }
-        }
-        catch (error) {
+
+        } catch (error) {
             console.error({ error });
             throw error;
         }
     }
-    async createDbGroupFromIamGroupIfNotExists(_) {
+
+    async createDbGroupFromIamGroupIfNotExists(_: { iamGroup: string, database: string, workgroupName: string }): Promise<any> {
+
         try {
-            const checkResult = await this.redshiftDataClient.send(new client_redshift_data_1.ExecuteStatementCommand({
+            const checkResult = await this.redshiftDataClient.send(new ExecuteStatementCommand({
                 Database: _.database,
                 Sql: `SELECT 1 FROM pg_group WHERE groname = '${_.iamGroup}';`,
                 WorkgroupName: _.workgroupName
             }));
-            await this.waitForStatement(checkResult.Id);
-            const describeCommand = new client_redshift_data_1.DescribeStatementCommand({ Id: checkResult.Id });
+
+            await this.waitForStatement(checkResult.Id!);
+
+            const describeCommand = new DescribeStatementCommand({ Id: checkResult.Id });
             const checkStatus = await this.redshiftDataClient.send(describeCommand);
+
             if (!checkStatus.ResultRows) {
-                const createGroupCommand = new client_redshift_data_1.ExecuteStatementCommand({
+                const createGroupCommand = new ExecuteStatementCommand({
                     Database: _.database,
                     Sql: `CREATE GROUP ${_.iamGroup};`,
                     WorkgroupName: _.workgroupName
                 });
+
                 const createResult = await this.redshiftDataClient.send(createGroupCommand);
-                await this.waitForStatement(createResult.Id);
+                await this.waitForStatement(createResult.Id!);
                 console.log(`Created "${_.iamGroup}" group`);
-            }
-            else {
+            } else {
                 console.log(`"${_.iamGroup}" group already exists`);
             }
-        }
-        catch (error) {
+        } catch (error: any) {
             console.error({ error });
             throw error;
         }
     }
-    async queryV1(_, Sql) {
-        const result = await this.redshiftDataClient.send(new client_redshift_data_1.ExecuteStatementCommand({
+
+    async queryV1(_: { database: string, workgroupName: string }, Sql: string) {
+        const result = await this.redshiftDataClient.send(new ExecuteStatementCommand({
             Database: _.database,
             Sql,
             WorkgroupName: _.workgroupName
         }));
-        return await this.waitForStatement(result.Id);
+
+        return await this.waitForStatement(result.Id!);
     }
-    async query(_, Sql) {
+
+
+    async query(_: { database: string, workgroupName: string }, Sql: string) {
         try {
-            const executeCommand = new client_redshift_data_1.ExecuteStatementCommand({
+            const executeCommand = new ExecuteStatementCommand({
                 Database: _.database,
                 Sql,
-                WorkgroupName: _.workgroupName
+                WorkgroupName: _.workgroupName,
             });
+
             const { Id } = await this.redshiftDataClient.send(executeCommand);
+
             if (!Id) {
                 throw new Error("Failed to get statement ID");
             }
+
             let status = "";
+
             do {
-                const describeCommand = new client_redshift_data_1.DescribeStatementCommand({ Id });
+                const describeCommand = new DescribeStatementCommand({ Id });
                 const { Status, Error: err } = await this.redshiftDataClient.send(describeCommand);
                 status = Status || "";
+
                 if (status === "FAILED") {
                     throw new Error(err);
                 }
+
                 if (status !== "FINISHED") {
                     await new Promise(resolve => setTimeout(resolve, 1000));
                 }
             } while (status !== "FINISHED");
+
             try {
-                const getResultsCommand = new client_redshift_data_1.GetStatementResultCommand({ Id });
+                const getResultsCommand = new GetStatementResultCommand({ Id });
                 const results = await this.redshiftDataClient.send(getResultsCommand);
+
                 const records = results.Records || [];
                 return records.map(record => {
                     return record.map(field => field.stringValue || field.longValue || field.doubleValue);
                 });
-            }
-            catch (error) {
+            } catch (error) {
                 return [];
             }
-        }
-        catch (error) {
+        } catch (error) {
             console.error({ detail: "Error executing query:", error });
             throw error;
         }
     }
-    async getAssociatedIAmRolesByWorkgroup(_) {
+
+    async getAssociatedIAmRolesByWorkgroup(_: { database: string, workgroupName: string }) {
         try {
             const query = `
             SELECT
@@ -217,9 +247,9 @@ let RedshiftDataService = class RedshiftDataService {
             )
             ORDER BY g.groname, u.usename;
           `;
-            return await this.query(_, query);
-        }
-        catch (error) {
+
+            return await this.query(_, query)
+        } catch (error) {
             if (error instanceof Error) {
                 console.error(`Error getting workgroup roles: ${error.message}`);
                 throw error;
@@ -227,10 +257,37 @@ let RedshiftDataService = class RedshiftDataService {
             throw new Error('An unknown error occurred');
         }
     }
-};
-exports.RedshiftDataService = RedshiftDataService;
-exports.RedshiftDataService = RedshiftDataService = __decorate([
-    (0, common_1.Injectable)(),
-    __metadata("design:paramtypes", [client_redshift_data_1.RedshiftDataClient,
-        client_redshift_serverless_1.RedshiftServerlessClient])
-], RedshiftDataService);
+
+    private async upsert<TValue>(_: { database: string, workgroupName: string }, value: TValue, tableQualifiers: { schema: string, table: string }) {
+        const { table, schema } = tableQualifiers;
+        // TODO: dynamically build out the select/insert clauses dynamically
+        //         try {
+        //             const upsertQuery = `
+        // WITH ${table}_x AS (SELECT '${value.user_id}' as user_id, '${value.profile_id}' as profile_id, '${value.email}' as email, '${value.date}' as date, '${value.weight}' as weight, '${value.source}' as source, '${value.created_at}' as created_at)
+        // UPDATE ${schema}.${table}
+        // SET
+        //   patient = a.patient,
+        //   data = a.data
+        // FROM ${table}_x AS a
+        // WHERE ${schema}.${table}.id = a.id;
+
+        // INSERT INTO ${schema}.${table} (
+        //   id,
+        //   patient,
+        //   data
+        // )
+        // SELECT
+        //   a.id,
+        //   a.patient,
+        //   a.data
+        // FROM ${table}_x AS a
+        // LEFT JOIN ${schema}.${table} AS b
+        //   ON a.id = b.id
+        // WHERE b.id IS NULL;`;
+
+        //             return await this.query(_, upsertQuery);
+        //         } catch (error: any) {
+        //             console.error({ error, detail: `"${schema}.${table}" upsert failed` });
+        //         }
+    }
+}

package/tsconfig.json

@@ -0,0 +1,16 @@
+{
+  "extends": "../../../tsconfig.server.json",
+  "compilerOptions": {
+    "outDir": "../../../dist/out-tsc"
+  },
+  "files": [],
+  "include": [],
+  "references": [
+    {
+      "path": "./tsconfig.lib.json"
+    },
+    {
+      "path": "./tsconfig.spec.json"
+    }
+  ]
+}

package/tsconfig.lib.json

@@ -0,0 +1,8 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "declaration": true
+  },
+  "exclude": ["jest.config.ts", "**/*.spec.ts", "**/*.test.ts"],
+  "include": ["**/*.ts"]
+}

package/tsconfig.spec.json

@@ -0,0 +1,21 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "types": [
+      "jest",
+      "node"
+    ]
+  },
+  "include": [
+    "jest.config.ts",
+    "**/*.test.ts",
+    "**/*.spec.ts",
+    "**/*.test.tsx",
+    "**/*.spec.tsx",
+    "**/*.test.js",
+    "**/*.spec.js",
+    "**/*.test.jsx",
+    "**/*.spec.jsx",
+    "**/*.d.ts"
+  ]
+}

package/dist/cjs/index.js

@@ -1,19 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./lib/classes/server-aws-redshift-config.class"), exports);
-__exportStar(require("./lib/services/redshift.service"), exports);
-__exportStar(require("./lib/server-aws-redshift.module"), exports);

package/dist/cjs/lib/classes/server-aws-redshift-config.class.d.ts

@@ -1,6 +0,0 @@
-export declare class ServerAwsRedshiftDataConfig {
-    AWS_ACCESS_KEY_ID?: string;
-    AWS_REGION: string;
-    AWS_SECRET_ACCESS_KEY?: string;
-    NODE_ENV: string;
-}

package/dist/cjs/lib/classes/server-aws-redshift-config.class.js

@@ -1,10 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ServerAwsRedshiftDataConfig = void 0;
-class ServerAwsRedshiftDataConfig {
-    AWS_ACCESS_KEY_ID;
-    AWS_REGION;
-    AWS_SECRET_ACCESS_KEY;
-    NODE_ENV;
-}
-exports.ServerAwsRedshiftDataConfig = ServerAwsRedshiftDataConfig;

package/dist/cjs/lib/server-aws-redshift.module.d.ts

@@ -1,4 +0,0 @@
-import { ServerAwsRedshiftDataConfig } from './classes/server-aws-redshift-config.class';
-export declare class ServerAwsRedshiftDataModule {
-    static configure(config: ServerAwsRedshiftDataConfig): any;
-}