Merge tag 'v0.8.1' into feature/update-doc

cyyeh · cyyeh · commit 4d9feee71d79 · 2023-08-18T16:02:29.000+08:00
diff --git a/packages/build/package.json b/packages/build/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@vulcan-sql/build",
   "description": "VulcanSQL package for building projects",
-  "version": "0.8.0",
+  "version": "0.8.1",
   "type": "commonjs",
   "publishConfig": {
     "access": "public"
@@ -22,6 +22,6 @@
   },
   "license": "MIT",
   "peerDependencies": {
-    "@vulcan-sql/core": "~0.8.0-0"
+    "@vulcan-sql/core": "~0.8.1-0"
   }
 }
diff --git a/packages/build/src/lib/schema-parser/schemaParser.ts b/packages/build/src/lib/schema-parser/schemaParser.ts
@@ -45,7 +45,6 @@ export class SchemaParser {
     for await (const schemaData of this.schemaReader.readSchema()) {
       const schema = await this.parseContent(schemaData);
       schema.metadata = metadata?.[schema.templateSource || schema.sourceName];
-      schema.urlPath = `/api${schema.urlPath}`
       // execute middleware
       await execute(schema);
       schemas.push(schema as APISchema);
diff --git a/packages/catalog-server/package.json b/packages/catalog-server/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@vulcan-sql/catalog-server",
   "description": "Catalog server for VulcanSQL",
-  "version": "0.8.0",
+  "version": "0.8.1",
   "publishConfig": {
     "access": "public"
   },
diff --git a/packages/catalog-server/utils/vulcanSQLAdapter.ts b/packages/catalog-server/utils/vulcanSQLAdapter.ts
@@ -108,7 +108,7 @@ class VulcanSQLAdapter {
       return isParam
         ? result.replace(param, filter[key])
         : `${result}${querySymbol}${key}=${filter[key]}`;
-    }, schema.urlPath);
+    }, `/api${schema.urlPath}`);
 
     const actualUrl = `${VULCAN_SQL_HOST}${actualPath}`;
     console.log('actualUrl: ', actualUrl);
diff --git a/packages/cli/package.json b/packages/cli/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@vulcan-sql/cli",
   "description": "CLI tools for VulcanSQL",
-  "version": "0.8.0",
+  "version": "0.8.1",
   "type": "commonjs",
   "bin": {
     "vulcan": "./src/index.js"
diff --git a/packages/core/package.json b/packages/core/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@vulcan-sql/core",
   "description": "Core package of VulcanSQL",
-  "version": "0.8.0",
+  "version": "0.8.1",
   "type": "commonjs",
   "publishConfig": {
     "access": "public"
diff --git a/packages/extension-authenticator-canner/package.json b/packages/extension-authenticator-canner/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@vulcan-sql/extension-authenticator-canner",
   "description": "Canner Enterprise authenticator for Vulcan SQL",
-  "version": "0.8.0",
+  "version": "0.8.1",
   "type": "commonjs",
   "publishConfig": {
     "access": "public"
@@ -24,7 +24,7 @@
   },
   "license": "MIT",
   "peerDependencies": {
-    "@vulcan-sql/core": "~0.8.0-0",
-    "@vulcan-sql/serve": "~0.8.0-0"
+    "@vulcan-sql/core": "~0.8.1-0",
+    "@vulcan-sql/serve": "~0.8.1-0"
   }
 }
diff --git a/packages/extension-dbt/package.json b/packages/extension-dbt/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@vulcan-sql/extension-dbt",
   "description": "Using dbt models form VulcanSQL projects",
-  "version": "0.8.0",
+  "version": "0.8.1",
   "type": "commonjs",
   "publishConfig": {
     "access": "public"
@@ -23,6 +23,6 @@
   },
   "license": "MIT",
   "peerDependencies": {
-    "@vulcan-sql/core": "~0.8.0-0"
+    "@vulcan-sql/core": "~0.8.1-0"
   }
 }
diff --git a/packages/extension-debug-tools/package.json b/packages/extension-debug-tools/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@vulcan-sql/extension-debug-tools",
   "description": "A collection of Vulcan extension debug tools",
