refactor: split utils (#209)

* refactor: split utils to multiple files #208

* Resolve test errors

Author: milapemi

index.js

@@ -10,7 +10,7 @@ import isMinified from "is-minified-code";
 import { SourceFile } from "./src/SourceFile.js";
 import { SourceParser } from "./src/SourceParser.js";
 import { warnings } from "./src/warnings.js";
-import { isOneLineExpressionExport } from "./src/utils.js";
+import { isOneLineExpressionExport } from "./src/utils/index.js";
 
 export function runASTAnalysis(
   str,

src/SourceFile.js

@@ -3,7 +3,7 @@ import { Utils, Literal } from "@nodesecure/sec-literal";
 import { VariableTracer } from "@nodesecure/estree-ast-utils";
 
 // Import Internal Dependencies
-import { rootLocation, toArrayLocation } from "./utils.js";
+import { rootLocation, toArrayLocation } from "./utils/index.js";
 import { generateWarning } from "./warnings.js";
 import { isObfuscatedCode, hasTrojanSource } from "./obfuscators/index.js";
 import { ProbeRunner } from "./ProbeRunner.js";

src/obfuscators/jjencode.js

@@ -1,5 +1,5 @@
 // Require Internal Dependencies
-import { notNullOrUndefined } from "../utils.js";
+import { notNullOrUndefined } from "../utils/index.js";
 
 // CONSTANTS
 const kJJRegularSymbols = new Set(["$", "_"]);

src/probes/isArrayExpression.js

@@ -1,5 +1,5 @@
 // Import Internal Dependencies
-import { extractNode } from "../utils.js";
+import { extractNode } from "../utils/index.js";
 
 // CONSTANTS
 const kLiteralExtractor = extractNode("Literal");

src/probes/isClassDeclaration.js

@@ -1,5 +1,5 @@
 // Import Internal Dependencies
-import { extractNode } from "../utils.js";
+import { extractNode } from "../utils/index.js";
 
 // CONSTANTS
 const kIdExtractor = extractNode("Identifier");

src/probes/isFunction.js

@@ -1,5 +1,5 @@
 // Import Internal Dependencies
-import { extractNode } from "../utils.js";
+import { extractNode } from "../utils/index.js";
 
 // CONSTANTS
 const kIdExtractor = extractNode("Identifier");

src/probes/isMethodDefinition.js

@@ -1,5 +1,5 @@
 // Import Internal Dependencies
-import { extractNode } from "../utils.js";
+import { extractNode } from "../utils/index.js";
 
 // CONSTANTS
 const kIdExtractor = extractNode("Identifier");

src/probes/isUnsafeCallee.js

@@ -1,5 +1,5 @@
 // Import Internal Dependencies
-import { isUnsafeCallee } from "../utils.js";
+import { isUnsafeCallee } from "../utils/index.js";
 import { ProbeSignals } from "../ProbeRunner.js";
 
 /**

src/utils.js

@@ -0,0 +1,40 @@
+// Import Third-party Dependencies
+import {
+  getCallExpressionIdentifier
+} from "@nodesecure/estree-ast-utils";
+
+export function exportAssignmentHasRequireLeave(expr) {
+  if (expr.type === "LogicalExpression") {
+    return atLeastOneBranchHasRequireLeave(expr.left, expr.right);
+  }
+
+  if (expr.type === "ConditionalExpression") {
+    return atLeastOneBranchHasRequireLeave(expr.consequent, expr.alternate);
+  }
+
+  if (expr.type === "CallExpression") {
+    return getCallExpressionIdentifier(expr) === "require";
+  }
+
+  if (expr.type === "MemberExpression") {
+    let rootMember = expr.object;
+    while (rootMember.type === "MemberExpression") {
+      rootMember = rootMember.object;
+    }
+
+    if (rootMember.type !== "CallExpression") {
+      return false;
+    }
+
+    return getCallExpressionIdentifier(rootMember) === "require";
+  }
+
+  return false;
+}
+
+function atLeastOneBranchHasRequireLeave(left, right) {
+  return [
+    exportAssignmentHasRequireLeave(left),
+    exportAssignmentHasRequireLeave(right)
+  ].some((hasRequire) => hasRequire);
+}

src/utils/exportAssignmentHasRequireLeave.js

@@ -0,0 +1,14 @@
+// Import Internal Dependencies
+import { notNullOrUndefined } from "./notNullOrUndefined.js";
+
+export function extractNode(expectedType) {
+  return (callback, nodes) => {
+    const finalNodes = Array.isArray(nodes) ? nodes : [nodes];
+
+    for (const node of finalNodes) {
+      if (notNullOrUndefined(node) && node.type === expectedType) {
+        callback(node);
+      }
+    }
+  };
+}

src/utils/extractNode.js

@@ -0,0 +1,7 @@
+export * from "./exportAssignmentHasRequireLeave.js";
+export * from "./extractNode.js";
+export * from "./isOneLineExpressionExport.js";
+export * from "./isUnsafeCallee.js";
+export * from "./notNullOrUndefined.js";
+export * from "./rootLocation.js";
+export * from "./toArrayLocation.js";

src/utils/index.js

@@ -0,0 +1,18 @@
+// Import Internal Dependencies
+import { exportAssignmentHasRequireLeave } from "./exportAssignmentHasRequireLeave.js";
+
+export function isOneLineExpressionExport(body) {
+  if (body.length > 1) {
+    return false;
+  }
+
+  if (body[0].type !== "ExpressionStatement") {
+    return false;
+  }
+
+  if (body[0].expression.type !== "AssignmentExpression") {
+    return false;
+  }
+
+  return exportAssignmentHasRequireLeave(body[0].expression.right);
+}

src/utils/isOneLineExpressionExport.js

@@ -0,0 +1,28 @@
+// Import Third-party Dependencies
+import { getCallExpressionIdentifier } from "@nodesecure/estree-ast-utils";
+
+function isEvalCallee(node) {
+  const identifier = getCallExpressionIdentifier(node, {
+    resolveCallExpression: false
+  });
+
+  return identifier === "eval";
+}
+
+function isFunctionCallee(node) {
+  const identifier = getCallExpressionIdentifier(node);
+
+  return identifier === "Function" && node.callee.type === "CallExpression";
+}
+
+export function isUnsafeCallee(node) {
+  if (isEvalCallee(node)) {
+    return [true, "eval"];
+  }
+
+  if (isFunctionCallee(node)) {
+    return [true, "Function"];
+  }
+
+  return [false, null];
+}

src/utils/isUnsafeCallee.js

@@ -0,0 +1,3 @@
+export function notNullOrUndefined(value) {
+  return value !== null && value !== void 0;
+}

src/utils/notNullOrUndefined.js

@@ -0,0 +1,3 @@
+export function rootLocation() {
+  return { start: { line: 0, column: 0 }, end: { line: 0, column: 0 } };
+}

src/utils/rootLocation.js

@@ -0,0 +1,11 @@
+// Import Internal Dependencies
+import { rootLocation } from "./rootLocation.js";
+
+export function toArrayLocation(location = rootLocation()) {
+  const { start, end = start } = location;
+
+  return [
+    [start.line || 0, start.column || 0],
+    [end.line || 0, end.column || 0]
+  ];
+}

src/utils/toArrayLocation.js

@@ -1,5 +1,5 @@
 // Import Internal Dependencies
-import * as utils from "./utils.js";
+import * as utils from "./utils/index.js";
 
 export const warnings = Object.freeze({
   "parsing-error": {

src/warnings.js

@@ -3,7 +3,7 @@ import { test } from "node:test";
 import assert from "node:assert";
 
 // Import Internal Dependencies
-import { rootLocation } from "../src/utils.js";
+import { rootLocation } from "../src/utils/index.js";
 import { generateWarning } from "../src/warnings.js";
 
 test("Given an encoded-literal kind it should generate a warning with deep location array", () => {