Merge pull request #71 from snyk/chore/osm-2746-improve-maintainability

feat: [OSM-2746] improve maintainability

Author: nico-incubiq

.circleci/config.yml

@@ -20,12 +20,12 @@ windows_defaults: &windows_defaults
 test_matrix_unix: &test_matrix_unix
   matrix:
     parameters:
-      node_version: [ '16.18', '18.18', '20.9' ]
+      node_version: [ '18.18', '20.9', '22.0' ]
 
 test_matrix_win: &test_matrix_win
   matrix:
     parameters:
-      node_version: [ '16', '18', '20' ]
+      node_version: [ '18', '20', '22' ]
 
 commands:
   install_deps:

.eslintrc.json

@@ -0,0 +1,6 @@
+{
+  "arrowParens": "always",
+  "trailingComma": "all",
+  "singleQuote": true,
+  "htmlWhitespaceSensitivity": "ignore"
+}

.prettierrc.json

@@ -0,0 +1,33 @@
+import eslint from '@eslint/js';
+import stylisticTs from '@stylistic/eslint-plugin-ts'
+import tseslint from 'typescript-eslint';
+
+export default tseslint.config({
+    files: ['**/*.ts'],
+    extends: [
+        eslint.configs.recommended,
+        tseslint.configs.recommended,
+    ],
+    languageOptions: {
+        parserOptions: {
+            parser: '@typescript-eslint/parser',
+            project: "./tsconfig.json"
+        },
+    },
+    plugins: {
+        '@stylistic/ts': stylisticTs,
+        '@typescript-eslint': tseslint.plugin,
+    },
+    rules: {
+        "indent": "off",
+        "@stylistic/ts/indent": ["error", 2],
+        "@typescript-eslint/await-thenable": 2,
+        "@typescript-eslint/ban-ts-comment": 2,
+        "@typescript-eslint/explicit-function-return-type": 0,
+        "@typescript-eslint/no-explicit-any": 0,
+        "@typescript-eslint/no-require-imports": 2,
+        "@typescript-eslint/no-unnecessary-type-assertion": 2,
+        "@typescript-eslint/promise-function-async": 2,
+        "@typescript-eslint/unbound-method": 2
+    },
+});

eslint.config.mjs

@@ -0,0 +1,7 @@
+/** @type {import('ts-jest').JestConfigWithTsJest} **/
+module.exports = {
+  testEnvironment: "node",
+  transform: {
+    "^.+\.tsx?$": ["ts-jest",{}],
+  },
+};

jest.config.js

@@ -1,34 +1,65 @@
 import * as path from 'path';
 import * as childProcess from 'child_process';
 
