Skip to content

Update: Allow parameters in elide filters #1295

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

Merged
kevinhinterlong merged 2 commits into from
Mar 23, 2021
Merged

Update: Allow parameters in elide filters #1295

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
13bae50
Update: Allow parameters in elide filters
Mar 18, 2021
1873bae
Update: Fix Elide filter param format
Mar 19, 2021
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
24 changes: 18 additions & 6 deletions packages/data/addon/adapters/facts/elide.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ import { omitBy } from 'lodash-es';
const escape = (value: string) => value.replace(/'/g, "\\\\'");

/**
* Formats elide request field
* Formats elide request field as `col(param1:"val1", param2:"val2")`
*/
export function getElideField(fieldName: string, parameters: Parameters = {}, alias?: string) {
const aliasStr = alias ? `${alias}:` : '';
Expand All @@ -50,6 +50,20 @@ export function getElideField(fieldName: string, parameters: Parameters = {}, al
return `${aliasStr}${field}${paramsStr}`;
}

/**
* Formats elide filter field as `col[param1:val1][param2:val2]`
*/
export function getElideFilterField(fieldName: string, parameters: Parameters = {}) {
const parts = fieldName.split('.');
const field = parts[parts.length - 1];

const paramsStr = Object.entries(parameters)
.map(([param, val]) => `[${param}:${val}]`)
.join('');

return `${field}${paramsStr}`;
}

export default class ElideFactsAdapter extends EmberObject implements NaviFactAdapter {
/**
* @property {Object} apollo - apollo client query manager using the overridden elide service
Expand Down Expand Up @@ -110,7 +124,7 @@ export default class ElideFactsAdapter extends EmberObject implements NaviFactAd
nbet: (f, v) => `${f}=lt=('${v[0]}'),${f}=gt=('${v[1]}')`,
};

private buildFilterStr(filters: Filter[], canonicalToAlias: Record<string, string>, dataSourceName: string): string {
private buildFilterStr(filters: Filter[], canonicalToAlias: Record<string, string>): string {
const filterStrings = filters.map((filter) => {
const { field, parameters, operator, values, type } = filter;

Expand All @@ -124,9 +138,7 @@ export default class ElideFactsAdapter extends EmberObject implements NaviFactAd
if (canonicalToAlias[canonicalName]) {
fieldStr = canonicalToAlias[canonicalName];
} else {
this.assertAllDefaultParams(filter, dataSourceName);
// TODO: Non default Parameters cannot be specified in filters yet
fieldStr = getElideField(field, {});
fieldStr = getElideFilterField(field, parameters);
}
let filterVals = values.map((v) => escape(`${v}`));

Expand Down Expand Up @@ -177,7 +189,7 @@ export default class ElideFactsAdapter extends EmberObject implements NaviFactAd
})
.join(' ');

const filterString = this.buildFilterStr(filters, columnCanonicalToAlias, request.dataSource);
const filterString = this.buildFilterStr(filters, columnCanonicalToAlias);
filterString.length && args.push(`filter: "${filterString}"`);

const sortStrings = sorts.map((sort) => {
Expand Down
46 changes: 19 additions & 27 deletions packages/data/tests/unit/adapters/facts/elide-test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ module('Unit | Adapter | facts/elide', function (hooks) {
const queryStr = adapter['dataQueryFromRequest'](TestRequest);
assert.equal(
queryStr,
`{"query":"{ table1(filter: \\"d3=in=('v1','v2');d4=in=('v3','v4');d5=isnull=true;time=ge=('2015-01-03');time=lt=('2015-01-04');col0=gt=('0')\\",sort: \\"col3\\",first: \\"10000\\") { edges { node { col0:m1 col1:m2 col2:r(p:\\"123\\") col3:d1 col4:d2 } } } }"}`,
`{"query":"{ table1(filter: \\"d3=in=('v1','v2');d4=in=('v3','v4');d5=isnull=true;time[grain:day]=ge=('2015-01-03');time[grain:day]=lt=('2015-01-04');col0=gt=('0')\\",sort: \\"col3\\",first: \\"10000\\") { edges { node { col0:m1 col1:m2 col2:r(p:\\"123\\") col3:d1 col4:d2 } } } }"}`,
'dataQueryFromRequestV2 returns the correct query string for the given request V2'
);

Expand Down Expand Up @@ -300,7 +300,7 @@ module('Unit | Adapter | facts/elide', function (hooks) {
const expectedColumns = TestRequest.columns
.map((c, idx) => getElideField(c.field, c.parameters, `col${idx}`))
.join(' ');
const expectedArgs = `(filter: "d3=in=('v1','v2');d4=in=('v3','v4');d5=isnull=true;time=ge=('2015-01-03');time=lt=('2015-01-04');col0=gt=('0')",sort: "col3",first: "10000")`;
const expectedArgs = `(filter: "d3=in=('v1','v2');d4=in=('v3','v4');d5=isnull=true;time[grain:day]=ge=('2015-01-03');time[grain:day]=lt=('2015-01-04');col0=gt=('0')",sort: "col3",first: "10000")`;

assert.equal(
requestObj.variables.query.replace(/[ \t\r\n]+/g, ' '),
Expand Down Expand Up @@ -581,7 +581,7 @@ module('Unit | Adapter | facts/elide', function (hooks) {
//test all of the escaped functionalities and verify them in the below assert
assert.equal(
queryStr,
`{"query":"{ table1(filter: \\"d6=in=('with, comma','no comma');d7=in=('with \\"quote\\"','but why');d8=in=('okay','with \\\\\\\\'single quote\\\\\\\\'')\\",sort: \\"d1\\",first: \\"10000\\") { edges { node { } } } }"}`,
`{"query":"{ table1(filter: \\"d6[field:id]=in=('with, comma','no comma');d7[field:id]=in=('with \\"quote\\"','but why');d8[field:id]=in=('okay','with \\\\\\\\'single quote\\\\\\\\'')\\",sort: \\"d1\\",first: \\"10000\\") { edges { node { } } } }"}`,
'dataQueryFromRequestV2 returns the correct query string with escaped quotes and commas for the given request V2'
);
});
Expand All @@ -605,7 +605,7 @@ module('Unit | Adapter | facts/elide', function (hooks) {
},
];
assert.equal(
adapter['buildFilterStr'](filters, { 'table1.dim1(p=q)': 'col1' }, 'elideData'),
adapter['buildFilterStr'](filters, { 'table1.dim1(p=q)': 'col1' }),
"col1=in=('*v1*');dim1=in=('*v2*')",
'`buildFilterStr` builds correct filter string for an aliased column'
);
Expand All @@ -623,7 +623,7 @@ module('Unit | Adapter | facts/elide', function (hooks) {
},
];
assert.equal(
adapter['buildFilterStr'](filters, {}, 'elideData'),
adapter['buildFilterStr'](filters, {}),
"dim1=in=('*v1*')",
'`buildFilterStr` builds correct filter string for a `contains` filter'
);
Expand All @@ -638,7 +638,7 @@ module('Unit | Adapter | facts/elide', function (hooks) {
},
];
assert.equal(
adapter['buildFilterStr'](escapedFilter, {}, 'elideData'),
adapter['buildFilterStr'](escapedFilter, {}),
"dim1=in=('*\\\\'*')",
'`buildFilterStr` builds correct filter string for a `contains` filter and escaped value'
);
Expand All @@ -656,7 +656,7 @@ module('Unit | Adapter | facts/elide', function (hooks) {
},
];
assert.equal(
adapter['buildFilterStr'](noValues, {}, 'elideData'),
adapter['buildFilterStr'](noValues, {}),
'',
'`buildFilterStr` returns an empty string if no filters have values'
);
Expand All @@ -678,7 +678,7 @@ module('Unit | Adapter | facts/elide', function (hooks) {
},
];
assert.equal(
adapter['buildFilterStr'](someValues, {}, 'elideData'),
adapter['buildFilterStr'](someValues, {}),
"dim2==('1')",
'`buildFilterStr` filters out filters with empty values'
);
Expand All @@ -702,31 +702,23 @@ module('Unit | Adapter | facts/elide', function (hooks) {
values: ['test'],
},
];
assert.throws(
() => adapter['buildFilterStr'](noValues, {}, 'elideData'),
/FactAdapterError: Parameters are not supported in elide unles table1.dim1\(param=val\) is added as a column./,
'`buildFilterStr` throws an error when there is no alias if non-default params are used'
assert.deepEqual(
adapter['buildFilterStr'](noValues, {}),
"dim1[param:val]=in=('*test*')",
'`buildFilterStr` returns a filter when there is no alias if params are used'
);

DefaultParams = { param: 'notval' };
assert.throws(
() => adapter['buildFilterStr'](noValues, {}, 'elideData'),
/FactAdapterError: Parameters are not supported in elide unles table1.dim1\(param=val\) is added as a column./,
'`buildFilterStr` throws an error when there is no alias if non-default params are used'
);

assert.deepEqual(
adapter['buildFilterStr'](noValues, { 'table1.dim1(param=val)': 'col1' }, 'elideData'),
`col1=in=('*test*')`,
'`buildFilterStr` returns alias if available when there are non-default params'
adapter['buildFilterStr'](noValues, {}),
"dim1[param:val]=in=('*test*')",
'`buildFilterStr` returns a filter when there is no alias if non-default params are used'
);

DefaultParams = { param: 'val' };

assert.deepEqual(
adapter['buildFilterStr'](noValues, {}, 'elideData'),
`dim1=in=('*test*')`,
'`buildFilterStr` returns a filter with no parameters when all are default'
adapter['buildFilterStr'](noValues, { 'table1.dim1(param=val)': 'col1' }),
`col1=in=('*test*')`,
'`buildFilterStr` returns alias if available'
);
});

Expand All @@ -735,7 +727,7 @@ module('Unit | Adapter | facts/elide', function (hooks) {
const adapter: ElideFactsAdapter = this.owner.lookup('adapter:facts/elide');
assert.equal(
decodeURIComponent(adapter.urlForFindQuery(TestRequest, {})),
`{"query":"{ table1(filter: \\"d3=in=('v1','v2');d4=in=('v3','v4');d5=isnull=true;time=ge=('2015-01-03');time=lt=('2015-01-04');col0=gt=('0')\\",sort: \\"col3\\",first: \\"10000\\") { edges { node { col0:m1 col1:m2 col2:r(p:\\"123\\") col3:d1 col4:d2 } } } }"}`,
`{"query":"{ table1(filter: \\"d3=in=('v1','v2');d4=in=('v3','v4');d5=isnull=true;time[grain:day]=ge=('2015-01-03');time[grain:day]=lt=('2015-01-04');col0=gt=('0')\\",sort: \\"col3\\",first: \\"10000\\") { edges { node { col0:m1 col1:m2 col2:r(p:\\"123\\") col3:d1 col4:d2 } } } }"}`,
'urlForFindQuery correctly built the query for the provided request'
);
});
Expand Down