-  "version": "0.8.0",
+  "version": "0.8.1",
   "type": "commonjs",
   "publishConfig": {
     "access": "public"
@@ -22,9 +22,9 @@
   },
   "license": "MIT",
   "peerDependencies": {
-    "@vulcan-sql/core": "~0.8.0-0"
+    "@vulcan-sql/core": "~0.8.1-0"
   },
   "devDependencies": {
-    "@vulcan-sql/test-utility": "~0.8.0-0"
+    "@vulcan-sql/test-utility": "~0.8.1-0"
   }
 }
diff --git a/packages/extension-driver-bq/package.json b/packages/extension-driver-bq/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@vulcan-sql/extension-driver-bq",
   "description": "BigQuery driver for Vulcan SQL",
-  "version": "0.8.0",
+  "version": "0.8.1",
   "type": "commonjs",
   "publishConfig": {
     "access": "public"
@@ -24,6 +24,6 @@
   },
   "license": "MIT",
   "peerDependencies": {
-    "@vulcan-sql/core": "~0.8.0-0"
+    "@vulcan-sql/core": "~0.8.1-0"
   }
 }
diff --git a/packages/extension-driver-canner/package.json b/packages/extension-driver-canner/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@vulcan-sql/extension-driver-canner",
   "description": "Canner Enterprise driver for Vulcan SQL",
-  "version": "0.8.0",
+  "version": "0.8.1",
   "type": "commonjs",
   "publishConfig": {
     "access": "public"
@@ -24,6 +24,6 @@
   },
   "license": "MIT",
   "peerDependencies": {
-    "@vulcan-sql/core": "~0.8.0-0"
+    "@vulcan-sql/core": "~0.8.1-0"
   }
 }
diff --git a/packages/extension-driver-clickhouse/package.json b/packages/extension-driver-clickhouse/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@vulcan-sql/extension-driver-clickhouse",
   "description": "Clickhouse driver for VulcanSQL",
-  "version": "0.8.0",
+  "version": "0.8.1",
   "type": "commonjs",
   "publishConfig": {
     "access": "public"
@@ -27,6 +27,6 @@
     "@clickhouse/client": "^0.1.1"
   },
   "peerDependencies": {
-    "@vulcan-sql/core": "~0.8.0-0"
+    "@vulcan-sql/core": "~0.8.1-0"
   }
 }
diff --git a/packages/extension-driver-duckdb/package.json b/packages/extension-driver-duckdb/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@vulcan-sql/extension-driver-duckdb",
   "description": "duckdb driver for Vulcan SQL",
-  "version": "0.8.0",
+  "version": "0.8.1",
   "type": "commonjs",
   "publishConfig": {
     "access": "public"
@@ -23,6 +23,6 @@
   },
   "license": "MIT",
   "peerDependencies": {
-    "@vulcan-sql/core": "~0.8.0-0"
+    "@vulcan-sql/core": "~0.8.1-0"
   }
 }
diff --git a/packages/extension-driver-ksqldb/package.json b/packages/extension-driver-ksqldb/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@vulcan-sql/extension-driver-ksqldb",
   "description": "ksqlDB driver for VulcanSQL",
-  "version": "0.8.0",
+  "version": "0.8.1",
   "type": "commonjs",
   "publishConfig": {
     "access": "public"
@@ -23,6 +23,6 @@
   },
   "license": "MIT",
   "peerDependencies": {
-    "@vulcan-sql/core": "~0.8.0-0"
+    "@vulcan-sql/core": "~0.8.1-0"
   }
 }
diff --git a/packages/extension-driver-pg/package.json b/packages/extension-driver-pg/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@vulcan-sql/extension-driver-pg",
   "description": "PG driver for Vulcan SQL",
-  "version": "0.8.0",
+  "version": "0.8.1",
   "type": "commonjs",
   "publishConfig": {
     "access": "public"
@@ -24,6 +24,6 @@
   },
   "license": "MIT",
   "peerDependencies": {
-    "@vulcan-sql/core": "~0.8.0-0"
+    "@vulcan-sql/core": "~0.8.1-0"
   }
 }
