fix(serve): the /auth route still need to contain "Authorization" header issue

- add the /auth route checking in auth credential middleware.
- refactor integration-testing example structure and add authenticate example

Author: kokokuo

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

@@ -0,0 +1,36 @@
+import { VulcanBuilder } from '@vulcan-sql/build';
+import { VulcanServer } from '@vulcan-sql/serve';
+import * as supertest from 'supertest';
+import projectConfig from './projectConfig';
+
+let server: VulcanServer;
+
+afterEach(async () => {
+  await server?.close();
+});
+
+it.each([
+  [
+    '436193eb-f686-4105-ad7b-b5945276c14a',
+    [
+      {
+        id: '436193eb-f686-4105-ad7b-b5945276c14a',
+        name: 'ivan',
+      },
+    ],
+  ],
+  ['2dc839e0-0f65-4dba-ac38-4eaf023d0008', []],
+])(
+  'Example1: Build and serve should work',
+  async (userId, expected) => {
+    const builder = new VulcanBuilder(projectConfig);
+    await builder.build();
+    server = new VulcanServer(projectConfig);
+    const httpServer = (await server.start())['http'];
+
+    const agent = supertest(httpServer);
+    const result = await agent.get(`/api/user/${userId}`);
+    expect(JSON.stringify(result.body)).toEqual(JSON.stringify(expected));
+  },
+  10000
+);

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

@@ -0,0 +1,47 @@
+import { IBuildOptions, VulcanBuilder } from '@vulcan-sql/build';
+import { ServeConfig, VulcanServer } from '@vulcan-sql/serve';
+
+import * as supertest from 'supertest';
+import defaultConfig from './projectConfig';
+
+let server: VulcanServer;
+
+const projectConfig: ServeConfig & IBuildOptions = {
+  ...defaultConfig,
+  auth: {
+    enabled: true,
+    options: {
+      basic: {
+        'users-list': [
+          {
+            name: 'user1',
+            // md5('test1')
+            md5Password: '5a105e8b9d40e1329780d62ea2265d8a',
+            attr: {
+              role: 'admin',
+            },
+          },
+        ],
+      },
+    },
+  },
+};
+
+afterEach(async () => {
+  await server.close();
+});
+
+it('Example1-2: authenticate user identity by /auth API', async () => {
+  const builder = new VulcanBuilder(projectConfig);
+  await builder.build();
+  server = new VulcanServer(projectConfig);
+  const httpServer = (await server.start())['http'];
+
+  const agent = supertest(httpServer);
+  const result = await agent.get(
+    '/auth?type=basic&username=user1&password=test1'
+  );
+  expect(result.body).toEqual({
+    token: 'dXNlcjE6dGVzdDE=',
+  });
+}, 10000);

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

@@ -1,20 +1,15 @@
-import {
-  VulcanBuilder,
-  IBuildOptions,
-  SchemaReaderType,
-} from '@vulcan-sql/build';
+import { SchemaReaderType } from '@vulcan-sql/build';
 import {
   ArtifactBuilderProviderType,
   ArtifactBuilderSerializerType,
   TemplateProviderType,
   DocumentSpec,
 } from '@vulcan-sql/core';
-import { VulcanServer, ServeConfig, APIProviderType } from '@vulcan-sql/serve';
+import { APIProviderType } from '@vulcan-sql/serve';
 import * as path from 'path';
-import * as supertest from 'supertest';
 import faker from '@faker-js/faker';
 
-const projectConfig: ServeConfig & IBuildOptions = {
+export default {
   name: 'example project 1',
   description: 'Vulcan project for integration testing',
   version: '0.0.1',
@@ -53,35 +48,3 @@ const projectConfig: ServeConfig & IBuildOptions = {
   },
   port: faker.datatype.number({ min: 20000, max: 30000 }),
 };
-
-let server: VulcanServer;
-
-afterEach(async () => {
-  await server?.close();
-});
-
-it.each([
-  [
-    '436193eb-f686-4105-ad7b-b5945276c14a',
-    [
-      {
-        id: '436193eb-f686-4105-ad7b-b5945276c14a',
-        name: 'ivan',
-      },
-    ],
-  ],
-  ['2dc839e0-0f65-4dba-ac38-4eaf023d0008', []],
-])(
-  'Example1: Build and serve should work',
-  async (userId, expected) => {
-    const builder = new VulcanBuilder(projectConfig);
-    await builder.build();
-    server = new VulcanServer(projectConfig);
-    const httpServer = (await server.start())['http'];
-
-    const agent = supertest(httpServer);
-    const result = await agent.get(`/api/user/${userId}`);
-    expect(JSON.stringify(result.body)).toEqual(JSON.stringify(expected));
-  },
-  10000
-);

packages/serve/src/lib/middleware/auth/authCredentialMiddleware.ts

@@ -57,6 +57,9 @@ export class AuthCredentialMiddleware extends BuiltInMiddleware<AuthOptions> {
 
     const options = this.getOptions() as AuthOptions;
 
+    // The /auth endpoint not need contains "Authorization" in header and auth credentials
+    if (context.path === '/auth') return;
+
     // pass current context to auth token for users
     for (const name of Object.keys(this.authenticators)) {
       // skip the disappeared auth type name in options