opticedge-cloud-utils 1.0.5 → 1.0.7

package/.eslintignore

@@ -0,0 +1,2 @@
+# Ignore compiled output
+dist/

package/dist/index.d.ts

@@ -1,3 +1,5 @@
 export * from './auth/verify';
-export * from './utils/secrets';
 export * from './db/mongo';
+export * from './utils/env';
+export * from './utils/secrets';
+export * from './utils/task';

package/dist/index.js

@@ -15,5 +15,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./auth/verify"), exports);
-__exportStar(require("./utils/secrets"), exports);
 __exportStar(require("./db/mongo"), exports);
+__exportStar(require("./utils/env"), exports);
+__exportStar(require("./utils/secrets"), exports);
+__exportStar(require("./utils/task"), exports);

package/dist/utils/env.d.ts

@@ -0,0 +1 @@
+export declare function getEnv(name: string): string;

package/dist/utils/env.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getEnv = getEnv;
+function getEnv(name) {
+    const value = process.env[name];
+    if (!value) {
+        throw new Error(`Missing env var: ${name}`);
+    }
+    return value;
+}

package/dist/utils/env.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/utils/env.test.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+// src/utils/env.test.ts
+const env_1 = require("./env");
+describe('getEnv', () => {
+    it('should return the value of an existing env var', () => {
+        process.env.TEST_KEY = 'test-value';
+        expect((0, env_1.getEnv)('TEST_KEY')).toBe('test-value');
+    });
+    it('should throw an error if the env var is not set', () => {
+        delete process.env.MISSING_KEY;
+        expect(() => (0, env_1.getEnv)('MISSING_KEY')).toThrow('Missing env var: MISSING_KEY');
+    });
+});

package/dist/utils/task.d.ts

@@ -0,0 +1 @@
+export declare function createTask(projectId: string, region: string, queueId: string, data: unknown, serviceAccount: string, audience: string): Promise<string>;

package/dist/utils/task.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createTask = createTask;
+const tasks_1 = require("@google-cloud/tasks");
+const tasksClient = new tasks_1.CloudTasksClient();
+async function createTask(projectId, region, queueId, data, serviceAccount, audience) {
+    if (!projectId || !region || !queueId || !serviceAccount || !audience) {
+        throw new Error('Missing required parameters for Cloud Tasks setup');
+    }
+    const parent = tasksClient.queuePath(projectId, region, queueId);
+    const task = {
+        httpRequest: {
+            httpMethod: tasks_1.protos.google.cloud.tasks.v2.HttpMethod.POST,
+            url: audience,
+            headers: {
+                'Content-Type': 'application/json'
+            },
+            body: Buffer.from(JSON.stringify(data)).toString('base64'),
+            oidcToken: {
+                serviceAccountEmail: serviceAccount,
+                audience
+            }
+        }
+    };
+    const [response] = await tasksClient.createTask({ parent, task });
+    if (!response.name) {
+        throw new Error('Failed to create task: no name returned');
+    }
+    return response.name;
+}

package/dist/utils/task.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/utils/task.test.js

