@eik/common 4.0.0-next.4 → 4.0.0-next.7

package/{lib/classes → packages/config-loader/src/errors}/multiple-config-sources-error.js

@@ -1,9 +1,11 @@
 const CustomError = require('./custom-error');
 
-module.exports = class MultipleConfigSourcesError extends CustomError {
+class MultipleConfigSourcesError extends CustomError {
     constructor() {
         super(
             `Eik configuration was defined in both in package.json and eik.json. You must specify one or the other.`,
         );
     }
-};
+}
+
+module.exports = MultipleConfigSourcesError;

package/{lib/classes → packages/config-loader/src/errors}/no-files-matched-error.js

@@ -1,6 +1,6 @@
-const CustomError = require('./custom-error');
+const CustomError = require('./custom-error.js');
 
-module.exports = class NoFilesMatchedError extends CustomError {
+class NoFilesMatchedError extends CustomError {
     /**
      * @param {string} file
      */
@@ -8,4 +8,6 @@ module.exports = class NoFilesMatchedError extends CustomError {
         const message = `No files found for path: '${file}'`;
         super(message);
     }
-};
+}
+
+module.exports = NoFilesMatchedError;

package/{lib/classes → packages/config-loader/src/errors}/single-dest-multiple-source-error.js

@@ -1,6 +1,6 @@
 const CustomError = require('./custom-error');
 
-module.exports = class SingleDestMultipleSourcesError extends CustomError {
+class SingleDestMultipleSourcesError extends CustomError {
     /**
      * @param {string} destFilePath
      */
@@ -9,4 +9,6 @@ module.exports = class SingleDestMultipleSourcesError extends CustomError {
             `Cannot specify a single file destination for multiple source files. See '${destFilePath}'`,
         );
     }
-};
+}
+
+module.exports = SingleDestMultipleSourcesError;

package/{lib/helpers → packages/config-loader/src}/get-defaults.js

@@ -1,18 +1,17 @@
 // @ts-check
 
-'use strict';
+const EikConfig = require('./eik-config.js');
+const configStore = require('./config-store.js');
 
-const configStore = require('./config-store');
-const EikConfig = require('../classes/eik-config');
 /**
  * Sets up and returns an object containing a set of default values for the app context.
  * Default values are fetched from the app's eik.json or package.json file as well as from .eikrc, if present in the users home directory.
  *
  * @param {string} cwd The current working directory
  *
- * @returns {import("../classes/eik-config")} EikConfig
+ * @returns {import("./eik-config.js")} EikConfig
  */
-module.exports = function getDefaults(cwd) {
+function getDefaults(cwd) {
     try {
         return configStore.findInDirectory(cwd);
     } catch (e) {
@@ -21,4 +20,6 @@ module.exports = function getDefaults(cwd) {
         }
         throw e;
     }
-};
+}
+
+module.exports = getDefaults;

package/{lib/helpers → packages/config-loader/src}/local-assets.js

@@ -5,7 +5,7 @@
  */
 const assert = require('assert');
 const fs = require('fs');
