refactor(api-apw): remove unnecessary cms code

apps/api/graphql/src/index.ts

@@ -22,11 +22,7 @@ import logsPlugins from "@webiny/handler-logs";
 import fileManagerS3 from "@webiny/api-file-manager-s3";
 import { createFormBuilder } from "@webiny/api-form-builder";
 import { createFormBuilderStorageOperations } from "@webiny/api-form-builder-so-ddb";
-import {
-    createHeadlessCmsGraphQL,
-    createHeadlessCmsContext,
-    createGraphQLFields
-} from "@webiny/api-headless-cms";
+import { createHeadlessCmsGraphQL, createHeadlessCmsContext } from "@webiny/api-headless-cms";
 import { createStorageOperations as createHeadlessCmsStorageOperations } from "@webiny/api-headless-cms-ddb";
 import securityPlugins from "./security";
 import tenantManager from "@webiny/api-tenant-manager";
@@ -79,13 +75,12 @@ export const handler = createHandler({
                 documentClient
             })
         }),
-        createHeadlessCmsGraphQL(),
         createHeadlessCmsContext({
             storageOperations: createHeadlessCmsStorageOperations({
-                documentClient,
-                modelFieldToGraphQLPlugins: createGraphQLFields()
+                documentClient
             })
         }),
+        createHeadlessCmsGraphQL(),
         createApwGraphQL(),
         createApwPageBuilderContext({
             storageOperations: createApwSaStorageOperations({ documentClient })

apps/api/headlessCMS/src/index.ts

@@ -7,11 +7,7 @@ import dbPlugins from "@webiny/handler-db";
 import { DynamoDbDriver } from "@webiny/db-dynamodb";
 import dynamoDbPlugins from "@webiny/db-dynamodb/plugins";
 import securityPlugins from "./security";
-import {
-    createHeadlessCmsContext,
-    createHeadlessCmsGraphQL,
-    createGraphQLFields
-} from "@webiny/api-headless-cms";
+import { createHeadlessCmsContext, createHeadlessCmsGraphQL } from "@webiny/api-headless-cms";
 import { createStorageOperations as createHeadlessCmsStorageOperations } from "@webiny/api-headless-cms-ddb";
 import logsPlugins from "@webiny/handler-logs";
 /**
@@ -44,8 +40,7 @@ export const handler = createHandler({
         i18nDynamoDbStorageOperations(),
         createHeadlessCmsContext({
             storageOperations: createHeadlessCmsStorageOperations({
-                documentClient,
-                modelFieldToGraphQLPlugins: createGraphQLFields()
+                documentClient
             })
         }),
         createHeadlessCmsGraphQL({ debug }),

packages/api-apw/__tests__/utils/createHeadlessCmsGQLHandler.ts

@@ -17,11 +17,7 @@ import {
 import { Plugin, PluginCollection } from "@webiny/plugins/types";
 import { createApwHeadlessCmsContext, createApwGraphQL } from "~/index";
 import { createStorageOperations as createHeadlessCmsStorageOperations } from "@webiny/api-headless-cms-ddb";
-import {
-    createGraphQLFields,
-    createHeadlessCmsContext,
-    createHeadlessCmsGraphQL
-} from "@webiny/api-headless-cms";
+import { createHeadlessCmsContext, createHeadlessCmsGraphQL } from "@webiny/api-headless-cms";
 /**
  * Unfortunately at we need to import the api-i18n-ddb package manually
  */
@@ -111,8 +107,7 @@ export const createHeadlessCmsGQLHandler = (params: CreateHeadlessCmsGQLHandlerP
      */
     const headlessCmsApp = createHeadlessCmsContext({
         storageOperations: createHeadlessCmsStorageOperations({
-            documentClient,
-            modelFieldToGraphQLPlugins: createGraphQLFields()
+            documentClient
         })
     });
 

packages/api-apw/__tests__/utils/createPageBuilderGQLHandler.ts

@@ -18,11 +18,7 @@ import {
 import { Plugin, PluginCollection } from "@webiny/plugins/types";
 import { createApwPageBuilderContext, createApwGraphQL } from "~/index";
 import { createStorageOperations as createHeadlessCmsStorageOperations } from "@webiny/api-headless-cms-ddb";
-import {
-    createGraphQLFields,
-    createHeadlessCmsContext,
-    createHeadlessCmsGraphQL
-} from "@webiny/api-headless-cms";
+import { createHeadlessCmsContext, createHeadlessCmsGraphQL } from "@webiny/api-headless-cms";
 /**
  * Unfortunately at we need to import the api-i18n-ddb package manually
  */
@@ -111,8 +107,7 @@ export const createPageBuilderGQLHandler = (params: GQLHandlerCallableParams) =>
      */
     const headlessCmsApp = createHeadlessCmsContext({
         storageOperations: createHeadlessCmsStorageOperations({
-            documentClient,
-            modelFieldToGraphQLPlugins: createGraphQLFields()
+            documentClient
         })
     });
 

packages/api-apw/src/plugins/context.ts

@@ -1,12 +1,10 @@
 import apwHooks from "./hooks";
 import WebinyError from "@webiny/error";
-import { createHeadlessCmsContext } from "@webiny/api-headless-cms";
 import { ContextPlugin } from "@webiny/handler/plugins/ContextPlugin";
 import { ApwContext } from "~/types";
 import { createApw } from "~/crud";
 import { apwPageBuilderHooks } from "./pageBuilder";
 import { createStorageOperations } from "~/storageOperations";
-import { createManageCMSPlugin } from "~/plugins/createManageCMSPlugin";
 import { SecurityPermission } from "@webiny/api-security/types";
 import { Tenant } from "@webiny/api-tenancy/types";
 import { CreateApwContextParams } from "~/scheduler/types";
@@ -16,6 +14,7 @@ import { isInstallationPending } from "./utils";
 import { extendPbPageSettingsSchema } from "~/plugins/pageBuilder/extendPbPageSettingsSchema";
 import { apwContentPagePlugins } from "~/plugins/pageBuilder/apwContentPagePlugins";
 import { apwCmsHooks } from "~/plugins/cms";
+import { I18NLocale } from "@webiny/api-i18n/types";
 
 const setupApwContext = (params: CreateApwContextParams) =>
     new ContextPlugin<ApwContext>(async context => {
@@ -25,15 +24,7 @@ const setupApwContext = (params: CreateApwContextParams) =>
             return;
         }
 
-        const contentHeadlessCmsContextPlugins = createHeadlessCmsContext({
-            storageOperations: context.cms.storageOperations
-        });
-        /**
-         * Register cms plugins required by `api-apw` package.
-         */
-        context.plugins.register([createManageCMSPlugin(), ...contentHeadlessCmsContextPlugins]);
-
-        const getLocale = () => {
+        const getLocale = (): I18NLocale => {
             const locale = i18n.getContentLocale();
             if (!locale) {
                 throw new WebinyError(

packages/api-headless-cms-ddb-es/__tests__/__api__/environment.js

@@ -15,8 +15,6 @@ const {
 const {
     createElasticsearchClient
 } = require("@webiny/project-utils/testing/elasticsearch/createClient");
-
-const { createGraphQLFields } = require("@webiny/api-headless-cms");
 /**
  * For this to work it must load plugins that have already been built
  */
@@ -129,7 +127,6 @@ class CmsTestEnvironment extends NodeEnvironment {
                     return createStorageOperations({
                         documentClient,
                         elasticsearch: elasticsearchClient,
-                        modelFieldToGraphQLPlugins: createGraphQLFields(),
                         table: table => ({ ...table, name: process.env.DB_TABLE }),
                         esTable: table => ({ ...table, name: process.env.DB_TABLE_ELASTICSEARCH }),
                         plugins: testPlugins.concat([

packages/api-headless-cms-ddb-es/src/index.ts

@@ -21,6 +21,7 @@ import { getElasticsearchOperators } from "@webiny/api-elasticsearch/operators";
 import { elasticsearchFields as cmsEntryElasticsearchFields } from "~/operations/entry/elasticsearchFields";
 import { elasticsearchIndexPlugins } from "./elasticsearch/indices";
 import { deleteElasticsearchIndex } from "./elasticsearch/deleteElasticsearchIndex";
+import { CmsModelFieldToGraphQLPlugin } from "@webiny/api-headless-cms/types";
 
 export const createStorageOperations: StorageOperationsFactory = params => {
     const {
@@ -29,8 +30,7 @@ export const createStorageOperations: StorageOperationsFactory = params => {
         esTable,
         documentClient,
         elasticsearch,
-        plugins: userPlugins,
-        modelFieldToGraphQLPlugins
+        plugins: userPlugins
     } = params;
 
     const tableInstance = createTable({
@@ -83,7 +83,6 @@ export const createStorageOperations: StorageOperationsFactory = params => {
         /**
          * Plugins of type CmsModelFieldToGraphQLPlugin.
          */
-        modelFieldToGraphQLPlugins,
         /**
          * Elasticsearch field definitions for the entry record.
          */
@@ -112,13 +111,18 @@ export const createStorageOperations: StorageOperationsFactory = params => {
 
     return {
         beforeInit: async context => {
-            context.plugins.register([
-                /**
-                 * Field plugins for DynamoDB.
-                 * We must pass them to the base application.
-                 */
-                dynamoDbPlugins()
-            ]);
+            /**
+             * Collect all required plugins from parent context.
+             */
+            const fieldPlugins = context.plugins.byType<CmsModelFieldToGraphQLPlugin>(
+                "cms-model-field-to-graphql"
+            );
+            plugins.register(fieldPlugins);
+
+            /**
+             * Pass the plugins to the parent context.
+             */
+            context.plugins.register([dynamoDbPlugins()]);
         },
         init: async context => {
             /**

packages/api-headless-cms-ddb-es/src/types.ts

@@ -166,7 +166,6 @@ export interface StorageOperationsFactoryParams {
     elasticsearch: Client;
     table?: TableModifier;
     esTable?: TableModifier;
-    modelFieldToGraphQLPlugins: CmsModelFieldToGraphQLPlugin[];
     attributes?: Record<ENTITIES, Attributes>;
     plugins?: PluginCollection;
 }

packages/api-headless-cms-ddb/__tests__/__api__/environment.js

@@ -2,8 +2,6 @@ const dbPlugins = require("@webiny/handler-db").default;
 const { DynamoDbDriver } = require("@webiny/db-dynamodb");
 const { DocumentClient } = require("aws-sdk/clients/dynamodb");
 const NodeEnvironment = require("jest-environment-node");
-
-const { createGraphQLFields } = require("@webiny/api-headless-cms");
 /**
  * For this to work it must load plugins that have already been built
  */
@@ -47,7 +45,6 @@ class CmsTestEnvironment extends NodeEnvironment {
                     const { plugins: testPlugins = [] } = params;
                     return createStorageOperations({
                         documentClient,
-                        modelFieldToGraphQLPlugins: createGraphQLFields(),
                         table: table => ({ ...table, name: process.env.DB_TABLE }),
                         plugins: testPlugins
                     });

packages/api-headless-cms-ddb/src/index.ts

@@ -13,15 +13,10 @@ import { createSettingsStorageOperations } from "~/operations/settings";
 import { createGroupsStorageOperations } from "~/operations/group";
 import { createModelsStorageOperations } from "~/operations/model";
 import { createEntriesStorageOperations } from "./operations/entry";
+import { CmsModelFieldToGraphQLPlugin } from "@webiny/api-headless-cms/types";
 
 export const createStorageOperations: StorageOperationsFactory = params => {
-    const {
-        attributes,
-        table,
-        documentClient,
-        plugins: userPlugins,
-        modelFieldToGraphQLPlugins
-    } = params;
+    const { attributes, table, documentClient, plugins: userPlugins } = params;
 
     const tableInstance = createTable({
         table,
@@ -61,10 +56,6 @@ export const createStorageOperations: StorageOperationsFactory = params => {
          * User defined custom plugins.
          */
         ...(userPlugins || []),
-        /**
-         * Plugins of type CmsModelFieldToGraphQLPlugin.
-         */
-        modelFieldToGraphQLPlugins,
         /**
          * DynamoDB filter plugins for the where conditions.
          */
@@ -77,13 +68,18 @@ export const createStorageOperations: StorageOperationsFactory = params => {
 
     return {
         beforeInit: async context => {
-            context.plugins.register([
-                /**
-                 * Field plugins for DynamoDB.
-                 * We must pass them to the base application.
-                 */
-                dynamoDbPlugins()
-            ]);
+            /**
+             * Collect all required plugins from parent context.
+             */
+            const fieldPlugins = context.plugins.byType<CmsModelFieldToGraphQLPlugin>(
+                "cms-model-field-to-graphql"
+            );
+            plugins.register(fieldPlugins);
+
+            /**
+             * Pass the plugins to the parent context.
+             */
+            context.plugins.register([dynamoDbPlugins()]);
         },
         getEntities: () => entities,
         getTable: () => tableInstance,

packages/api-headless-cms-ddb/src/types.ts

@@ -1,7 +1,6 @@
 import { Plugin } from "@webiny/plugins/types";
 import {
     CmsModelField,
-    CmsModelFieldToGraphQLPlugin,
     HeadlessCmsStorageOperations as BaseHeadlessCmsStorageOperations
 } from "@webiny/api-headless-cms/types";
 import { DynamoDBTypes, TableConstructor } from "dynamodb-toolbox/dist/classes/Table";
@@ -54,7 +53,6 @@ export interface TableModifier {
 export interface StorageOperationsFactoryParams {
     documentClient: DocumentClient;
     table?: TableModifier;
-    modelFieldToGraphQLPlugins: CmsModelFieldToGraphQLPlugin[];
     attributes?: Record<ENTITIES, Attributes>;
     plugins?: Plugin[] | Plugin[][];
 }

packages/api-headless-cms/__tests__/contentAPI/republish.entries.test.ts

@@ -7,6 +7,8 @@ import { useCategoryReadHandler } from "../utils/useCategoryReadHandler";
 import mdbid from "mdbid";
 import { useProductReadHandler } from "../utils/useProductReadHandler";
 import { useProductManageHandler } from "../utils/useProductManageHandler";
+import { PluginsContainer } from "@webiny/plugins";
+import { createGraphQLFields } from "~/graphqlFields";
 const cliPackageJson = require("@webiny/cli/package.json");
 const webinyVersion = cliPackageJson.version;
 
@@ -361,6 +363,12 @@ describe("Republish entries", () => {
 
         const { storageOperations } = useCategoryManageHandler(manageOpts);
 
+        if (storageOperations.beforeInit) {
+            await storageOperations.beforeInit({
+                plugins: new PluginsContainer(createGraphQLFields())
+            } as any);
+        }
+
         const { entry: galaEntry } = createEntry(productModel, {
             title: "Gala",
             category: {

packages/api-headless-cms/__tests__/storageOperations/entries.test.ts

@@ -6,6 +6,8 @@ import {
 } from "./helpers";
 import { CmsModel, HeadlessCmsStorageOperations } from "~/types";
 import { useGraphQLHandler } from "../utils/useGraphQLHandler";
+import { createGraphQLFields } from "~/graphqlFields";
+import { PluginsContainer } from "@webiny/plugins";
 
 jest.setTimeout(60000);
 
@@ -47,6 +49,20 @@ describe("Entries storage operations", () => {
         path: "manage/en-US"
     });
 
+    /**
+     * We must load CMS GraphQL field plugins for the storage operations to work.
+     * This is specifically for DDB and DDB+ES storage operations.
+     * Some others might not need them...
+     */
+    beforeAll(async () => {
+        if (!storageOperations.beforeInit) {
+            return;
+        }
+        await storageOperations.beforeInit({
+            plugins: new PluginsContainer(createGraphQLFields())
+        } as any);
+    });
+
     beforeEach(async () => {
         await deletePersonModel({
             storageOperations

packages/api-headless-cms/src/graphql/system.ts

@@ -89,7 +89,7 @@ const plugin: GraphQLSchemaPlugin<CmsContext> = {
  */
 export const createSystemSchemaPlugin = (): ContextPlugin<CmsContext> => {
     return new ContextPlugin<CmsContext>(async context => {
-        if (context.cms.type) {
+        if (context.cms?.type) {
             return;
         }
         context.plugins.register(plugin);