Merge pull request #443 from snyk/refactor/snyk-monitor-direct-import

refactor: untangling lib/index.js part 1, monitor

package.json

@@ -25,6 +25,7 @@
     "build": "tsc",
     "build-watch": "tsc -w",
     "eslint": "eslint -c .eslintrc src",
+    "find-circular": "npm run build && madge --circular ./dist",
     "tslint": "tslint --project tsconfig.json --format stylish --exclude **/src/**/*.js",
     "prepare": "npm run build",
     "tap": "tap test/*.test.* -Rspec --timeout=300 --node-arg=-r --node-arg=ts-node/register",
@@ -95,6 +96,7 @@
     "@types/needle": "^2.0.4",
     "@types/node": "^10.0.0",
     "eslint": "^5.16.0",
+    "madge": "^3.4.4",
     "nock": "^10.0.6",
     "proxyquire": "^1.7.4",
     "restify": "^4.1.1",

src/cli/commands/monitor.ts

@@ -4,6 +4,7 @@ import * as _ from 'lodash';
 import * as fs from 'then-fs';
 import {exists as apiTokenExists} from '../../lib/api-token';
 import snyk = require('../../lib/'); // TODO(kyegupov): fix import
+import {monitor as snykMonitor} from '../../lib/monitor';
 import * as config from '../../lib/config';
 import * as url from 'url';
 import chalk from 'chalk';
@@ -14,8 +15,7 @@ import * as detect from '../../lib/detect';
 import * as plugins from '../../lib/plugins';
 import ModuleInfo = require('../../lib/module-info'); // TODO(kyegupov): fix import
 import * as docker from '../../lib/docker-promotion';
-import { MonitorError } from '../../lib/monitor';
-import {SingleDepRootResult, MultiDepRootsResult, isMultiResult} from '../../lib/types';
+import {SingleDepRootResult, MultiDepRootsResult, isMultiResult, MonitorError } from '../../lib/types';
 
 const SEPARATOR = '\n-------------------------------------------------------\n';
 
@@ -146,8 +146,6 @@ async function monitor(...args0: any[]): Promise<any> {
       // Post the project dependencies to the Registry
       const monOutputs: string[] = [];
       for (const depRootDeps of perDepRootResults) {
-        // TODO(kyegupov): make snyk.monitor typed by converting src/lib/index.js to TS
-        const snykMonitor = snyk.monitor as any as (path, meta, depRootDeps) => Promise<any>;
         const res = await promiseOrCleanup(
           snykMonitor(path, meta, depRootDeps),
           spinner.clear(postingMonitorSpinnerLabel));

src/cli/commands/protect/wizard.js

@@ -18,6 +18,7 @@ const getVersion = require('../version');
 const allPrompts = require('./prompts');
 const answersToTasks = require('./tasks');
 const snyk = require('../../../lib/');
+const snykMonitor = require('../../../lib/monitor').monitor;
 const isCI = require('../../../lib/is-ci');
 const protect = require('../../../lib/protect');
 const authorization = require('../../../lib/authorization');
@@ -519,7 +520,7 @@ function processAnswers(answers, policy, options) {
 
       return info.inspect(cwd, targetFile, options)
         .then(spinner(lbl))
-        .then(snyk.monitor.bind(null, cwd, meta))
+        .then(snykMonitor.bind(null, cwd, meta))
         // clear spinner in case of success or failure
         .then(spinner.clear(lbl))
         .catch((error) => {

src/lib/capture.js

@@ -3,6 +3,7 @@ module.exports = captureRequires;
 var path = require('path');
 var modules = [];
 var snyk = require('../lib');
+var snykMonitor = require('../lib/monitor').monitor;
 
 function captureRequires() {
   var timer = null;
@@ -42,7 +43,7 @@ function resolve() {
 
   // then collect all the package deps and post a monitor
   var cwd = path.resolve(candidate, '..');
-  snyk.modules(cwd).then(snyk.monitor.bind(null, cwd, {
+  snyk.modules(cwd).then(snykMonitor.bind(null, cwd, {
     method: 'require',
   }));
 }

src/lib/index.js

@@ -3,6 +3,14 @@ module.exports = snyk;
 var cluster = require('cluster');
 var snykConfig = require('./config');
 
+// This module exports a function with properties attached.
+// The properties represent other modules - so, it's some kind of "world object"
+// that is used to indirectly import modules.
+// The function modifies the object and returns it.
+// This also introduces some circular imports.
+
+// TODO(kyegupov): untangle this, resolve circular imports, convert to Typescript
+
 function snyk(options) {
   if (!options) {
     options = {};
@@ -50,7 +58,6 @@ Object.defineProperty(snyk, 'api', {
 
 snyk.modules = require('./modules');
 snyk.test = require('./snyk-test');
-snyk.monitor = require('./monitor');
 snyk.bus = require('./bus');
 snyk.policy = require('snyk-policy');
 snyk.isRequired = true; // changed to false when loaded via cli

src/lib/monitor.ts

@@ -1,5 +1,3 @@
-module.exports = monitor;
-
 import * as snyk from '../lib';
 import {exists as apiTokenExists} from './api-token';
 import * as request from './request';
@@ -8,12 +6,7 @@ import * as os from 'os';
 import * as _ from 'lodash';
 import * as isCI from './is-ci';
 import * as analytics from './analytics';
-import { SingleDepRootResult } from './types';
-
-export class MonitorError extends Error {
-  public code?: number;
-  public userMessage?: string;
-}
+import { SingleDepRootResult, MonitorError } from './types';
 
 // TODO(kyegupov): clean up the type, move to snyk-cli-interface repository
 
@@ -42,7 +35,7 @@ interface Meta {
   projectName: string;
 }
 
-function monitor(root, meta, info: SingleDepRootResult) {
+export function monitor(root, meta, info: SingleDepRootResult): Promise<any> {
   const pkg = info.package;
   const pluginMeta = info.plugin;
   let policyPath = meta['policy-path'];

src/lib/types.ts

@@ -52,3 +52,8 @@ export interface MultiDepRootsResult {
 export function isMultiResult(pet: SingleDepRootResult | MultiDepRootsResult): pet is MultiDepRootsResult {
   return !!(pet as MultiDepRootsResult).depRoots;
 }
+
+export class MonitorError extends Error {
+  public code?: number;
+  public userMessage?: string;
+}