Skip to content

Commit 7b1beee

Browse files
paustintpaustint
committed
multiple bugfixes
Added support for WITH, FOR, UPDATE, nested functions resolves #18 resolves #19 resolves #27 resolves #25
1 parent 20be43f commit 7b1beee

File tree

9 files changed

+389
-28
lines changed

9 files changed

+389
-28
lines changed

‎debug/cli.js‎

Lines changed: 0 additions & 4 deletions
This file was deleted.

‎debug/test.js‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,12 @@
11
var soqlParserJs = require('../dist');
22

33
const query = `
4-
SELECT Account.Name, (SELECT Contact.LastName FROM Account.Contacts) FROM Account
4+
SELECT Title FROM FAQ__kav WHERE PublishStatus='online' and Language = 'en_US' and KnowledgeArticleVersion = 'ka230000000PCiy' UPDATE VIEWSTAT
55
`;
66

77
const parsedQuery = soqlParserJs.parseQuery(query, { logging: true });
88

99
console.log(JSON.stringify(parsedQuery, null, 2));
10+
11+
// SELECT amount, FORMAT(amount) Amt, convertCurrency(amount) editDate, FORMAT(convertCurrency(amount)) convertedCurrency FROM Opportunity where id = '12345'
12+
// SELECT FORMAT(MIN(closedate)) Amt FROM opportunity

‎docs/src/components/sample-queries.tsx‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -142,6 +142,30 @@ export default class SampleQueries extends React.Component<ISampleQueriesProps,
142142
num: 31,
143143
soql: `SELECT LeadSource, COUNT(Name) FROM Lead GROUP BY LeadSource HAVING COUNT(Name) > 100 and LeadSource > 'Phone'`,
144144
},
145+
{
146+
key: 32,
147+
num: 32,
148+
soql: `SELECT Title FROM KnowledgeArticleVersion WHERE PublishStatus='online' WITH DATA CATEGORY Geography__c ABOVE usa__c`,
149+
},
150+
{
151+
key: 33,
152+
num: 33,
153+
soql: `SELECT Title FROM Question WHERE LastReplyDate > 2005-10-08T01:02:03Z WITH DATA CATEGORY Geography__c AT (usa__c, uk__c)`,
154+
},
155+
{
156+
key: 34,
157+
num: 34,
158+
soql: `SELECT UrlName FROM KnowledgeArticleVersion WHERE PublishStatus='draft' WITH DATA CATEGORY Geography__c AT usa__c AND Product__c ABOVE_OR_BELOW mobile_phones__c`,
159+
},
160+
{ key: 35, num: 35, soql: `SELECT Name, ID FROM Contact LIMIT 1 FOR VIEW` },
161+
{ key: 36, num: 36, soql: `SELECT Name, ID FROM Contact LIMIT 1 FOR REFERENCE` },
162+
{ key: 37, num: 37, soql: `SELECT Id FROM Account LIMIT 2 FOR UPDATE UPDATE TRACKING` },
163+
{
164+
key: 38,
165+
num: 38,
166+
soql: `SELECT amount, FORMAT(amount) Amt, convertCurrency(amount) editDate, FORMAT(convertCurrency(amount)) convertedCurrency FROM Opportunity where id = '12345'`,
167+
},
168+
{ key: 39, num: 39, soql: `SELECT FORMAT(MIN(closedate)) Amt FROM opportunity` },
145169
];
146170
};
147171

‎lib/SoqlComposer.ts‎

Lines changed: 31 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ import {
77
HavingClause,
88
OrderByClause,
99
TypeOfField,
10+
WithDataCategoryClause,
11+
ForClause,
1012
} from './models/SoqlQuery.model';
1113
import * as utils from './utils';
1214

