Merge pull request #3863 from snyk/feat/pass-http-client-to-plugins

feat: pass snykHttpClient to plugin.inspect

Author: Jdunsby

package-lock.json

@@ -116,7 +116,7 @@
     "snyk-cpp-plugin": "2.20.1",
     "snyk-docker-plugin": "^5.4.3",
     "snyk-go-plugin": "1.19.2",
-    "snyk-gradle-plugin": "3.22.2",
+    "snyk-gradle-plugin": "3.23.0",
     "snyk-module": "3.1.0",
     "snyk-mvn-plugin": "2.31.0",
     "snyk-nodejs-lockfile-parser": "1.38.0",

package.json

@@ -223,6 +223,7 @@ export function args(rawArgv: string[]): Args {
     'prune-repeated-subdependencies',
     'dry-run',
     'sequential',
+    'gradle-normalize-deps',
   ];
   for (const dashedArg of argumentsToTransform) {
     if (argv[dashedArg]) {

src/cli/args.ts

@@ -10,6 +10,7 @@ export function ModuleInfo(plugin, policy) {
       root,
       targetFile,
       options,
+      snykHttpClient,
     ): Promise<pluginApi.SinglePackageResult | pluginApi.MultiProjectResult> {
       const pluginOptions = merge(
         {
@@ -19,7 +20,12 @@ export function ModuleInfo(plugin, policy) {
       );
 
       debug('calling plugin inspect()', { root, targetFile, pluginOptions });
-      const info = await plugin.inspect(root, targetFile, pluginOptions);
+      const info = await plugin.inspect(
+        root,
+        targetFile,
+        pluginOptions,
+        snykHttpClient,
+      );
       debug('plugin inspect() done');
 
       // attach policy if not provided by plugin

src/lib/module-info/index.ts

@@ -2,6 +2,7 @@ import plugins = require('.');
 import { ModuleInfo } from '../module-info';
 import { legacyPlugin as pluginApi } from '@snyk/cli-interface';
 import { TestOptions, Options, MonitorOptions } from '../types';
+import { snykHttpClient } from '../request/snyk-http-client';
 
 export async function getSinglePluginResult(
   root: string,
@@ -14,6 +15,7 @@ export async function getSinglePluginResult(
     root,
     targetFile || options.file,
     { ...options },
+    snykHttpClient,
   );
   return inspectRes;
 }

src/lib/plugins/get-single-plugin-result.ts

@@ -0,0 +1,39 @@
+import * as needle from 'needle';
+import { OutgoingHttpHeaders } from 'http';
+import { NeedleHttpVerbs } from 'needle';
+import { makeRequest } from '../request/index';
+import { getAuthHeader } from '../api-token';
+import config from '../config';
+import { Payload } from '../request/types';
+
+interface RequestInfo {
+  method: NeedleHttpVerbs;
+  path: string;
+  body: any;
+  headers?: OutgoingHttpHeaders;
+  qs?: {};
+  json?: boolean;
+  timeout?: number;
+  family?: number;
+}
+
+export async function snykHttpClient(
+  requestInfo: RequestInfo,
+): Promise<{
+  res: needle.NeedleResponse;
+  body: any;
+}> {
+  let { path } = requestInfo;
+  if (!path.startsWith('/')) path = `/${path}`;
+
+  const payload: Payload = {
+    ...requestInfo,
+    url: `${config.API_REST_URL}${path}`,
+    headers: {
+      ...requestInfo.headers,
+      Authorization: getAuthHeader(),
+    },
+  };
+
+  return makeRequest(payload);
+}

src/lib/request/snyk-http-client.ts

@@ -225,7 +225,8 @@ export type SupportedUserReachableFacingCliArgs =
   | 'sub-project'
   | 'trust-policies'
   | 'yarn-workspaces'
-  | 'maven-aggregate-project';
+  | 'maven-aggregate-project'
+  | 'gradle-normalize-deps';
 
 export enum SupportedCliCommands {
   version = 'version',

src/lib/types.ts

@@ -41,6 +41,7 @@ import { DepGraphBuilder } from '@snyk/dep-graph';
 import * as depGraphLib from '@snyk/dep-graph';
 import { getFixturePath } from '../jest/util/getFixturePath';
 import { getWorkspacePath } from '../jest/util/getWorkspacePath';
+import { snykHttpClient } from '../../src/lib/request/snyk-http-client';
 
 /*
   TODO: enable these tests, once we switch from node-tap
@@ -927,6 +928,7 @@ if (!isWindows) {
           packageManager: 'pip',
           path: 'pip-app',
         },
+        snykHttpClient,
       ],
       'calls python plugin',
     );
@@ -990,6 +992,7 @@ if (!isWindows) {
           packageManager: 'pip',
           path: 'pip-app',
         },
+        snykHttpClient,
       ],
       'calls python plugin',
     );
@@ -1042,6 +1045,7 @@ if (!isWindows) {
           file: 'build.gradle',
           path: 'gradle-app',
         },
+        snykHttpClient,
       ],
       'calls gradle plugin',
     );
@@ -1111,6 +1115,7 @@ if (!isWindows) {
           packageManager: 'gradle',
           path: 'gradle-app',
         },
+        snykHttpClient,
       ],
       'calls gradle plugin',
     );
@@ -1170,6 +1175,7 @@ if (!isWindows) {
           packageManager: 'gradle',
           path: 'gradle-app',
         },
+        snykHttpClient,
       ],
       'calls gradle plugin',
     );
@@ -1224,6 +1230,7 @@ if (!isWindows) {
           packageManager: 'gradle',
           path: 'gradle-app',
         },
+        snykHttpClient,
       ],
       'calls plugin for the 1st path',
     );
@@ -1239,6 +1246,7 @@ if (!isWindows) {
           packageManager: 'pip',
           path: 'pip-app',
         },
+        snykHttpClient,
       ],
       'calls plugin for the 2nd path',
     );
@@ -1316,6 +1324,7 @@ if (!isWindows) {
           packageManager: 'gomodules',
           path: 'golang-gomodules',
         },
+        snykHttpClient,
       ],
       'calls golang plugin',
     );
@@ -1364,6 +1373,7 @@ if (!isWindows) {
           packageManager: 'golangdep',
           path: 'golang-app',
         },
+        snykHttpClient,
       ],
       'calls golang plugin',
     );
@@ -1412,6 +1422,7 @@ if (!isWindows) {
           packageManager: 'govendor',
           path: 'golang-app',
         },
+        snykHttpClient,
       ],
       'calls golang plugin',
     );
@@ -1458,6 +1469,7 @@ if (!isWindows) {
           packageManager: 'cocoapods',
           path: './',
         },
+        snykHttpClient,
       ],
       'calls CocoaPods plugin',
     );
@@ -1506,6 +1518,7 @@ if (!isWindows) {
           packageManager: 'cocoapods',
           path: './',
         },
+        snykHttpClient,
       ],
       'calls CocoaPods plugin',
     );
@@ -1560,6 +1573,7 @@ if (!isWindows) {
           packageManager: 'cocoapods',
           path: './',
         },
+        snykHttpClient,
       ],
       'calls CocoaPods plugin',
     );

test/tap/cli-monitor.acceptance.test.ts

@@ -65,6 +65,7 @@ const after = tap.runOnly ? only : test;
 // Should be after `process.env` setup.
 import * as plugins from '../../src/lib/plugins/index';
 import * as ecoSystemPlugins from '../../src/lib/ecosystems/plugins';
+import { snykHttpClient } from '../../src/lib/request/snyk-http-client';
 
 /*
   TODO: enable these tests, once we switch from node-tap
@@ -134,6 +135,7 @@ test('Languages', async (t) => {
           languageTest.tests[testName](
             { server, plugins, ecoSystemPlugins, versionNumber, cli },
             { chdirWorkspaces },
+            snykHttpClient,
           ),
         );
         server.restore();