-const configStore = require('./config-store');
+const configStore = require('./config-store.js');
 
 /**
  * Sets up asset routes for local development. Mounted paths match those on Eik server and values are read from projects eik.json file.
@@ -57,4 +57,5 @@ async function localAssets(app, rootEikDirectory = process.cwd()) {
         }
     });
 }
+
 module.exports = localAssets;

package/{lib/helpers → packages/config-loader/src/utils}/resolve-files.js

@@ -4,12 +4,13 @@ const { promisify } = require('util');
 const { extname, join, isAbsolute, basename, sep, normalize } = require('path');
 const isGlob = require('is-glob');
 const glob = promisify(require('glob'));
+// const { ResolvedFiles } = require('../index.js');
 const {
     removeTrailingSlash,
     addLeadingSlash,
     removeLeadingSlash,
-} = require('./path-slashes');
-const ResolvedFiles = require('../classes/resolved-files');
+} = require('@eik/common-utils');
+const ResolvedFiles = require('../classes/resolved-files.js');
 
 /**
  * Create a new path from a path string preceeding a glob or the whole path if no glob is found

package/packages/config-loader/test/config-store.test.js

@@ -0,0 +1,231 @@
+const { test } = require('tap');
+const fs = require('fs').promises;
+const { join } = require('path');
+const os = require('os');
+
+const EikConfig = require('../src/eik-config.js');
+const configStore = require('../src/config-store.js');
+
+function mkdirTempDir() {
+    return fs.mkdtemp(join(os.tmpdir(), 'eik-config'));
+}
+
+const mockEikJSON = (data) => ({
+    name: 'magarita',
+    server: 'http://server',
+    files: { '/': 'pizza' },
+    version: '0.0.0',
+    ...data,
+});
+
+const mockPackageJSON = ({
+    name = 'magarita',
+    version = '0.0.0',
+    other = {},
+    eik = {},
+}) => ({
+    name,
+    version,
+    ...other,
+    eik: {
+        server: 'http://server',
+        files: { '/': 'pizza' },
+        ...eik,
+    },
+});
+
+test('loads from package.json', (t) => {
+    const config = configStore.findInDirectory('/pizza dir', (path) => {
+        if (path.includes('eik.json') || path.includes('.eikrc')) return null;
+        t.match(path, '/pizza dir/package.json');
+        return mockPackageJSON({
+            other: { notIncluded: 'fish' },
+            eik: { 'import-map': 'http://map' },
+        });
+    });
+    t.equal(config.name, 'magarita');
+    t.equal(config.version, '0.0.0');
+    t.equal(config.notIncluded, undefined);
+    t.same(config.map, ['http://map']);
+    t.end();
+});
+
+test('loads from eik.json', (t) => {
+    const config = configStore.findInDirectory('/pizza dir', (path) => {
+        if (path.includes('package.json') || path.includes('.eikrc'))
+            return null;
+        t.match(path, '/pizza dir/eik.json');
+        return mockEikJSON();
+    });
+    t.equal(config.name, 'magarita');
+    t.end();
+});
+
+test('loads from eik.json - invalid config', (t) => {
+    try {
+        configStore.findInDirectory('/pizza dir', (path) => {
+            if (path.includes('package.json') || path.includes('.eikrc'))
+                return null;
+            return {};
+        });
+    } catch (err) {
+        t.match(
+            `${err}`,
+            `InvalidConfigError: Eik config object was invalid: 'config.findInDirectory operation failed: Invalid eik.json schema: must have required property 'server'`,
+        );
+    }
+    t.end();
+});
+
+test('package.json and eik.json not being present', (t) => {
+    t.plan(1);
+    try {
+        configStore.findInDirectory('/pizza dir', () => null);
+    } catch (e) {
+        t.equal(
+            e.message,
+            "No package.json or eik.json file found in: '/pizza dir'",
+        );
+    }
+    t.end();
+});
+
+test('package.json and eik.json both have eik config', (t) => {
+    t.plan(1);
+    const jsonReaderStub = (path) => {
+        if (path.includes('package.json'))
+            return { eik: { pizza: 'magarita' } };
+        return {};
+    };
+    try {
+        configStore.findInDirectory('/pizza dir', jsonReaderStub);
+    } catch (e) {
+        t.equal(
+            e.message,
+            'Eik configuration was defined in both in package.json and eik.json. You must specify one or the other.',
+        );
+    }
+
+    t.end();
+});
+
+test('name is pulled from package.json if not defined in eik.json', (t) => {
+    const jsonReaderStub = (path) => {
+        if (path.includes('package.json'))
+            return {
+                name: 'big pizza co',
+                version: '0.0.0',
+                eik: {
+                    server: 'https://test',
+                    files: {
+                        '/': './dist/**/*.js',
+                    },
+                },
+            };
+        if (path.includes('eik.json')) return null;
+        return {};
+    };
+    const config = configStore.findInDirectory('/pizza dir', jsonReaderStub);
+    t.equal(config.name, 'big pizza co');
+    t.equal(config.version, '0.0.0');
+    t.equal(config.server, 'https://test');
+    t.same(config.files, {
+        '/': './dist/**/*.js',
+    });
+    t.end();
+});
+
+test('tokens are present', (t) => {
+    const config = configStore.findInDirectory('/pizza dir', (path) => {
+        if (path.includes('eik.json')) return mockEikJSON();
+        if (path.includes('.eikrc'))
+            return { tokens: [['http://server', 'muffins']] };
+        return {};
+    });
+    t.equal(config.server, 'http://server');
+    t.equal(config.token, 'muffins');
+    t.end();
+});
+
+test('invalid json error', (t) => {
+    t.plan(1);
+    const jsonReaderStub = (path) => {
+        if (path.includes('.json')) JSON.parse('not json');
+        return {};
+    };
+
+    try {
+        configStore.findInDirectory('/pizza dir', jsonReaderStub);
+    } catch (e) {
+        t.equal(e.message, 'Unexpected token o in JSON at position 1');
+    }
+    t.end();
+});
+
+test('no configuration present', (t) => {
+    t.plan(1);
+    try {
+        configStore.findInDirectory('/pizza dir', () => {});
+    } catch (e) {
+        t.equal(
+            e.message,
+            "No package.json or eik.json file found in: '/pizza dir'",
+        );
+    }
+    t.end();
+});
+
+test('reading without stubbed json', (t) => {
+    const config = configStore.findInDirectory(__dirname);
+    t.equal(config.name, 'my-app');
+    t.end();
+});
+
+test('saves config to disk', async (t) => {
+    const path = await mkdirTempDir();
+    const config = new EikConfig(
+        {
+            name: 'magarita',
+            server: 'http://server',
+            files: { '/': 'pizza' },
+            version: '0.0.0',
+            out: './biscuits',
+        },
+        null,
+        path,
+    );
+
+    configStore.persistToDisk(config);
+
+    const persistedConfig = configStore.findInDirectory(path);
+    t.equal(persistedConfig.out, 'biscuits');
+    t.end();
+});
+
+test('saves config to disk - invalid config - passed config not a instance of EikConfig', async (t) => {
+    const config = {};
+    try {
+        configStore.persistToDisk(config);
+    } catch (err) {
+        t.match(
+            `${err}`,
+            `InvalidConfigError: Eik config object was invalid: 'config.persistToDisk operation failed: config.validate is not a function'`,
+        );
+    }
+
+    t.end();
+});
+
+test('saves config to disk - invalid config', async (t) => {
+    const config = new EikConfig(null);
+    try {
+        configStore.persistToDisk(config);
+    } catch (err) {
+        t.match(
+            `${err}`,
+            `InvalidConfigError: Eik config object was invalid: 'config.persistToDisk operation failed: Invalid eik.json schema: must have required property 'server'`,
+        );
+    }
+
+    t.end();
+});