@@ -72,8 +74,8 @@ export class Compose {
7274
output += ` ${utils.get(query.sObjectPrefix, '.')}${query.sObject}${utils.get(query.sObjectAlias, '', ' ')}`;
7375
this.log(output);
7476

75-
if (query.whereClause) {
76-
output += ` WHERE ${this.parseWhereClause(query.whereClause)}`;
77+
if (query.where) {
78+
output += ` WHERE ${this.parseWhereClause(query.where)}`;
7779
this.log(output);
7880
}
7981

@@ -103,6 +105,21 @@ export class Compose {
103105
this.log(output);
104106
}
105107

108+
if (query.withDataCategory) {
109+
output += ` WITH DATA CATEGORY ${this.parseWithDataCategory(query.withDataCategory)}`;
110+
this.log(output);
111+
}
112+
113+
if (query.for) {
114+
output += ` FOR ${query.for}`;
115+
this.log(output);
116+
}
117+
118+
if (query.update) {
119+
output += ` UPDATE ${query.update}`;
120+
this.log(output);
121+
}
122+
106123
// TODO: add FOR support https://github.com/paustint/soql-parser-js/issues/19
107124

108125
return output;
@@ -195,4 +212,16 @@ export class Compose {
195212
return output.trim();
196213
}
197214
}
215+
216+
private parseWithDataCategory(withDataCategory: WithDataCategoryClause): string {
217+
return withDataCategory.conditions
218+
.map(condition => {
219+
const params =
220+
condition.parameters.length > 1
221+
? `(${condition.parameters.join(', ')})`
222+
: `${condition.parameters.join(', ')}`;
223+
return `${condition.groupName} ${condition.selector} ${params}`;
224+
})
225+
.join(' AND ');
226+
}
198227
}

‎lib/SoqlListener.ts‎

Lines changed: 34 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,15 @@ import {
1010
OrderByClause,
1111
Query,
1212
WhereClause,
13+
WithDataCategoryCondition,
14+
GroupSelector,
15+
ForClause,
16+
TypeOfFieldCondition,
17+
UpdateClause,
1318
} from './models/SoqlQuery.model';
1419
import { SoqlQueryConfig } from './SoqlParser';
1520

16-
export type currItem = 'field' | 'typeof' | 'from' | 'where' | 'groupby' | 'orderby' | 'having';
21+
export type currItem = 'field' | 'typeof' | 'from' | 'where' | 'groupby' | 'orderby' | 'having' | 'withDataCategory';
1722

