yujunjun/strapi
1
0
Fork 0
mirror of https://github.com/strapi/strapi.git synced 2025-09-25 08:19:07 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore: Add comments on why the GraphQL regex is needed in core right now

Browse Source
This commit is contained in:
Gustav Hansen 2022-07-12 17:38:15 +02:00
parent 1973fb57f6
commit f880614ad8
2 changed files with 24 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
packages/core/content-type-builder/admin/src/components/FormModal/attributes/types.js
View File

@ -131,7 +131,18 @@ const types = {
return yup.object(shape);
},
enumeration: (usedAttributeNames, reservedNames) => {
// See GraphQL Spec https://spec.graphql.org/June2018/#sec-Names
/**
* For enumerations the least common denomiator is GraphQL, where
* values needs to match the secure name regex:
* GraphQL Spec https://spec.graphql.org/June2018/#sec-Names
*
* Therefore we need to make sure our users only use values, which
* can be returned by GraphQL, by checking the regressed values
* agains the GraphQL regex.
*
* TODO V5: check if we can avoid this coupling by moving this logic
* into the GraphQL plugin.
*/
const GRAPHQL_ENUM_REGEX = new RegExp('^[_A-Za-z][_0-9A-Za-z]*$');
const shape = {

13
packages/core/strapi/lib/core/domain/content-type/validator.js
View File

@ -24,7 +24,18 @@ const LIFECYCLES = [
'afterDeleteMany',
];
// See GraphQL Spec https://spec.graphql.org/June2018/#sec-Names
/**
* For enumerations the least common denomiator is GraphQL, where
* values needs to match the secure name regex:
* GraphQL Spec https://spec.graphql.org/June2018/#sec-Names
*
* Therefore we need to make sure our users only use values, which
* can be returned by GraphQL, by checking the regressed values
* agains the GraphQL regex.
*
* TODO V5: check if we can avoid this coupling by moving this logic
* into the GraphQL plugin.
*/
const GRAPHQL_ENUM_REGEX = new RegExp('^[_A-Za-z][_0-9A-Za-z]*$');
const lifecyclesShape = _.mapValues(_.keyBy(LIFECYCLES), () =>