feat(content-releases): add publish webhook (#19515)

* feat(content-releases): add publish webhook

* apply Marks feedback

examples/getstarted/config/features.js

@@ -1 +1,5 @@
-module.exports = ({ env }) => ({});
+module.exports = ({ env }) => ({
+  future: {
+    contentReleasesScheduling: env('STRAPI_FUTURE_CONTENT_RELEASES_SCHEDULING', false),
+  },
+});

packages/core/admin/ee/admin/src/pages/SettingsPage/pages/Webhooks/components/EventsTable.tsx

@@ -1,11 +1,21 @@
 import { Events } from '../../../../../../../../admin/src/pages/Settings/pages/Webhooks/components/Events';
 
-const events = {
+const eeTables = {
+  'review-workflows': {
     'review-workflows': ['review-workflows.updateEntryStage'],
+  },
+  releases: {
+    releases: ['releases.publish'],
+  },
 };
 
-const getHeaders = () => {
-  return [{ id: 'review-workflows.updateEntryStage', defaultMessage: 'Stage Change' }];
+const getHeaders = (table: keyof typeof eeTables) => {
+  switch (table) {
+    case 'review-workflows':
+      return () => [{ id: 'review-workflows.updateEntryStage', defaultMessage: 'Stage Change' }];
+    case 'releases':
+      return () => [{ id: 'releases.publish', defaultMessage: 'Publish' }];
+  }
 };
 
 const EventsTableEE = () => {
@@ -13,8 +23,12 @@ const EventsTableEE = () => {
     <Events.Root>
       <Events.Headers />
       <Events.Body />
-      <Events.Headers getHeaders={getHeaders} />
-      <Events.Body providedEvents={events} />
+      {(Object.keys(eeTables) as Array<keyof typeof eeTables>).map((table) => (
+        <>
+          <Events.Headers getHeaders={getHeaders(table)} />
+          <Events.Body providedEvents={eeTables[table]} />
+        </>
+      ))}
     </Events.Root>
   );
 };

packages/core/content-releases/server/src/__tests__/index.test.ts

@@ -84,6 +84,9 @@ describe('bootstrap', () => {
     log: {
       error: jest.fn(),
     },
+    webhookStore: {
+      addAllowedEvent: jest.fn(),
+    },
   };
 
   beforeEach(() => {

packages/core/content-releases/server/src/bootstrap.ts

@@ -1,7 +1,7 @@
 /* eslint-disable @typescript-eslint/no-var-requires */
 import type { LoadedStrapi, Entity as StrapiEntity } from '@strapi/types';
 
-import { RELEASE_ACTION_MODEL_UID } from './constants';
+import { ALLOWED_WEBHOOK_EVENTS, RELEASE_ACTION_MODEL_UID } from './constants';
 import { getService } from './utils';
 
 const { features } = require('@strapi/strapi/dist/utils/ee');
@@ -69,6 +69,10 @@ export const bootstrap = async ({ strapi }: { strapi: LoadedStrapi }) => {
 
           throw err;
         });
+
+      Object.entries(ALLOWED_WEBHOOK_EVENTS).forEach(([key, value]) => {
+        strapi.webhookStore.addAllowedEvent(key, value);
+      });
     }
   }
 };

packages/core/content-releases/server/src/constants.ts

@@ -45,3 +45,7 @@ export const ACTIONS = [
     pluginName: 'content-releases',
   },
 ];
+
+export const ALLOWED_WEBHOOK_EVENTS = {
+  RELEASES_PUBLISH: 'releases.publish',
+};

packages/core/content-releases/server/src/services/__tests__/release.test.ts

@@ -26,6 +26,9 @@ const baseStrapiMock = {
       isEnabled: jest.fn().mockReturnValue(true),
     },
   },
+  eventHub: {
+    emit: jest.fn(),
+  },
   telemetry: {
     send: jest.fn().mockReturnValue(true),
   },

packages/core/content-releases/server/src/services/release.ts

@@ -4,7 +4,7 @@ import type { LoadedStrapi, EntityService, UID, Schema } from '@strapi/types';
 
 import _ from 'lodash/fp';
 
-import { RELEASE_ACTION_MODEL_UID, RELEASE_MODEL_UID } from '../constants';
+import { ALLOWED_WEBHOOK_EVENTS, RELEASE_ACTION_MODEL_UID, RELEASE_MODEL_UID } from '../constants';
 import type {
   GetReleases,
   CreateRelease,
@@ -48,7 +48,19 @@ const getGroupName = (queryValue?: ReleaseActionGroupBy) => {
   }
 };
 
