test(serve, int-test): test query from pg-mem

Author: oscar60310

package.json

@@ -56,6 +56,7 @@
     "from2": "^2.3.0",
     "jest": "27.5.1",
     "nx": "14.0.3",
+    "pg-mem": "^2.6.3",
     "prettier": "^2.5.1",
     "supertest": "^6.2.3",
     "ts-essentials": "^9.1.2",

packages/integration-testing/src/example1/buildAndServe.spec.ts

@@ -1,6 +1,7 @@
 import { VulcanBuilder, IBuildOptions } from '@vulcan-sql/build';
 import { VulcanServer, ServeConfig, APIProviderType } from '@vulcan-sql/serve';
 import * as path from 'path';
+import * as supertest from 'supertest';
 
 const projectConfig: ServeConfig & IBuildOptions = {
   name: 'example project 1',
@@ -24,12 +25,35 @@ const projectConfig: ServeConfig & IBuildOptions = {
     folderPath: __dirname,
   },
   types: [APIProviderType.RESTFUL],
+  executor: {
+    type: 'pg-mem',
+  },
+  extensions: {
+    mockEx: path.resolve(__dirname, '..', 'mockExtensions'),
+  },
+  'rate-limit': {
+    options: { interval: { min: 1 }, max: 10000 },
+  },
 };
 
-it('Example1: Build and server should work', async () => {
+let server: VulcanServer;
+
+afterEach(async () => {
+  await server.close();
+});
+
+it('Example1: Build and serve should work', async () => {
   const builder = new VulcanBuilder();
   await builder.build(projectConfig);
-  const server = new VulcanServer(projectConfig);
-  await server.start(3000);
-  await server.close();
+  server = new VulcanServer(projectConfig);
+  const httpServer = await server.start(3000);
+
+  const agent = supertest(httpServer);
+  const result = await agent.get(
+    '/user?id=436193eb-f686-4105-ad7b-b5945276c14a'
+  );
+  expect(result.body).toContainEqual({
+    id: '436193eb-f686-4105-ad7b-b5945276c14a',
+    name: 'ivan',
+  });
 }, 10000);

packages/integration-testing/src/example1/sqls/user.yaml

@@ -1,7 +1,7 @@
-url: /user/:id
+url: /user
 request:
   - fieldName: id
-    fieldIn: path
+    fieldIn: query
     description: user id
     validators:
       - uuid

packages/integration-testing/src/mockExtensions/index.ts

@@ -0,0 +1 @@
+export * from './mockDb';

packages/integration-testing/src/mockExtensions/mockDb.ts

@@ -0,0 +1,34 @@
+import {
+  DataResult,
+  DataSource,
+  ExecuteOptions,
+  VulcanExtensionId,
+} from '@vulcan-sql/core';
+import { newDb } from 'pg-mem';
+import { Stream } from 'stream';
+
+const db = newDb();
+db.public.many(`create table users(id uuid, name varchar);
+insert into users values ('436193eb-f686-4105-ad7b-b5945276c14a','ivan');
+`);
+
+@VulcanExtensionId('pg-mem')
+export class MockDataSource extends DataSource {
+  public async execute(options: ExecuteOptions): Promise<DataResult> {
+    const data = db.public.many(options.statement);
+    const readStream = new Stream.Readable({
+      objectMode: true,
+      read: () => null,
+    });
+    data.forEach((r) => readStream.push(r));
+    readStream.push(null);
+    return {
+      getColumns: () => {
+        return [];
+      },
+      getData: () => {
+        return readStream;
+      },
+    };
+  }
+}

packages/serve/src/lib/route/route-component/baseRoute.ts

@@ -52,7 +52,9 @@ export abstract class BaseRoute implements IRoute {
     const { reqParams } = transformed;
     // could template name or template path, use for template engine
     const { templateSource } = this.apiSchema;
-    const result = await this.templateEngine.execute(templateSource, reqParams);
+    const result = await this.templateEngine.execute(templateSource, {
+      context: { params: reqParams },
+    });
     return result;
   }
 }

packages/serve/src/lib/route/route-component/restfulRoute.ts

@@ -34,10 +34,10 @@ export class RestfulRoute extends BaseRoute {
 
   public async respond(ctx: KoaRouterContext) {
     const transformed = await this.prepare(ctx);
-    await this.handle(transformed);
-    // TODO: get template engine handled result and return response by checking API schema
+    const result = await this.handle(transformed);
     ctx.response.body = {
-      ...transformed,
+      data: result.getData(),
+      columns: result.getColumns(),
     };
   }