package/packages/config-loader/test/eik-config/cwd.test.js

@@ -0,0 +1,35 @@
+const { test } = require('tap');
+const EikConfig = require('../../src/eik-config.js');
+
+const validEikConfig = {
+    name: 'pizza',
+    server: 'http://server',
+    files: { '/': 'pizza' },
+    version: '0.0.0',
+};
+
+test('EikConfig: .cwd set to /some/path', (t) => {
+    const config = new EikConfig(validEikConfig, [], '/some/path');
+    t.equal(config.cwd, '/some/path', 'should equal the given cwd');
+    t.end();
+});
+
+test('EikConfig: .cwd set to /some/path/', (t) => {
+    const config = new EikConfig(validEikConfig, [], '/some/path/');
+    t.equal(config.cwd, '/some/path', 'should normalize the given cwd');
+    t.end();
+});
+
+test('EikConfig: .cwd set to invalid relative path some/path', (t) => {
+    try {
+        // eslint-disable-next-line no-new
+        new EikConfig(validEikConfig, [], 'some/path');
+    } catch (err) {
+        t.match(
+            err.message,
+            '"configRootDir" must be an absolute path:',
+            'should throw expected error with message',
+        );
+    }
+    t.end();
+});

package/packages/config-loader/test/eik-config/map.test.js

@@ -0,0 +1,31 @@
+const { test } = require('tap');
+const EikConfig = require('../../src/eik-config.js');
+
+const validEikConfig = {
+    name: 'pizza',
+    server: 'http://server',
+    files: { '/': 'pizza' },
+    version: '0.0.0',
+};
+
+test('EikConfig: .map: set to string http://map', (t) => {
+    const config = new EikConfig({
+        ...validEikConfig,
+        'import-map': 'http://map',
+    });
+    t.same(config.map, ['http://map'], 'should be wrapped into an array');
+    t.end();
+});
+
+test('EikConfig: .map: set to an array with two values', (t) => {
+    const config = new EikConfig({
+        ...validEikConfig,
+        'import-map': ['http://map', 'http://map'],
+    });
+    t.same(
+        config.map,
+        ['http://map', 'http://map'],
+        'should remain the same as input',
+    );
+    t.end();
+});