Improve apex bind variable parsing #155

resolves #155

Author: paustint

CHANGELOG.md

@@ -1,6 +1,12 @@
 # Changelog
 
-## 4.1.0
+## 4.2.0
+
+June 7, 2021
+
+#155 - Apex bind variable support is improved to allow parsing of more complex Apex.
+
+## 4.1.1
 
 June 6, 2021
 

src/models.ts

@@ -201,7 +201,31 @@ export interface ExpressionContext {
 }
 
 export interface ApexBindVariableExpressionContext {
-  Identifier: IToken[];
+  apex: (CstNode | IToken)[];
+  COLON: IToken[];
+  DECIMAL?: IToken[];
+}
+
+export interface ApexBindVariableNewInstantiationContext {
+  NEW: IToken[];
+  FUNCTION: IToken[];
+  apexBindVariableGeneric?: CstNode[];
+  apexBindVariableFunctionParams: CstNode[];
+}
+export interface ApexBindVariableFunctionCallContext {
+  FUNCTION: IToken[];
+  apexBindVariableFunctionParams: CstNode[];
+}
+export interface ApexBindVariableGenericContext {
+  COMMA: IToken[];
+  GREATER_THAN: IToken[];
+  LESS_THAN: IToken[];
+  PARAMETER: IToken[];
+}
+export interface ApexBindVariableFunctionParamsContext {
+  L_PAREN: IToken[];
+  R_PAREN: IToken[];
+  PARAMETER?: IToken[];
 }
 
 export interface ExpressionOperatorContext {

src/parser/lexer.ts

@@ -263,6 +263,7 @@ export const AboveOrBelow = createToken({
   longer_alt: Identifier,
   categories: [Keyword, Identifier],
 });
+export const ApexNew = createToken({ name: 'new', pattern: /new/i, longer_alt: Identifier, categories: [Keyword, Identifier] });
 export const At = createToken({ name: 'AT', pattern: /AT/i, longer_alt: Identifier, categories: [Keyword, Identifier] });
 export const Below = createToken({ name: 'BELOW', pattern: /BELOW/i, longer_alt: Identifier, categories: [Keyword, Identifier] });
 export const DataCategory = createToken({
@@ -913,6 +914,7 @@ export const allTokens = [
 
   AboveOrBelow,
   Above,
+  ApexNew,
   At,
   Below,
   DataCategory,

src/parser/parser.ts

@@ -33,6 +33,7 @@ export class SoqlParser extends CstParser {
   private $_aggregateFunction: any = undefined;
   private $_otherFunction: any = undefined;
   private $_atomicExpression: any = undefined;
+  private $_apexBindVariableExpression: any = undefined;
   private $_arrayExpression: any = undefined;
   private $_relationalOperator: any = undefined;
   private $_selectClause: any = undefined;
@@ -617,7 +618,62 @@ export class SoqlParser extends CstParser {
 
   private apexBindVariableExpression = this.RULE('apexBindVariableExpression', () => {
     this.CONSUME(lexer.Colon);
-    this.CONSUME(lexer.Identifier);
+    // First item in list could optionally be a new instantiation
+    this.OPTION(() => {
+      this.SUBRULE(this.apexBindVariableNewInstantiation, { LABEL: 'apex' });
+      this.OPTION1(() => {
+        this.CONSUME(lexer.Decimal);
+      });
+    });
+    // Chained function calls or nested arguments with function calls at the end
+    this.MANY_SEP({
+      SEP: lexer.Decimal,
+      DEF: () => {
+        this.OR(
+          this.$_apexBindVariableExpression ||
+            (this.$_apexBindVariableExpression = [
+              { ALT: () => this.SUBRULE(this.apexBindVariableFunctionCall, { LABEL: 'apex' }) },
+              { ALT: () => this.CONSUME(lexer.Identifier, { LABEL: 'apex' }) },
+            ]),
+        );
+      },
+    });
+  });
+
+  private apexBindVariableNewInstantiation = this.RULE('apexBindVariableNewInstantiation', () => {
+    this.CONSUME(lexer.ApexNew, { LABEL: 'NEW' });
+    this.CONSUME(lexer.Identifier, { LABEL: 'FUNCTION' });
+    this.OPTION(() => {
+      this.SUBRULE(this.apexBindVariableGeneric);
+    });
+    this.SUBRULE(this.apexBindVariableFunctionParams);
+  });
+
+  private apexBindVariableFunctionCall = this.RULE('apexBindVariableFunctionCall', () => {
+    this.CONSUME(lexer.Identifier, { LABEL: 'FUNCTION' });
+    this.SUBRULE(this.apexBindVariableFunctionParams);
+  });
+
+  private apexBindVariableGeneric = this.RULE('apexBindVariableGeneric', () => {
+    this.CONSUME(lexer.LessThan);
+    this.AT_LEAST_ONE_SEP({
+      SEP: lexer.Comma,
+      DEF: () => {
+        this.CONSUME(lexer.Identifier, { LABEL: 'PARAMETER' });
+      },
+    });
+    this.CONSUME(lexer.GreaterThan);
+  });
+
+  private apexBindVariableFunctionParams = this.RULE('apexBindVariableFunctionParams', () => {
+    this.CONSUME(lexer.LParen);
+    this.MANY_SEP({
+      SEP: lexer.Comma,
+      DEF: () => {
+        this.CONSUME(lexer.Identifier, { LABEL: 'PARAMETER' });
+      },
+    });
+    this.CONSUME(lexer.RParen);
   });
 
   private arrayExpression = this.RULE('arrayExpression', () => {

src/parser/visitor.ts

@@ -34,6 +34,10 @@ import {
 } from '../api/api-models';
 import {
   ApexBindVariableExpressionContext,
+  ApexBindVariableFunctionCallContext,
+  ApexBindVariableFunctionParamsContext,
+  ApexBindVariableGenericContext,
+  ApexBindVariableNewInstantiationContext,
   ArrayExpressionWithType,
   AtomicExpressionContext,
   BooleanContext,
@@ -791,7 +795,29 @@ class SOQLVisitor extends BaseSoqlVisitor {
   }
 
   apexBindVariableExpression(ctx: ApexBindVariableExpressionContext): string {
-    return ctx.Identifier[0].image;
+    return ctx.apex.map(item => (isToken(item) ? item.image : this.visit(item))).join('.');
+  }
+
+  apexBindVariableNewInstantiation(ctx: ApexBindVariableNewInstantiationContext): string {
+    let output = `new ${ctx.FUNCTION[0].image}`;
+    if (ctx.apexBindVariableGeneric) {
+      output += this.visit(ctx.apexBindVariableGeneric[0]);
+    }
+    output += this.visit(ctx.apexBindVariableFunctionParams[0]);
+    return output;
+  }
+
+  apexBindVariableFunctionCall(ctx: ApexBindVariableFunctionCallContext): string {
+    return `${ctx.FUNCTION[0].image}${this.visit(ctx.apexBindVariableFunctionParams[0])}`;
+  }
+
+  apexBindVariableGeneric(ctx: ApexBindVariableGenericContext): string {
+    return `<${ctx.PARAMETER.map(item => item.image).join(', ')}>`;
+  }
+
+  apexBindVariableFunctionParams(ctx: ApexBindVariableFunctionParamsContext): string {
+    const params = Array.isArray(ctx.PARAMETER) ? ctx.PARAMETER : [];
+    return `(${params.map(item => item.image).join(', ')})`;
   }
 
   arrayExpression(ctx: ValueContext): ArrayExpressionWithType[] {

test/test-cases.ts

@@ -2265,18 +2265,85 @@ export const testCases: TestCase[] = [
   },
   {
     testCase: 112,
-    options: { allowApexBindVariables: true, ignoreParseErrors: true },
+    options: { allowApexBindVariables: true },
     soql: `SELECT Id, (SELECT Id FROM Contacts WHERE Id IN :contactMap.keySet()) FROM Account WHERE Id IN :accountMap.keySet()`,
-    soqlComposed: `SELECT Id, (SELECT Id FROM Contacts) FROM Account`,
     output: {
       fields: [
         {
           type: 'Field',
           field: 'Id',
         },
-        { type: 'FieldSubquery', subquery: { fields: [{ type: 'Field', field: 'Id' }], relationshipName: 'Contacts' } },
+        {
+          type: 'FieldSubquery',
+          subquery: {
+            fields: [{ type: 'Field', field: 'Id' }],
+            relationshipName: 'Contacts',
+            where: { left: { field: 'Id', literalType: 'APEX_BIND_VARIABLE', operator: 'IN', value: 'contactMap.keySet()' } },
+          },
+        },
+      ],
+      sObject: 'Account',
+      where: { left: { field: 'Id', literalType: 'APEX_BIND_VARIABLE', operator: 'IN', value: 'accountMap.keySet()' } },
+    },
+  },
+  {
+    testCase: 113,
+    options: { allowApexBindVariables: true, ignoreParseErrors: true },
+    soql: `SELECT Id, (SELECT Id FROM Contacts WHERE Id IN :contact_900Map.keySet()) FROM Account WHERE Id IN :acco INVALID untMap.keySet()`,
+    soqlComposed: `SELECT Id, (SELECT Id FROM Contacts WHERE Id IN :contact_900Map.keySet()) FROM Account`,
+    output: {
+      fields: [
+        {
+          type: 'Field',
+          field: 'Id',
+        },
+        {
+          type: 'FieldSubquery',
+          subquery: {
+            fields: [{ type: 'Field', field: 'Id' }],
+            relationshipName: 'Contacts',
+            where: { left: { field: 'Id', literalType: 'APEX_BIND_VARIABLE', operator: 'IN', value: 'contact_900Map.keySet()' } },
+          },
+        },
+      ],
+      sObject: 'Account',
+    },
+  },
+  {
+    testCase: 114,
+    options: { allowApexBindVariables: true },
+    soql: `SELECT Id FROM Account WHERE Id IN :new Map<Id, SObject>(someVar).keySet()`,
+    output: {
+      fields: [
+        {
+          type: 'Field',
+          field: 'Id',
+        },
+      ],
+      sObject: 'Account',
+      where: { left: { field: 'Id', literalType: 'APEX_BIND_VARIABLE', operator: 'IN', value: 'new Map<Id, SObject>(someVar).keySet()' } },
+    },
+  },
+  {
+    testCase: 115,
+    options: { allowApexBindVariables: true },
+    soql: `SELECT Id FROM Account WHERE Id IN :new Map<Id, SObject>(someVar).getSomeClass().records`,
+    output: {
+      fields: [
+        {
+          type: 'Field',
+          field: 'Id',
+        },
       ],
       sObject: 'Account',
+      where: {
+        left: {
+          field: 'Id',
+          literalType: 'APEX_BIND_VARIABLE',
+          operator: 'IN',
+          value: 'new Map<Id, SObject>(someVar).getSomeClass().records',
+        },
+      },
     },
   },
 ];

test/test.spec.ts

@@ -12,7 +12,7 @@ const replacements = [{ matching: / last /i, replace: ' LAST ' }];
 // Uncomment these to easily test one specific query - useful for troubleshooting/bugfixing
 
 // describe.only('parse queries', () => {
-//   const testCase = testCases.find(tc => tc.testCase === 109);
+//   const testCase = testCases.find(tc => tc.testCase === 62);
 //   it(`should correctly parse test case ${testCase.testCase} - ${testCase.soql}`, () => {
 //     const soqlQuery = parseQuery(testCase.soql, testCase.options);
 //     console.log(soqlQuery);