Merge pull request #276 from Canner/fix/support-cache-profile-for-canner-store

Fix: Correct the profile of cache layer schema for Canner Persistence Store

Author: kokokuo

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);

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);

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

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: {

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),
         };

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) {

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 = {};