feat(schema-compiler): Yaml - report error on misconfiguration (object instead of array) (#6407)

Author: ovr

packages/cubejs-schema-compiler/src/compiler/YamlCompiler.ts

@@ -10,6 +10,7 @@ import { CubeSymbols } from './CubeSymbols';
 import { DataSchemaCompiler } from './DataSchemaCompiler';
 import { nonStringFields } from './CubeValidator';
 import { CubeDictionary } from './CubeDictionary';
+import { ErrorReporter } from './ErrorReporter';
 
 type EscapeStateStack = {
   inFormattedStr?: boolean;
@@ -24,11 +25,11 @@ export class YamlCompiler {
   public constructor(private cubeSymbols: CubeSymbols, private cubeDictionary: CubeDictionary) {
   }
 
-  public compileYamlFile(file, errorsReport, cubes, contexts, exports, asyncModules, toCompile, compiledFiles) {
+  public compileYamlFile(file, errorsReport: ErrorReporter, cubes, contexts, exports, asyncModules, toCompile, compiledFiles) {
     if (!file.content.trim()) {
       return;
     }
-    
+
     const yamlObj = YAML.load(file.content);
     for (const key of Object.keys(yamlObj)) {
       if (key === 'cubes') {
@@ -47,7 +48,7 @@ export class YamlCompiler {
     }
   }
 
-  private transpileAndPrepareJsFile(file, methodFn, cubeObj, errorsReport) {
+  private transpileAndPrepareJsFile(file, methodFn, cubeObj, errorsReport: ErrorReporter) {
     const yamlAst = this.transformYamlCubeObj(cubeObj, errorsReport);
 
     const cubeOrViewCall = t.callExpression(t.identifier(methodFn), [t.stringLiteral(cubeObj.name), yamlAst]);
@@ -59,7 +60,7 @@ export class YamlCompiler {
     };
   }
 
-  private transformYamlCubeObj(cubeObj, errorsReport) {
+  private transformYamlCubeObj(cubeObj, errorsReport: ErrorReporter) {
     cubeObj = this.camelizeObj(cubeObj);
     cubeObj.measures = this.yamlArrayToObj(cubeObj.measures || [], 'measure', errorsReport);
     cubeObj.dimensions = this.yamlArrayToObj(cubeObj.dimensions || [], 'dimension', errorsReport);
@@ -220,14 +221,21 @@ export class YamlCompiler {
     return ast.program.body[0]?.expression;
   }
 
-  private yamlArrayToObj(yamlArray, memberType, errorsReport) {
-    return yamlArray.map(({ name, ...rest }) => {
+  private yamlArrayToObj(yamlArray, memberType: string, errorsReport: ErrorReporter) {
+    if (!Array.isArray(yamlArray)) {
+      errorsReport.error(`${memberType}s must be defined as array`);
+      return {};
+    }
+
+    const remapped = yamlArray.map(({ name, ...rest }) => {
       if (!name) {
         errorsReport.error(`name isn't defined for ${memberType}: ${YAML.stringify(rest)}`);
         return {};
       } else {
         return { [name]: rest };
       }
-    }).reduce((a, b) => ({ ...a, ...b }), {});
+    });
+
+    return remapped.reduce((a, b) => ({ ...a, ...b }), {});
   }
 }

packages/cubejs-schema-compiler/test/unit/yaml-schema.test.ts

@@ -0,0 +1,26 @@
+import { prepareCompiler, prepareYamlCompiler } from './PrepareCompiler';
+import { createCubeSchema } from './utils';
+
+describe('Yaml Schema Testing', () => {
+  it('members must be defined as arrays', async () => {
+    const { compiler } = prepareYamlCompiler(
+      `
+      cubes:
+      - name: Products
+        sql: "select * from tbl"
+        dimensions:
+          name: Title
+          sql: name
+          type: string
+      `
+    );
+
+    try {
+      await compiler.compile();
+
+      throw new Error('compile must return an error');
+    } catch (e: any) {
+      expect(e.message).toContain('dimensions must be defined as array');
+    }
+  });
+});