Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add support for context var index #111

Merged
merged 3 commits into from
Jul 1, 2024
Merged

feat: add support for context var index #111

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
32299b3
feat: add support for context var index
koladilip Jun 28, 2024
45c68a3
fix: context var mappings
koladilip Jul 1, 2024
b2816f0
fix: context var mappings
koladilip Jul 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 18 additions & 7 deletions src/engine.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import { JsonTemplateTranslator } from './translator';
import {
EngineOptions,
Expression,
FlatMappingAST,
FlatMappingPaths,
PathType,
SyntaxType,
Expand Down Expand Up @@ -66,7 +67,7 @@ export class JsonTemplateEngine {
}));
}

static validateMappings(mappings: FlatMappingPaths[]) {
static validateMappings(mappings: FlatMappingPaths[], options?: EngineOptions) {
JsonTemplateEngine.prepareMappings(mappings).forEach((mapping) => {
if (
!JsonTemplateEngine.isValidJSONPath(mapping.input) ||
Expand All @@ -79,18 +80,24 @@ export class JsonTemplateEngine {
);
}
});
JsonTemplateEngine.parseMappingPaths(mappings);
JsonTemplateEngine.parseMappingPaths(mappings, options);
}

static parseMappingPaths(mappings: FlatMappingPaths[], options?: EngineOptions): Expression {
const flatMappingAST = JsonTemplateEngine.prepareMappings(mappings)
private static createFlatMappingsAST(
mappings: FlatMappingPaths[],
options?: EngineOptions,
): FlatMappingAST[] {
return JsonTemplateEngine.prepareMappings(mappings)
.filter((mapping) => mapping.input && mapping.output)
.map((mapping) => ({
...mapping,
inputExpr: JsonTemplateEngine.parse(mapping.input, options).statements[0],
outputExpr: JsonTemplateEngine.parse(mapping.output, options).statements[0],
}));
return convertToObjectMapping(flatMappingAST);
}

static parseMappingPaths(mappings: FlatMappingPaths[], options?: EngineOptions): Expression {
return convertToObjectMapping(JsonTemplateEngine.createFlatMappingsAST(mappings, options));
}

static create(templateOrExpr: TemplateInput, options?: EngineOptions): JsonTemplateEngine {
Expand Down Expand Up @@ -120,9 +127,13 @@ export class JsonTemplateEngine {
return JsonTemplateEngine.translateExpression(JsonTemplateEngine.parse(template, options));
}

static reverseTranslate(expr: Expression, options?: EngineOptions): string {
static reverseTranslate(expr: Expression | FlatMappingPaths[], options?: EngineOptions): string {
const translator = new JsonTemplateReverseTranslator(options);
return translator.translate(expr);
let newExpr = expr;
if (Array.isArray(expr)) {
newExpr = JsonTemplateEngine.parseMappingPaths(expr as FlatMappingPaths[], options);
}
return translator.translate(newExpr as Expression);
}

static convertMappingsToTemplate(mappings: FlatMappingPaths[], options?: EngineOptions): string {
Expand Down
14 changes: 9 additions & 5 deletions src/parser.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1443,9 +1443,9 @@
return this.lexer.throwUnexpectedToken();
}

private static pathContainsVariables(parts: Expression[]): boolean {
private static shouldPathBeConvertedAsBlock(parts: Expression[]): boolean {
return parts
.filter((part) => part.type === SyntaxType.PATH_OPTIONS)
.filter((part, index) => part.type === SyntaxType.PATH_OPTIONS && index < parts.length - 1)

Check warning on line 1448 in src/parser.ts

View workflow job for this annotation

GitHub Actions / Coverage annotations (🧪 jest-coverage-report-action)

🌿 Branch is not covered 

Warning! Not covered branch
.some((part) => part.options?.index ?? part.options?.item);
}

Expand Down Expand Up @@ -1550,17 +1550,21 @@
newPathExpr.parts.shift();
}

const shouldConvertAsBlock = JsonTemplateParser.pathContainsVariables(newPathExpr.parts);
const shouldConvertAsBlock = JsonTemplateParser.shouldPathBeConvertedAsBlock(newPathExpr.parts);
let lastPart = getLastElement(newPathExpr.parts);
let fnExpr: FunctionCallExpression | undefined;
if (lastPart?.type === SyntaxType.FUNCTION_CALL_EXPR) {
fnExpr = newPathExpr.parts.pop() as FunctionCallExpression;
}

lastPart = getLastElement(newPathExpr.parts);
if (lastPart?.type === SyntaxType.PATH_OPTIONS) {
newPathExpr.parts.pop();
if (lastPart?.type === SyntaxType.PATH_OPTIONS && lastPart.options?.toArray) {

Check warning on line 1561 in src/parser.ts

View workflow job for this annotation

GitHub Actions / Coverage annotations (🧪 jest-coverage-report-action)

🌿 Branch is not covered 

Warning! Not covered branch
newPathExpr.returnAsArray = lastPart.options?.toArray;
if (!lastPart.options.item && !lastPart.options.index) {

Check warning on line 1563 in src/parser.ts

View workflow job for this annotation

GitHub Actions / Coverage annotations (🧪 jest-coverage-report-action)

🧾 Statement is not covered 

Warning! Not covered statement
newPathExpr.parts.pop();

Check warning on line 1564 in src/parser.ts

View workflow job for this annotation

GitHub Actions / Coverage annotations (🧪 jest-coverage-report-action)

🧾 Statement is not covered 

Warning! Not covered statement
} else {

Check warning on line 1565 in src/parser.ts

View workflow job for this annotation

GitHub Actions / Coverage annotations (🧪 jest-coverage-report-action)

🧾 Statement is not covered 

Warning! Not covered statement
lastPart.options.toArray = false;

Check warning on line 1566 in src/parser.ts

View workflow job for this annotation

GitHub Actions / Coverage annotations (🧪 jest-coverage-report-action)

🧾 Statement is not covered 

Warning! Not covered statement
}

Check warning on line 1567 in src/parser.ts

View workflow job for this annotation

GitHub Actions / Coverage annotations (🧪 jest-coverage-report-action)

🧾 Statement is not covered 

Warning! Not covered statement

Check warning on line 1567 in src/parser.ts

View check run for this annotation

Codecov / codecov/patch

src/parser.ts#L1563-L1567 

Added lines #L1563 - L1567 were not covered by tests
}

Check warning on line 1568 in src/parser.ts

View workflow job for this annotation

GitHub Actions / Coverage annotations (🧪 jest-coverage-report-action)

🌿 Branch is not covered 

Warning! Not covered branch
newPathExpr.parts = JsonTemplateParser.combinePathOptionParts(newPathExpr.parts);

Expand Down
8 changes: 5 additions & 3 deletions src/reverse_translator.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import { JsonTemplateEngine } from './engine';
import { PathType } from './types';

describe('reverse_translator', () => {
it('should reverse translate with indentation', () => {
Expand All @@ -12,7 +13,7 @@ describe('reverse_translator', () => {

it('should reverse translate json mappings', () => {
const template = JsonTemplateEngine.reverseTranslate(
JsonTemplateEngine.parse([
[
{
input: '$.userId',
output: '$.user.id',
Expand Down Expand Up @@ -41,10 +42,11 @@ describe('reverse_translator', () => {
input: '$.products[?(@.category)].(@.price * @.quantity * (1 - $.discount / 100)).sum()',
output: '$.events[0].revenue',
},
]),
],
{ defaultPathType: PathType.JSON },
);
expect(template).toEqual(
'{\n "user": {\n "id": $.userId\n },\n "events": [{\n "items": $.products{.category}.({\n "discount": $.discount,\n "product_id": .id,\n "options": .variations[*].({\n "s": .size\n })[],\n "value": .price * .quantity * (1 - $.discount / 100)\n })[],\n "name": $.events[0],\n "revenue": $.products{.category}.(.price * .quantity * (1 - $.discount / 100)).sum()\n }]\n}',
'{\n "user": {\n "id": $.userId\n },\n "events": [{\n "items": $.products[?(@.category)].({\n "discount": $.discount,\n "product_id": @.id,\n "options": @.variations[*].({\n "s": @.size\n })[],\n "value": @.price * @.quantity * (1 - $.discount / 100)\n })[],\n "name": $.events[0],\n "revenue": $.products[?(@.category)].(@.price * @.quantity * (1 - $.discount / 100)).sum()\n }]\n}',
);
});
});
27 changes: 17 additions & 10 deletions src/translator.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -310,17 +310,21 @@ export class JsonTemplateTranslator {
code.push(JsonTemplateTranslator.covertToArrayValue(data));
if (
JsonTemplateTranslator.isArrayFilterExpr(expr.parts[partNum]) ||
JsonTemplateTranslator.isAllFilterExpr(expr.parts[partNum]) ||
JsonTemplateTranslator.isToArray(expr, partNum)
) {
code.push(`${data} = [${data}];`);
}
return code.join('');
}

static isAllFilterExpr(expr: Expression): boolean {
return (
expr.type === SyntaxType.OBJECT_FILTER_EXPR && expr.filter.type === SyntaxType.ALL_FILTER_EXPR
);
}

private translatePathParts(expr: PathExpression, dest: string): string {
if (!expr.parts.length) {
return '';
}
const { parts } = expr;
const code: string[] = [];
const numParts = parts.length;
Expand Down Expand Up @@ -384,8 +388,9 @@ export class JsonTemplateTranslator {
}
const code: string[] = [];
code.push(this.translatePathRoot(expr, dest, ctx));
code.push(this.translatePathParts(expr, dest));
if (expr.returnAsArray && expr.parts.length === 0) {
if (expr.parts.length > 0) {
code.push(this.translatePathParts(expr, dest));
} else if (expr.returnAsArray) {
code.push(JsonTemplateTranslator.covertToArrayValue(dest));
}
return code.join('');
Expand Down Expand Up @@ -786,11 +791,13 @@ export class JsonTemplateTranslator {
ctx: string,
): string {
const code: string[] = [];
const condition = this.acquireVar();
code.push(JsonTemplateTranslator.generateAssignmentCode(condition, 'true'));
code.push(this.translateExpr(expr.filter, condition, ctx));
code.push(`if(!${condition}) {${dest} = undefined;}`);
this.releaseVars(condition);
if (expr.filter.type !== SyntaxType.ALL_FILTER_EXPR) {
const condition = this.acquireVar();
code.push(JsonTemplateTranslator.generateAssignmentCode(condition, 'true'));
code.push(this.translateExpr(expr.filter, condition, ctx));
code.push(`if(!${condition}) {${dest} = undefined;}`);
this.releaseVars(condition);
}
return code.join('');
}

Expand Down
2 changes: 1 addition & 1 deletion src/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -284,7 +284,7 @@ export type FlatMappingPaths = {
};

export type FlatMappingAST = FlatMappingPaths & {
inputExpr: PathExpression;
inputExpr: Expression;
outputExpr: PathExpression;
};

Expand Down
Loading
Loading