diff --git a/packages/extension-driver-snowflake/package.json b/packages/extension-driver-snowflake/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@vulcan-sql/extension-driver-snowflake",
   "description": "Snowflake driver for VulcanSQL",
-  "version": "0.8.0",
+  "version": "0.8.1",
   "type": "commonjs",
   "publishConfig": {
     "access": "public"
@@ -30,6 +30,6 @@
     "@types/snowflake-sdk": "^1.6.8"
   },
   "peerDependencies": {
-    "@vulcan-sql/core": "~0.8.0-0"
+    "@vulcan-sql/core": "~0.8.1-0"
   }
 }
diff --git a/packages/extension-huggingface/package.json b/packages/extension-huggingface/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@vulcan-sql/extension-huggingface",
   "description": "Hugging Face feature for VulcanSQL",
-  "version": "0.8.0",
+  "version": "0.8.1",
   "type": "commonjs",
   "publishConfig": {
     "access": "public"
@@ -23,6 +23,6 @@
   },
   "license": "MIT",
   "peerDependencies": {
-    "@vulcan-sql/core": "~0.8.0-0"
+    "@vulcan-sql/core": "~0.8.1-0"
   }
 }
diff --git a/packages/extension-store-canner/package.json b/packages/extension-store-canner/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@vulcan-sql/extension-store-canner",
   "description": "Canner persistence store for Vulcan SQL",
-  "version": "0.8.0",
+  "version": "0.8.1",
   "type": "commonjs",
   "publishConfig": {
     "access": "public"
@@ -24,7 +24,7 @@
   },
   "license": "MIT",
   "peerDependencies": {
-    "@vulcan-sql/core": "~0.8.0-0"
+    "@vulcan-sql/core": "~0.8.1-0"
   },
   "dependencies": {
     "@canner/canner-storage": "^0.0.7"
diff --git a/packages/extension-store-canner/src/lib/canner/persistenceStore.ts b/packages/extension-store-canner/src/lib/canner/persistenceStore.ts
@@ -141,13 +141,17 @@ export class CannerPersistenceStore extends PersistentStore {
           merged.templates[workspaceSourceName] = value;
         });
         // API Schemas
+        const profile = `canner-${workspaceSqlName}`;
         artifact.schemas.forEach((schema) => {
           // concat the workspace sql name prefix to urlPath, urlPath has the "/" prefix, so concat directly
           schema.urlPath = `${workspaceSqlName}${schema.urlPath}`;
           // concat the workspace sql name prefix to template source, so it could find the "sourceName" in templates
           schema.templateSource = `${workspaceSqlName}/${schema.templateSource}`;
           // replace the profile to the canner enterprise integration used profile name, it will match to the profiles from canner profile reader.
-          schema.profiles = [`canner-${workspaceSqlName}`];
+          schema.profiles = [profile];
+          schema.cache =
+            schema.cache?.map((cacheData) => ({ ...cacheData, profile })) || [];
+
           merged.schemas.push(schema);
         });
         // Specs, only support the oas3 specification for canner enterprise integration used
diff --git a/packages/extension-store-canner/src/test/cannerPersistenceStore.spec.ts b/packages/extension-store-canner/src/test/cannerPersistenceStore.spec.ts
@@ -2,7 +2,11 @@ import * as sinon from 'ts-sinon';
 import faker from '@faker-js/faker';
 import * as oas3 from 'openapi3-ts';
 import { BaseStorageService } from '@canner/canner-storage';
