Merge pull request #53 from snyk/chore/add-options-to-analysis

feat/add options to analysis functions

README.md

@@ -1,4 +1,4 @@
-# tsc
+# code-client
 
 Typescript consumer of public API
 
@@ -16,17 +16,16 @@ $ npm install --save @snyk/code-client
 ### Creates and initializes an instance
 
 ```javascript
-import tsc from '@snyk/code-client';
+import codeClient from '@snyk/code-client';
 
 // An address of server which will be used in order to send code and analyse it.
 const baseURL = 'https://www.snyk.io';
-
 ```
 
 ### Requests the creation of a new login session
 
 ```javascript
-const loginResponse = await tsc.startSession({
+const loginResponse = await codeClient.startSession({
   baseURL,
   // An identificator for the editor using the Snyk APIs
   source: 'atom',
@@ -40,8 +39,9 @@ const { sessionToken, loginURL } = loginResponse.value;
 ```
 
 ### Checks status of the login process
+
 ```javascript
-const sessionResponse = await tsc.checkSession({ baseURL, sessionToken });
+const sessionResponse = await codeClient.checkSession({ baseURL, sessionToken });
 if (sessionResponse.type === 'error') {
   // Handle error and alert user
 }
@@ -53,33 +53,48 @@ const isLoggedIn = sessionResponse.value; // boolean
 
 ```javascript
 /** Building bundle process started with provided data */
