@ryanstark24/sfgraph-core 1.4.0 → 1.6.0

package/dist/parsers/apex/class.d.ts

@@ -1,10 +1,168 @@
+import { type EdgeFact, type NodeFact, REL_TYPES } from "../../domain/index.js";
 import type { ParseContext, ParseResult, Parser } from "../contract.js";
+import { type FieldAccess } from "./field-access.js";
+import { type RecordTypeOpts } from "./name-refs.js";
+export { APEX_NODE_HASH_SALT } from "../hash-salts.js";
+/**
+ * apex-parser (antlr4ts) keeps a DFA cache on each grammar's static ATN. It is
+ * per isolate, it is never trimmed, and it grows with every distinct input:
+ * over a large Vlocity corpus it held ~190 MB live (and a 2-4x larger V8 heap) in each
+ * parse worker. The cache is only a memo for prediction, so dropping it does
+ * not change any parse result. Release it after this many syntax checks in the
+ * current isolate (each parse worker, or the main thread in serial mode).
+ * Measured on a large Vlocity repo, 4 workers: 50 cut peak RSS by ~1.07 GB for ~5% more parse
+ * time.
+ */
+export declare const APEX_DFA_CLEAR_INTERVAL = 50;
+/** Test hook: restart the DFA-release counter for this isolate. */
+export declare function resetApexDfaCounterForTest(): void;
 export interface ApexClassInput {
     className: string;
     body: string;
     metaXml?: string;
     isTrigger?: boolean;
 }
