@lightdash/cli 0.1467.1 → 0.1469.0

package/dist/handlers/compile.js

@@ -3,7 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.compileHandler = exports.compile = void 0;
 const tslib_1 = require("tslib");
 const common_1 = require("@lightdash/common");
-const fs_1 = require("fs");
 const path_1 = tslib_1.__importDefault(require("path"));
 const uuid_1 = require("uuid");
 const analytics_1 = require("../analytics/analytics");
@@ -11,28 +10,11 @@ const context_1 = require("../dbt/context");
 const manifest_1 = require("../dbt/manifest");
 const validation_1 = require("../dbt/validation");
 const globalState_1 = tslib_1.__importDefault(require("../globalState"));
+const lightdash_config_1 = require("../lightdash-config");
 const styles = tslib_1.__importStar(require("../styles"));
 const compile_1 = require("./dbt/compile");
 const getDbtVersion_1 = require("./dbt/getDbtVersion");
 const getWarehouseClient_1 = tslib_1.__importDefault(require("./dbt/getWarehouseClient"));
-const readAndLoadLightdashProjectConfig = async (projectDir) => {
-    const configPath = path_1.default.join(projectDir, 'lightdash.config.yml');
-    try {
-        const fileContents = await fs_1.promises.readFile(configPath, 'utf8');
-        const config = await (0, common_1.loadLightdashProjectConfig)(fileContents);
-        return config;
-    }
-    catch (e) {
-        globalState_1.default.debug(`No lightdash.config.yml found in ${configPath}`);
-        if (e instanceof Error && 'code' in e && e.code === 'ENOENT') {
-            // Return default config if file doesn't exist
-            return {
-                spotlight: common_1.DEFAULT_SPOTLIGHT_CONFIG,
-            };
-        }
-        throw e;
-    }
-};
 const compile = async (options) => {
     const dbtVersion = await (0, getDbtVersion_1.getDbtVersion)();
     globalState_1.default.debug(`> dbt version ${dbtVersion}`);
@@ -92,7 +74,7 @@ ${errors.join('')}`));
     }
     globalState_1.default.debug(`> Converting explores with adapter: ${manifest.metadata.adapter_type}`);
     globalState_1.default.debug(`> Loading lightdash project config from ${absoluteProjectPath}`);
-    const lightdashProjectConfig = await readAndLoadLightdashProjectConfig(absoluteProjectPath);
+    const lightdashProjectConfig = await (0, lightdash_config_1.readAndLoadLightdashProjectConfig)(absoluteProjectPath);
     globalState_1.default.debug(`> Loaded lightdash project config`);
     const validExplores = await (0, common_1.convertExplores)(validModelsWithTypes, false, manifest.metadata.adapter_type, [
         common_1.DbtManifestVersion.V10,

package/dist/handlers/deploy.js

@@ -44,7 +44,7 @@ const deploy = async (explores, options) => {
             process.exit(1);
         }
     }
-    const lightdashProjectConfig = await (0, lightdash_config_1.loadLightdashProjectConfig)(path_1.default.join(options.projectDir, 'lightdash.config.yml'));
+    const lightdashProjectConfig = await (0, lightdash_config_1.readAndLoadLightdashProjectConfig)(path_1.default.resolve(options.projectDir));
     await replaceProjectYamlTags(options.projectUuid, lightdashProjectConfig);
     await (0, apiClient_1.lightdashApi)({
         method: 'PUT',

package/dist/lightdash-config/index.d.ts

@@ -1,2 +1 @@
-import { LightdashProjectConfig } from '@lightdash/common';
-export declare const loadLightdashProjectConfig: (configPath: string) => Promise<LightdashProjectConfig>;
+export declare const readAndLoadLightdashProjectConfig: (projectDir: string) => Promise<import("@lightdash/common").LightdashProjectConfig>;

package/dist/lightdash-config/index.js

@@ -1,23 +1,20 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.loadLightdashProjectConfig = void 0;
+exports.readAndLoadLightdashProjectConfig = void 0;
 const tslib_1 = require("tslib");
 const common_1 = require("@lightdash/common");
-const better_ajv_errors_1 = tslib_1.__importDefault(require("better-ajv-errors"));
-const fs_1 = require("fs");
-const yaml = tslib_1.__importStar(require("js-yaml"));
-const ajv_1 = require("../ajv");
-const loadLightdashProjectConfig = async (configPath) => {
+const promises_1 = tslib_1.__importDefault(require("fs/promises"));
+const path_1 = tslib_1.__importDefault(require("path"));
+const globalState_1 = tslib_1.__importDefault(require("../globalState"));
+const readAndLoadLightdashProjectConfig = async (projectDir) => {
+    const configPath = path_1.default.join(projectDir, 'lightdash.config.yml');
     try {
-        const configFile = yaml.load(await fs_1.promises.readFile(configPath, 'utf8'));
-        const validate = ajv_1.ajv.compile(common_1.lightdashProjectConfigSchema);
-        if (!validate(configFile)) {
-            const errors = (0, better_ajv_errors_1.default)(common_1.lightdashProjectConfigSchema, configFile, validate.errors || [], { indent: 2 });
-            throw new common_1.ParseError(`Invalid lightdash.config.yml at ${configPath}\n${errors}`);
-        }
-        return configFile;
+        const fileContents = await promises_1.default.readFile(configPath, 'utf8');
+        const config = await (0, common_1.loadLightdashProjectConfig)(fileContents);
+        return config;
     }
     catch (e) {
+        globalState_1.default.debug(`No lightdash.config.yml found in ${configPath}`);
         if (e instanceof Error && 'code' in e && e.code === 'ENOENT') {
             // Return default config if file doesn't exist
             return {
@@ -27,4 +24,4 @@ const loadLightdashProjectConfig = async (configPath) => {
         throw e;
     }
 };
-exports.loadLightdashProjectConfig = loadLightdashProjectConfig;
+exports.readAndLoadLightdashProjectConfig = readAndLoadLightdashProjectConfig;

package/dist/lightdash-config/lightdash-config.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/lightdash-config/lightdash-config.test.js

@@ -0,0 +1,66 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const common_1 = require("@lightdash/common");
+const promises_1 = tslib_1.__importDefault(require("fs/promises"));
+const _1 = require(".");
+const VALID_CONFIG_CONTENTS = 'spotlight:\n' +
+    '  default_visibility: show # Optional, defaults to "show"\n' +
+    '  categories:\n' +
+    '    core:\n' +
+    '      label: "Core Metrics"\n' +
+    '      color: blue\n' +
+    '    experimental:\n' +
+    '      label: "Experimental Metrics"\n' +
+    '      color: orange\n' +
+    '    sales:\n' +
+    '      label: "Sales"\n' +
+    '      color: green\n';
+const VALID_CONFIG = {
+    spotlight: {
+        default_visibility: 'show',
+        categories: {
+            core: { label: 'Core Metrics', color: 'blue' },
+            experimental: { label: 'Experimental Metrics', color: 'orange' },
+            sales: { label: 'Sales', color: 'green' },
+        },
+    },
+};
+const INVALID_CONFIG_CONTENTS = 'I am invalid';
+const readFileSpy = jest.spyOn(promises_1.default, 'readFile');
+describe('Existing lightdash.config.yml file', () => {
+    describe('when valid', () => {
+        it('should load the config file', async () => {
+            readFileSpy.mockResolvedValueOnce(VALID_CONFIG_CONTENTS);
+            const config = await (0, _1.readAndLoadLightdashProjectConfig)('');
+            expect(config).toEqual(VALID_CONFIG);
+        });
+    });
+    describe('when invalid', () => {
+        it('should throw an error', async () => {
+            readFileSpy.mockResolvedValueOnce(INVALID_CONFIG_CONTENTS);
+            await expect((0, _1.readAndLoadLightdashProjectConfig)('')).rejects.toThrow(/Invalid lightdash.config.yml with errors/);
+        });
+    });
+});
+class MockedFSError extends Error {
+    code;
+    constructor(message, code) {
+        super(message);
+        this.code = code;
+    }
+}
+describe('Missing lightdash.config.yml file', () => {
+    it('should load the default config', async () => {
+        // ! Throwing a mock error, not something we should rely on but when running the test in jest `e instanceof Error` is false, but when running the code in node it is true
+        // ! Check: https://github.com/jestjs/jest/issues/11808
+        readFileSpy.mockRejectedValueOnce(new MockedFSError('file not found', 'ENOENT'));
+        const config = await (0, _1.readAndLoadLightdashProjectConfig)('./some/path/to/nonexisting/file');
+        expect(config).toEqual({
+            spotlight: common_1.DEFAULT_SPOTLIGHT_CONFIG,
+        });
+    });
+});
+afterAll(() => {
+    jest.restoreAllMocks();
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lightdash/cli",
-  "version": "0.1467.1",
+  "version": "0.1469.0",
   "license": "MIT",
   "bin": {
     "lightdash": "dist/index.js"
@@ -30,8 +30,8 @@
     "parse-node-version": "^2.0.0",
     "unique-names-generator": "^4.7.1",
     "uuid": "^11.0.3",
-    "@lightdash/common": "0.1467.1",
-    "@lightdash/warehouses": "0.1467.1"
+    "@lightdash/common": "0.1469.0",
+    "@lightdash/warehouses": "0.1469.0"
   },
   "description": "Lightdash CLI tool",
   "devDependencies": {