-tsc.emitter.on('scanFilesProgress', (processed: number) = {
+codeClient.emitter.on('scanFilesProgress', (processed: number) = {
   console.log(`Indexed ${processed} files`);
 });
 
 /** Bundle upload process is started with provided data */
-tsc.emitter.on('uploadBundleProgress', (processed: number, total: number) => {
+codeClient.emitter.on('uploadBundleProgress', (processed: number, total: number) => {
   console.log(`Upload bundle progress: ${processed}/${total}`);
 });
 
 /** Receives an error object and logs an error message */
-tsc.emitter.on('sendError', error => {
+codeClient.emitter.on('sendError', error => {
   console.log(error);
 });
+
+/** Logs HTTP requests sent to the API **/
+codeClient.emitter.on('apiRequestLog', (message) => {
+  console.log(message);
+});
+
 ```
 
 Complete list of events:
-  - supportedFilesLoaded: uploading supported file extensions, can be also used for instantiating file watcher
-  - scanFilesProgress: emits a number of files being found
-  - createBundleProgress: emits a progress in instantiating packages for analysis
-  - uploadBundleProgress: emits a progress in uploading files
-  - analyseProgress: emits a progress in analysis job
-  - error: emits in case of an error
+
+- supportedFilesLoaded: uploading supported file extensions, can be also used for instantiating file watcher
+- scanFilesProgress: emits a number of files being found
+- createBundleProgress: emits a progress in instantiating packages for analysis
+- uploadBundleProgress: emits a progress in uploading files
+- analyseProgress: emits a progress in analysis job
+- error: emits in case of an error
 
 ### Run analysis
 
 ```javascript
-const bundle = await tsc.analyzeFolders(baseURL, sessionToken, false, 1, ['/home/user/repo']);
+const bundle = await codeClient.analyzeFolders({
+  baseURL,
+  sessionToken,
+  includeLint: false,
+  severity: 1,
+  paths: ['/home/user/repo'],
+  sarif,
+  source,
+});
 
 // bundle implements interface IFileBundle:
 //   readonly baseURL: string;
@@ -97,7 +112,7 @@ const bundle = await tsc.analyzeFolders(baseURL, sessionToken, false, 1, ['/home
 ### Creates a new bundle based on a previously uploaded one
 
 ```javascript
-const result = await tsc.extendBundle({
+const result = await codeClient.extendBundle({
   sessionToken,
   bundleId,
   files: {
@@ -112,8 +127,15 @@ const { bundleId, missingFiles, uploadURL } = result;
 ### Run analysis of remote git repository
 
 ```javascript
-
-const bundle = await analyzeGit(baseURL, sessionToken, false, 1, 'git@github.com:DeepCodeAI/cli.git@320d98a6896f5376efe6cefefb6e70b46b97d566');
+const bundle = await analyzeGit({
+  baseURL,
+  sessionToken,
+  includeLint: false,
+  severity: 1,
+  gitUri: 'git@github.com:DeepCodeAI/cli.git@320d98a6896f5376efe6cefefb6e70b46b97d566',
+  sarif: true,
+  source,
+});
 
 // bundle implements interface IGitBundle
 //   readonly baseURL: string;

development.md

@@ -1,12 +1,14 @@
 # Package development notes
 
 To use and debug package locally you don't need publish it to NPM registry:
+
 ```shell script
 $ cd <package-location>
 $ npm install && npm run build && npx yalc publish
 ```
 
 After that you have to create symlink to your package in your project folder:
+
 ```shell script
 $ cd <project-location>
 $ npx yalc add @snyk/code-client
@@ -17,6 +19,7 @@ $ npx yalc add @snyk/code-client
 ### Before publishing make sure test pass
 
 Test variables:
+
 - `SNYK_URL` is the DC server URL (staging deployment if not provided)
 - `SNYK_API_KEY` is a sessionToken of a user with access to the Snyk
 - `SNYK_API_KEY_NO_ACCESS` is a sessionToken of a user with no access to the snyk organization (even better if on a different platform than GitHub)

src/analysis.ts

@@ -31,6 +31,12 @@ import {
   IFileBundle,
   IBundleResult,
 } from './interfaces/analysis-result.interface';
+import {
+  FolderOptions,
+  AnalyzeFoldersOptions,
+  AnalyzeGitOptions,
+  GitOptions,
+} from './interfaces/analysis-options.interface';
 
 const sleep = (duration: number) => new Promise(resolve => setTimeout(resolve, duration));
 
@@ -43,6 +49,7 @@ async function pollAnalysis({
   oAuthToken,
   username,
   limitToFiles,
+  source,
 }: {
   baseURL: string;
   sessionToken: string;
@@ -52,6 +59,7 @@ async function pollAnalysis({
   oAuthToken?: string;
   username?: string;
   limitToFiles?: string[];
+  source: string;
 }): Promise<IResult<AnalysisFailedResponse | AnalysisFinishedResponse, GetAnalysisErrorCodes>> {
   let analysisResponse: IResult<GetAnalysisResponseDto, GetAnalysisErrorCodes>;
   let analysisData: GetAnalysisResponseDto;
@@ -73,6 +81,7 @@ async function pollAnalysis({
       includeLint,
       severity,
       limitToFiles,
+      source,
     });
 
     if (analysisResponse.type === 'error') {
@@ -111,6 +120,7 @@ export async function analyzeBundle({
   oAuthToken,
   username,
   limitToFiles,
+  source,
 }: {
   baseURL: string;
   sessionToken: string;
@@ -120,6 +130,7 @@ export async function analyzeBundle({
   oAuthToken?: string;
   username?: string;
   limitToFiles?: string[];
+  source: string;
 }): Promise<IBundleResult> {
   // Call remote bundle for analysis results and emit intermediate progress
   const analysisData = await pollAnalysis({
@@ -131,6 +142,7 @@ export async function analyzeBundle({
     includeLint,
     severity,
     limitToFiles,
+    source,
   });
 
   if (analysisData.type === 'error') {
@@ -203,21 +215,35 @@ function mergeBundleResults(bundle: IFileBundle, analysisData: IBundleResult, li
     analysisResults,
   };
 }
+let analyzeFolderDefaults = {
+  baseURL: defaultBaseURL,
+  sessionToken: '',
+  includeLint: false,
+  severity: AnalysisSeverity.info,
+  symlinksEnabled: false,
+  maxPayload: MAX_PAYLOAD,
+  defaultFileIgnores: IGNORES_DEFAULT,
+  sarif: false,
+  source: '',
+};
+export async function analyzeFolders(options: FolderOptions): Promise<IFileBundle> {
+  const analysisOptions: AnalyzeFoldersOptions = { ...analyzeFolderDefaults, ...options };
+  const {
+    baseURL,
+    sessionToken,
+    includeLint,
+    severity,
+    paths,
+    symlinksEnabled,
+    maxPayload,
+    defaultFileIgnores,
+    sarif,
+    source,
+  } = analysisOptions;
 
-export async function analyzeFolders(
-  baseURL = defaultBaseURL,
-  sessionToken = '',
-  includeLint = false,
-  severity = AnalysisSeverity.info,
-  paths: string[],
-  symlinksEnabled = false,
-  maxPayload = MAX_PAYLOAD,
-  defaultFileIgnores = IGNORES_DEFAULT,
-  sarif = false,
-): Promise<IFileBundle> {
   // Get supported filters and test baseURL for correctness and availability
   emitter.supportedFilesLoaded(null);
-  const resp = await getFilters(baseURL);
+  const resp = await getFilters(baseURL, source);
   if (resp.type === 'error') {
     throw resp.error;
   }
@@ -249,7 +275,7 @@ export async function analyzeFolders(
 
   // Create remote bundle
   const remoteBundle = bundleFiles.length
-    ? await remoteBundleFactory(baseURL, sessionToken, bundleFiles, [], baseDir, null, maxPayload)
+    ? await remoteBundleFactory(baseURL, sessionToken, bundleFiles, [], baseDir, null, maxPayload, source)
     : null;
 
   // Analyze bundle
@@ -271,11 +297,12 @@ export async function analyzeFolders(
     };
   } else {
     analysisData = await analyzeBundle({
-      baseURL,
-      sessionToken,
-      includeLint,
-      severity,
+      baseURL: baseURL,
+      sessionToken: sessionToken,
+      includeLint: includeLint!,
+      severity: severity!,
       bundleId: remoteBundle.bundleId,
+      source,
     });
     analysisData.analysisResults.files = normalizeResultFiles(analysisData.analysisResults.files, baseDir);
   }
@@ -303,6 +330,7 @@ export async function extendAnalysis(
   bundle: IFileBundle,
   filePaths: string[],
   maxPayload = MAX_PAYLOAD,
+  source: string,
 ): Promise<IFileBundle | null> {
   const { files, removedFiles } = await prepareExtendingBundle(
     bundle.baseDir,
@@ -326,6 +354,7 @@ export async function extendAnalysis(
     bundle.baseDir,
     bundle.bundleId,
     maxPayload,
+    source,
   );
 
   if (remoteBundle === null) {
@@ -341,6 +370,7 @@ export async function extendAnalysis(
     severity: bundle.severity,
     bundleId: remoteBundle.bundleId,
     limitToFiles: files.map(f => f.bundlePath),
+    source,
   });
   // Transform relative paths into absolute
   analysisData.analysisResults.files = normalizeResultFiles(analysisData.analysisResults.files, bundle.baseDir);
@@ -353,22 +383,30 @@ export async function extendAnalysis(
   );
 }
 
-export async function analyzeGit(
-  baseURL = defaultBaseURL,
-  sessionToken = '',
-  includeLint = false,
-  severity = AnalysisSeverity.info,
-  gitUri: string,
-  sarif = false,
-  oAuthToken?: string,
-  username?: string,
-): Promise<IGitBundle> {
-  const bundleResponse = await createGitBundle({ baseURL, sessionToken, oAuthToken, username, gitUri });
+const analyzeGitDefaults = {
+  baseURL: defaultBaseURL,
+  sessionToken: '',
+  includeLint: false,
+  severity: AnalysisSeverity.info,
+  sarif: false,
+  source: '',
+};
+
+export async function analyzeGit(options: GitOptions): Promise<IGitBundle> {
+  const analysisOptions: AnalyzeGitOptions = { ...analyzeGitDefaults, ...options };
+  const { baseURL, sessionToken, oAuthToken, username, includeLint, severity, gitUri, sarif, source } = analysisOptions;
+  const bundleResponse = await createGitBundle({
+    baseURL,
+    sessionToken,
+    oAuthToken,
+    username,
+    gitUri,
+    source,
+  });
   if (bundleResponse.type === 'error') {
     throw bundleResponse.error;
   }
   const { bundleId } = bundleResponse.value;
-
   const analysisData = await analyzeBundle({
     baseURL,
     sessionToken,
@@ -377,6 +415,7 @@ export async function analyzeGit(
     includeLint,
     severity,
     bundleId,
+    source,
   });
 
   const result = {