+/**
+ * The bundled apex-parser grammar predates Apex's null-coalescing operator, so
+ * `a ?? b` is a syntax error to it. For grammar validation only, rewrite every
+ * code-level `??` (never inside comments or strings) to `||`: same length, so
+ * token offsets stay valid, and the same binary-expression shape. The original
+ * source is still used for every extraction and snippet.
+ */
+export declare function rewriteNullCoalescing(src: string): string;
+/**
+ * Human-readable message for a parse failure. apex-parser's
+ * ThrowingErrorListener throws a plain `{ line, column, message }` object (not
+ * an Error), which `String(err)` turned into "[object Object]".
+ */
+export declare function formatParseError(err: unknown): string;
+/**
+ * Compute the character ranges of loop BODIES (`{ … }` opened by for/while/
+ * do) within a method body. Used to stamp `inLoop: true` on SOQL/DML edges in
+ * the regex extraction path so governor-risk detection works on the DEFAULT
+ * parser mode — not only under SFGRAPH_APEX_PARSER=ast (the AST extractor
+ * stamps inLoop separately). The body passed here has strings/comments
+ * stripped, so brace counting is reliable.
+ *
+ * A for-EACH header query — `for (Account a : [SELECT …]) {…}` — runs once and
+ * is correctly EXCLUDED: its index falls before the loop body's opening brace,
+ * not inside the recorded range. Known limitation (shared with the populate
+ * body-scan): a braceless single-statement loop body isn't tracked.
+ */
+export declare function computeLoopRanges(body: string): Array<{
+    start: number;
+    end: number;
+}>;
+export declare const SOSL_RE: RegExp;
+/** Dynamic query entry points (the query text is a runtime string). */
+export declare const DYNAMIC_QUERY_RE: RegExp;
+/**
+ * T15 I-5: one EXECUTES_SOSL `SOSL:*` edge when `code` has an inline SOSL
+ * query, stamped `inLoop` when any of them sits inside a loop body.
+ */
+export declare function emitSoslEdge(ctx: ParseContext, srcQname: string, code: string, inLoopAt: (idx: number) => boolean, edges: EdgeFact[]): void;
+/**
+ * T15 I-5: the dynamic query calls (`Database.query`, `Search.query`, ...)
+ * inside a loop body of `code` (strings/comments stripped), as sorted
+ * distinct canonical names. Stamped on the method / trigger node as
+ * `dynamicQueryInLoop`; empty when none.
+ */
+export declare function dynamicQueriesInLoop(code: string, inLoopAt: (idx: number) => boolean): string[];
+/**
+ * Extract the outer object + SELECT clause from a SOQL query's inner text (the
+ * part after `[SELECT`). The object is the identifier after the first `FROM`
+ * encountered at parenthesis depth 0; subquery/semi-join FROMs (depth > 0) are
+ * skipped. Returns object=null for a malformed query.
+ */
+export declare function parseSoql(inner: string): {
+    object: string | null;
+    selectClause: string;
+};
+export declare const DML_RE: RegExp;
+/** `Database.insert(recs)`, `Database.update(recs, false)`, `Database.INSERT(…)`:
+ *  the Database class DML methods (Apex is case-insensitive). Group 2 is the
+ *  first argument when it is a plain name. */
+export declare const DATABASE_DML_RE: RegExp;
+/**
+ * EXECUTES_DML `DML:<op>` for DML statements (`insert x;`, `delete [SELECT …]`)
+ * and Database DML calls (`Database.insert(x)`) in `code` (strings/comments
+ * stripped), stamped `inLoop` when inside a loop body. `target` is the record
+ * expression's name when there is one.
+ *
+ * When the record expression's sObject type is known (see `recordTypeAt`:
+ * `new T(…)`, an inline query, a variable `objects.lookup` types, or
+ * `Trigger.new` / `Trigger.old`), also EXECUTES_DML `CustomObject:<T>`, like
+ * EXECUTES_SOQL, one per object with the sorted operations in `ops`. That edge
+ * carries no `inLoop`: the governor checks read the `DML:<op>` marker, so a
+ * statement in a loop is reported once.
+ */
+export declare function emitDmlEdges(ctx: ParseContext, srcQname: string, code: string, inLoopAt: (idx: number) => boolean, edges: EdgeFact[], objects?: RecordTypeOpts): void;
+/** A relationship traversal the parser records for the post-merge resolver
+ *  (parsers/apex/ref-resolver.ts): `path` (`Account.Name`) read or written
+ *  from a record of `object`. */
+export interface ApexRelationshipPath {
+    object: string;
+    path: string;
+    rel: typeof REL_TYPES.READS_FIELD | typeof REL_TYPES.WRITES_FIELD;
+}
+/**
+ * Inline `[SELECT …]` queries in `code`: EXECUTES_SOQL on the outer FROM
+ * object (with `query`, `inLoop`) and READS_FIELD for every plain field the
+ * outer query names (SELECT list, WHERE / HAVING operands, GROUP BY, ORDER
+ * BY). Dotted relationship fields are not this object's fields: they are
+ * appended to `paths`.
+ */
+export declare function emitInlineSoqlEdges(ctx: ParseContext, srcQname: string, code: string, inLoopAt: (idx: number) => boolean, edges: EdgeFact[], paths: ApexRelationshipPath[], children?: ApexChildRelationship[]): void;
+/**
+ * A string literal that is exactly a custom field API name (`'Tier__c'`), with
+ * the sObject types the same method declares (parameters and locals). Resolved
+ * post-merge (parsers/apex/ref-resolver.ts): READS_FIELD `{via:
+ * "field-name-literal"}` when exactly one of those objects defines the field.
+ * Covers helpers such as `setFieldIfNull(acc, 'Tier__c', v)` and `rec.get('Tier__c')`.
+ */
+export interface ApexFieldNameLiteral {
+    field: string;
+    objects: string[];
+}
+/** A child-relationship subquery (`(SELECT … FROM Contacts)` in the SELECT
+ *  list of a query on `object`), resolved to the child object post-merge
+ *  (parsers/apex/ref-resolver.ts). `fields` are the subquery's plain fields. */
+export interface ApexChildRelationship {
+    object: string;
+    relationship: string;
+    fields: string[];
+}
+/**
+ * Push READS_FIELD / WRITES_FIELD edges for member-access field refs, skipping
+ * any (rel, dst) already emitted for this source since `fromIdx` (e.g. a
+ * READS_FIELD from a SOQL select list) so existing edge attributes are kept.
+ */
+export declare function emitFieldAccessEdges(ctx: ParseContext, srcQname: string, accesses: FieldAccess[], edges: EdgeFact[], fromIdx: number): void;
+/**
+ * READS_FIELD `dynamic: true` for the outer SELECT fields and the WHERE /
+ * HAVING / GROUP BY / ORDER BY field operands of each folded dynamic SOQL
+ * string in `queries` (see foldDynamicSoql, dynamicSoqlClauseFields). Only
+ * when the FROM object is literal text; computed fields are skipped. A
+ * (src, dst) READS_FIELD already emitted since `fromIdx` is not repeated.
+ * Returns the number of clause field operands skipped because FROM is
+ * computed (see setDynamicSoqlSkips).
+ */
+export declare function emitDynamicSoqlEdges(ctx: ParseContext, srcQname: string, queries: string[], edges: EdgeFact[], fromIdx: number): number;
+/**
+ * Parse stat on a source node: `dynamicSoqlFieldsSkipped`, the dynamic SOQL
+ * clause field operands not attributed because the query's FROM is computed
+ * (only when there are any). The apex ref resolver sums it.
+ */
+export declare function setDynamicSoqlSkips(node: NodeFact | undefined, skipped: number): void;
+/**
+ * Collapse repeated EXECUTES_SOQL / EXECUTES_DML facts with the same
+ * (src, rel, dst) into one, in place of first occurrence. The store merges
+ * edges last-wins on that key, so without this an out-of-loop query after an
+ * in-loop one on the same object erased `inLoop`. The kept fact carries
+ * `inLoop: true` if any occurrence did (taking that occurrence's attributes),
+ * and `count` = number of occurrences when more than one.
+ */
+export declare function aggregateGovernorFacts(edges: EdgeFact[]): EdgeFact[];
 export declare class ApexClassParser implements Parser<ApexClassInput> {
     readonly category: "ApexClass";
     readonly type = "ApexClass";

package/dist/parsers/apex/class.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"class.d.ts","sourceRoot":"","sources":["../../../src/parsers/apex/class.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAGxE,MAAM,WAAW,cAAc;IAC7B,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAwRD,qBAAa,eAAgB,YAAW,MAAM,CAAC,cAAc,CAAC;IAC5D,QAAQ,CAAC,QAAQ,cAAgC;IACjD,QAAQ,CAAC,IAAI,eAAe;IAEtB,KAAK,CAAC,KAAK,EAAE,cAAc,EAAE,GAAG,EAAE,YAAY,GAAG,OAAO,CAAC,WAAW,CAAC;CA6W5E"}
+{"version":3,"file":"class.d.ts","sourceRoot":"","sources":["../../../src/parsers/apex/class.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,QAAQ,EAAqB,KAAK,QAAQ,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAGnG,OAAO,KAAK,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAqBxE,OAAO,EACL,KAAK,WAAW,EAKjB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EACL,KAAK,cAAc,EAKpB,MAAM,gBAAgB,CAAC;AASxB,OAAO,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AAEvD;;;;;;;;;GASG;AACH,eAAO,MAAM,uBAAuB,KAAK,CAAC;AAY1C,mEAAmE;AACnE,wBAAgB,0BAA0B,IAAI,IAAI,CAEjD;AAED,MAAM,WAAW,cAAc;IAC7B,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AA4ND;;;;;;GAMG;AACH,wBAAgB,qBAAqB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CASzD;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,OAAO,GAAG,MAAM,CAYrD;AAoHD;;;;;;;;;;;;GAYG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,MAAM,GAAG,KAAK,CAAC;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,GAAG,EAAE,MAAM,CAAA;CAAE,CAAC,CAsErF;AAQD,eAAO,MAAM,OAAO,QAAkB,CAAC;AAEvC,uEAAuE;AACvE,eAAO,MAAM,gBAAgB,QACuG,CAAC;AAErI;;;GAGG;AACH,wBAAgB,YAAY,CAC1B,GAAG,EAAE,YAAY,EACjB,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,MAAM,EACZ,QAAQ,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,EAClC,KAAK,EAAE,QAAQ,EAAE,GAChB,IAAI,CAYN;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,GAAG,MAAM,EAAE,CAkB/F;AAED;;;;;GAKG;AACH,wBAAgB,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG;IAAE,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IAAC,YAAY,EAAE,MAAM,CAAA;CAAE,CAkBxF;AACD,eAAO,MAAM,MAAM,QAA4E,CAAC;AAChG;;8CAE8C;AAC9C,eAAO,MAAM,eAAe,QACkE,CAAC;AAE/F;;;;;;;;;;;;GAYG;AACH,wBAAgB,YAAY,CAC1B,GAAG,EAAE,YAAY,EACjB,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,MAAM,EACZ,QAAQ,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,EAClC,KAAK,EAAE,QAAQ,EAAE,EACjB,OAAO,GAAE,cAAmB,GAC3B,IAAI,CAqCN;AAED;;iCAEiC;AACjC,MAAM,WAAW,oBAAoB;IACnC,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,OAAO,SAAS,CAAC,WAAW,GAAG,OAAO,SAAS,CAAC,YAAY,CAAC;CACnE;AAED;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CACjC,GAAG,EAAE,YAAY,EACjB,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,MAAM,EACZ,QAAQ,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,EAClC,KAAK,EAAE,QAAQ,EAAE,EACjB,KAAK,EAAE,oBAAoB,EAAE,EAC7B,QAAQ,CAAC,EAAE,qBAAqB,EAAE,GACjC,IAAI,CA2BN;AAED;;;;;;GAMG;AACH,MAAM,WAAW,oBAAoB;IACnC,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,EAAE,CAAC;CACnB;AAiCD;;gFAEgF;AAChF,MAAM,WAAW,qBAAqB;IACpC,MAAM,EAAE,MAAM,CAAC;IACf,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,MAAM,EAAE,CAAC;CAClB;AAwDD;;;;GAIG;AACH,wBAAgB,oBAAoB,CAClC,GAAG,EAAE,YAAY,EACjB,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,WAAW,EAAE,EACvB,KAAK,EAAE,QAAQ,EAAE,EACjB,OAAO,EAAE,MAAM,GACd,IAAI,CAkBN;AAED;;;;;;;;GAQG;AACH,wBAAgB,oBAAoB,CAClC,GAAG,EAAE,YAAY,EACjB,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,MAAM,EAAE,EACjB,KAAK,EAAE,QAAQ,EAAE,EACjB,OAAO,EAAE,MAAM,GACd,MAAM,CAwCR;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,QAAQ,GAAG,SAAS,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI,CAIrF;AAED;;;;;;;GAOG;AACH,wBAAgB,sBAAsB,CAAC,KAAK,EAAE,QAAQ,EAAE,GAAG,QAAQ,EAAE,CAuBpE;AAqCD,qBAAa,eAAgB,YAAW,MAAM,CAAC,cAAc,CAAC;IAC5D,QAAQ,CAAC,QAAQ,cAAgC;IACjD,QAAQ,CAAC,IAAI,eAAe;IAEtB,KAAK,CAAC,KAAK,EAAE,cAAc,EAAE,GAAG,EAAE,YAAY,GAAG,OAAO,CAAC,WAAW,CAAC;CAmnB5E"}