@strapi/plugin-graphql 4.0.0-beta.12 → 4.0.0-beta.16

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@strapi/plugin-graphql",
-  "version": "4.0.0-beta.12",
+  "version": "4.0.0-beta.16",
   "description": "Adds GraphQL endpoint with default API methods.",
   "strapi": {
     "displayName": "GraphQL",
     "name": "graphql",
-    "description": "graphql.plugin.description",
+    "description": "Adds GraphQL endpoint with default API methods.",
     "kind": "plugin"
   },
   "scripts": {
@@ -15,7 +15,7 @@
     "@apollo/federation": "^0.28.0",
     "@graphql-tools/schema": "8.1.2",
     "@graphql-tools/utils": "^8.0.2",
-    "@strapi/utils": "4.0.0-beta.12",
+    "@strapi/utils": "4.0.0-beta.16",
     "apollo-server-core": "3.1.2",
     "apollo-server-koa": "3.1.2",
     "glob": "^7.1.7",
@@ -29,7 +29,8 @@
     "koa-compose": "^4.1.0",
     "lodash": "4.17.21",
     "nexus": "1.1.0",
-    "pluralize": "^8.0.0"
+    "pluralize": "^8.0.0",
+    "subscriptions-transport-ws": "0.9.19"
   },
   "devDependencies": {
     "cross-env": "^7.0.3",
@@ -52,5 +53,5 @@
     "npm": ">=6.0.0"
   },
   "license": "SEE LICENSE IN LICENSE",
-  "gitHead": "67fee6f3d59df974e8770bb123549f972edda905"
+  "gitHead": "71bdfa34637832e8e78a6cf1b57c8c6dbadf133d"
 }

package/server/bootstrap.js

@@ -1,6 +1,8 @@
 'use strict';
 
 const { isEmpty, mergeWith, isArray } = require('lodash/fp');
