Merge pull request #295 from Canner/feature/pass-headers-down-to-datasource

onlyjackfrost · web-flow · commit fa73cfd332af · 2023-09-11T19:24:06.000+08:00
Feature(Core, Extension-driver-canner): pass headers down to datasource &amp; use info in API headers to connect to canner
diff --git a/packages/core/src/lib/data-query/builder/dataQueryBuilder.ts b/packages/core/src/lib/data-query/builder/dataQueryBuilder.ts
@@ -3,6 +3,7 @@ import {
   Pagination,
   DataResult,
   isOffsetPagination,
+  IncomingHttpHeaders,
 } from '@vulcan-sql/core/models';
 import * as uuid from 'uuid';
 import { find, isEmpty, isNull, isUndefined } from 'lodash';
@@ -411,6 +412,7 @@ export interface IDataQueryBuilder {
   take(size: number, move: number): IDataQueryBuilder;
   // paginate
   paginate(pagination: Pagination): void;
+  setHeaders(headers: IncomingHttpHeaders): void;
   value(): Promise<DataResult>;
   clone(): IDataQueryBuilder;
   parameterizeOperations(): Promise<Partial<Parameterized<SQLClauseOperation>>>;
@@ -425,19 +427,22 @@ export class DataQueryBuilder implements IDataQueryBuilder {
   public readonly identifier: string;
   private profileName: string;
   private parameterizer: IParameterizer;
+  private headers: IncomingHttpHeaders;
 
   constructor({
     statement,
     operations,
     parameterizer,
     dataSource,
     profileName,
+    headers,
   }: {
     statement: string;
     operations?: SQLClauseOperation;
     parameterizer: IParameterizer;
     dataSource: DataSource;
     profileName: string;
+    headers: IncomingHttpHeaders;
   }) {
     this.identifier = uuid.v4();
     this.statement = statement;
@@ -453,6 +458,7 @@ export class DataQueryBuilder implements IDataQueryBuilder {
       limit: null,
       offset: null,
     };
+    this.headers = headers;
     this.profileName = profileName;
   }
 
@@ -647,6 +653,7 @@ export class DataQueryBuilder implements IDataQueryBuilder {
       dataSource: this.dataSource,
       parameterizer: this.parameterizer,
       profileName: this.profileName,
+      headers: this.headers,
     });
     builderCallback(wrappedBuilder);
     this.recordWhere({
@@ -1096,6 +1103,7 @@ export class DataQueryBuilder implements IDataQueryBuilder {
       operations: this.operations,
       parameterizer: this.parameterizer.clone(),
       profileName: this.profileName,
+      headers: this.headers,
     });
   }
 
@@ -1107,6 +1115,11 @@ export class DataQueryBuilder implements IDataQueryBuilder {
     this.take(pagination.limit, pagination.offset);
   }
 
+  public setHeaders(headers: IncomingHttpHeaders) {
+    if (!headers) return;
+    this.headers = headers;
+  }
+
   public async parameterizeOperations(): Promise<
     Partial<Parameterized<SQLClauseOperation>>
   > {
@@ -1127,6 +1140,7 @@ export class DataQueryBuilder implements IDataQueryBuilder {
       operations: await this.parameterizeOperations(),
       bindParams: this.parameterizer.getBinding(),
       profileName: this.profileName,
+      headers: this.headers,
     });
 
     return result;
diff --git a/packages/core/src/lib/data-query/executor.ts b/packages/core/src/lib/data-query/executor.ts
@@ -1,5 +1,6 @@
 import {
   DataSource,
+  IncomingHttpHeaders,
   PrepareParameterFunc,
   RequestParameter,
 } from '@vulcan-sql/core/models';
@@ -12,7 +13,8 @@ export interface IExecutor {
   createBuilder(
     profileName: string,
     query: string,
-    parameterizer: IParameterizer
+    parameterizer: IParameterizer,
+    headers?: IncomingHttpHeaders
   ): Promise<IDataQueryBuilder>;
   prepare: PrepareParameterFunc;
 }
@@ -39,13 +41,15 @@ export class QueryExecutor implements IExecutor {
   public async createBuilder(
     profileName: string,
     query: string,
-    parameterizer: IParameterizer
+    parameterizer: IParameterizer,
+    headers?: IncomingHttpHeaders
   ) {
     return new DataQueryBuilder({
       statement: query,
       parameterizer,
       dataSource: this.dataSourceFactory(profileName)!,
       profileName,
+      headers: headers || {},
     });
   }
 }
diff --git a/packages/core/src/lib/template-engine/built-in-extensions/cache/cacheTagRunner.ts b/packages/core/src/lib/template-engine/built-in-extensions/cache/cacheTagRunner.ts
@@ -25,7 +25,7 @@ export class CacheTagRunner extends TagRunner {
     this.executor = executor;
   }
 
-  public async run({ context, args, contentArgs }: TagRunnerOptions) {
+  public async run({ context, args, contentArgs, metadata }: TagRunnerOptions) {
     // Get the variable name, if the cache tag has variable name, then we use the variable and keep the builder in the variable, and make user could use by xxx.value() like the req feature.
     // However if the cache tag not has variable name, means you would like to get the result directly after query, then we will replace the original query main builder to the cache builder.
     const name = String(args[0]);
@@ -50,10 +50,12 @@ export class CacheTagRunner extends TagRunner {
     // Set the default vulcan created cache table schema, so we could query the cache table directly, not need user to type schema in the SQL.
     query = `set schema=${vulcanCacheSchemaName};`.concat('\n').concat(query);
     // Create the builder which access "vulcan.cache" data source for cache layer query
+    const headers = metadata.getHeaders();
     const builder = await this.executor.createBuilder(
       cacheProfileName,
       query,
-      parameterizer
+      parameterizer,
+      headers
     );
     context.setVariable(name, builder);
 
diff --git a/packages/core/src/lib/template-engine/built-in-extensions/query-builder/reqTagRunner.ts b/packages/core/src/lib/template-engine/built-in-extensions/query-builder/reqTagRunner.ts
@@ -47,16 +47,20 @@ export class ReqTagRunner extends TagRunner {
       .join('\n')
       .replace(/--.*(?:\n|$)|\/\*[\s\S]*?\*\//g, ''); // remove single-line comments and multi-line comments
 
+    const headers = metadata.getHeaders();
     let builder: IDataQueryBuilder | undefined;
     // Replace to put the directly query cache builder to original query main builder of  "__wrapper__builder",
     // it means we can use the cache builder to execute the query directly and get result to be final result
     builder = context.lookup(CACHE_MAIN_BUILDER_VAR_NAME);
-    if (builder) context.setVariable(name, builder);
-    else {
+    if (builder) {
+      if (headers) builder.setHeaders(headers);
+      context.setVariable(name, builder);
+    } else {
       builder = await this.executor.createBuilder(
         profileName,
         query,
-        parameterizer
+        parameterizer,
+        headers
       );
       context.setVariable(name, builder);
     }
diff --git a/packages/core/src/lib/template-engine/compiler.ts b/packages/core/src/lib/template-engine/compiler.ts
@@ -1,4 +1,8 @@
-import { DataResult, KoaRequest } from '@vulcan-sql/core/models';
+import {
+  DataResult,
+  IncomingHttpHeaders,
+  KoaRequest,
+} from '@vulcan-sql/core/models';
 import { Pagination } from '../../models/pagination';
 
 export interface TemplateLocation {
@@ -32,6 +36,7 @@ export interface ExecuteContext {
   user?: UserInfo;
   profileName: string;
   req?: KoaRequest;
+  headers?: IncomingHttpHeaders;
 }
 
 export interface Compiler {
diff --git a/packages/core/src/lib/template-engine/nunjucksExecutionMetadata.ts b/packages/core/src/lib/template-engine/nunjucksExecutionMetadata.ts
@@ -1,6 +1,6 @@
 import * as nunjucks from 'nunjucks';
 import { ExecuteContext, UserInfo } from './compiler';
-import { KoaRequest } from '@vulcan-sql/core/models';
+import { IncomingHttpHeaders, KoaRequest } from '@vulcan-sql/core/models';
 
 export const ReservedContextKeys = {
   CurrentProfileName: 'RESERVED_CURRENT_PROFILE_NAME',
@@ -12,12 +12,20 @@ export class NunjucksExecutionMetadata {
   private parameters: Record<string, any>;
   private userInfo?: UserInfo;
   private req?: KoaRequest;
+  private headers?: IncomingHttpHeaders;
 
-  constructor({ parameters = {}, profileName, user, req }: ExecuteContext) {
+  constructor({
+    parameters = {},
+    profileName,
+    user,
+    req,
+    headers,
+  }: ExecuteContext) {
     this.parameters = parameters;
     this.profileName = profileName;
     this.userInfo = user;
     this.req = req;
+    this.headers = headers;
   }
 
   /** Load from nunjucks context */
@@ -26,6 +34,7 @@ export class NunjucksExecutionMetadata {
       parameters: context.lookup('context')?.params || {},
       user: context.lookup('context')?.user || {},
       req: context.lookup('context')?.req || {},
+      headers: context.lookup('context')?.headers || {},
       profileName: context.lookup(ReservedContextKeys.CurrentProfileName)!,
     });
   }
@@ -38,6 +47,7 @@ export class NunjucksExecutionMetadata {
         user: this.userInfo,
         req: this.req,
         profile: this.profileName,
+        headers: this.headers,
       },
       [ReservedContextKeys.CurrentProfileName]: this.profileName,
     };
@@ -54,4 +64,8 @@ export class NunjucksExecutionMetadata {
   public getRequest() {
     return this.req;
   }
+
+  public getHeaders() {
+    return this.headers;
+  }
 }
diff --git a/packages/core/src/models/artifact.ts b/packages/core/src/models/artifact.ts
@@ -30,8 +30,10 @@ import {
 import { Type } from 'class-transformer';
 import 'reflect-metadata';
 import { Request as KoaRequest } from 'koa';
+import { IncomingHttpHeaders } from 'http';
 
 export type { KoaRequest };
+export type { IncomingHttpHeaders };
 
 // Pagination mode should always be UPPERCASE because schema parser will transform the user inputs.
 export enum PaginationMode {
diff --git a/packages/core/src/models/extensions/dataSource.ts b/packages/core/src/models/extensions/dataSource.ts
@@ -1,6 +1,10 @@
 /* eslint-disable @typescript-eslint/no-unused-vars */
 import { Parameterized, SQLClauseOperation } from '@vulcan-sql/core/data-query';
-import { CacheLayerStoreFormatType, Profile } from '@vulcan-sql/core/models';
+import {
+  CacheLayerStoreFormatType,
+  IncomingHttpHeaders,
+  Profile,
+} from '@vulcan-sql/core/models';
 import { TYPES } from '@vulcan-sql/core/types';
 import { inject, multiInject, optional } from 'inversify';
 import { Readable } from 'stream';
@@ -58,6 +62,7 @@ export interface ExecuteOptions {
   /** The parameter bindings, we guarantee the order of the keys in the map is the same as the order when they were used in queries. */
   bindParams: BindParameters;
   profileName: string;
+  headers?: IncomingHttpHeaders;
 }
 
 export type PrepareParameterFunc = {
diff --git a/packages/core/test/data-query/builder/group-by-clause.spec.ts b/packages/core/test/data-query/builder/group-by-clause.spec.ts
@@ -35,6 +35,7 @@ describe('Test data query builder > group by clause', () => {
         dataSource: stubDataSource,
         parameterizer: stubParameterizer,
         profileName: '',
+        headers: {},
       });
       columns.map((column) => {
         builder = builder.groupBy(column);
@@ -62,6 +63,7 @@ describe('Test data query builder > group by clause', () => {
         dataSource: stubDataSource,
         parameterizer: stubParameterizer,
         profileName: '',
+        headers: {},
       });
       builder.groupBy(first, second, third);
 
diff --git a/packages/core/test/data-query/builder/having-clause.spec.ts b/packages/core/test/data-query/builder/having-clause.spec.ts
@@ -32,6 +32,7 @@ const createStubBuilder = ({ statement }: { statement: string }) =>
     dataSource: createStub().dataSource,
     parameterizer: createStub().parameterizer,
     profileName: '',
+    headers: {},
   });
 
 describe('Test data query builder > having clause', () => {
diff --git a/packages/core/test/data-query/builder/join-clause.spec.ts b/packages/core/test/data-query/builder/join-clause.spec.ts
@@ -29,6 +29,7 @@ const createStubBuilder = ({ statement }: { statement: string }) =>
     dataSource: createStub().dataSource,
     parameterizer: createStub().parameterizer,
     profileName: '',
+    headers: {},
   });
 
 describe('Test data query builder > join clause', () => {
diff --git a/packages/core/test/data-query/builder/limit-offset-clause.spec.ts b/packages/core/test/data-query/builder/limit-offset-clause.spec.ts
@@ -15,6 +15,7 @@ const createStubBuilder = ({ statement }: { statement: string }) =>
     dataSource: createStub().dataSource,
     parameterizer: createStub().parameterizer,
     profileName: '',
+    headers: {},
   });
 
 describe('Test data query builder > limit-offset by clause', () => {
diff --git a/packages/core/test/data-query/builder/order-by-clause.spec.ts b/packages/core/test/data-query/builder/order-by-clause.spec.ts
@@ -21,6 +21,7 @@ const createStubBuilder = ({ statement }: { statement: string }) =>
     dataSource: createStub().dataSource,
     parameterizer: createStub().parameterizer,
     profileName: '',
+    headers: {},
   });
 
 describe('Test data query builder > order by clause', () => {
diff --git a/packages/core/test/data-query/builder/parameterize.spec.ts b/packages/core/test/data-query/builder/parameterize.spec.ts
@@ -13,6 +13,7 @@ const createStubs = ({ statement }: { statement: string }) => {
       dataSource,
       parameterizer,
       profileName: '',
+      headers: {},
     }),
     dataSource,
     parameterizer,
diff --git a/packages/core/test/data-query/builder/select-clause.spec.ts b/packages/core/test/data-query/builder/select-clause.spec.ts
@@ -51,6 +51,7 @@ const createStubBuilder = ({ statement }: { statement: string }) =>
     dataSource: createStub().dataSource,
     parameterizer: createStub().parameterizer,
     profileName: '',
+    headers: {},
   });
 
 describe('Test data query builder > select clause', () => {
diff --git a/packages/core/test/data-query/builder/where-clause.spec.ts b/packages/core/test/data-query/builder/where-clause.spec.ts
@@ -25,6 +25,7 @@ const createStubBuilder = ({ statement }: { statement: string }) =>
     dataSource: createStub().dataSource,
     parameterizer: createStub().parameterizer,
     profileName: '',
+    headers: {},
   });
 
 jest.mock('uuid');
diff --git a/packages/core/test/template-engine/built-in-extensions/query-builder/operations.spec.ts b/packages/core/test/template-engine/built-in-extensions/query-builder/operations.spec.ts
@@ -23,6 +23,7 @@ const createTestCompilerWithBuilder = async () => {
         statement: query,
         parameterizer,
         dataSource,
+        headers: {},
       });
     }
   );
diff --git a/packages/extension-driver-canner/src/lib/cannerDataSource.ts b/packages/extension-driver-canner/src/lib/cannerDataSource.ts
diff --git a/packages/extension-driver-canner/test/cannerDataSource.spec.ts b/packages/extension-driver-canner/test/cannerDataSource.spec.ts
diff --git a/packages/extension-driver-canner/test/mock/index.ts b/packages/extension-driver-canner/test/mock/index.ts
diff --git a/packages/extension-driver-canner/test/mock/mockCannerDataSource.ts b/packages/extension-driver-canner/test/mock/mockCannerDataSource.ts
diff --git a/packages/serve/src/lib/route/route-component/baseRoute.ts b/packages/serve/src/lib/route/route-component/baseRoute.ts
diff --git a/packages/serve/src/lib/route/route-component/graphQLRoute.ts b/packages/serve/src/lib/route/route-component/graphQLRoute.ts
diff --git a/packages/serve/src/lib/route/route-component/restfulRoute.ts b/packages/serve/src/lib/route/route-component/restfulRoute.ts