-export const composerVersionCmd = {command: 'composer', args: ['--version']};
-export const composerShowCmd = {command: 'composer', args: ['show', '-p']};
-export const pharVersionCmd = {
-  command: `php`,
-  args: [`${path.resolve(path.resolve() + '/composer.phar')}`, '--version']
+type Command = {
+  command: string;
+  args: string[];
 };
-export const pharShowCmd = {
-  command: `php`,
-  args: [`${path.resolve(path.resolve() + '/composer.phar')}`, 'show', '-p', '--format=json']
+
+function versionCmd(this: Command): Command {
+  return {
+    command: this.command,
+    args: [...this.args, '--version'],
+  };
+}
+
+function listPlatformDepsCmd(this: Command): Command {
+  return {
+    command: this.command,
+    args: [...this.args, 'show', '-p', '--format=json'],
+  };
+}
+
+export const globalComposer = {
+  command: 'composer',
+  args: [],
+  version: versionCmd,
+  listPlatformDeps: listPlatformDepsCmd,
+};
+export const localComposer = {
+  command: 'php',
+  args: [`${path.resolve(path.resolve() + '/composer.phar')}`],
+  version: versionCmd,
+  listPlatformDeps: listPlatformDepsCmd,
 };
 
 function cleanUpComposerWarnings(composerOutput: string): string {
-  // Remove all lines preceding the JSON data; including Deprecation messages and blank lines.
+  // Remove all lines preceding the JSON data; including "Deprecated" messages and blank lines.
   const lines = composerOutput.split('\n');
-  const jsonStartIndex = lines.findIndex((line) => line.length > 0 && !line.startsWith('Deprecated:'));
+  const jsonStartIndex = lines.findIndex((line) => line.startsWith('{'));
 
   return lines.slice(jsonStartIndex).join('\n');
 }
 
-export function cmdReturnsOk(cmd: string, args: string[] = []): boolean {
-  const spawnOptions: childProcess.SpawnOptions = {shell: false};
-  return !!cmd && childProcess.spawnSync(cmd, args, spawnOptions).status === 0;
+export function cmdReturnsOk(cmd: Command): boolean {
+  const spawnOptions: childProcess.SpawnOptions = { shell: false };
+  return (
+    !!cmd &&
+    childProcess.spawnSync(cmd.command, cmd.args, spawnOptions).status === 0
+  );
 }
 
 // run a cmd in a specific folder and it's result should be there
-export function execWithResult(cmd: string, basePath: string, args: string[] = []): string {
-  const spawnOptions: childProcess.SpawnOptions = {cwd: basePath, shell: false}
-  const execResult = childProcess.spawnSync(cmd, args, spawnOptions);
+export function execWithResult(cmd: Command, basePath: string): string {
+  const spawnOptions: childProcess.SpawnOptions = {
+    cwd: basePath,
+    shell: false,
+  };
+  const execResult = childProcess.spawnSync(
+    cmd.command,
+    cmd.args,
+    spawnOptions,
+  );
 
   // Throw the whole Result object in case of error, similarly to `execSync`.
   if (execResult.status !== 0) {

lib/composer-cmds.ts

@@ -5,9 +5,18 @@ import { PhpPluginResult, PhpOptions } from './types';
 
 const PLUGIN_NAME = 'snyk-php-plugin';
 
-export async function inspect(basePath: string, fileName: string, options: PhpOptions = {}): Promise<PhpPluginResult> {
+export async function inspect(
+  basePath: string,
+  fileName: string,
+  options: PhpOptions = {},
+): Promise<PhpPluginResult> {
   const systemVersions = systemDeps(basePath, options);
-  const depsTree = composerLockFileParser.buildDepTreeFromFiles(basePath, fileName, systemVersions, options.dev);
+  const depsTree = composerLockFileParser.buildDepTreeFromFiles(
+    basePath,
+    fileName,
+    systemVersions,
+    options.dev,
+  );
 
   return Promise.resolve({
     package: depsTree,

lib/index.ts

@@ -1,37 +1,33 @@
-import * as os from 'os';
 import { SystemPackages } from '@snyk/composer-lockfile-parser';
 
 import * as cmds from './composer-cmds';
 import { PhpOptions } from './types';
 
-function isSet(variable): boolean {
-  return typeof variable !== 'undefined';
-}
-
-export function systemDeps(basePath: string, options: PhpOptions): SystemPackages {
-  const composerOk = isSet(options.composerIsFine) ?
-    options.composerIsFine : cmds.cmdReturnsOk(cmds.composerVersionCmd.command, cmds.composerVersionCmd.args);
-  const composerPharOk = isSet(options.composerPharIsFine) ?
-    options.composerPharIsFine : cmds.cmdReturnsOk(cmds.pharVersionCmd.command, cmds.pharVersionCmd.args);
+export function systemDeps(
+  basePath: string,
+  options: PhpOptions,
+): SystemPackages {
+  const composerOk =
+    options.composerIsFine ?? cmds.cmdReturnsOk(cmds.globalComposer.version());
+  const composerPharOk =
+    options.composerPharIsFine ??
+    cmds.cmdReturnsOk(cmds.localComposer.version());
 
   let finalVersionsObj = {};
 
-  if (options.systemVersions && (Object.keys(options.systemVersions).length > 0)) {
+  if (
+    options.systemVersions &&
+    Object.keys(options.systemVersions).length > 0
+  ) {
     // give first preference to a stub
     finalVersionsObj = options.systemVersions;
-  } else if (composerOk) {
-    const lines = cmds.execWithResult(cmds.composerShowCmd.command, basePath, cmds.composerShowCmd.args).split(os.EOL);
-    lines.forEach((line) => {
-      const [part1, part2] = line.split(/\s+/);
-      if (part2) {
-        finalVersionsObj[part1] = part2;
-      }
-    });
-  } else if (composerPharOk) {
-    const output = cmds.execWithResult(cmds.pharShowCmd.command, basePath, cmds.pharShowCmd.args);
+  } else if (composerOk || composerPharOk) {
+    const composer = composerOk ? cmds.globalComposer : cmds.localComposer;
+
+    const output = cmds.execWithResult(composer.listPlatformDeps(), basePath);
     const versionsObj = JSON.parse(output).platform;
 
-    versionsObj.forEach(({name, version}) => {
+    versionsObj.forEach(({ name, version }) => {
       finalVersionsObj[name] = version;
     });
   } else {

lib/system-deps.ts

@@ -5,11 +5,14 @@
   "scripts": {
     "build": "tsc",
     "build-watch": "tsc -w",
-    "lint": "eslint {lib,test}/**/*.ts",
+    "lint": "npm run lint:js && npm run lint:format",
+    "lint:js": "eslint {lib,test}/**/*.ts",
+    "lint:format": "prettier --check '{lib,test}/**/*.ts'",
+    "format": "prettier --write '{lib,test}/**/*.ts'",
     "prepare": "npm run build",
     "semantic-release": "semantic-release",
     "test": "npm run lint && npm run unit-test",
-    "unit-test": "tap -Rspec test/*.test.ts --timeout=300"
+    "unit-test": "jest --testTimeout=500"
   },
   "files": [
     "dist",
@@ -23,21 +26,23 @@
   "author": "Snyk <https://snyk.io>",
   "license": "Apache-2.0",
   "engines": {
-    "node": ">=8"
+    "node": ">=18"
   },
   "dependencies": {
     "@snyk/cli-interface": "^2.9.1",
     "@snyk/composer-lockfile-parser": "^1.4.1",
     "@snyk/dep-graph": "^1.22.0",
-    "tslib": "1.14.1"
+    "tslib": "^2.8.1"
   },
   "devDependencies": {
-    "@types/node": "6.14.6",
-    "@typescript-eslint/eslint-plugin": "1.10.2",
-    "@typescript-eslint/parser": "1.10.2",
-    "eslint": "5.16.0",
-    "sync-request": "3.0.1",
-    "tap": "12.7.0",
-    "typescript": "3.8.3"
+    "@stylistic/eslint-plugin-ts": "^4.2.0",
+    "@types/node": "^22.15.2",
+    "@typescript-eslint/parser": "^8.31.0",
+    "eslint": "9.25.1",
+    "eslint-config-prettier": "^10.1.2",
+    "prettier": "^3.5.3",
+    "ts-jest": "^29.3.2",
+    "typescript": "5.8.3",
+    "typescript-eslint": "^8.31.0"
   }
 }