feat(core): add method for dependencies installer manifest object validation

Ovidiu Barabula · Ovidiu Barabula · commit bdc0b9d46199 · 2018-05-08T16:30:47.000+03:00
diff --git a/src/util/dependencies-installer.spec.ts b/src/util/dependencies-installer.spec.ts
@@ -110,6 +110,14 @@ describe('DependenciesInstaller', () => {
       const { devDependencies } = await fileReader.read();
       expect(devDependencies['my-dev-package-1']).to.equal('^1.0.0');
     });
+
+
+    it('doesn\'t do anything if <manifest> is not valid', async () => {
+      await installer.add({});
+      const { devDependencies } = await fileReader.read();
+      expect(devDependencies['my-dev-package-1']).to.equal('^1.0.0');
+    });
+  });
   });
 
 
@@ -157,6 +165,75 @@ describe('DependenciesInstaller', () => {
   });
 
 
+  describe('private method isManifestValid()', () => {
+    beforeEach(async () => {
+      installer = await InstallerSingleton.getInstance(process.cwd());
+    });
+
+
+    it('returns true if <manifest> has dependencies object', () => {
+      expect(installer.isManifestValid({ dependencies: { 'my-package': '1.0.0' } })).to.be.true;
+      expect(installer.isManifestValid({
+        dependencies: { 'my-package': '1.0.0' },
+        devDependencies: {},
+      })).to.be.true;
+    });
+
+
+    it('returns true if <manifest> has devDependencies object', () => {
+      expect(installer.isManifestValid({
+        dependencies: {},
+        devDependencies: { 'my-package': '1.0.0' },
+      })).to.be.true;
+    });
+
+
+    it('returns false if <manifest> argument is not an object', () => {
+      expect(installer.isManifestValid(1)).to.be.false;
+    });
+
+
+    it('returns false if <manifest> argument is empty', () => {
+      expect(installer.isManifestValid({})).to.be.false;
+    });
+
+
+    it('returns false if <manifest> argument is missing both dependencies and devDependencies keys', () => {
+      expect(installer.isManifestValid({ 'some-key': 'value' })).to.be.false;
+    });
+
+
+    it('returns false if <manifest> argument has non-object dependencies', () => {
+      expect(installer.isManifestValid({ dependencies: 1 })).to.be.false;
+    });
+
+
+    it('returns false if <manifest> argument has non-object devDependencies', () => {
+      expect(installer.isManifestValid({ devDependencies: 1 })).to.be.false;
+    });
+
+
+    it('returns false if <manifest> argument has non-object dependencies and devDependencies', () => {
+      expect(installer.isManifestValid({ dependencies: 1, devDependencies: 1 })).to.be.false;
+    });
+
+
+    it('returns false if <manifest> argument has dependencies but is empty', () => {
+      expect(installer.isManifestValid({ dependencies: {} })).to.be.false;
+    });
+
+
+    it('returns false if <manifest> argument has devDependencies but is empty', () => {
+      expect(installer.isManifestValid({ devDependencies: {} })).to.be.false;
+    });
+
+
+    it('returns false if <manifest> argument has both dependencies and devDependencies empty', () => {
+      expect(installer.isManifestValid({ dependencies: {}, devDependencies: {} })).to.be.false;
+    });
+  });
+
+
   describe('private method logError()', () => {
     beforeEach(async () => {
       installer = await InstallerSingleton.getInstance(process.cwd());
diff --git a/src/util/dependencies-installer.ts b/src/util/dependencies-installer.ts
@@ -12,7 +12,14 @@ import { Stream } from 'stream';
 import { Config } from '../config-manager';
 import FileReader from './file-reader';
 import Logger, { ILogger } from './logger';
-import { required, sortObjectKeys } from './utility-functions';
+import {
+  isObject,
+  isObjectEmpty,
+  limitFn,
+  pluginName,
+  required,
+  sortObjectKeys,
+} from './utility-functions';
 
 
 export type PackageManager = 'yarn' | 'npm';
@@ -39,13 +46,16 @@ export interface DependenciesInstallerDefaults {
   managers: PackageManagersList;
 }
 
+export type DependenciesSubscriber = (manifest: DependenciesManifest, name: string) => void;
+
 export interface DependenciesInstaller {
   add(manifest: DependenciesManifest): Promise<void>;
   run(): Promise<void>;
   /* test:start */
   checkForManagers?(): Promise<void>;
   hasNoManagers?(): boolean;
   isManagerInstalled?(manager: PackageManager): Promise<boolean>;
+  isManifestValid?(manifest: DependenciesManifest): boolean;
   logError?(stream: Stream): void;
   logOutput?(stream: Stream): void;
   /* test:end */
@@ -57,7 +67,9 @@ const MESSAGES = {
   INSTALLING: 'Installing dependencies using',
   LOOKING_FOR_MANAGERS: 'Looking for package managers\u2026',
   MANAGER_FOUND: 'Package manager found',
+  MANIFEST_SCHEMA: 'When registering your plugin dependencies use the "package.json" schema',
   MANUAL_VERSION_CHANGE_REQUIRED: 'Unexpected behaviour or errors might occur. Please change the version of the package manually!',
+  REGISTERING_PLUGIN_DEPS: 'Registering dependencies',
 };
 
 // Custom error messages
@@ -66,6 +78,7 @@ export const ERRORS = {
   DEPENDENCY_ALREADY_ADDED: 'Package already exists',
   DEPENDENCY_VERSION_MISMATCH: 'Package already exists with different version',
   MANAGERS_REQUIRED: 'You need at least one package manager on your system (e.g. \'yarn\', \'npm\')',
+  MANIFEST_INVALID: 'Dependencies <manifest> object is invalid',
   NO_MANAGERS: 'Wow, no package managers were found on your system',
 };
 
@@ -80,7 +93,7 @@ export async function Installer(
   options?: DependenciesInstallerOptions,
 ): Promise<DependenciesInstaller> {
   const defaultOptions: DependenciesInstallerDefaults = {
-    logChannel: 'PackageInstaller',
+    logChannel: 'DepsInstaller',
     managers: ['yarn', 'npm'],
   };
 
@@ -111,11 +124,96 @@ export async function Installer(
   let availableManagers: PackageManagersList = [];
 
 
+  /**
+   * Check validity of <manifest> object
+   * @param manifest Dependencies manifest object
+   */
+  function isManifestValid(manifest: DependenciesManifest) {
+    if (!isObject(manifest)) {
+      logger.error(`${ERRORS.MANIFEST_INVALID}: not an object`);
+      return false;
+    }
+
+    if (isObjectEmpty(manifest)) {
+      logger.error(`${ERRORS.MANIFEST_INVALID}: object is empty`);
+      return false;
+    }
+
+    // Not valid if both "devDependencies" and "dependencies" keys are missing
+    if (!Object.keys(manifest).some(key => ['dependencies', 'devDependencies'].includes(key))) {
+      logger.error(`${ERRORS.MANIFEST_INVALID}: object should have at least one of the following keys: 'dependencies', 'devDependencies'`);
+      return false;
+    }
+
+    // If "dependencies" or "devDependencies" are not objects
+    if (
+      (typeof manifest.dependencies !== 'undefined' && !isObject(manifest.dependencies)) ||
+      (typeof manifest.devDependencies !== 'undefined' && !isObject(manifest.devDependencies))
+    ) {
+      logger.error(`${ERRORS.MANIFEST_INVALID}: manifest's 'dependencies' and 'devDependencies' should be objects`);
+      return false;
+    }
+
+    // If manifest contains "devDependencies" or "dependencies" keys, but are empty
+    if (
+      // Has "devDependencies", but is empty
+      (
+        typeof manifest.dependencies === 'undefined' &&
+        (
+          typeof manifest.devDependencies !== 'undefined' &&
+          isObject(manifest.devDependencies) &&
+          isObjectEmpty(manifest.devDependencies)
+        )
+      ) ||
+      // Has "dependencies", but is empty
+      (
+        typeof manifest.devDependencies === 'undefined' &&
+        (
+          typeof manifest.dependencies !== 'undefined' &&
+          isObject(manifest.dependencies) &&
+          isObjectEmpty(manifest.dependencies)
+        )
+      ) ||
+      // Has both "dependencies" and "devDependencies" empty
+      (
+        typeof manifest.dependencies !== 'undefined' &&
+        isObject(manifest.dependencies) &&
+        isObjectEmpty(manifest.dependencies) &&
+        typeof manifest.devDependencies !== 'undefined' &&
+        isObject(manifest.devDependencies) &&
+        isObjectEmpty(manifest.devDependencies)
+      )
+    ) {
+      logger.error(
+        `${ERRORS.MANIFEST_INVALID}: manifest's 'dependencies' or 'devDependencies' objects should not be empty`,
+    );
+      return false;
+    }
+
+    return true;
+  }
+
+
   /**
    * Add dependencies to package.json
    * @param dependencies Object with "dependencies" and "devDependencies"
    */
   async function add(manifest: DependenciesManifest): Promise<void> {
+    // Validate manifest parameter
+    if (!isManifestValid(manifest)) {
+      const schema = {
+        dependencies: {
+          package: '^1.0.1',
+          package2: '^2.2.0',
+        },
+        devDependencies: {
+          'dev-package': '~3.1.4',
+        },
+      };
+      logger.warn(`${MESSAGES.MANIFEST_SCHEMA}:\n${JSON.stringify(schema, null, 2)}`);
+      return undefined;
+    }
+
     try {
       // Get current dependencies
       const projectConfig = await fileReader.read();
@@ -306,6 +404,7 @@ export async function Installer(
     checkForManagers,
     hasNoManagers,
     isManagerInstalled,
+    isManifestValid,
     logError,
     logOutput,
   };