+const { execute, subscribe } = require('graphql');
+const { SubscriptionServer } = require('subscriptions-transport-ws');
 const { ApolloServer } = require('apollo-server-koa');
 const {
   ApolloServerPluginLandingPageDisabled,
@@ -31,6 +33,8 @@ module.exports = async ({ strapi }) => {
 
   const { config } = strapi.plugin('graphql');
 
+  const path = config('endpoint');
+
   const defaultServerConfig = {
     // Schema
     schema,
@@ -59,14 +63,29 @@ module.exports = async ({ strapi }) => {
     ],
   };
 
-  const serverConfig = merge(defaultServerConfig, config('apolloServer', {}));
+  const serverConfig = merge(defaultServerConfig, config('apolloServer'));
+
+  // Handle subscriptions
+  if (config('subscriptions')) {
+    const subscriptionServer = SubscriptionServer.create(
+      { schema, execute, subscribe },
+      { server: strapi.server.httpServer, path }
+    );
+
+    serverConfig.plugins.push({
+      async serverWillStart() {
+        return {
+          async drainServer() {
+            subscriptionServer.close();
+          },
+        };
+      },
+    });
+  }
 
   // Create a new Apollo server
   const server = new ApolloServer(serverConfig);
 
-  // Link the Apollo server & the Strapi app
-  const path = config('endpoint', '/graphql');
-
   // Register the upload middleware
   useUploadMiddleware(strapi, path);
 
@@ -77,6 +96,7 @@ module.exports = async ({ strapi }) => {
     strapi.log.error('Failed to start the Apollo server', e.message);
   }
 
+  // Link the Apollo server & the Strapi app
   strapi.server.routes([
     {
       method: 'ALL',

package/server/config/default-config.js

@@ -0,0 +1,13 @@
+'use strict';
+
+module.exports = {
+  shadowCRUD: true,
+
+  endpoint: '/graphql',
+
+  subscriptions: false,
+
+  maxLimit: -1,
+
+  apolloServer: {},
+};

package/server/config/index.js

@@ -0,0 +1,7 @@
+'use strict';
+
+const defaultConfig = require('./default-config');
+
+module.exports = {
+  default: defaultConfig,
+};

package/server/services/builders/filters/content-type.js

@@ -13,7 +13,7 @@ module.exports = ({ strapi }) => {
     const utils = strapi.plugin('graphql').service('utils');
     const extension = strapi.plugin('graphql').service('extension');
 
-    const { getFiltersInputTypeName } = utils.naming;
+    const { getFiltersInputTypeName, getScalarFilterInputTypeName } = utils.naming;
     const { isStrapiScalar, isRelation } = utils.attributes;
 
     const { attributes } = contentType;
@@ -31,6 +31,15 @@ module.exports = ({ strapi }) => {
             .hasFiltersEnabeld()
         );
 
+        const isIDFilterEnabled = extension
+          .shadowCRUD(contentType.uid)
+          .field('id')
+          .hasFiltersEnabeld();
+        // Add an ID filter to the collection types
+        if (contentType.kind === 'collectionType' && isIDFilterEnabled) {
+          t.field('id', { type: getScalarFilterInputTypeName('ID') });
+        }
+
         // Add every defined attribute
         for (const [attributeName, attribute] of validAttributes) {
           // Handle scalars

package/server/services/builders/input.js

@@ -1,6 +1,9 @@
 'use strict';
 
 const { inputObjectType, nonNull } = require('nexus');
+const {
+  contentTypes: { isWritableAttribute },
+} = require('@strapi/utils');
 
 module.exports = context => {
   const { strapi } = context;
@@ -45,9 +48,9 @@ module.exports = context => {
               .hasInputEnabled();
           };
 
-          const validAttributes = Object.entries(attributes).filter(([attributeName]) =>
-            isFieldEnabled(attributeName)
-          );
+          const validAttributes = Object.entries(attributes).filter(([attributeName]) => {
+            return isWritableAttribute(contentType, attributeName) && isFieldEnabled(attributeName);
+          });
 
           // Add the ID for the component to enable inplace updates
           if (modelType === 'component' && isFieldEnabled('id')) {

package/server/services/builders/resolvers/association.js

@@ -4,7 +4,7 @@ const { get } = require('lodash/fp');
 
 const utils = require('@strapi/utils');
 
-const { sanitize } = utils;
+const { sanitize, pipeAsync } = utils;
 const { ApplicationError } = utils.errors;
 
 module.exports = ({ strapi }) => {
@@ -65,11 +65,7 @@ module.exports = ({ strapi }) => {
           const unwrapData = get(attributeName);
 
           // Sanitizer definition
-          const sanitizeMorphAttribute = sanitize.utils.pipeAsync(
-            wrapData,
-            sanitizeData,
-            unwrapData
-          );
+          const sanitizeMorphAttribute = pipeAsync(wrapData, sanitizeData, unwrapData);
 
           return sanitizeMorphAttribute(data);
         }

package/server/services/builders/resolvers/component.js

@@ -5,8 +5,12 @@ module.exports = ({ strapi }) => ({
     const { transformArgs } = strapi.plugin('graphql').service('builders').utils;
 
     return async (parent, args = {}) => {
-      const contentType = strapi.contentTypes[contentTypeUID];
-      const transformedArgs = transformArgs(args, { contentType, usePagination: true });
+      const contentType = strapi.getModel(contentTypeUID);
+
+      const { component: componentName } = contentType.attributes[attributeName];
+      const component = strapi.getModel(componentName);
+
+      const transformedArgs = transformArgs(args, { contentType: component, usePagination: true });
 
       return strapi.entityService.load(contentTypeUID, parent, attributeName, transformedArgs);
     };

package/server/services/builders/type.js

@@ -66,7 +66,7 @@ module.exports = context => {
       strapi,
     });
 
-    const args = getContentTypeArgs(targetComponent);
+    const args = getContentTypeArgs(targetComponent, { multiple: !!attribute.repeatable });
 
     builder.field(attributeName, { type, resolve, args });
   };
@@ -150,12 +150,6 @@ module.exports = context => {
     const type = attribute.multiple
       ? naming.getRelationResponseCollectionName(fileContentType)
       : naming.getEntityResponseName(fileContentType);
-    const resolverPath = `${naming.getTypeName(contentType)}.${attributeName}`;
-    const resolverAuthScope = `${fileUID}.find`;
-
-    extension.use({
-      resolversConfig: { [resolverPath]: { auth: { scope: [resolverAuthScope] } } },
-    });
 
     builder.field(attributeName, { type, resolve, args });
   };
@@ -275,10 +269,9 @@ module.exports = context => {
         isRelation,
       } = utils.attributes;
 
-      const { attributes, modelType, options = {} } = contentType;
+      const { attributes, modelType } = contentType;
 
       const attributesKey = Object.keys(attributes);
-      const hasTimestamps = isArray(options.timestamps);
 
       const name = (modelType === 'component' ? getComponentName : getTypeName).call(
         null,
@@ -293,17 +286,7 @@ module.exports = context => {
             t.nonNull.id('id');
           }
 
-          // 1. Timestamps
-          // If the content type has timestamps enabled
-          // then we should add the corresponding attributes in the definition
-          if (hasTimestamps) {
-            const [createdAtKey, updatedAtKey] = contentType.options.timestamps;
-
-            t.nonNull.dateTime(createdAtKey);
-            t.nonNull.dateTime(updatedAtKey);
-          }
-
-          /** 2. Attributes
+          /** Attributes
            *
            * Attributes can be of 7 different kind:
            * - Scalar

package/server/services/builders/utils.js

@@ -25,6 +25,8 @@ module.exports = ({ strapi }) => {
 
       // Components
       if (modelType === 'component') {
+        if (!multiple) return {};
+
         return {
           filters: naming.getFiltersInputTypeName(contentType),
           pagination: args.PaginationArg,
@@ -96,6 +98,7 @@ module.exports = ({ strapi }) => {
      */
     transformArgs(args, { contentType, usePagination = false } = {}) {
       const { mappers } = getService('utils');
+      const { config } = strapi.plugin('graphql');
       const { pagination = {}, filters = {} } = args;
 
       // Init
@@ -103,8 +106,8 @@ module.exports = ({ strapi }) => {
 
       // Pagination
       if (usePagination) {
-        const defaultLimit = strapi.plugin('graphql').config('defaultLimit');
-        const maxLimit = strapi.plugin('graphql').config('maxLimit', -1);
+        const defaultLimit = config('defaultLimit');
+        const maxLimit = config('maxLimit');
 
         Object.assign(
           newArgs,

package/server/services/content-api/index.js

@@ -5,6 +5,7 @@ const {
   makeExecutableSchema,
   addResolversToSchema,
 } = require('@graphql-tools/schema');
+const { pruneSchema } = require('@graphql-tools/utils');
 const { makeSchema } = require('nexus');
 const { prop, startsWith } = require('lodash/fp');
 
@@ -37,7 +38,7 @@ module.exports = ({ strapi }) => {
   let builders;
 
   const buildSchema = () => {
-    const isShadowCRUDEnabled = !!config('shadowCRUD', true);
+    const isShadowCRUDEnabled = !!config('shadowCRUD');
 
     // Create a new empty type registry
     registry = getGraphQLService('type-registry').new();
@@ -71,7 +72,11 @@ module.exports = ({ strapi }) => {
     // Wrap resolvers if needed (auth, middlewares, policies...) as configured in the extension
     const wrappedSchema = wrapResolvers({ schema, strapi, extension });
 
-    return wrappedSchema;
+    // Prune schema, remove unused types
+    // eg: removes registered subscriptions if they're disabled in the config)
+    const prunedSchema = pruneSchema(wrappedSchema);
+
+    return prunedSchema;
   };
 
   const buildSchemas = ({ registry }) => {

package/server/services/content-api/wrap-resolvers.js

@@ -33,8 +33,6 @@ const wrapResolvers = ({ schema, strapi, extension = {} }) => {
 
   const typeMap = schema.getTypeMap();
 
-  // Iterate over every field from every type within the
-  // schema's type map and wrap its resolve attribute if needed
   Object.entries(typeMap).forEach(([type, definition]) => {
     const isGraphQLObjectType = definition instanceof GraphQLObjectType;
     const isIgnoredType = introspectionQueries.includes(type);
@@ -82,12 +80,12 @@ const wrapResolvers = ({ schema, strapi, extension = {} }) => {
         const authConfig = get('auth', resolverConfig);
         const authContext = get('state.auth', context);
 
-        const isMutationOrQuery = ['Mutation', 'Query'].includes(type);
+        const isValidType = ['Mutation', 'Query', 'Subscription'].includes(type);
         const hasConfig = !isNil(authConfig);
 
         const isAuthDisabled = authConfig === false;
 
-        if ((isMutationOrQuery || hasConfig) && !isAuthDisabled) {
+        if ((isValidType || hasConfig) && !isAuthDisabled) {
           try {
             await strapi.auth.verify(authContext, authConfig);
           } catch (error) {

package/server/services/utils/mappers/graphql-filters-to-strapi-query.js

@@ -1,6 +1,6 @@
 'use strict';
 
-const { has, propEq, isNil } = require('lodash/fp');
+const { has, propEq, isNil, isDate, isObject } = require('lodash/fp');
 
 // todo[v4]: Find a way to get that dynamically
 const virtualScalarAttributes = ['id'];
@@ -15,7 +15,9 @@ module.exports = ({ strapi }) => {
       return data.map(recursivelyReplaceScalarOperators);
     }
 
-    if (typeof data !== 'object') {
+    // Note: We need to make an exception for date since GraphQL
+    // automatically cast date strings to date instances in args
+    if (isDate(data) || !isObject(data)) {
       return data;
     }
 

package/strapi-server.js

@@ -2,9 +2,11 @@
 
 const bootstrap = require('./server/bootstrap');
 const services = require('./server/services');
+const config = require('./server/config');
 
 module.exports = (/* strapi, config */) => {
   return {
+    config,
     bootstrap,
     services,
   };