1823
export interface Context {
1924
isSubQuery: boolean;
@@ -29,7 +34,7 @@ export class SoqlQuery implements Query {
2934
subqueries: Query[];
3035
sObject: string;
3136
sObjectAlias?: string;
32-
whereClause?: WhereClause;
37+
where?: WhereClause;
3338
limit?: number;
3439
offset?: number;
3540
groupBy?: GroupByClause;
@@ -166,6 +171,9 @@ export class Listener implements SOQLListener {
166171
if (this.config.logging) {
167172
console.log('enterData_category_group_name:', ctx.text);
168173
}
174+
this.context.tempData.conditions.push({
175+
groupName: ctx.text,
176+
});
169177
}
170178
exitData_category_group_name(ctx: Parser.Data_category_group_nameContext) {
171179
if (this.config.logging) {
@@ -176,6 +184,8 @@ export class Listener implements SOQLListener {
176184
if (this.config.logging) {
177185
console.log('enterData_category_name:', ctx.text);
178186
}
187+
const condition = utils.getLastItem<WithDataCategoryCondition>(this.context.tempData.conditions);
188+
condition.parameters.push(ctx.text);
179189
}
180190
exitData_category_name(ctx: Parser.Data_category_nameContext) {
181191
if (this.config.logging) {
@@ -350,7 +360,8 @@ export class Listener implements SOQLListener {
350360
console.log('enterFunction_name:', ctx.text);
351361
}
352362
if (this.context.currentItem === 'field') {
353-
this.context.tempData.name = ctx.text;
363+
const currFn: FunctionExp = this.context.tempData.fn || this.context.tempData;
364+
currFn.name = ctx.text;
354365
}
355366
if (this.context.currentItem === 'having') {
356367
this.context.tempData.currConditionOperation.left.fn.name = ctx.text;
@@ -467,7 +478,7 @@ export class Listener implements SOQLListener {
467478
console.log('exitWhere_clause:', ctx.text);
468479
}
469480

470-
this.getSoqlQuery().whereClause = this.context.tempData.data;
481+
this.getSoqlQuery().where = this.context.tempData.data;
471482
this.context.tempData = null;
472483
}
473484
enterGroupby_clause(ctx: Parser.Groupby_clauseContext) {
@@ -623,6 +634,7 @@ export class Listener implements SOQLListener {
623634
console.log('enterFunction_call_spec:', ctx.text);
624635
}
625636
if (this.context.currentItem === 'field') {
637+
// If nested function, init nested fn operator
626638
this.context.tempData = {};
627639
}
628640
if (this.context.currentItem === 'having') {
@@ -655,7 +667,11 @@ export class Listener implements SOQLListener {
655667
}
656668
// COUNT(ID) or Count()
657669
if (this.context.currentItem === 'field') {
658-
this.context.tempData.text = ctx.text;
670+
if (this.context.tempData.text) {
671+
this.context.tempData.fn = {};
672+
}
673+
const currFn: FunctionExp = this.context.tempData.fn || this.context.tempData;
674+
currFn.text = ctx.text;
659675
}
660676
if (this.context.currentItem === 'having') {
661677
this.context.tempData.currConditionOperation.left.fn = {
@@ -760,7 +776,7 @@ export class Listener implements SOQLListener {
760776
if (this.config.logging) {
761777
console.log('enterTypeof_then_clause:', ctx.text);
762778
}
763-
const whenThenClause = this.context.tempData.typeOf.conditions[this.context.tempData.typeOf.conditions.length - 1];
779+
const whenThenClause = utils.getLastItem<TypeOfFieldCondition>(this.context.tempData.typeOf.conditions);
764780
whenThenClause.fieldList = ctx.getChild(1).text.split(',');
765781
}
766782
exitTypeof_then_clause(ctx: Parser.Typeof_then_clauseContext) {
@@ -1072,11 +1088,17 @@ export class Listener implements SOQLListener {
10721088
if (this.config.logging) {
10731089
console.log('enterWith_data_category_clause:', ctx.text);
10741090
}
1091+
this.context.currentItem = 'withDataCategory';
1092+
this.context.tempData = {
1093+
conditions: [],
1094+
};
10751095
}
10761096
exitWith_data_category_clause(ctx: Parser.With_data_category_clauseContext) {
10771097
if (this.config.logging) {
10781098
console.log('exitWith_data_category_clause:', ctx.text);
10791099
}
1100+
this.getSoqlQuery().withDataCategory = this.context.tempData;
1101+
this.context.tempData = null;
10801102
}
10811103
enterData_category_spec_list(ctx: Parser.Data_category_spec_listContext) {
10821104
if (this.config.logging) {
@@ -1102,6 +1124,8 @@ export class Listener implements SOQLListener {
11021124
if (this.config.logging) {
11031125
console.log('enterData_category_parameter_list:', ctx.text);
11041126
}
1127+
const condition = utils.getLastItem<WithDataCategoryCondition>(this.context.tempData.conditions);
1128+
condition.parameters = [];
11051129
}
11061130
exitData_category_parameter_list(ctx: Parser.Data_category_parameter_listContext) {
11071131
if (this.config.logging) {
@@ -1112,6 +1136,8 @@ export class Listener implements SOQLListener {
11121136
if (this.config.logging) {
11131137
console.log('enterData_category_selector:', ctx.text);
11141138
}
1139+
const condition = utils.getLastItem<WithDataCategoryCondition>(this.context.tempData.conditions);
1140+
condition.selector = ctx.text.toUpperCase() as GroupSelector;
11151141
}
11161142
exitData_category_selector(ctx: Parser.Data_category_selectorContext) {
11171143
if (this.config.logging) {
@@ -1249,6 +1275,7 @@ export class Listener implements SOQLListener {
12491275
if (this.config.logging) {
12501276
console.log('enterFor_value:', ctx.text);
12511277
}
1278+
this.getSoqlQuery().for = ctx.text.toUpperCase() as ForClause;
12521279
}
12531280
exitFor_value(ctx: Parser.For_valueContext) {
12541281
if (this.config.logging) {
@@ -1264,5 +1291,6 @@ export class Listener implements SOQLListener {
12641291
if (this.config.logging) {
12651292
console.log('exitUpdate_value:', ctx.text);
12661293
}
1294+
this.getSoqlQuery().update = ctx.text as UpdateClause;
12671295
}
12681296
}

‎lib/models/SoqlQuery.model.ts‎

Lines changed: 22 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,26 @@
11
export type LogicalOperator = 'AND' | 'OR';
22
export type Operator = '=' | '<=' | '>=' | '>' | '<' | 'LIKE' | 'IN' | 'NOT IN' | 'INCLUDES' | 'EXCLUDES';
3+
export type TypeOfFieldConditionType = 'WHEN' | 'ELSE';
4+
export type GroupSelector = 'ABOVE' | 'AT' | 'BELOW' | 'ABOVE_OR_BELOW';
5+
export type LogicalPrefix = 'NOT';
6+
export type ForClause = 'VIEW' | 'UPDATE' | 'REFERENCE';
7+
export type UpdateClause = 'TRACKING' | 'VIEWSTAT';
38

49
export interface Query {
510
fields: Field[];
611
subqueries: Query[];
712
sObject: string;
813
sObjectAlias?: string;
914
sObjectPrefix?: string;
10-
whereClause?: WhereClause;
15+
where?: WhereClause;
1116
limit?: number;
1217
offset?: number;
1318
groupBy?: GroupByClause;
1419
having?: HavingClause;
1520
orderBy?: OrderByClause | OrderByClause[];
21+
withDataCategory?: WithDataCategoryClause;
22+
for?: ForClause;
23+
update?: UpdateClause;
1624
}
1725

1826
export interface SelectStatement {
@@ -34,7 +42,7 @@ export interface TypeOfField {
3442
}
3543

3644
export interface TypeOfFieldCondition {
37-
type: 'WHEN' | 'ELSE';
45+
type: TypeOfFieldConditionType;
3846
objectType?: string; // not present when ELSE
3947
fieldList: string[];
4048
}
@@ -48,7 +56,7 @@ export interface WhereClause {
4856
export interface Condition {
4957
openParen?: number;
5058
closeParen?: number;
51-
logicalPrefix?: 'NOT';
59+
logicalPrefix?: LogicalPrefix;
5260
field: string;
5361
operator: Operator;
5462
value: string | string[];
@@ -86,4 +94,15 @@ export interface FunctionExp {
8694
name?: string; // Count
8795
alias?: string;
8896
parameter?: string | string[];
97+
fn?: FunctionExp; // used for nested functions FORMAT(MIN(CloseDate))
98+
}
99+
100+
export interface WithDataCategoryClause {
101+
conditions: WithDataCategoryCondition[];
102+
}
103+
104+
export interface WithDataCategoryCondition {
105+
groupName: string;
106+
selector: GroupSelector;
107+
parameters: string[];
89108
}

‎lib/utils.ts‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,10 @@ export function getIfTrue(val: boolean | null | undefined, returnStr: string): s
2828
return isBoolean(val) && val ? returnStr : '';
2929
}
3030

31+
export function getLastItem<T>(arr: T[]): T {
32+
return arr[arr.length - 1];
33+
}
34+
3135
export function getAsArrayStr(val: string | string[], alwaysParens: boolean = false): string {
3236
if (isArray(val)) {
3337
if (val.length > 0) {

0 commit comments

Comments
 (0)