@snyk/composer-lockfile-parser - npm Package Compare versions

Comparing version 1.0.3 to 1.1.0

dist/index.d.ts

 import { ComposerJsonFile, ComposerLockFile, ComposerParserResponse, SystemPackages } from './types';
-declare function buildDepTree(lockFileContent: string, manifestFileContent: string, defaultProjectName: string, systemVersions: SystemPackages): ComposerParserResponse;
-declare function buildDepTreeFromFiles(basePath: string, lockFileName: string, systemVersions: SystemPackages): ComposerParserResponse;
+declare function buildDepTree(lockFileContent: string, manifestFileContent: string, defaultProjectName: string, systemVersions: SystemPackages, includeDev?: boolean): ComposerParserResponse;
+declare function buildDepTreeFromFiles(basePath: string, lockFileName: string, systemVersions: SystemPackages, includeDev?: boolean): ComposerParserResponse;
 export { buildDepTree, buildDepTreeFromFiles, SystemPackages, ComposerJsonFile, ComposerLockFile, ComposerParserResponse, };

dist/index.js

@@ -8,3 +8,4 @@ "use strict";
 var composer_parser_1 = require("./parsers/composer-parser");
-function buildDepTree(lockFileContent, manifestFileContent, defaultProjectName, systemVersions) {
+function buildDepTree(lockFileContent, manifestFileContent, defaultProjectName, systemVersions, includeDev) {
+    if (includeDev === void 0) { includeDev = false; }
     var lockFileJson = file_parser_1.FileParser.parseLockFile(lockFileContent);
@@ -15,13 +16,16 @@ var manifestJson = file_parser_1.FileParser.parseManifestFile(manifestFileContent);
     }
-    var applicationName = manifestJson.name || defaultProjectName;
-    var applicationVersion = composer_parser_1.ComposerParser.getVersion(manifestJson) || '0.0.0';
+    var name = manifestJson.name || defaultProjectName;
+    var version = composer_parser_1.ComposerParser.getVersion(manifestJson) || '0.0.0';
+    var dependencies = composer_parser_1.ComposerParser.buildDependencies(manifestJson, lockFileJson.packages, manifestJson, [name + "@" + version], systemVersions, includeDev);
     return {
-        name: applicationName,
-        version: applicationVersion,
+        name: name,
+        version: version,
+        dependencies: dependencies,
         packageFormatVersion: 'composer:0.0.1',
-        dependencies: composer_parser_1.ComposerParser.buildDependencies(manifestJson, lockFileJson.packages, manifestJson, [applicationName + "@" + applicationVersion], systemVersions),
+        hasDevDependencies: includeDev,
     };
 }
 exports.buildDepTree = buildDepTree;
-function buildDepTreeFromFiles(basePath, lockFileName, systemVersions) {
+function buildDepTreeFromFiles(basePath, lockFileName, systemVersions, includeDev) {
+    if (includeDev === void 0) { includeDev = false; }
     if (!basePath) {
@@ -47,3 +51,3 @@ throw new errors_1.InvalidUserInputError('Missing `basePath` parameter for buildDepTreeFromFiles()');
     var defaultProjectName = getDefaultProjectName(basePath, lockFileName);
-    return buildDepTree(lockFileContent, manifestFileContent, defaultProjectName, systemVersions);
+    return buildDepTree(lockFileContent, manifestFileContent, defaultProjectName, systemVersions, includeDev);
 }
@@ -50,0 +54,0 @@ exports.buildDepTreeFromFiles = buildDepTreeFromFiles;

dist/parsers/composer-parser.d.ts

@@ -5,4 +5,4 @@ import { DepTree, SystemPackages, PackageRefCount, LockFilePackage, ComposerJsonFile } from '../types';
     static getVersion(depObj: ComposerJsonFile | LockFilePackage): string;
-    static buildDependencies(composerJsonObj: ComposerJsonFile, composerLockObjPackages: LockFilePackage[], depObj: ComposerJsonFile | LockFilePackage, depRecursiveArray: string[], systemVersions: SystemPackages, packageReferencesCount?: PackageRefCount): DepTree | {};
+    static buildDependencies(composerJsonObj: ComposerJsonFile, composerLockObjPackages: LockFilePackage[], depObj: ComposerJsonFile | LockFilePackage, depRecursiveArray: string[], systemVersions: SystemPackages, includeDev?: boolean, packageReferencesCount?: PackageRefCount): DepTree | {};
     private static alreadyAddedDep;
 }

dist/parsers/composer-parser.js

@@ -20,3 +20,4 @@ "use strict";
     };