-import { APISchema, ArtifactBuilderOptions } from '@vulcan-sql/core';
+import {
+  APISchema,
+  ArtifactBuilderOptions,
+  CacheLayerInfo,
+} from '@vulcan-sql/core';
 import * as storageServiceModule from '../lib/storageService';
 import {
   BuiltInArtifact,
@@ -160,6 +164,12 @@ describe('Test CannerPersistenceStore', () => {
             urlPath: '/orders',
             templateSource: 'sales/orders',
             profiles: [faker.word.noun()],
+            cache: [
+              {
+                ...sinon.stubInterface<CacheLayerInfo>(),
+                profile: faker.lorem.word(),
+              },
+            ],
           },
         ],
         specs: {
@@ -184,6 +194,7 @@ describe('Test CannerPersistenceStore', () => {
             urlPath: '/products/:id',
             templateSource: 'marketing/products',
             profiles: [faker.word.noun()],
+            cache: [],
           },
         ],
         specs: {
@@ -213,11 +224,17 @@ describe('Test CannerPersistenceStore', () => {
           urlPath: `${fakeWorkspaces.ws1.sqlName}/orders`,
           templateSource: `${fakeWorkspaces.ws1.sqlName}/sales/orders`,
           profiles: [`canner-${fakeWorkspaces.ws1.sqlName}`],
+          cache: [
+            {
+              profile: `canner-${fakeWorkspaces.ws1.sqlName}`,
+            },
+          ],
         },
         {
           urlPath: `${fakeWorkspaces.ws2.sqlName}/products/:id`,
           templateSource: `${fakeWorkspaces.ws2.sqlName}/marketing/products`,
           profiles: [`canner-${fakeWorkspaces.ws2.sqlName}`],
+          cache: [],
         },
       ],
       specs: {
diff --git a/packages/serve/package.json b/packages/serve/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@vulcan-sql/serve",
   "description": "VulcanSQL package for serving projects",
-  "version": "0.8.0",
+  "version": "0.8.1",
   "type": "commonjs",
   "publishConfig": {
     "access": "public"
@@ -22,7 +22,7 @@
   },
   "license": "MIT",
   "peerDependencies": {
-    "@vulcan-sql/core": "~0.8.0-0"
+    "@vulcan-sql/core": "~0.8.1-0"
   },
   "dependencies": {
     "redoc": "2.0.0-rc.76"
diff --git a/packages/serve/src/lib/catalog-router/catalogRouters.ts b/packages/serve/src/lib/catalog-router/catalogRouters.ts
@@ -43,7 +43,7 @@ export class CatalogRouters extends CatalogRouter {
       const baseUrl = `${ctx.protocol}://${ctx.host}`;
       const result = {
         ...schema,
-        url: `${baseUrl}${schema.urlPath}`,
+        url: `${baseUrl}/api${schema.urlPath}`,
         apiDocUrl: `${baseUrl}${this.getAPIDocUrl(schema)}`,
         shareKey: this.getShareKey(ctx.request.headers.authorization),
         responseFormat: responseFormatOption.enabled
@@ -60,7 +60,7 @@ export class CatalogRouters extends CatalogRouter {
       const result = schemas.map((schema) => {
         return {
           ...schema,
-          url: `${baseUrl}${schema.urlPath}`,
+          url: `${baseUrl}/api${schema.urlPath}`,
           apiDocUrl: `${baseUrl}${this.getAPIDocUrl(schema)}`,
           shareKey: this.getShareKey(ctx.request.headers.authorization),
         };
diff --git a/packages/serve/src/lib/route/route-component/restfulRoute.ts b/packages/serve/src/lib/route/route-component/restfulRoute.ts
@@ -8,7 +8,7 @@ export class RestfulRoute extends BaseRoute {
   constructor(options: RouteOptions) {
     super(options);
     const { apiSchema } = options;
-    this.urlPath = apiSchema.urlPath;
+    this.urlPath = this.combineURLs('/api', apiSchema.urlPath);
   }
 
   public async respond(ctx: KoaContext) {
diff --git a/packages/serve/test/app.spec.ts b/packages/serve/test/app.spec.ts
@@ -386,7 +386,7 @@ describe('Test vulcan server for calling restful APIs', () => {
         .listen(faker.datatype.number({ min: 20000, max: 30000 }));
 
       // arrange input api url
-      const apiUrl = KoaRouter.url(schema.urlPath, ctx.params);
+      const apiUrl = KoaRouter.url('/api' + schema.urlPath, ctx.params);
 
       // arrange expected result
       const expected: RequestParameters = {};
diff --git a/packages/test-utility/package.json b/packages/test-utility/package.json

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@vulcan-sql/build",`
`3`	`3`	`"description": "VulcanSQL package for building projects",`
`4`		`- "version": "0.8.0",`
	`4`	`+ "version": "0.8.1",`
`5`	`5`	`"type": "commonjs",`
`6`	`6`	`"publishConfig": {`
`7`	`7`	`"access": "public"`
`@@ -22,6 +22,6 @@`
`22`	`22`	`},`
`23`	`23`	`"license": "MIT",`
`24`	`24`	`"peerDependencies": {`
`25`		`- "@vulcan-sql/core": "~0.8.0-0"`
	`25`	`+ "@vulcan-sql/core": "~0.8.1-0"`
`26`	`26`	`}`
`27`	`27`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@vulcan-sql/catalog-server",`
`3`	`3`	`"description": "Catalog server for VulcanSQL",`
`4`		`- "version": "0.8.0",`
	`4`	`+ "version": "0.8.1",`
`5`	`5`	`"publishConfig": {`
`6`	`6`	`"access": "public"`
`7`	`7`	`},`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@vulcan-sql/cli",`
`3`	`3`	`"description": "CLI tools for VulcanSQL",`
`4`		`- "version": "0.8.0",`
	`4`	`+ "version": "0.8.1",`
`5`	`5`	`"type": "commonjs",`
`6`	`6`	`"bin": {`
`7`	`7`	`"vulcan": "./src/index.js"`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@vulcan-sql/core",`
`3`	`3`	`"description": "Core package of VulcanSQL",`
`4`		`- "version": "0.8.0",`
	`4`	`+ "version": "0.8.1",`
`5`	`5`	`"type": "commonjs",`
`6`	`6`	`"publishConfig": {`
`7`	`7`	`"access": "public"`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@vulcan-sql/extension-authenticator-canner",`
`3`	`3`	`"description": "Canner Enterprise authenticator for Vulcan SQL",`
`4`		`- "version": "0.8.0",`
	`4`	`+ "version": "0.8.1",`
`5`	`5`	`"type": "commonjs",`
`6`	`6`	`"publishConfig": {`
`7`	`7`	`"access": "public"`
`@@ -24,7 +24,7 @@`
`24`	`24`	`},`
`25`	`25`	`"license": "MIT",`
`26`	`26`	`"peerDependencies": {`
`27`		`- "@vulcan-sql/core": "~0.8.0-0",`
`28`		`- "@vulcan-sql/serve": "~0.8.0-0"`
	`27`	`+ "@vulcan-sql/core": "~0.8.1-0",`
	`28`	`+ "@vulcan-sql/serve": "~0.8.1-0"`
`29`	`29`	`}`
`30`	`30`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@vulcan-sql/extension-dbt",`
`3`	`3`	`"description": "Using dbt models form VulcanSQL projects",`
`4`		`- "version": "0.8.0",`
	`4`	`+ "version": "0.8.1",`
`5`	`5`	`"type": "commonjs",`
`6`	`6`	`"publishConfig": {`
`7`	`7`	`"access": "public"`
`@@ -23,6 +23,6 @@`
`23`	`23`	`},`
`24`	`24`	`"license": "MIT",`
`25`	`25`	`"peerDependencies": {`
`26`		`- "@vulcan-sql/core": "~0.8.0-0"`
	`26`	`+ "@vulcan-sql/core": "~0.8.1-0"`
`27`	`27`	`}`
`28`	`28`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@vulcan-sql/extension-driver-bq",`
`3`	`3`	`"description": "BigQuery driver for Vulcan SQL",`
`4`		`- "version": "0.8.0",`
	`4`	`+ "version": "0.8.1",`
`5`	`5`	`"type": "commonjs",`
`6`	`6`	`"publishConfig": {`
`7`	`7`	`"access": "public"`
`@@ -24,6 +24,6 @@`
`24`	`24`	`},`
`25`	`25`	`"license": "MIT",`
`26`	`26`	`"peerDependencies": {`
`27`		`- "@vulcan-sql/core": "~0.8.0-0"`
	`27`	`+ "@vulcan-sql/core": "~0.8.1-0"`
`28`	`28`	`}`
`29`	`29`	`}`