@@ -0,0 +1,54 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const mockCreateTask = jest.fn();
+const mockQueuePath = jest.fn((projectId, region, queueId) => `projects/${projectId}/locations/${region}/queues/${queueId}`);
+jest.mock('@google-cloud/tasks', () => {
+    return {
+        CloudTasksClient: jest.fn(() => ({
+            createTask: mockCreateTask,
+            queuePath: mockQueuePath
+        })),
+        protos: {
+            google: {
+                cloud: {
+                    tasks: {
+                        v2: {
+                            HttpMethod: {
+                                POST: 'POST'
+                            }
+                        }
+                    }
+                }
+            }
+        }
+    };
+});
+const task_1 = require("./task");
+describe('createTask', () => {
+    beforeEach(() => {
+        mockCreateTask.mockReset();
+    });
+    it('throws error if any required parameter is missing', async () => {
+        // Missing projectId
+        await expect((0, task_1.createTask)('', 'region', 'queue', {}, 'serviceAccount', 'audience')).rejects.toThrow('Missing required parameters for Cloud Tasks setup');
+        // Missing region
+        await expect((0, task_1.createTask)('project', '', 'queue', {}, 'serviceAccount', 'audience')).rejects.toThrow('Missing required parameters for Cloud Tasks setup');
+        // Missing queueId
+        await expect((0, task_1.createTask)('project', 'region', '', {}, 'serviceAccount', 'audience')).rejects.toThrow('Missing required parameters for Cloud Tasks setup');
+        // Missing serviceAccount
+        await expect((0, task_1.createTask)('project', 'region', 'queue', {}, '', 'audience')).rejects.toThrow('Missing required parameters for Cloud Tasks setup');
+        // Missing audience
+        await expect((0, task_1.createTask)('project', 'region', 'queue', {}, 'serviceAccount', '')).rejects.toThrow('Missing required parameters for Cloud Tasks setup');
+    });
+    it('should create a task and return task name', async () => {
+        const mockTaskName = 'projects/test-project/locations/us-central1/queues/test-queue/tasks/task-123';
+        mockCreateTask.mockResolvedValue([{ name: mockTaskName }]);
+        const result = await (0, task_1.createTask)('test-project', 'us-central1', 'test-queue', { test: 'data' }, 'test-sa@test.iam.gserviceaccount.com', 'https://run-url');
+        expect(result).toBe(mockTaskName);
+        expect(mockCreateTask).toHaveBeenCalledTimes(1);
+    });
+    it('should throw error if task name is missing', async () => {
+        mockCreateTask.mockResolvedValue([{}]); // Simulate missing name
+        await expect((0, task_1.createTask)('test-project', 'us-central1', 'test-queue', { foo: 'bar' }, 'test@project.iam.gserviceaccount.com', 'https://example.com')).rejects.toThrow('Failed to create task: no name returned');
+    });
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "opticedge-cloud-utils",
-  "version": "1.0.5",
+  "version": "1.0.7",
   "description": "Common utilities for cloud functions",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -16,6 +16,7 @@
   "license": "MIT",
   "dependencies": {
     "@google-cloud/secret-manager": "^6.0.1",
+    "@google-cloud/tasks": "^6.1.0",
     "google-auth-library": "^9.15.1",
     "mongodb": "^6.16.0"
   },

package/src/index.ts

@@ -1,3 +1,5 @@
 export * from './auth/verify'
-export * from './utils/secrets'
 export * from './db/mongo'
+export * from './utils/env'
+export * from './utils/secrets'
+export * from './utils/task'

package/src/utils/env.test.ts

@@ -0,0 +1,14 @@
+// src/utils/env.test.ts
+import { getEnv } from './env'
+
+describe('getEnv', () => {
+  it('should return the value of an existing env var', () => {
+    process.env.TEST_KEY = 'test-value'
+    expect(getEnv('TEST_KEY')).toBe('test-value')
+  })
+
+  it('should throw an error if the env var is not set', () => {
+    delete process.env.MISSING_KEY
+    expect(() => getEnv('MISSING_KEY')).toThrow('Missing env var: MISSING_KEY')
+  })
+})

package/src/utils/env.ts

@@ -0,0 +1,7 @@
+export function getEnv(name: string): string {
+  const value = process.env[name]
+  if (!value) {
+    throw new Error(`Missing env var: ${name}`)
+  }
+  return value
+}

package/src/utils/task.test.ts

@@ -0,0 +1,94 @@
+const mockCreateTask = jest.fn()
+const mockQueuePath = jest.fn(
+  (projectId, region, queueId) => `projects/${projectId}/locations/${region}/queues/${queueId}`
+)
+
+jest.mock('@google-cloud/tasks', () => {
+  return {
+    CloudTasksClient: jest.fn(() => ({
+      createTask: mockCreateTask,
+      queuePath: mockQueuePath
+    })),
+    protos: {
+      google: {
+        cloud: {
+          tasks: {
+            v2: {
+              HttpMethod: {
+                POST: 'POST'
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+})
+
+import { createTask } from './task'
+
+describe('createTask', () => {
+  beforeEach(() => {
+    mockCreateTask.mockReset()
+  })
+
+  it('throws error if any required parameter is missing', async () => {
+    // Missing projectId
+    await expect(
+      createTask('', 'region', 'queue', {}, 'serviceAccount', 'audience')
+    ).rejects.toThrow('Missing required parameters for Cloud Tasks setup')
+
+    // Missing region
+    await expect(
+      createTask('project', '', 'queue', {}, 'serviceAccount', 'audience')
+    ).rejects.toThrow('Missing required parameters for Cloud Tasks setup')
+
+    // Missing queueId
+    await expect(
+      createTask('project', 'region', '', {}, 'serviceAccount', 'audience')
+    ).rejects.toThrow('Missing required parameters for Cloud Tasks setup')
+
+    // Missing serviceAccount
+    await expect(createTask('project', 'region', 'queue', {}, '', 'audience')).rejects.toThrow(
+      'Missing required parameters for Cloud Tasks setup'
+    )
+
+    // Missing audience
+    await expect(
+      createTask('project', 'region', 'queue', {}, 'serviceAccount', '')
+    ).rejects.toThrow('Missing required parameters for Cloud Tasks setup')
+  })
+
+  it('should create a task and return task name', async () => {
+    const mockTaskName =
+      'projects/test-project/locations/us-central1/queues/test-queue/tasks/task-123'
+    mockCreateTask.mockResolvedValue([{ name: mockTaskName }])
+
+    const result = await createTask(
+      'test-project',
+      'us-central1',
+      'test-queue',
+      { test: 'data' },
+      'test-sa@test.iam.gserviceaccount.com',
+      'https://run-url'
+    )
+
+    expect(result).toBe(mockTaskName)
+    expect(mockCreateTask).toHaveBeenCalledTimes(1)
+  })
+
+  it('should throw error if task name is missing', async () => {
+    mockCreateTask.mockResolvedValue([{}]) // Simulate missing name
+
+    await expect(
+      createTask(
+        'test-project',
+        'us-central1',
+        'test-queue',
+        { foo: 'bar' },
+        'test@project.iam.gserviceaccount.com',
+        'https://example.com'
+      )
+    ).rejects.toThrow('Failed to create task: no name returned')
+  })
+})

package/src/utils/task.ts

@@ -0,0 +1,39 @@
+import { CloudTasksClient, protos } from '@google-cloud/tasks'
+
+const tasksClient = new CloudTasksClient()
+
+export async function createTask(
+  projectId: string,
+  region: string,
+  queueId: string,
+  data: unknown,
+  serviceAccount: string,
+  audience: string
+): Promise<string> {
+  if (!projectId || !region || !queueId || !serviceAccount || !audience) {
+    throw new Error('Missing required parameters for Cloud Tasks setup')
+  }
+
+  const parent = tasksClient.queuePath(projectId, region, queueId)
+
+  const task: protos.google.cloud.tasks.v2.ITask = {
+    httpRequest: {
+      httpMethod: protos.google.cloud.tasks.v2.HttpMethod.POST,
+      url: audience,
+      headers: {
+        'Content-Type': 'application/json'
+      },
+      body: Buffer.from(JSON.stringify(data)).toString('base64'),
+      oidcToken: {
+        serviceAccountEmail: serviceAccount,
+        audience
+      }
+    }
+  }
+
+  const [response] = await tasksClient.createTask({ parent, task })
+  if (!response.name) {
+    throw new Error('Failed to create task: no name returned')
+  }
+  return response.name
+}