-    ComposerParser.buildDependencies = function (composerJsonObj, composerLockObjPackages, depObj, depRecursiveArray, systemVersions, packageReferencesCount) {
+    ComposerParser.buildDependencies = function (composerJsonObj, composerLockObjPackages, depObj, depRecursiveArray, systemVersions, includeDev, packageReferencesCount) {
+        if (includeDev === void 0) { includeDev = false; }
         if (packageReferencesCount === void 0) { packageReferencesCount = {}; }
@@ -55,3 +56,3 @@ var requires = _.get(depObj, 'require', undefined);
                 result[depName].dependencies =
-                    ComposerParser.buildDependencies(composerJsonObj, composerLockObjPackages, _.find(composerLockObjPackages, { name: depName }), depRecursiveArray, systemVersions, packageReferencesCount);
+                    ComposerParser.buildDependencies(composerJsonObj, composerLockObjPackages, _.find(composerLockObjPackages, { name: depName }), depRecursiveArray, systemVersions, includeDev, packageReferencesCount);
                 depRecursiveArray.pop();
@@ -58,0 +59,0 @@ }

dist/types/index.d.ts

@@ -9,2 +9,3 @@ /**
     require: ComposerDependencies;
+    'require-dev'?: ComposerDependencies;
 }
@@ -21,2 +22,3 @@ export interface ComposerExtras {
     packages: LockFilePackage[];
+    'packages-dev'?: LockFileDependencies[];
 }
@@ -30,2 +32,3 @@ /**
     require: LockFileDependencies;
+    'require-dev'?: LockFileDependencies;
 }
@@ -42,3 +45,10 @@ export interface LockFileDependencies {
     dependencies: DepTreeDependencies;
+    labels?: {
+        scope?: Scope;
+    };
 }
+export declare enum Scope {
+    prod = "prod",
+    dev = "dev"
+}
 export declare type DepTreeDependencies = DepTree | {};
@@ -62,2 +72,3 @@ /**
     dependencies: DepTreeDependencies;
+    hasDevDependencies: boolean;
 }

dist/types/index.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+var Scope;
+(function (Scope) {
+    Scope["prod"] = "prod";
+    Scope["dev"] = "dev";
+})(Scope = exports.Scope || (exports.Scope = {}));
 //# sourceMappingURL=index.js.map

lib/index.ts

@@ -13,3 +13,4 @@ import * as fs from 'fs';
   defaultProjectName: string,
-  systemVersions: SystemPackages): ComposerParserResponse {
+  systemVersions: SystemPackages,
+  includeDev = false): ComposerParserResponse {
 
@@ -23,11 +24,19 @@ const lockFileJson: ComposerLockFile = FileParser.parseLockFile(lockFileContent);
 
-  const applicationName: string = manifestJson.name || defaultProjectName;
-  const applicationVersion: string = ComposerParser.getVersion(manifestJson) || '0.0.0';
+  const name: string = manifestJson.name || defaultProjectName;
+  const version: string = ComposerParser.getVersion(manifestJson) || '0.0.0';
+  const dependencies = ComposerParser.buildDependencies(
+    manifestJson,
+    lockFileJson.packages,
+    manifestJson,
+    [`${name}@${version}`],
+    systemVersions,
+    includeDev,
+  );
 
   return {
-    name: applicationName,
-    version: applicationVersion,
+    name,
+    version,
+    dependencies,
     packageFormatVersion: 'composer:0.0.1',
-    dependencies: ComposerParser.buildDependencies(manifestJson, lockFileJson.packages, manifestJson,
-      [`${applicationName}@${applicationVersion}`], systemVersions),
+    hasDevDependencies: includeDev,
   };
@@ -39,3 +48,4 @@ }
   lockFileName: string,
-  systemVersions: SystemPackages): ComposerParserResponse {
+  systemVersions: SystemPackages,
+  includeDev = false): ComposerParserResponse {
   if (!basePath) {
@@ -69,3 +79,3 @@ throw new InvalidUserInputError('Missing `basePath` parameter for buildDepTreeFromFiles()');
 
-  return buildDepTree(lockFileContent, manifestFileContent, defaultProjectName, systemVersions);
+  return buildDepTree(lockFileContent, manifestFileContent, defaultProjectName, systemVersions, includeDev);
 }
@@ -72,0 +82,0 @@

lib/parsers/composer-parser.ts

@@ -40,2 +40,3 @@ import * as _ from 'lodash';
     systemVersions: SystemPackages,
+    includeDev = false,
     packageReferencesCount: PackageRefCount = {}): DepTree | {} {
@@ -85,2 +86,3 @@ const requires: ComposerDependencies | undefined = _.get(depObj, 'require', undefined);
             systemVersions,
+            includeDev,
             packageReferencesCount);
@@ -87,0 +89,0 @@ depRecursiveArray.pop();

lib/types/index.ts

@@ -9,2 +9,3 @@ /**
   require: ComposerDependencies;
+  'require-dev'?: ComposerDependencies;
 }
@@ -24,2 +25,3 @@
   packages: LockFilePackage[];
+  'packages-dev'?: LockFileDependencies[];
 }
@@ -34,2 +36,3 @@
   require: LockFileDependencies;
+  'require-dev'?: LockFileDependencies;
 }
@@ -48,4 +51,12 @@
   dependencies: DepTreeDependencies;
+  labels?: {
+     scope?: Scope;
+  };
 }
 
+export enum Scope {
+  prod = 'prod',
+  dev = 'dev',
+}
+
 export type DepTreeDependencies = DepTree | {};
@@ -72,2 +83,3 @@
   dependencies: DepTreeDependencies;
+  hasDevDependencies: boolean;
 }

package.json

@@ -39,3 +39,4 @@ {
     "@types/node": "6.14.6",
-    "sync-request": "6.1.0",
+    "@types/node-fetch": "^2.5.2",
+    "node-fetch": "^2.6.0",
     "tap": "12.7.0",
@@ -45,3 +46,3 @@ "tslint": "5.17.0",
   },
-  "version": "1.0.3"
+  "version": "1.1.0"
 }

test/fixtures/many_deps_php_project/composer_deps.json

@@ -5,2 +5,3 @@ {
   "packageFormatVersion": "composer:0.0.1",
+  "hasDevDependencies": false,
   "dependencies": {
@@ -7,0 +8,0 @@ "php": {

test/fixtures/no_branch_alias/composer_deps.json

@@ -5,2 +5,3 @@ {
   "packageFormatVersion": "composer:0.0.1",
+  "hasDevDependencies": false,
   "dependencies": {
@@ -7,0 +8,0 @@ "php": {

test/fixtures/proj_with_aliases_external_github/composer_deps.json

@@ -5,2 +5,3 @@ {
   "packageFormatVersion": "composer:0.0.1",
+  "hasDevDependencies": false,
   "dependencies": {
@@ -7,0 +8,0 @@ "php": {

test/fixtures/proj_with_aliases/composer_deps.json

@@ -5,2 +5,3 @@ {
   "packageFormatVersion": "composer:0.0.1",
+  "hasDevDependencies": false,
   "dependencies": {
@@ -7,0 +8,0 @@ "php": {

test/fixtures/proj_with_no_deps/composer_deps.json

@@ -5,2 +5,3 @@ {
   "packageFormatVersion": "composer:0.0.1",
+  "hasDevDependencies": false,
   "dependencies": {
@@ -7,0 +8,0 @@ "php": {

test/fixtures/vulnerable_project/composer_deps.json

@@ -5,2 +5,3 @@ {
   "packageFormatVersion": "composer:0.0.1",
+  "hasDevDependencies": false,
   "dependencies": {
@@ -7,0 +8,0 @@ "php": {

test/inspect.test.ts

@@ -5,3 +5,3 @@ import * as fs from 'fs';
 import * as path from 'path';
-import request from 'sync-request';
+import fetch from 'node-fetch';
 
@@ -41,2 +41,16 @@ import { buildDepTreeFromFiles } from '../lib';
 
+tap.test('dev dependencies are not parsed by default', async (t) => {
+  const projFolder = './test/fixtures/proj_with_dev_deps';
+  try {
+    const depTree = buildDepTreeFromFiles(projFolder, './composer.lock', systemVersionsStub);
+    t.test('match packages with expected', (test) => {
+      const expTree = JSON.parse(fs.readFileSync(path.resolve(projFolder, 'composer_deps.json'), 'utf-8'));
+      test.deepEqual(depTree, expTree);
+      test.end();
+    });
+  } catch (err) {
+    t.fail('Unexpected error', err);
+  }
+});
+
 tap.test('missing function `basePath` param', async (t) => {
@@ -148,2 +162,3 @@ try {
         packageFormatVersion: 'composer:0.0.1',
+        hasDevDependencies: false,
       }, 'root pkg');
@@ -168,2 +183,3 @@
         packageFormatVersion: 'composer:0.0.1',
+        hasDevDependencies: false,
       }, 'root pkg');
@@ -219,3 +235,3 @@
     try {
-      const res = request('GET', apiBranchesUrl, {
+      const res = await fetch(apiBranchesUrl, {
         headers: {
@@ -225,3 +241,3 @@ 'user-agent': 'CI Testing',
       });
-      branchesData = JSON.parse(res.getBody().toString());
+      branchesData = await res.json();
     } catch (error) {
@@ -228,0 +244,0 @@ branchesData = [

No alert changes

Improved metrics

Total package byte prevSize

840198

increased by7.27%

Number of package files

81

increased by3.85%

Lines of code

7640

increased by1.3%

Worsened metrics

Dev dependency count

7

increased by16.67%

No dependency changes