-const createReleaseService = ({ strapi }: { strapi: LoadedStrapi }) => ({
+const createReleaseService = ({ strapi }: { strapi: LoadedStrapi }) => {
+  const dispatchWebhook = (
+    event: string,
+    { isPublished, release, error }: { isPublished: boolean; release?: Release; error?: unknown }
+  ) => {
+    strapi.eventHub.emit(event, {
+      isPublished,
+      error,
+      release,
+    });
+  };
+
+  return {
     async create(releaseData: CreateRelease.Request['body'], { user }: { user: UserInfo }) {
       const releaseWithCreatorFields = await setCreatorFields({ user })(releaseData);
 
@@ -201,7 +213,9 @@ const createReleaseService = ({ strapi }: { strapi: LoadedStrapi }) => ({
       releaseData: UpdateRelease.Request['body'],
       { user }: { user: UserInfo }
     ) {
-    const releaseWithCreatorFields = await setCreatorFields({ user, isEdition: true })(releaseData);
+      const releaseWithCreatorFields = await setCreatorFields({ user, isEdition: true })(
+        releaseData
+      );
 
       const { validateUniqueNameForPendingRelease, validateScheduledAtIsLaterThanNow } = getService(
         'release-validation',
@@ -315,7 +329,9 @@ const createReleaseService = ({ strapi }: { strapi: LoadedStrapi }) => ({
       });
     },
 
-  async countActions(query: EntityService.Params.Pick<typeof RELEASE_ACTION_MODEL_UID, 'filters'>) {
+    async countActions(
+      query: EntityService.Params.Pick<typeof RELEASE_ACTION_MODEL_UID, 'filters'>
+    ) {
       return strapi.entityService.count(RELEASE_ACTION_MODEL_UID, query);
     },
 
@@ -409,12 +425,17 @@ const createReleaseService = ({ strapi }: { strapi: LoadedStrapi }) => ({
     },
 
     async getAllComponents() {
-    const contentManagerComponentsService = strapi.plugin('content-manager').service('components');
+      const contentManagerComponentsService = strapi
+        .plugin('content-manager')
+        .service('components');
 
       const components = await contentManagerComponentsService.findAllComponents();
 
       const componentsMap = components.reduce(
-      (acc: { [key: Schema.Component['uid']]: Schema.Component }, component: Schema.Component) => {
+        (
+          acc: { [key: Schema.Component['uid']]: Schema.Component },
+          component: Schema.Component
+        ) => {
           acc[component.uid] = component;
 
           return acc;
@@ -466,6 +487,7 @@ const createReleaseService = ({ strapi }: { strapi: LoadedStrapi }) => ({
     },
 
     async publish(releaseId: PublishRelease.Request['params']['id']) {
+      try {
         // We need to pass the type because entityService.findOne is not returning the correct type
         const releaseWithPopulatedActionEntries = (await strapi.entityService.findOne(
           RELEASE_MODEL_UID,
@@ -615,7 +637,7 @@ const createReleaseService = ({ strapi }: { strapi: LoadedStrapi }) => ({
         });
 
         // When the transaction fails it throws an error, when it is successful proceed to updating the release
-    const release = await strapi.entityService.update(RELEASE_MODEL_UID, releaseId, {
+        const release = (await strapi.entityService.update(RELEASE_MODEL_UID, releaseId, {
           data: {
             /*
              * The type returned from the entity service: Partial<Input<"plugin::content-releases.release">> looks like it's wrong
@@ -623,11 +645,34 @@ const createReleaseService = ({ strapi }: { strapi: LoadedStrapi }) => ({
             // @ts-expect-error see above
             releasedAt: new Date(),
           },
+          populate: {
+            actions: {
+              // @ts-expect-error is not expecting count but it is working
+              count: true,
+            },
+          },
+        })) as Release;
+
+        if (strapi.features.future.isEnabled('contentReleasesScheduling')) {
+          dispatchWebhook(ALLOWED_WEBHOOK_EVENTS.RELEASES_PUBLISH, {
+            isPublished: true,
+            release,
           });
+        }
 
         strapi.telemetry.send('didPublishContentRelease');
 
         return release;
+      } catch (error) {
+        if (strapi.features.future.isEnabled('contentReleasesScheduling')) {
+          dispatchWebhook(ALLOWED_WEBHOOK_EVENTS.RELEASES_PUBLISH, {
+            isPublished: false,
+            error,
+          });
+        }
+
+        throw error;
+      }
     },
 
     async updateAction(
@@ -681,6 +726,7 @@ const createReleaseService = ({ strapi }: { strapi: LoadedStrapi }) => ({
 
       return deletedAction;
     },
-});
+  };
+};
 
 export default createReleaseService;