Merge pull request #1276 from opencomponents/dev-filter-components

ricardo-devis-agullo · web-flow · commit 43d7c4647bce · 2021-11-16T16:31:02.000+01:00
[CLI-FEATURE] filter components to run when running oc dev
diff --git a/src/cli/commands.ts b/src/cli/commands.ts
@@ -52,6 +52,11 @@ export default {
           boolean: false,
           description: 'Url prefix for registry server',
           default: ''
+        },
+        components: {
+          array: true,
+          description:
+            'List of component names that you want to be packaged and exposed on dev registry'
         }
       },
       usage: 'Usage: $0 dev <dirPath> [port] [baseUrl] [options]'
diff --git a/src/cli/domain/get-components-by-dir.ts b/src/cli/domain/get-components-by-dir.ts
@@ -5,8 +5,20 @@ import { Component } from '../../types';
 export default function getComponentsByDir() {
   return (
     componentsDir: string,
-    callback: (err: Error | null, data: string[]) => void
+    componentsToRunOrCb:
+      | string[]
+      | ((err: Error | null, data: string[]) => void),
+    callbackMaybe?: (err: Error | null, data: string[]) => void
   ): void => {
+    const componentsToRun =
+      typeof componentsToRunOrCb === 'function'
+        ? undefined
+        : componentsToRunOrCb;
+    const callback =
+      typeof componentsToRunOrCb === 'function'
+        ? componentsToRunOrCb
+        : callbackMaybe!;
+
     const isOcComponent = function (file: string) {
       const filePath = path.resolve(componentsDir, file);
       const packagePath = path.join(filePath, 'package.json');
@@ -31,6 +43,11 @@ export default function getComponentsByDir() {
 
     try {
       dirContent = fs.readdirSync(componentsDir);
+      if (componentsToRun) {
+        dirContent = dirContent.filter(content =>
+          componentsToRun.includes(content)
+        );
+      }
     } catch (err) {
       return callback(null, []);
     }
diff --git a/src/cli/facade/dev.ts b/src/cli/facade/dev.ts
@@ -28,6 +28,7 @@ const dev =
       baseUrl: string;
       fallbackRegistryUrl: string;
       hotReloading?: boolean;
+      components: string[];
       watch?: boolean;
       verbose?: boolean;
       production?: boolean;
@@ -137,96 +138,101 @@ const dev =
     };
 
     logger.warn(cliMessages.SCANNING_COMPONENTS, true);
-    local.getComponentsByDir(componentsDir, (err, components) => {
-      if (_.isEmpty(components)) {
-        err = cliErrors.DEV_FAIL(cliErrors.COMPONENTS_NOT_FOUND) as any;
-        callback(err, undefined as any);
-        return logger.err(String(err));
-      }
+    local.getComponentsByDir(
+      componentsDir,
+      opts.components as any,
+      (err, components) => {
+        if (_.isEmpty(components)) {
+          err = cliErrors.DEV_FAIL(cliErrors.COMPONENTS_NOT_FOUND) as any;
+          callback(err, undefined as any);
+          return logger.err(String(err));
+        }
 
-      logger.ok('OK');
-      _.forEach(components, component =>
-        logger.log(colors.green('├── ') + component)
-      );
+        logger.ok('OK');
+        _.forEach(components, component =>
+          logger.log(colors.green('├── ') + component)
+        );
 
-      handleDependencies({ components, logger }, (err, dependencies) => {
-        if (err) {
-          logger.err(err);
-          return callback(err, undefined as any);
-        }
-        packageComponents(components, () => {
-          async.waterfall(
-            [
-              (next: any) => {
-                if (hotReloading) {
-                  getPort(port + 1, (error, otherPort) => {
-                    if (error) {
-                      return next(error);
-                    }
-                    const liveReloadServer = livereload.createServer({
-                      port: otherPort
+        handleDependencies({ components, logger }, (err, dependencies) => {
+          if (err) {
+            logger.err(err);
+            return callback(err, undefined as any);
+          }
+          packageComponents(components, () => {
+            async.waterfall(
+              [
+                (next: any) => {
+                  if (hotReloading) {
+                    getPort(port + 1, (error, otherPort) => {
+                      if (error) {
+                        return next(error);
+                      }
+                      const liveReloadServer = livereload.createServer({
+                        port: otherPort
+                      });
+                      const refresher = () => liveReloadServer.refresh('/');
+                      next(null, { refresher, port: otherPort });
                     });
-                    const refresher = () => liveReloadServer.refresh('/');
-                    next(null, { refresher, port: otherPort });
-                  });
-                } else {
-                  next(null, { refresher: _.noop, port: null });
+                  } else {
+                    next(null, { refresher: _.noop, port: null });
+                  }
                 }
-              }
-            ],
-            (err, liveReload: any) => {
-              if (err) {
-                logger.err(String(err));
-                return callback(err, undefined as any);
-              }
-
-              const registry = oc.Registry({
-                baseUrl,
-                prefix: opts.prefix || '',
-                dependencies: dependencies.modules,
-                discovery: true,
-                env: { name: 'local' },
-                fallbackRegistryUrl,
-                hotReloading,
-                liveReloadPort: liveReload.port,
-                local: true,
-                path: path.resolve(componentsDir),
-                port,
-                templates: dependencies.templates,
-                verbosity: 1
-              });
-
-              registerPlugins(registry);
-
-              logger.warn(cliMessages.REGISTRY_STARTING(baseUrl));
-              if (liveReload.port) {
-                logger.warn(
-                  cliMessages.REGISTRY_LIVERELOAD_STARTING(liveReload.port)
-                );
-              }
-              registry.start(err => {
+              ],
+              (err, liveReload: any) => {
                 if (err) {
-                  if ((err as any).code === 'EADDRINUSE') {
-                    err = cliErrors.PORT_IS_BUSY(port) as any;
-                  }
-
                   logger.err(String(err));
                   return callback(err, undefined as any);
                 }
 
-                if (optWatch) {
-                  watchForChanges(
-                    { components, refreshLiveReload: liveReload.refresher },
-                    packageComponents
+                const registry = oc.Registry({
+                  baseUrl,
+                  prefix: opts.prefix || '',
+                  dependencies: dependencies.modules,
+                  discovery: true,
+                  env: { name: 'local' },
+                  fallbackRegistryUrl,
+                  hotReloading,
+                  liveReloadPort: liveReload.port,
+                  local: true,
+                  components: opts.components,
+                  path: path.resolve(componentsDir),
+                  port,
+                  templates: dependencies.templates,
+                  verbosity: 1
+                });
+
+                registerPlugins(registry);
+
+                logger.warn(cliMessages.REGISTRY_STARTING(baseUrl));
+                if (liveReload.port) {
+                  logger.warn(
+                    cliMessages.REGISTRY_LIVERELOAD_STARTING(liveReload.port)
                   );
                 }
-                callback(null, registry);
-              });
-            }
-          );
+                registry.start(err => {
+                  if (err) {
+                    if ((err as any).code === 'EADDRINUSE') {
+                      err = cliErrors.PORT_IS_BUSY(port) as any;
+                    }
+
+                    logger.err(String(err));
+                    return callback(err, undefined as any);
+                  }
+
+                  if (optWatch) {
+                    watchForChanges(
+                      { components, refreshLiveReload: liveReload.refresher },
+                      packageComponents
+                    );
+                  }
+                  callback(null, registry);
+                });
+              }
+            );
+          });
         });
-      });
-    });
+      }
+    );
   };
 
 export default dev;
diff --git a/src/registry/domain/repository.ts b/src/registry/domain/repository.ts
@@ -58,16 +58,18 @@ export default function repository(conf: Config): Repository {
         .toString();
     },
     getComponents(): string[] {
-      const validComponents = fs.readdirSync(conf.path).filter(file => {
-        const isDir = fs.lstatSync(path.join(conf.path, file)).isDirectory();
-        const isValidComponent = isDir
-          ? fs
-              .readdirSync(path.join(conf.path, file))
-              .filter(file => file === '_package').length === 1
-          : false;
-
-        return isValidComponent;
-      });
+      const validComponents =
+        conf.components ||
+        fs.readdirSync(conf.path).filter(file => {
+          const isDir = fs.lstatSync(path.join(conf.path, file)).isDirectory();
+          const isValidComponent = isDir
+            ? fs
+                .readdirSync(path.join(conf.path, file))
+                .filter(file => file === '_package').length === 1
+            : false;
+
+          return isValidComponent;
+        });
 
       validComponents.push('oc-client');
       return validComponents;
diff --git a/src/types.ts b/src/types.ts
@@ -127,6 +127,7 @@ export interface Config {
   hotReloading: boolean;
   keepAliveTimeout?: number;
   liveReloadPort: number;
+  components?: string[];
   local: boolean;
   path: string;
   plugins: Record<string, (...args: unknown[]) => void>;
@@ -291,6 +292,7 @@ export interface Local {
   ) => void;
   getComponentsByDir: (
     componentsDir: string,
+    componentsToRun: (err: Error | null, data: string[]) => void | string[],
     callback: (err: Error | null, data: string[]) => void
   ) => void;
   init: (
diff --git a/test/unit/cli-domain-get-components-by-dir.js b/test/unit/cli-domain-get-components-by-dir.js
@@ -34,8 +34,12 @@ const initialise = function () {
   return { local: local, fs: fsMock };
 };
 
-const executeComponentsListingByDir = function (local, callback) {
-  return local('.', callback);
+const executeComponentsListingByDir = function (
+  local,
+  componentsToRun,
+  callback
+) {
+  return local('.', componentsToRun, callback);
 };
 
 describe('cli : domain : get-components-by-dir', () => {
@@ -65,7 +69,7 @@ describe('cli : domain : get-components-by-dir', () => {
       data.fs.readJsonSync.onCall(3).returns({ oc: { packaged: true } });
       data.fs.readJsonSync.onCall(4).returns({});
 
-      executeComponentsListingByDir(data.local, (err, res) => {
+      executeComponentsListingByDir(data.local, undefined, (err, res) => {
         error = err;
         result = res;
         done();
@@ -94,7 +98,7 @@ describe('cli : domain : get-components-by-dir', () => {
       data.fs.readJsonSync.onCall(0).throws(new Error('syntax error: fubar'));
       data.fs.readJsonSync.onCall(1).returns({ oc: {} });
 
-      executeComponentsListingByDir(data.local, (err, res) => {
+      executeComponentsListingByDir(data.local, undefined, (err, res) => {
         error = err;
         result = res;
         done();
@@ -128,7 +132,7 @@ describe('cli : domain : get-components-by-dir', () => {
         .onCall(2)
         .throws(new Error('ENOENT: no such file or directory'));
 
-      executeComponentsListingByDir(data.local, (err, res) => {
+      executeComponentsListingByDir(data.local, undefined, (err, res) => {
         error = err;
         result = res;
         done();
@@ -143,4 +147,48 @@ describe('cli : domain : get-components-by-dir', () => {
       expect(result).to.eql([]);
     });
   });
+
+  describe('when components are filtered', () => {
+    let error;
+    let result;
+    beforeEach(done => {
+      const data = initialise();
+
+      data.fs.readdirSync
+        .onCall(0)
+        .returns([
+          'component1',
+          'component2',
+          'component3',
+          'component4',
+          'package.json'
+        ]);
+
+      data.fs.readJsonSync.onCall(0).returns({ oc: {} });
+      data.fs.readJsonSync.onCall(1).returns({ oc: {} });
+      data.fs.readJsonSync.onCall(2).returns({ oc: {} });
+      data.fs.readJsonSync.onCall(3).returns({ oc: {} });
+      data.fs.readJsonSync
+        .onCall(4)
+        .throws(new Error('ENOENT: no such file or directory'));
+
+      executeComponentsListingByDir(
+        data.local,
+        ['component1', 'component3'],
+        (err, res) => {
+          error = err;
+          result = res;
+          done();
+        }
+      );
+    });
+
+    it('should not error', () => {
+      expect(error).to.be.null;
+    });
+
+    it('should get an the filtered list', () => {
+      expect(result).to.eql(['./component1', './component3']);
+    });
+  });
 });
