Files
directus/app/src/utils/query-to-gql-string.ts
Rijk van Zanten 2983e61870 The Great TypeScript Modernization Program Season 3 Episode 6: The Big One (#18014)
* Step 1

* Step 2

* False sense of confidence

* Couple more before dinner

* Update schema package

* Update format-title

* Upgrade specs file

* Close

* Replace ts-node-dev with tsx, and various others

* Replace lodash with lodash-es

* Add lodash-es types

* Update knex import

* More fun is had

* FSE

* Consolidate repos

* Various tweaks and fixes

* Fix specs

* Remove dependency on knex-schema-inspector

* Fix wrong imports of inspector

* Move shared exceptions to new package

* Move constants to separate module

* Move types to new types package

* Use directus/types

* I believe this is no longer needed

* [WIP] Start moving utils to esm

* ESMify Shared

* Move shared utils to  @directus/utils

* Use @directus/utils instead of @directus/shared/utils

* It runs!

* Use correct schemaoverview type

* Fix imports

* Fix the thing

* Start on new update-checker lib

* Use new update-check package

* Swap out directus/shared in app

* Pushing through the last bits now

* Dangerously make extensions SDK ESM

* Use @directus/types in tests

* Copy util function to test

* Fix linter config

* Add missing import

* Hot takes

* Fix build

* Curse these default exports

* No tests in constants

* Add tests

* Remove tests from types

* Add tests for exceptions

* Fix test

* Fix app tests

* Fix import in test

* Fix various tests

* Fix specs export

* Some more tests

* Remove broken integration tests

These were broken beyond repair.. They were also written before we really knew what we we're doing with tests, so I think it's better to say goodbye and start over with these

* Regenerate lockfile

* Fix imports from merge

* I create my own problems

* Make sharp play nice

* Add vitest config

* Install missing blackbox dep

* Consts shouldn't be in types

tsk tsk tsk tsk

* Fix type/const usage in extensions-sdk

* cursed.default

* Reduce circular deps

* Fix circular dep in items service

* vvv

* Trigger testing for all vendors

* Add workaround for rollup

* Prepend the file protocol for the ESM loader to be compatible with Windows
"WARN: Only URLs with a scheme in: file and data are supported by the default ESM loader. On Windows, absolute paths must be valid file:// URLs. Received protocol 'c:'"

* Fix postgres

* Schema package updates

Co-authored-by: Azri Kahar <42867097+azrikahar@users.noreply.github.com>

* Resolve cjs/mjs extensions

* Clean-up eslint config

* fixed extension concatination

* using string interpolation for consistency

* Revert MySQL optimisation

* Revert testing for all vendors

* Replace tsx with esbuild-kit/esm-loader

Is a bit faster and we can rely on the built-in `watch` and `inspect`
functionalities of Node.js

Note: The possibility to watch other files (.env in our case) might be
added in the future, see https://github.com/nodejs/node/issues/45467

* Use exact version for esbuild-kit/esm-loader

* Fix import

---------

Co-authored-by: ian <licitdev@gmail.com>
Co-authored-by: Brainslug <tim@brainslug.nl>
Co-authored-by: Azri Kahar <42867097+azrikahar@users.noreply.github.com>
Co-authored-by: Pascal Jufer <pascal-jufer@bluewin.ch>
2023-04-04 17:41:56 -04:00

101 lines
2.8 KiB
TypeScript

import { useFieldsStore } from '@/stores/fields';
import { Filter, Query } from '@directus/types';
import { parseJSON, toArray } from '@directus/utils';
import { jsonToGraphQLQuery } from 'json-to-graphql-query';
import { isEmpty, pick, set, omitBy, isUndefined, transform } from 'lodash';
import { extractFieldFromFunction } from './extract-field-from-function';
type QueryInfo = { collection: string; key: string; query: Query };
export function queryToGqlString(queries: QueryInfo | QueryInfo[]): string | null {
if (!queries || isEmpty(queries)) return null;
const queryJSON: Record<string, any> = {
query: {},
};
for (const query of toArray(queries)) {
queryJSON.query[query.key] = formatQuery(query);
}
return jsonToGraphQLQuery(queryJSON);
}
export function formatQuery({ collection, query }: QueryInfo): Record<string, any> {
const queryKeysInArguments: (keyof Query)[] = ['limit', 'sort', 'filter', 'offset', 'page', 'search'];
const alias = collection.startsWith('directus_') ? collection.substring(9) : collection;
const formattedQuery: Record<string, any> = {
__args: omitBy(pick(query, ...queryKeysInArguments), isUndefined),
__aliasFor: alias,
};
const fields = query.fields ?? [useFieldsStore().getPrimaryKeyFieldForCollection(collection)!.field];
if (query?.aggregate && !isEmpty(query.aggregate)) {
formattedQuery.__aliasFor = alias + '_aggregated';
for (const [aggregateFunc, fields] of Object.entries(query.aggregate)) {
if (!formattedQuery[aggregateFunc]) {
formattedQuery[aggregateFunc] = {};
}
fields.forEach((field) => {
formattedQuery[aggregateFunc][field] = true;
});
}
if (query.group) {
formattedQuery.group = true;
formattedQuery.__args.groupBy = query.group;
}
} else {
for (const field of fields) {
set(formattedQuery, field, true);
}
}
if (query.deep) {
// TBD @TODO
}
if (query.filter) {
try {
const filterValue = typeof query.filter === 'object' ? query.filter : parseJSON(String(query.filter));
formattedQuery.__args.filter = replaceFuncs(filterValue);
} catch {
// Keep current value there
}
}
return formattedQuery;
}
/**
* Replace functions from Directus-Filter format to GraphQL format
*/
function replaceFuncs(filter?: Filter | null): null | undefined | Filter {
if (!filter) return filter;
return replaceFuncDeep(filter);
function replaceFuncDeep(filter: Record<string, any>) {
return transform(filter, (result: Record<string, any>, value, key) => {
if (typeof key === 'string' && key.includes('(') && key.includes(')')) {
const { fn, field } = extractFieldFromFunction(key);
if (fn) {
result[`${field}_func`] = {
[fn]: value,
};
} else {
result[key] = value;
}
} else {
result[key] = value?.constructor === Object || value?.constructor === Array ? replaceFuncDeep(value) : value;
}
});
}
}