fix #236, can't write comments in sql files

Author: cyyeh

packages/core/src/lib/template-engine/built-in-extensions/cache/cacheTagRunner.ts

@@ -44,7 +44,9 @@ export class CacheTagRunner extends TagRunner {
     query = query
       .split(/\r?\n/)
       .filter((line) => line.trim().length > 0)
-      .join('\n');
+      .join('\n')
+      .replace(/--.*(?:\n|$)|\/\*[\s\S]*?\*\//g, '') // remove single-line comments and multi-line comments
+
     // 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

packages/core/src/lib/template-engine/built-in-extensions/query-builder/reqTagRunner.ts

@@ -11,6 +11,14 @@ import { Parameterizer } from '@vulcan-sql/core/data-query';
 import { InternalError } from '../../../utils/errors';
 import { CACHE_MAIN_BUILDER_VAR_NAME } from '../cache/constants';
 
+import {
+  getLogger,
+} from '@vulcan-sql/core';
+
+const logger = getLogger({
+  scopeName: 'CORE',
+});
+
 @VulcanInternalExtension()
 export class ReqTagRunner extends TagRunner {
   public tags = ['req'];
@@ -40,10 +48,12 @@ export class ReqTagRunner extends TagRunner {
     for (let index = 0; index < contentArgs.length; index++) {
       query += await contentArgs[index]();
     }
+
     query = query
       .split(/\r?\n/)
       .filter((line) => line.trim().length > 0)
-      .join('\n');
+      .join('\n')
+      .replace(/--.*(?:\n|$)|\/\*[\s\S]*?\*\//g, '') // remove single-line comments and multi-line comments
 
     let builder: IDataQueryBuilder | undefined;
     // Replace to put the directly query cache builder to original query main builder of  "__wrapper__builder",

packages/core/test/template-engine/built-in-extensions/cache/cache.spec.ts

@@ -174,3 +174,41 @@ select count(*) as count from vulcan.user where user.id = {{ context.params.user
   expect(binding[0].get('$1')).toBe(`user-id`);
   expect(resultData).toEqual([{ count: 1 }]);
 });
+
+it('Extension should remove comments in sql statements', async () => {
+  // Arrange
+  const {
+    compiler,
+    loader,
+    builder,
+    executeTemplate,
+    getCreatedQueries,
+    getCreatedBinding,
+  } = await createTestCompiler();
+  const { compiledData } = await compiler.compile(`
+-- this is comment1
+{% cache %} -- this is comment2
+select count(*) as count from vulcan.user where user.id = {{ context.params.userId }}; -- this is comment3
+{% endcache %} -- this is comment4
+-- this is comment5
+  `);
+  builder.value.onFirstCall().resolves({
+    getColumns: () => [],
+    getData: () => arrayToStream([{ count: 1 }]),
+  });
+  // Action
+  loader.setSource('test', compiledData);
+  const result = await executeTemplate('test', {
+    userId: 'user-id',
+  });
+  const resultData = await streamToArray(result.getData());
+  const queries = await getCreatedQueries();
+  const binding = await getCreatedBinding();
+
+  // Assert, cache tag runner add the "set schema=vulcan;" in the prefix sql statement to make query could get correct cache table of schema.
+  expect(queries[0].trim()).toBe(
+    `set schema=vulcan;\n select count(*) as count from vulcan.user where user.id = $1;`
+  );
+  expect(binding[0].get('$1')).toBe(`user-id`);
+  expect(resultData).toEqual([{ count: 1 }]);
+});

packages/core/test/template-engine/built-in-extensions/query-builder/builder.spec.ts

@@ -167,3 +167,43 @@ it('Extension should throw error when no profile defined', async () => {
     `No profile name found`
   );
 });
+
+it('xtension should remove comments in sql statements', async () => {
+  // Arrange
+  const {
+    compiler,
+    loader,
+    builder,
+    executeTemplate,
+    getCreatedQueries,
+    getCreatedBinding,
+  } = await createTestCompiler();
+  const { compiledData } = await compiler.compile(`
+-- this is comment1
+{% req userCount main %} -- this is comment2
+-- this is comment3
+select count(*) as count from user where user.id = {{ context.params.userId }}; -- this is comment4
+-- this is comment5
+{% endreq %}
+
+-- this is comment6
+  `);
+  builder.value.onFirstCall().resolves({
+    getColumns: () => [],
+    getData: () => arrayToStream([{ count: 1 }]),
+  });
+  // Action
+  loader.setSource('test', compiledData);
+  const result = await executeTemplate('test', {
+    userId: 'user-id',
+  });
+  const resultData = await streamToArray(result.getData());
+  const queries = await getCreatedQueries();
+  const binding = await getCreatedBinding();
+  // Assert
+  expect(queries[0].trim()).toBe(
+    `select count(*) as count from user where user.id = $1;`
+  );
+  expect(binding[0].get('$1')).toBe(`user-id`);
+  expect(resultData).toEqual([{ count: 1 }]);
+});