@dbos-inc/koa-serve 3.5.7 → 3.5.44-preview.gc094fdab44

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dbos-inc/koa-serve",
-  "version": "3.5.7",
+  "version": "3.5.44-preview.gc094fdab44",
   "description": "DBOS HTTP Package for serving workflows with Koa",
   "license": "MIT",
   "repository": {

package/src/dboshttp.ts

@@ -2,20 +2,7 @@ import { IncomingHttpHeaders } from 'http';
 import { ParsedUrlQuery } from 'querystring';
 import { randomUUID } from 'node:crypto';
 
-import {
-  DBOS,
-  DBOSLifecycleCallback,
-  Error as DBOSErrors,
-  MethodParameter,
-  requestArgValidation,
-  ArgRequired,
-  ArgOptional,
-  DefaultArgRequired,
-  DefaultArgValidate,
-  DefaultArgOptional,
-  ArgDate,
-  ArgVarchar,
-} from '@dbos-inc/dbos-sdk';
+import { DBOS, DBOSLifecycleCallback, Error as DBOSErrors, MethodParameter } from '@dbos-inc/dbos-sdk';
 
 export enum APITypes {
   GET = 'GET',
@@ -107,7 +94,7 @@ export class DBOSHTTPBase implements DBOSLifecycleCallback {
       propertyKey: string,
       descriptor: TypedPropertyDescriptor<(this: This, ...args: Args) => Promise<Return>>,
     ) {
-      const { registration, regInfo } = DBOS.associateFunctionWithInfo(er, descriptor.value!, {
+      const { regInfo } = DBOS.associateFunctionWithInfo(er, descriptor.value!, {
         ctorOrProto: target,
         name: propertyKey,
       });
@@ -117,7 +104,6 @@ export class DBOSHTTPBase implements DBOSLifecycleCallback {
         apiURL: url,
         apiType: verb,
       });
-      requestArgValidation(registration);
 
       return descriptor;
     };
@@ -148,27 +134,9 @@ export class DBOSHTTPBase implements DBOSLifecycleCallback {
     return this.httpApiDec(APITypes.DELETE, url);
   }
 
-  /** Parameter decorator indicating which source to use (URL, BODY, etc) for arg data */
-  static argSource(source: ArgSources) {
-    return function (target: object, propertyKey: PropertyKey, parameterIndex: number) {
-      const curParam = DBOS.associateParamWithInfo(
-        DBOSHTTP,
-        // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
-        Object.getOwnPropertyDescriptor(target, propertyKey)!.value,
-        {
-          ctorOrProto: target,
-          name: propertyKey.toString(),
-          param: parameterIndex,
-        },
-      ) as DBOSHTTPArgInfo;
-
-      curParam.argSource = source;
-    };
-  }
-
   protected getArgSource(arg: MethodParameter) {
-    const arginfo = arg.getRegisteredInfo(DBOSHTTP) as DBOSHTTPArgInfo;
-    return arginfo?.argSource ?? ArgSources.AUTO;
+    void arg;
+    return ArgSources.AUTO;
   }
 
   logRegisteredEndpoints(): void {
@@ -189,29 +157,4 @@ export class DBOSHTTPBase implements DBOSLifecycleCallback {
       }
     }
   }
-
-  static argRequired(target: object, propertyKey: PropertyKey, parameterIndex: number) {
-    ArgRequired(target, propertyKey, parameterIndex);
-  }
-
-  static argOptional(target: object, propertyKey: PropertyKey, parameterIndex: number) {
-    ArgOptional(target, propertyKey, parameterIndex);
-  }
-
-  static argDate() {
-    return ArgDate();
-  }
-  static argVarchar(n: number) {
-    return ArgVarchar(n);
-  }
-
-  static defaultArgRequired<T extends { new (...args: unknown[]): object }>(ctor: T) {
-    return DefaultArgRequired(ctor);
-  }
-  static defaultArgOptional<T extends { new (...args: unknown[]): object }>(ctor: T) {
-    return DefaultArgOptional(ctor);
-  }
-  static defaultArgValidate<T extends { new (...args: unknown[]): object }>(ctor: T) {
-    return DefaultArgValidate(ctor);
-  }
 }

package/src/dboskoa.ts

@@ -344,7 +344,7 @@ export class DBOSKoa extends DBOSHTTPBase {
           } catch (e) {
             if (e instanceof Error) {
               span?.setStatus({ code: SpanStatusCode.ERROR, message: e.message });
-              let st = (e as DBOSErrors.DBOSResponseError)?.status || 500;
+              let st = 500;
               if (isClientRequestError(e)) {
                 st = 400; // Set to 400: client-side error.
               }

package/src/index.ts

@@ -1,5 +1,3 @@
-import { DBOSKoa } from './dboskoa';
-
 export {
   ArgSources,
   DBOSHTTP,
@@ -14,17 +12,3 @@ export {
 } from './dboshttp';
 
 export { DBOSKoa, DBOSKoaAuthContext, DBOSKoaClassReg, DBOSKoaAuthMiddleware, DBOSKoaConfig } from './dboskoa';
-
-// Export these as unbound functions.  We know this is safe,
-//  and it more closely matches the existing library syntax.
-// (Using the static function as a decorator, for some reason,
-//  is erroneously getting considered as unbound by some lint versions,
-//  as there are no parens following it?)
-export const DefaultArgOptional = DBOSKoa.defaultArgOptional;
-export const DefaultArgRequired = DBOSKoa.defaultArgRequired;
-export const DefaultArgValidate = DBOSKoa.defaultArgValidate;
-export const ArgDate = DBOSKoa.argDate;
-export const ArgOptional = DBOSKoa.argOptional;
-export const ArgRequired = DBOSKoa.argRequired;
-export const ArgSource = DBOSKoa.argSource;
-export const ArgVarchar = DBOSKoa.argVarchar;

package/tests/auth.test.ts

@@ -9,21 +9,13 @@ import request from 'supertest';
 
 const dhttp = new DBOSKoa();
 
-interface TestKvTable {
-  id?: number;
-  value?: string;
-}
-
 describe('httpserver-defsec-tests', () => {
   let app: Koa;
   let appRouter: Router;
 
-  const testTableName = 'dbos_test_kv';
-
   beforeAll(async () => {
     DBOS.setConfig({
       name: 'dbos-koa-test',
-      userDatabaseClient: 'pg-node',
     });
     return Promise.resolve();
   });
@@ -31,8 +23,6 @@ describe('httpserver-defsec-tests', () => {
   beforeEach(async () => {
     const _classes = [TestEndpointDefSec, SecondClass];
     await DBOS.launch();
-    await DBOS.queryUserDB(`DROP TABLE IF EXISTS ${testTableName};`);
-    await DBOS.queryUserDB(`CREATE TABLE IF NOT EXISTS ${testTableName} (id SERIAL PRIMARY KEY, value TEXT);`);
     middlewareCounter = 0;
     middlewareCounter2 = 0;
     middlewareCounterG = 0;
@@ -71,17 +61,17 @@ describe('httpserver-defsec-tests', () => {
 
   test('not-authenticated', async () => {
     const response = await request(app.callback()).get('/requireduser?name=alice');
-    expect(response.statusCode).toBe(401);
+    expect(response.statusCode).toBe(500);
   });
 
   test('not-you', async () => {
     const response = await request(app.callback()).get('/requireduser?name=alice&userid=go_away');
-    expect(response.statusCode).toBe(401);
+    expect(response.statusCode).toBe(500);
   });
 
   test('not-authorized', async () => {
     const response = await request(app.callback()).get('/requireduser?name=alice&userid=bob');
-    expect(response.statusCode).toBe(403);
+    expect(response.statusCode).toBe(500);
   });
 
   test('authorized', async () => {
@@ -93,22 +83,6 @@ describe('httpserver-defsec-tests', () => {
   test('cascade-authorized', async () => {
     const response = await request(app.callback()).get('/workflow?name=alice&userid=a_real_user');
     expect(response.statusCode).toBe(200);
-
-    const txnResponse = await request(app.callback()).get('/transaction?name=alice&userid=a_real_user');
-    expect(txnResponse.statusCode).toBe(200);
-  });
-
-  // We can directly test a transaction with passed in authorizedRoles.
-  test('direct-transaction-test', async () => {
-    await DBOS.withAuthedContext('user', ['user'], async () => {
-      const res = await TestEndpointDefSec.testTranscation('alice');
-      expect(res).toBe('hello 1');
-    });
-
-    // Unauthorized.
-    await expect(TestEndpointDefSec.testTranscation('alice')).rejects.toThrow(
-      new DBOSError.DBOSNotAuthorizedError('User does not have a role with permission to call testTranscation', 403),
-    );
   });
 
   async function authTestMiddleware(ctx: DBOSKoaAuthContext) {
@@ -171,18 +145,14 @@ describe('httpserver-defsec-tests', () => {
       return Promise.resolve(`Please say hello to ${name}`);
     }
 
-    @DBOS.transaction()
-    static async testTranscation(name: string) {
-      const { rows } = await DBOS.pgClient.query<TestKvTable>(
-        `INSERT INTO ${testTableName}(value) VALUES ($1) RETURNING id`,
-        [name],
-      );
-      return `hello ${rows[0].id}`;
+    @DBOS.step()
+    static async testStep(name: string) {
+      return Promise.resolve(`hello ${name}`);
     }
 
     @DBOS.workflow()
     static async testWorkflow(name: string) {
-      const res = await TestEndpointDefSec.testTranscation(name);
+      const res = await TestEndpointDefSec.testStep(name);
       return res;
     }
 
@@ -190,11 +160,6 @@ describe('httpserver-defsec-tests', () => {
     static async testWfEndpoint(name: string) {
       return await TestEndpointDefSec.testWorkflow(name);
     }
-
-    @dhttp.getApi('/transaction')
-    static async testTxnEndpoint(name: string) {
-      return await TestEndpointDefSec.testTranscation(name);
-    }
   }
 
   class SecondClass {

package/tests/endpoints.test.ts

@@ -2,7 +2,7 @@
 import Koa from 'koa';
 import Router from '@koa/router';
 
-import { DBOS, DBOSResponseError, Error as DBOSErrors, StatusString } from '@dbos-inc/dbos-sdk';
+import { DBOS, Error as DBOSErrors, StatusString } from '@dbos-inc/dbos-sdk';
 
 import { DBOSKoa, DBOSKoaAuthContext, RequestIDHeader, WorkflowIDHeader } from '../src';
 
@@ -10,11 +10,6 @@ import request from 'supertest';
 
 const dhttp = new DBOSKoa();
 
-interface TestKvTable {
-  id?: number;
-  value?: string;
-}
-
 import { randomUUID } from 'node:crypto';
 import { IncomingMessage } from 'http';
 import { bodyParser } from '@koa/bodyparser';
@@ -29,12 +24,9 @@ describe('httpserver-tests', () => {
   let app: Koa;
   let appRouter: Router;
 
-  const testTableName = 'dbos_test_kv';
-
   beforeAll(async () => {
     DBOS.setConfig({
       name: 'dbos-koa-test',
-      userDatabaseClient: 'pg-node',
     });
     return Promise.resolve();
   });
@@ -42,8 +34,6 @@ describe('httpserver-tests', () => {
   beforeEach(async () => {
     const _classes = [TestEndpoints];
     await DBOS.launch();
-    await DBOS.queryUserDB(`DROP TABLE IF EXISTS ${testTableName};`);
-    await DBOS.queryUserDB(`CREATE TABLE IF NOT EXISTS ${testTableName} (id INT PRIMARY KEY, value TEXT);`);
     app = new Koa();
     appRouter = new Router();
     dhttp.registerWithApp(app, appRouter);
@@ -107,17 +97,12 @@ describe('httpserver-tests', () => {
   });
 
   test('post-test-custom-body', async () => {
-    let response = await request(app.callback())
+    const response = await request(app.callback())
       .post('/testpost')
       .set('Content-Type', 'application/custom-content-type')
       .send(JSON.stringify({ name: 'alice' }));
     expect(response.statusCode).toBe(200);
     expect(response.text).toBe('hello alice');
-    response = await request(app.callback())
-      .post('/testpost')
-      .set('Content-Type', 'application/rejected-custom-content-type')
-      .send(JSON.stringify({ name: 'alice' }));
-    expect(response.statusCode).toBe(400);
   });
 
   test('put-test', async () => {
@@ -127,17 +112,12 @@ describe('httpserver-tests', () => {
   });
 
   test('put-test-custom-body', async () => {
-    let response = await request(app.callback())
+    const response = await request(app.callback())
       .put('/testput')
       .set('Content-Type', 'application/custom-content-type')
       .send(JSON.stringify({ name: 'alice' }));
     expect(response.statusCode).toBe(200);
     expect(response.text).toBe('hello alice');
-    response = await request(app.callback())
-      .put('/testput')
-      .set('Content-Type', 'application/rejected-custom-content-type')
-      .send(JSON.stringify({ name: 'alice' }));
-    expect(response.statusCode).toBe(400);
   });
 
   test('patch-test', async () => {
@@ -147,23 +127,12 @@ describe('httpserver-tests', () => {
   });
 
   test('patch-test-custom-body', async () => {
-    let response = await request(app.callback())
+    const response = await request(app.callback())
       .patch('/testpatch')
       .set('Content-Type', 'application/custom-content-type')
       .send(JSON.stringify({ name: 'alice' }));
     expect(response.statusCode).toBe(200);
     expect(response.text).toBe('hello alice');
-    response = await request(app.callback())
-      .patch('/testpatch')
-      .set('Content-Type', 'application/rejected-custom-content-type')
-      .send(JSON.stringify({ name: 'alice' }));
-    expect(response.statusCode).toBe(400);
-  });
-
-  test('endpoint-transaction', async () => {
-    const response = await request(app.callback()).post('/transaction/alice');
-    expect(response.statusCode).toBe(200);
-    expect(response.text).toBe('hello 1');
   });
 
   test('endpoint-step', async () => {
@@ -175,31 +144,30 @@ describe('httpserver-tests', () => {
   test('endpoint-workflow', async () => {
     const response = await request(app.callback()).post('/workflow?name=alice');
     expect(response.statusCode).toBe(200);
-    expect(response.text).toBe('hello 1');
+    expect(response.text).toBe('alice');
   });
 
   test('endpoint-error', async () => {
     const response = await request(app.callback()).post('/error').send({ name: 'alice' });
     expect(response.statusCode).toBe(500);
-    expect(response.body.details.code).toBe('23505'); // Should be the expected error.
   });
 
   test('endpoint-handler', async () => {
     const response = await request(app.callback()).get('/handler/alice');
     expect(response.statusCode).toBe(200);
-    expect(response.text).toBe('hello 1');
+    expect(response.text).toBe('alice');
   });
 
   test('endpoint-testStartWorkflow', async () => {
     const response = await request(app.callback()).get('/testStartWorkflow/alice');
     expect(response.statusCode).toBe(200);
-    expect(response.text).toBe('hello 1');
+    expect(response.text).toBe('alice');
   });
 
   test('endpoint-testInvokeWorkflow', async () => {
     const response = await request(app.callback()).get('/testInvokeWorkflow/alice');
     expect(response.statusCode).toBe(200);
-    expect(response.text).toBe('hello 1');
+    expect(response.text).toBe('alice');
   });
 
   // This feels unclean, but supertest doesn't expose the error message the people we want. See:
@@ -210,17 +178,11 @@ describe('httpserver-tests', () => {
 
   test('response-error', async () => {
     const response = await request(app.callback()).get('/dbos-error');
-    expect(response.statusCode).toBe(503);
+    expect(response.statusCode).toBe(500);
     expect((response as unknown as Res).res.statusMessage).toBe('customize error');
     expect(response.body.message).toBe('customize error');
   });
 
-  test('datavalidation-error', async () => {
-    const response = await request(app.callback()).get('/query');
-    expect(response.statusCode).toBe(400);
-    expect(response.body.details.dbosErrorCode).toBe(9);
-  });
-
   test('dbos-redirect', async () => {
     const response = await request(app.callback()).get('/redirect');
     expect(response.statusCode).toBe(302);
@@ -248,17 +210,17 @@ describe('httpserver-tests', () => {
 
   test('not-authenticated', async () => {
     const response = await request(app.callback()).get('/requireduser?name=alice');
-    expect(response.statusCode).toBe(401);
+    expect(response.statusCode).toBe(500);
   });
 
   test('not-you', async () => {
     const response = await request(app.callback()).get('/requireduser?name=alice&userid=go_away');
-    expect(response.statusCode).toBe(401);
+    expect(response.statusCode).toBe(500);
   });
 
   test('not-authorized', async () => {
     const response = await request(app.callback()).get('/requireduser?name=alice&userid=bob');
-    expect(response.statusCode).toBe(403);
+    expect(response.statusCode).toBe(500);
   });
 
   test('authorized', async () => {
@@ -268,17 +230,17 @@ describe('httpserver-tests', () => {
 
   test('not-authenticated2', async () => {
     const response = await request(app.callback()).get('/requireduser2?name=alice');
-    expect(response.statusCode).toBe(401);
+    expect(response.statusCode).toBe(500);
   });
 
   test('not-you2', async () => {
     const response = await request(app.callback()).get('/requireduser2?name=alice&userid=go_away');
-    expect(response.statusCode).toBe(401);
+    expect(response.statusCode).toBe(500);
   });
 
   test('not-authorized2', async () => {
     const response = await request(app.callback()).get('/requireduser2?name=alice&userid=bob');
-    expect(response.statusCode).toBe(403);
+    expect(response.statusCode).toBe(500);
   });
 
   test('authorized2', async () => {
@@ -292,12 +254,12 @@ describe('httpserver-tests', () => {
       .post('/workflow?name=bob')
       .set({ 'dbos-idempotency-key': workflowID });
     expect(response.statusCode).toBe(200);
-    expect(response.text).toBe('hello 1');
+    expect(response.text).toBe('bob');
 
     // Retrieve the workflow with WFID.
     const retrievedHandle = DBOS.retrieveWorkflow(workflowID);
     expect(retrievedHandle).not.toBeNull();
-    await expect(retrievedHandle.getResult()).resolves.toBe('hello 1');
+    await expect(retrievedHandle.getResult()).resolves.toBe('bob');
     await expect(retrievedHandle.getStatus()).resolves.toMatchObject({
       status: StatusString.SUCCESS,
     });
@@ -307,12 +269,12 @@ describe('httpserver-tests', () => {
     const workflowID = randomUUID();
     const response = await request(app.callback()).get('/handler/bob').set({ 'dbos-idempotency-key': workflowID });
     expect(response.statusCode).toBe(200);
-    expect(response.text).toBe('hello 1');
+    expect(response.text).toBe('bob');
 
     // Retrieve the workflow with WFID.
     const retrievedHandle = DBOS.retrieveWorkflow(workflowID);
     expect(retrievedHandle).not.toBeNull();
-    await expect(retrievedHandle.getResult()).resolves.toBe('hello 1');
+    await expect(retrievedHandle.getResult()).resolves.toBe('bob');
     await expect(retrievedHandle.getStatus()).resolves.toMatchObject({
       status: StatusString.SUCCESS,
     });
@@ -349,7 +311,6 @@ describe('httpserver-tests', () => {
       parsedMethods: ['POST', 'PUT', 'PATCH', 'GET', 'DELETE'],
     }),
   )
-  @DBOSKoa.defaultArgRequired
   class TestEndpoints {
     @dhttp.getApi('/hello')
     static async hello() {
@@ -378,6 +339,12 @@ describe('httpserver-tests', () => {
       return Promise.resolve(url);
     }
 
+    @dhttp.getApi('/dbos-error')
+    @DBOS.workflow()
+    static async dbosErr() {
+      return Promise.reject(new Error('customize error'));
+    }
+
     @dhttp.getApi('/query')
     static async helloQuery(name: string) {
       DBOS.logger.info(`query with name ${name}`); // Test logging.
@@ -423,12 +390,6 @@ describe('httpserver-tests', () => {
       return Promise.resolve(`hello ${name}`);
     }
 
-    @dhttp.getApi('/dbos-error')
-    @DBOS.transaction()
-    static async dbosErr() {
-      return Promise.reject(new DBOSResponseError('customize error', 503));
-    }
-
     @dhttp.getApi('/handler/:name')
     static async testHandler(name: string) {
       const workflowID: string = DBOSKoa.koaContext.get(WorkflowIDHeader);
@@ -450,16 +411,6 @@ describe('httpserver-tests', () => {
       return await TestEndpoints.testWorkflow(name);
     }
 
-    @dhttp.postApi('/transaction/:name')
-    @DBOS.transaction()
-    static async testTransaction(name: string) {
-      const { rows } = await DBOS.pgClient.query<TestKvTable>(
-        `INSERT INTO ${testTableName}(id, value) VALUES (1, $1) RETURNING id`,
-        [name],
-      );
-      return `hello ${rows[0].id}`;
-    }
-
     @dhttp.getApi('/step/:input')
     @DBOS.step()
     static async testStep(input: string) {
@@ -469,30 +420,27 @@ describe('httpserver-tests', () => {
     @dhttp.postApi('/workflow')
     @DBOS.workflow()
     static async testWorkflow(name: string) {
-      const res = await TestEndpoints.testTransaction(name);
-      return TestEndpoints.testStep(res);
+      return TestEndpoints.testStep(name);
     }
 
     @dhttp.postApi('/error')
     @DBOS.workflow()
     static async testWorkflowError(name: string) {
-      // This workflow should encounter duplicate primary key error.
-      let res = await TestEndpoints.testTransaction(name);
-      res = await TestEndpoints.testTransaction(name);
-      return res;
+      await Promise.resolve();
+      throw Error(name);
     }
 
     @dhttp.getApi('/requireduser')
     @DBOS.requiredRole(['user'])
     static async testAuth(name: string) {
       if (DBOS.authenticatedUser !== 'a_real_user') {
-        throw new DBOSResponseError('uid not a real user!', 400);
+        throw new Error('uid not a real user!');
       }
       if (!DBOS.authenticatedRoles.includes('user')) {
-        throw new DBOSResponseError("roles don't include user!", 400);
+        throw new Error("roles don't include user!");
       }
       if (DBOS.assumedRole !== 'user') {
-        throw new DBOSResponseError('Should never happen! Not assumed to be user', 400);
+        throw new Error('Should never happen! Not assumed to be user');
       }
       return Promise.resolve(`Please say hello to ${name}`);
     }
@@ -501,13 +449,13 @@ describe('httpserver-tests', () => {
     @DBOS.requiredRole(['user'])
     static async testAuth2(name: string) {
       if (DBOS.authenticatedUser !== 'a_real_user') {
-        throw new DBOSResponseError('uid not a real user!', 400);
+        throw new Error('uid not a real user!');
       }
       if (!DBOS.authenticatedRoles.includes('user')) {
-        throw new DBOSResponseError("roles don't include user!", 400);
+        throw new Error("roles don't include user!");
       }
       if (DBOS.assumedRole !== 'user') {
-        throw new DBOSResponseError('Should never happen! Not assumed to be user', 400);
+        throw new Error('Should never happen! Not assumed to be user');
       }
       return Promise.resolve(`Please say hello to ${name}`);
     }

package/tests/steps.test.ts

@@ -56,14 +56,9 @@ describe('registerstep', () => {
     expect(response1.statusCode).toBe(200);
     const response2 = await request(app.callback()).get('/api/i2?user=jeremy');
     expect(response2.statusCode).toBe(200);
-    const response3 = await request(app.callback()).get('/api/i1');
-    expect(response3.statusCode).toBe(400);
-    const response4 = await request(app.callback()).get('/api/i2');
-    expect(response4.statusCode).toBe(400);
   });
 });
 
-@DBOSKoa.defaultArgValidate
 class KnexKoa {
   @customstep()
   @dhttp.getApi('/api/i2')

package/tests/transactions.test.ts

@@ -77,14 +77,9 @@ describe('KnexDataSource', () => {
     expect(response1.statusCode).toBe(200);
     const response2 = await request(app.callback()).get('/api/i2?user=jeremy');
     expect(response2.statusCode).toBe(200);
-    const response3 = await request(app.callback()).get('/api/i1');
-    expect(response3.statusCode).toBe(400);
-    const response4 = await request(app.callback()).get('/api/i2');
-    expect(response4.statusCode).toBe(400);
   });
 });
 
-@DBOSKoa.defaultArgValidate
 class KnexKoa {
   @knexds.transaction()
   @dhttp.getApi('/api/i2')