@flisk/analyze-tracking 0.8.1 → 0.8.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flisk/analyze-tracking",
-  "version": "0.8.1",
+  "version": "0.8.3",
   "description": "Analyzes tracking code in a project and generates data schemas",
   "main": "src/index.js",
   "bin": {

package/src/analyze/index.js

@@ -4,7 +4,7 @@
  */
 
 const path = require('path');
-const ts = require('typescript');
+
 const { parseCustomFunctionSignature } = require('./utils/customFunctionParser');
 const { getAllFiles } = require('../utils/fileProcessor');
 const { analyzeJsFile } = require('./javascript');
@@ -19,11 +19,6 @@ async function analyzeDirectory(dirPath, customFunctions) {
   const customFunctionSignatures = (customFunctions && customFunctions?.length > 0) ? customFunctions.map(parseCustomFunctionSignature) : null;
 
   const files = getAllFiles(dirPath);
-  const tsFiles = files.filter(file => /\.(tsx?)$/.test(file));
-  const tsProgram = ts.createProgram(tsFiles, {
-    target: ts.ScriptTarget.ESNext,
-    module: ts.ModuleKind.CommonJS,
-  });
 
   for (const file of files) {
     let events = [];
@@ -37,7 +32,8 @@ async function analyzeDirectory(dirPath, customFunctions) {
     if (isJsFile) {
       events = analyzeJsFile(file, customFunctionSignatures);
     } else if (isTsFile) {
-      events = analyzeTsFile(file, tsProgram, customFunctionSignatures);
+      // Pass null program so analyzeTsFile will create a per-file program using the file's nearest tsconfig.json
+      events = analyzeTsFile(file, null, customFunctionSignatures);
     } else if (isPythonFile) {
       events = await analyzePythonFile(file, customFunctionSignatures);
     } else if (isRubyFile) {

package/src/analyze/ruby/extractors.js

@@ -4,15 +4,17 @@
  */
 
 const { getValueType } = require('./types');
+const prismPromise = import('@ruby/prism');
 
 /**
  * Extracts the event name from a tracking call based on the source
  * @param {Object} node - The AST CallNode
  * @param {string} source - The detected analytics source
  * @param {Object} customConfig - Custom configuration for custom functions
+ * @param {Object} constantMap - Map of constants to resolve constant paths
  * @returns {string|null} - The extracted event name or null
  */
-function extractEventName(node, source, customConfig = null) {
+async function extractEventName(node, source, customConfig = null, constantMap = {}) {
   if (source === 'segment' || source === 'rudderstack') {
     // Both Segment and Rudderstack use the same format
     const params = node.arguments_?.arguments_?.[0]?.elements;
@@ -62,8 +64,33 @@ function extractEventName(node, source, customConfig = null) {
     }
 
     const eventArg = args[customConfig.eventIndex];
-    if (eventArg?.unescaped?.value) {
-      return eventArg.unescaped.value;
+    if (eventArg) {
+      // String literal
+      if (eventArg.unescaped?.value) {
+        return eventArg.unescaped.value;
+      }
+
+      // Constant references
+      const { ConstantReadNode, ConstantPathNode } = await prismPromise;
+      const buildConstPath = (n) => {
+        if (!n) return '';
+        if (n instanceof ConstantReadNode) return n.name;
+        if (n instanceof ConstantPathNode) {
+          const parent = buildConstPath(n.parent);
+          return parent ? `${parent}::${n.name}` : n.name;
+        }
+        return '';
+      };
+
+      if (eventArg instanceof ConstantReadNode) {
+        const name = eventArg.name;
+        // Try to resolve with current constant map, else return name
+        return constantMap[name] || name;
+      }
+      if (eventArg instanceof ConstantPathNode) {
+        const pathStr = buildConstPath(eventArg);
+        return constantMap[pathStr] || pathStr;
+      }
     }
     return null;
   }
@@ -79,7 +106,7 @@ function extractEventName(node, source, customConfig = null) {
  * @returns {Object|null} - The extracted properties or null
  */
 async function extractProperties(node, source, customConfig = null) {
-  const { HashNode, ArrayNode } = await import('@ruby/prism');
+  const { HashNode, ArrayNode } = await prismPromise;
 
   if (source === 'segment' || source === 'rudderstack') {
     // Both Segment and Rudderstack use the same format
@@ -235,7 +262,7 @@ async function extractProperties(node, source, customConfig = null) {
  * @returns {Object} - The extracted properties
  */
 async function extractHashProperties(hashNode) {
-  const { AssocNode, HashNode, ArrayNode } = await import('@ruby/prism');
+  const { AssocNode, HashNode, ArrayNode } = await prismPromise;
   const properties = {};
   
   for (const element of hashNode.elements) {
@@ -278,7 +305,7 @@ async function extractHashProperties(hashNode) {
  * @returns {Object} - Type information for array items
  */
 async function extractArrayItemProperties(arrayNode) {
-  const { HashNode } = await import('@ruby/prism');
+  const { HashNode } = await prismPromise;
 
   if (arrayNode.elements.length === 0) {
     return { type: 'any' };

package/src/analyze/ruby/index.js

@@ -4,11 +4,162 @@
  */
 
 const fs = require('fs');
+const path = require('path');
 const TrackingVisitor = require('./visitor');
 
 // Lazy-loaded parse function from Ruby Prism
 let parse = null;
 
+/**
+ * Extracts the string literal value from an AST node, ignoring a trailing `.freeze` call.
+ * Supports:
+ *   - StringNode
+ *   - CallNode with receiver StringNode and method `freeze`
+ *
+ * @param {import('@ruby/prism').PrismNode} node
+ * @returns {string|null}
+ */
+async function extractStringLiteral(node) {
+  if (!node) return null;
+
+  const {
+    StringNode,
+    CallNode
+  } = await import('@ruby/prism');
+
+  if (node instanceof StringNode) {
+    return node.unescaped?.value ?? null;
+  }
+
+  // Handle "_Section".freeze pattern
+  if (node instanceof CallNode && node.name === 'freeze' && node.receiver) {
+    return extractStringLiteral(node.receiver);
+  }
+
+  return null;
+}
+
+/**
+ * Recursively traverses an AST to collect constant assignments and build a map
+ * of fully-qualified constant names (e.g. "TelemetryHelper::FINISHED_SECTION")
+ * to their string literal values.
+ *
+ * @param {import('@ruby/prism').PrismNode} node - current AST node
+ * @param {string[]} namespaceStack - stack of module/class names
+ * @param {Object} constantMap - accumulator map of constant path -> string value
+ */
+async function collectConstants(node, namespaceStack, constantMap) {
+  if (!node) return;
+
+  const {
+    ModuleNode,
+    ClassNode,
+    StatementsNode,
+    ConstantWriteNode,
+    ConstantPathWriteNode,
+    ConstantPathNode
+  } = await import('@ruby/prism');
+
+  // Helper to build constant path from ConstantPathNode
+  const buildConstPath = (pathNode) => {
+    if (!pathNode) return '';
+    if (pathNode.type === 'ConstantReadNode') {
+      return pathNode.name;
+    }
+    if (pathNode.type === 'ConstantPathNode') {
+      const parent = buildConstPath(pathNode.parent);
+      return parent ? `${parent}::${pathNode.name}` : pathNode.name;
+    }
+    return '';
+  };
+
+  // Process constant assignments
+  if (node instanceof ConstantWriteNode) {
+    const fullName = [...namespaceStack, node.name].join('::');
+    const literal = await extractStringLiteral(node.value);
+    if (literal !== null) {
+      constantMap[fullName] = literal;
+    }
+  } else if (node instanceof ConstantPathWriteNode) {
+    const fullName = buildConstPath(node.target);
+    const literal = await extractStringLiteral(node.value);
+    if (fullName && literal !== null) {
+      constantMap[fullName] = literal;
+    }
+  }
+
+  // Recurse into children depending on node type
+  if (node instanceof ModuleNode || node instanceof ClassNode) {
+    // Enter namespace
+    const name = node.constantPath?.name || node.name; // ModuleNode has constantPath
+    const childNamespaceStack = name ? [...namespaceStack, name] : namespaceStack;
+
+    if (node.body) {
+      await collectConstants(node.body, childNamespaceStack, constantMap);
+    }
+    return;
+  }
+
+  // Generic traversal for other nodes
+  if (node instanceof StatementsNode) {
+    for (const child of node.body) {
+      await collectConstants(child, namespaceStack, constantMap);
+    }
+    return;
+  }
+
+  // Fallback: iterate over enumerable properties to find nested nodes
+  for (const key of Object.keys(node)) {
+    const val = node[key];
+    if (!val) continue;
+
+    const traverseChild = async (child) => {
+      if (child && typeof child === 'object' && (child.location || child.constructor?.name?.endsWith('Node'))) {
+        await collectConstants(child, namespaceStack, constantMap);
+      }
+    };
+
+    if (Array.isArray(val)) {
+      for (const c of val) {
+        await traverseChild(c);
+      }
+    } else {
+      await traverseChild(val);
+    }
+  }
+}
+
+/**
+ * Builds a map of constant names to their literal string values for all .rb
+ * files in the given directory. This is a best-effort resolver intended for
+ * test fixtures and small projects and is not a fully-fledged Ruby constant
+ * resolver.
+ *
+ * @param {string} directory
+ * @returns {Promise<Object<string,string>>}
+ */
+async function buildConstantMapForDirectory(directory) {
+  const constantMap = {};
+
+  if (!fs.existsSync(directory)) return constantMap;
+
+  const files = fs.readdirSync(directory).filter(f => f.endsWith('.rb'));
+
+  for (const file of files) {
+    const fullPath = path.join(directory, file);
+    try {
+      const content = fs.readFileSync(fullPath, 'utf8');
+      const ast = await parse(content);
+      await collectConstants(ast.value, [], constantMap);
+    } catch (err) {
+      // Ignore parse errors for unrelated files
+      continue;
+    }
+  }
+
+  return constantMap;
+}
+
 /**
  * Analyzes a Ruby file for analytics tracking calls
  * @param {string} filePath - Path to the Ruby file to analyze
@@ -27,6 +178,10 @@ async function analyzeRubyFile(filePath, customFunctionSignatures = null) {
     // Read the file content
     const code = fs.readFileSync(filePath, 'utf8');
 
+    // Build constant map for current directory (sibling .rb files)
+    const currentDir = path.dirname(filePath);
+    const constantMap = await buildConstantMapForDirectory(currentDir);
+
     // Parse the Ruby code into an AST once
     let ast;
     try {
@@ -36,8 +191,8 @@ async function analyzeRubyFile(filePath, customFunctionSignatures = null) {
       return [];
     }
 
-    // Single visitor pass covering all custom configs
-    const visitor = new TrackingVisitor(code, filePath, customFunctionSignatures || []);
+    // Single visitor pass covering all custom configs, with constant map for resolution
+    const visitor = new TrackingVisitor(code, filePath, customFunctionSignatures || [], constantMap);
     const events = await visitor.analyze(ast);
 
     // Deduplicate events

package/src/analyze/ruby/traversal.js

@@ -3,6 +3,10 @@
  * @module analyze/ruby/traversal
  */
 
+
+// Prevent infinite recursion in AST traversal
+const MAX_RECURSION_DEPTH = 20;
+
 /**
  * Finds the wrapping function for a given node
  * @param {Object} node - The current AST node
@@ -33,8 +37,9 @@ async function findWrappingFunction(node, ancestors) {
  * @param {Object} node - The current AST node
  * @param {Function} nodeVisitor - Function to call for each node
  * @param {Array} ancestors - The ancestor nodes stack
+ * @param {number} depth - Current recursion depth to prevent infinite loops
  */
-async function traverseNode(node, nodeVisitor, ancestors = []) {
+async function traverseNode(node, nodeVisitor, ancestors = [], depth = 0) {
   const { 
     ProgramNode, 
     StatementsNode, 
@@ -46,11 +51,23 @@ async function traverseNode(node, nodeVisitor, ancestors = []) {
     AssocNode, 
     ClassNode, 
     ModuleNode,
-    CallNode
+    CallNode,
+    CaseNode,
+    WhenNode
   } = await import('@ruby/prism');
 
   if (!node) return;
 
+  // Prevent infinite recursion with depth limit
+  if (depth > MAX_RECURSION_DEPTH) {
+    return;
+  }
+
+  // Check for circular references - if this node is already in ancestors, skip it
+  if (ancestors.includes(node)) {
+    return;
+  }
+
   ancestors.push(node);
 
   // Call the visitor for this node
@@ -60,45 +77,102 @@ async function traverseNode(node, nodeVisitor, ancestors = []) {
 
   // Visit all child nodes based on node type
   if (node instanceof ProgramNode) {
-    await traverseNode(node.statements, nodeVisitor, ancestors);
+    await traverseNode(node.statements, nodeVisitor, ancestors, depth + 1);
   } else if (node instanceof StatementsNode) {
     for (const child of node.body) {
-      await traverseNode(child, nodeVisitor, ancestors);
+      await traverseNode(child, nodeVisitor, ancestors, depth + 1);
     }
   } else if (node instanceof ClassNode) {
     if (node.body) {
-      await traverseNode(node.body, nodeVisitor, ancestors);
+      await traverseNode(node.body, nodeVisitor, ancestors, depth + 1);
     }
   } else if (node instanceof ModuleNode) {
     if (node.body) {
-      await traverseNode(node.body, nodeVisitor, ancestors);
+      await traverseNode(node.body, nodeVisitor, ancestors, depth + 1);
     }
   } else if (node instanceof DefNode) {
     if (node.body) {
-      await traverseNode(node.body, nodeVisitor, ancestors);
+      await traverseNode(node.body, nodeVisitor, ancestors, depth + 1);
     }
   } else if (node instanceof IfNode) {
     if (node.statements) {
-      await traverseNode(node.statements, nodeVisitor, ancestors);
+      await traverseNode(node.statements, nodeVisitor, ancestors, depth + 1);
     }
     if (node.subsequent) {
-      await traverseNode(node.subsequent, nodeVisitor, ancestors);
+      await traverseNode(node.subsequent, nodeVisitor, ancestors, depth + 1);
     }
   } else if (node instanceof BlockNode) {
     if (node.body) {
-      await traverseNode(node.body, nodeVisitor, ancestors);
+      await traverseNode(node.body, nodeVisitor, ancestors, depth + 1);
     }
   } else if (node instanceof ArgumentsNode) {
-    for (const arg of node.arguments) {
-      await traverseNode(arg, nodeVisitor, ancestors);
+    const argsList = node.arguments || [];
+    for (const arg of argsList) {
+      await traverseNode(arg, nodeVisitor, ancestors, depth + 1);
     }
   } else if (node instanceof HashNode) {
     for (const element of node.elements) {
-      await traverseNode(element, nodeVisitor, ancestors);
+      await traverseNode(element, nodeVisitor, ancestors, depth + 1);
     }
   } else if (node instanceof AssocNode) {
-    await traverseNode(node.key, nodeVisitor, ancestors);
-    await traverseNode(node.value, nodeVisitor, ancestors);
+    await traverseNode(node.key, nodeVisitor, ancestors, depth + 1);
+    await traverseNode(node.value, nodeVisitor, ancestors, depth + 1);
+  } else if (node instanceof CaseNode) {
+    // Traverse through each 'when' clause and the optional else clause
+    const whenClauses = node.whens || node.conditions || node.when_bodies || [];
+    for (const when of whenClauses) {
+      await traverseNode(when, nodeVisitor, ancestors, depth + 1);
+    }
+    if (node.else_) {
+      await traverseNode(node.else_, nodeVisitor, ancestors, depth + 1);
+    } else if (node.elseBody) {
+      await traverseNode(node.elseBody, nodeVisitor, ancestors, depth + 1);
+    }
+  } else if (node instanceof WhenNode) {
+    // Handle a single when clause: traverse its condition(s) and body
+    if (Array.isArray(node.conditions)) {
+      for (const cond of node.conditions) {
+        await traverseNode(cond, nodeVisitor, ancestors, depth + 1);
+      }
+    } else if (node.conditions) {
+      await traverseNode(node.conditions, nodeVisitor, ancestors, depth + 1);
+    }
+    if (node.statements) {
+      await traverseNode(node.statements, nodeVisitor, ancestors, depth + 1);
+    }
+    if (node.next) {
+      await traverseNode(node.next, nodeVisitor, ancestors, depth + 1);
+    }
+  } else {
+    // Generic fallback: iterate over enumerable properties to find nested nodes
+    for (const key of Object.keys(node)) {
+      const val = node[key];
+      if (!val) continue;
+
+      const visitChild = async (child) => {
+        if (child && typeof child === 'object') {
+          // More restrictive check: ensure it's actually a Prism AST node
+          // Check for specific Prism node indicators and avoid circular references
+          if (
+            child.location && 
+            child.constructor && 
+            child.constructor.name && 
+            child.constructor.name.endsWith('Node') &&
+            !ancestors.includes(child)
+          ) {
+            await traverseNode(child, nodeVisitor, ancestors, depth + 1);
+          }
+        }
+      };
+
+      if (Array.isArray(val)) {
+        for (const c of val) {
+          await visitChild(c);
+        }
+      } else {
+        await visitChild(val);
+      }
+    }
   }
 
   ancestors.pop();

package/src/analyze/ruby/visitor.js

@@ -8,10 +8,11 @@ const { extractEventName, extractProperties } = require('./extractors');
 const { findWrappingFunction, traverseNode, getLineNumber } = require('./traversal');
 
 class TrackingVisitor {
-  constructor(code, filePath, customConfigs = []) {
+  constructor(code, filePath, customConfigs = [], constantMap = {}) {
     this.code = code;
     this.filePath = filePath;
     this.customConfigs = Array.isArray(customConfigs) ? customConfigs : [];
+    this.constantMap = constantMap || {};
     this.events = [];
   }
 
@@ -42,7 +43,7 @@ class TrackingVisitor {
 
       if (!source) return;
 
-      const eventName = extractEventName(node, source, matchedConfig);
+      const eventName = await extractEventName(node, source, matchedConfig, this.constantMap);
       if (!eventName) return;
 
       const line = getLineNumber(this.code, node.location);

package/src/analyze/typescript/parser.js

@@ -7,6 +7,7 @@ const ts = require('typescript');
 const { detectAnalyticsSource } = require('./detectors');
 const { extractEventData, processEventData } = require('./extractors');
 const { findWrappingFunction } = require('./utils/function-finder');
+const path = require('path');
 
 /**
  * Error thrown when TypeScript program cannot be created
@@ -44,16 +45,37 @@ function getProgram(filePath, existingProgram) {
   }
 
   try {
-    // Create a minimal program for single file analysis
-    const options = {
+    // Try to locate a tsconfig.json nearest to the file to inherit compiler options (important for path aliases)
+    const searchPath = path.dirname(filePath);
+    const configPath = ts.findConfigFile(searchPath, ts.sys.fileExists, 'tsconfig.json');
+
+    let compilerOptions = {
       target: ts.ScriptTarget.Latest,
       module: ts.ModuleKind.CommonJS,
       allowJs: true,
       checkJs: false,
-      noEmit: true
+      noEmit: true,
+      jsx: ts.JsxEmit.Preserve
     };
+    let rootNames = [filePath];
+
+    if (configPath) {
+      // Read and parse the tsconfig.json
+      const readResult = ts.readConfigFile(configPath, ts.sys.readFile);
+      if (!readResult.error && readResult.config) {
+        const parseResult = ts.parseJsonConfigFileContent(
+          readResult.config,
+          ts.sys,
+          path.dirname(configPath)
+        );
+        if (!parseResult.errors || parseResult.errors.length === 0) {
+          compilerOptions = { ...compilerOptions, ...parseResult.options };
+          rootNames = parseResult.fileNames.length > 0 ? parseResult.fileNames : rootNames;
+        }
+      }
+    }
 
-    const program = ts.createProgram([filePath], options);
+    const program = ts.createProgram(rootNames, compilerOptions);
     return program;
   } catch (error) {
     throw new ProgramError(filePath, error);