@strapi/content-releases 0.0.0-next.56199ab7a5f3320e0debcbe4a24fe0b8cd599e21 → 0.0.0-next.615ae85762cbae9fc80af36685075ef25abd1c88

package/dist/server/index.mjs

@@ -1,6 +1,8 @@
-import { setCreatorFields, errors, validateYupSchema, yup as yup$1, mapAsync } from "@strapi/utils";
+import { contentTypes as contentTypes$1, mapAsync, setCreatorFields, errors, validateYupSchema, yup as yup$1 } from "@strapi/utils";
+import { difference, keys } from "lodash";
 import _ from "lodash/fp";
 import EE from "@strapi/strapi/dist/utils/ee";
+import { scheduleJob } from "node-schedule";
 import * as yup from "yup";
 const RELEASE_MODEL_UID = "plugin::content-releases.release";
 const RELEASE_ACTION_MODEL_UID = "plugin::content-releases.release-action";
@@ -48,40 +50,50 @@ const ACTIONS = [
     pluginName: "content-releases"
   }
 ];
-const getService = (name, { strapi: strapi2 } = { strapi: global.strapi }) => {
-  return strapi2.plugin("content-releases").service(name);
-};
+async function deleteActionsOnDisableDraftAndPublish({
+  oldContentTypes,
+  contentTypes: contentTypes2
+}) {
+  if (!oldContentTypes) {
+    return;
+  }
+  for (const uid in contentTypes2) {
+    if (!oldContentTypes[uid]) {
+      continue;
+    }
+    const oldContentType = oldContentTypes[uid];
+    const contentType = contentTypes2[uid];
+    if (contentTypes$1.hasDraftAndPublish(oldContentType) && !contentTypes$1.hasDraftAndPublish(contentType)) {
+      await strapi.db?.queryBuilder(RELEASE_ACTION_MODEL_UID).delete().where({ contentType: uid }).execute();
+    }
+  }
+}
+async function deleteActionsOnDeleteContentType({ oldContentTypes, contentTypes: contentTypes2 }) {
+  const deletedContentTypes = difference(keys(oldContentTypes), keys(contentTypes2)) ?? [];
+  if (deletedContentTypes.length) {
+    await mapAsync(deletedContentTypes, async (deletedContentTypeUID) => {
+      return strapi.db?.queryBuilder(RELEASE_ACTION_MODEL_UID).delete().where({ contentType: deletedContentTypeUID }).execute();
+    });
+  }
+}
 const { features: features$2 } = require("@strapi/strapi/dist/utils/ee");
 const register = async ({ strapi: strapi2 }) => {
-  if (features$2.isEnabled("cms-content-releases") && strapi2.features.future.isEnabled("contentReleases")) {
+  if (features$2.isEnabled("cms-content-releases")) {
     await strapi2.admin.services.permission.actionProvider.registerMany(ACTIONS);
-    const releaseActionService = getService("release-action", { strapi: strapi2 });
-    const eventManager = getService("event-manager", { strapi: strapi2 });
-    const destroyContentTypeUpdateListener = strapi2.eventHub.on(
-      "content-type.update",
-      async ({ contentType }) => {
-        if (contentType.schema.options.draftAndPublish === false) {
-          await releaseActionService.deleteManyForContentType(contentType.uid);
-        }
-      }
-    );
-    eventManager.addDestroyListenerCallback(destroyContentTypeUpdateListener);
-    const destroyContentTypeDeleteListener = strapi2.eventHub.on(
-      "content-type.delete",
-      async ({ contentType }) => {
-        await releaseActionService.deleteManyForContentType(contentType.uid);
-      }
-    );
-    eventManager.addDestroyListenerCallback(destroyContentTypeDeleteListener);
+    strapi2.hook("strapi::content-types.beforeSync").register(deleteActionsOnDisableDraftAndPublish);
+    strapi2.hook("strapi::content-types.afterSync").register(deleteActionsOnDeleteContentType);
   }
 };
+const getService = (name, { strapi: strapi2 } = { strapi: global.strapi }) => {
+  return strapi2.plugin("content-releases").service(name);
+};
 const { features: features$1 } = require("@strapi/strapi/dist/utils/ee");
 const bootstrap = async ({ strapi: strapi2 }) => {
-  if (features$1.isEnabled("cms-content-releases") && strapi2.features.future.isEnabled("contentReleases")) {
+  if (features$1.isEnabled("cms-content-releases")) {
     strapi2.db.lifecycles.subscribe({
       afterDelete(event) {
         const { model, result } = event;
-        if (model.kind === "collectionType" && model.options.draftAndPublish) {
+        if (model.kind === "collectionType" && model.options?.draftAndPublish) {
           const { id } = result;
           strapi2.db.query(RELEASE_ACTION_MODEL_UID).deleteMany({
             where: {
@@ -97,7 +109,7 @@ const bootstrap = async ({ strapi: strapi2 }) => {
        */
       async beforeDeleteMany(event) {
         const { model, params } = event;
-        if (model.kind === "collectionType" && model.options.draftAndPublish) {
+        if (model.kind === "collectionType" && model.options?.draftAndPublish) {
           const { where } = params;
           const entriesToDelete = await strapi2.db.query(model.uid).findMany({ select: ["id"], where });
           event.state.entriesToDelete = entriesToDelete;
@@ -122,6 +134,24 @@ const bootstrap = async ({ strapi: strapi2 }) => {
         }
       }
     });
+    if (strapi2.features.future.isEnabled("contentReleasesScheduling")) {
+      getService("scheduling", { strapi: strapi2 }).syncFromDatabase().catch((err) => {
+        strapi2.log.error(
+          "Error while syncing scheduled jobs from the database in the content-releases plugin. This could lead to errors in the releases scheduling."
+        );
+        throw err;
+      });
+    }
+  }
+};
+const destroy = async ({ strapi: strapi2 }) => {
+  if (strapi2.features.future.isEnabled("contentReleasesScheduling")) {
+    const scheduledJobs = getService("scheduling", {
+      strapi: strapi2
+    }).getAll();
+    for (const [, job] of scheduledJobs) {
+      job.cancel();
+    }
   }
 };
 const schema$1 = {
@@ -150,6 +180,12 @@ const schema$1 = {
     releasedAt: {
       type: "datetime"
     },
+    scheduledAt: {
+      type: "datetime"
+    },
+    timezone: {
+      type: "string"
+    },
     actions: {
       type: "relation",
       relation: "oneToMany",
@@ -212,15 +248,6 @@ const contentTypes = {
   release: release$1,
   "release-action": releaseAction$1
 };
-const createReleaseActionService = ({ strapi: strapi2 }) => ({
-  async deleteManyForContentType(contentTypeUid) {
-    return strapi2.db.query(RELEASE_ACTION_MODEL_UID).deleteMany({
-      where: {
-        target_type: contentTypeUid
-      }
-    });
-  }
-});
 const getGroupName = (queryValue) => {
   switch (queryValue) {
     case "contentType":
@@ -236,10 +263,25 @@ const getGroupName = (queryValue) => {
 const createReleaseService = ({ strapi: strapi2 }) => ({
   async create(releaseData, { user }) {
     const releaseWithCreatorFields = await setCreatorFields({ user })(releaseData);
-    await getService("release-validation", { strapi: strapi2 }).validatePendingReleasesLimit();
-    return strapi2.entityService.create(RELEASE_MODEL_UID, {
+    const {
+      validatePendingReleasesLimit,
+      validateUniqueNameForPendingRelease,
+      validateScheduledAtIsLaterThanNow
+    } = getService("release-validation", { strapi: strapi2 });
+    await Promise.all([
+      validatePendingReleasesLimit(),
+      validateUniqueNameForPendingRelease(releaseWithCreatorFields.name),
+      validateScheduledAtIsLaterThanNow(releaseWithCreatorFields.scheduledAt)
+    ]);
+    const release2 = await strapi2.entityService.create(RELEASE_MODEL_UID, {
       data: releaseWithCreatorFields
     });
+    if (strapi2.features.future.isEnabled("contentReleasesScheduling") && releaseWithCreatorFields.scheduledAt) {
+      const schedulingService = getService("scheduling", { strapi: strapi2 });
+      await schedulingService.set(release2.id, release2.scheduledAt);
+    }
+    strapi2.telemetry.send("didCreateContentRelease");
+    return release2;
   },
   async findOne(id, query = {}) {
     const release2 = await strapi2.entityService.findOne(RELEASE_MODEL_UID, id, {
@@ -258,51 +300,66 @@ const createReleaseService = ({ strapi: strapi2 }) => ({
       }
     });
   },
-  async findManyForContentTypeEntry(contentTypeUid, entryId, {
-    hasEntryAttached
-  } = {
-    hasEntryAttached: false
-  }) {
-    const whereActions = hasEntryAttached ? {
-      // Find all Releases where the content type entry is present
-      actions: {
-        target_type: contentTypeUid,
-        target_id: entryId
-      }
-    } : {
-      // Find all Releases where the content type entry is not present
-      $or: [
-        {
-          $not: {
-            actions: {
-              target_type: contentTypeUid,
-              target_id: entryId
-            }
-          }
+  async findManyWithContentTypeEntryAttached(contentTypeUid, entryId) {
+    const releases = await strapi2.db.query(RELEASE_MODEL_UID).findMany({
+      where: {
+        actions: {
+          target_type: contentTypeUid,
+          target_id: entryId
         },
-        {
-          actions: null
+        releasedAt: {
+          $null: true
         }
-      ]
-    };
-    const populateAttachedAction = hasEntryAttached ? {
-      // Filter the action to get only the content type entry
-      actions: {
-        where: {
+      },
+      populate: {
+        // Filter the action to get only the content type entry
+        actions: {
+          where: {
+            target_type: contentTypeUid,
+            target_id: entryId
+          }
+        }
+      }
+    });
+    return releases.map((release2) => {
+      if (release2.actions?.length) {
+        const [actionForEntry] = release2.actions;
+        delete release2.actions;
+        return {
+          ...release2,
+          action: actionForEntry
+        };
+      }
+      return release2;
+    });
+  },
+  async findManyWithoutContentTypeEntryAttached(contentTypeUid, entryId) {
+    const releasesRelated = await strapi2.db.query(RELEASE_MODEL_UID).findMany({
+      where: {
+        releasedAt: {
+          $null: true
+        },
+        actions: {
           target_type: contentTypeUid,
           target_id: entryId
         }
       }
-    } : {};
+    });
     const releases = await strapi2.db.query(RELEASE_MODEL_UID).findMany({
       where: {
-        ...whereActions,
+        $or: [
+          {
+            id: {
+              $notIn: releasesRelated.map((release2) => release2.id)
+            }
+          },
+          {
+            actions: null
+          }
+        ],
         releasedAt: {
           $null: true
         }
-      },
-      populate: {
-        ...populateAttachedAction
       }
     });
     return releases.map((release2) => {
@@ -319,6 +376,14 @@ const createReleaseService = ({ strapi: strapi2 }) => ({
   },
   async update(id, releaseData, { user }) {
     const releaseWithCreatorFields = await setCreatorFields({ user, isEdition: true })(releaseData);
+    const { validateUniqueNameForPendingRelease, validateScheduledAtIsLaterThanNow } = getService(
+      "release-validation",
+      { strapi: strapi2 }
+    );
+    await Promise.all([
+      validateUniqueNameForPendingRelease(releaseWithCreatorFields.name, id),
+      validateScheduledAtIsLaterThanNow(releaseWithCreatorFields.scheduledAt)
+    ]);
     const release2 = await strapi2.entityService.findOne(RELEASE_MODEL_UID, id);
     if (!release2) {
       throw new errors.NotFoundError(`No release found for id ${id}`);
@@ -334,6 +399,15 @@ const createReleaseService = ({ strapi: strapi2 }) => ({
       // @ts-expect-error see above
       data: releaseWithCreatorFields
     });
+    if (strapi2.features.future.isEnabled("contentReleasesScheduling")) {
+      const schedulingService = getService("scheduling", { strapi: strapi2 });
+      if (releaseData.scheduledAt) {
+        await schedulingService.set(id, releaseData.scheduledAt);
+      } else if (release2.scheduledAt) {
+        schedulingService.cancel(id);
+      }
+    }
+    strapi2.telemetry.send("didUpdateContentRelease");
     return updatedRelease;
   },
   async createAction(releaseId, action) {
@@ -491,6 +565,11 @@ const createReleaseService = ({ strapi: strapi2 }) => ({
       });
       await strapi2.entityService.delete(RELEASE_MODEL_UID, releaseId);
     });
+    if (strapi2.features.future.isEnabled("contentReleasesScheduling") && release2.scheduledAt) {
+      const schedulingService = getService("scheduling", { strapi: strapi2 });
+      await schedulingService.cancel(release2.id);
+    }
+    strapi2.telemetry.send("didDeleteContentRelease");
     return release2;
   },
   async publish(releaseId) {
@@ -501,7 +580,9 @@ const createReleaseService = ({ strapi: strapi2 }) => ({
         populate: {
           actions: {
             populate: {
-              entry: true
+              entry: {
+                fields: ["id"]
+              }
             }
           }
         }
@@ -516,30 +597,80 @@ const createReleaseService = ({ strapi: strapi2 }) => ({
     if (releaseWithPopulatedActionEntries.actions.length === 0) {
       throw new errors.ValidationError("No entries to publish");
     }
-    const actions = {};
+    const collectionTypeActions = {};
+    const singleTypeActions = [];
     for (const action of releaseWithPopulatedActionEntries.actions) {
       const contentTypeUid = action.contentType;
-      if (!actions[contentTypeUid]) {
-        actions[contentTypeUid] = {
-          publish: [],
-          unpublish: []
-        };
-      }
-      if (action.type === "publish") {
-        actions[contentTypeUid].publish.push(action.entry);
+      if (strapi2.contentTypes[contentTypeUid].kind === "collectionType") {
+        if (!collectionTypeActions[contentTypeUid]) {
+          collectionTypeActions[contentTypeUid] = {
+            entriestoPublishIds: [],
+            entriesToUnpublishIds: []
+          };
+        }
+        if (action.type === "publish") {
+          collectionTypeActions[contentTypeUid].entriestoPublishIds.push(action.entry.id);
+        } else {
+          collectionTypeActions[contentTypeUid].entriesToUnpublishIds.push(action.entry.id);
+        }
       } else {
-        actions[contentTypeUid].unpublish.push(action.entry);
+        singleTypeActions.push({
+          uid: contentTypeUid,
+          action: action.type,
+          id: action.entry.id
+        });
       }
     }
     const entityManagerService = strapi2.plugin("content-manager").service("entity-manager");
+    const populateBuilderService = strapi2.plugin("content-manager").service("populate-builder");
     await strapi2.db.transaction(async () => {
-      for (const contentTypeUid of Object.keys(actions)) {
-        const { publish, unpublish } = actions[contentTypeUid];
-        if (publish.length > 0) {
-          await entityManagerService.publishMany(publish, contentTypeUid);
+      for (const { uid, action, id } of singleTypeActions) {
+        const populate = await populateBuilderService(uid).populateDeep(Infinity).build();
+        const entry = await strapi2.entityService.findOne(uid, id, { populate });
+        try {
+          if (action === "publish") {
+            await entityManagerService.publish(entry, uid);
+          } else {
+            await entityManagerService.unpublish(entry, uid);
+          }
+        } catch (error) {
+          if (error instanceof errors.ApplicationError && (error.message === "already.published" || error.message === "already.draft"))
+            ;
+          else {
+            throw error;
+          }
+        }
+      }
+      for (const contentTypeUid of Object.keys(collectionTypeActions)) {
+        const populate = await populateBuilderService(contentTypeUid).populateDeep(Infinity).build();
+        const { entriestoPublishIds, entriesToUnpublishIds } = collectionTypeActions[contentTypeUid];
+        const entriesToPublish = await strapi2.entityService.findMany(
+          contentTypeUid,
+          {
+            filters: {
+              id: {
+                $in: entriestoPublishIds
+              }
+            },
+            populate
+          }
+        );
+        const entriesToUnpublish = await strapi2.entityService.findMany(
+          contentTypeUid,
+          {
+            filters: {
+              id: {
+                $in: entriesToUnpublishIds
+              }
+            },
+            populate
+          }
+        );
+        if (entriesToPublish.length > 0) {
+          await entityManagerService.publishMany(entriesToPublish, contentTypeUid);
         }
-        if (unpublish.length > 0) {
-          await entityManagerService.unpublishMany(unpublish, contentTypeUid);
+        if (entriesToUnpublish.length > 0) {
+          await entityManagerService.unpublishMany(entriesToUnpublish, contentTypeUid);
         }
       }
     });
@@ -552,6 +683,7 @@ const createReleaseService = ({ strapi: strapi2 }) => ({
         releasedAt: /* @__PURE__ */ new Date()
       }
     });
+    strapi2.telemetry.send("didPublishContentRelease");
     return release2;
   },
   async updateAction(actionId, releaseId, update) {
@@ -637,34 +769,94 @@ const createReleaseValidationService = ({ strapi: strapi2 }) => ({
     if (pendingReleasesCount >= maximumPendingReleases) {
       throw new errors.ValidationError("You have reached the maximum number of pending releases");
     }
+  },
+  async validateUniqueNameForPendingRelease(name, id) {
+    const pendingReleases = await strapi2.entityService.findMany(RELEASE_MODEL_UID, {
+      filters: {
+        releasedAt: {
+          $null: true
+        },
+        name,
+        ...id && { id: { $ne: id } }
+      }
+    });
+    const isNameUnique = pendingReleases.length === 0;
+    if (!isNameUnique) {
+      throw new errors.ValidationError(`Release with name ${name} already exists`);
+    }
+  },
+  async validateScheduledAtIsLaterThanNow(scheduledAt) {
+    if (scheduledAt && new Date(scheduledAt) <= /* @__PURE__ */ new Date()) {
+      throw new errors.ValidationError("Scheduled at must be later than now");
+    }
   }
 });
-const createEventManagerService = () => {
-  const state = {
-    destroyListenerCallbacks: []
-  };
+const createSchedulingService = ({ strapi: strapi2 }) => {
+  const scheduledJobs = /* @__PURE__ */ new Map();
   return {
-    addDestroyListenerCallback(destroyListenerCallback) {
-      state.destroyListenerCallbacks.push(destroyListenerCallback);
+    async set(releaseId, scheduleDate) {
+      const release2 = await strapi2.db.query(RELEASE_MODEL_UID).findOne({ where: { id: releaseId, releasedAt: null } });
+      if (!release2) {
+        throw new errors.NotFoundError(`No release found for id ${releaseId}`);
+      }
+      const job = scheduleJob(scheduleDate, async () => {
+        try {
+          await getService("release").publish(releaseId);
+        } catch (error) {
+        }
+        this.cancel(releaseId);
+      });
+      if (scheduledJobs.has(releaseId)) {
+        this.cancel(releaseId);
+      }
+      scheduledJobs.set(releaseId, job);
+      return scheduledJobs;
     },
-    destroyAllListeners() {
-      if (!state.destroyListenerCallbacks.length) {
-        return;
+    cancel(releaseId) {
+      if (scheduledJobs.has(releaseId)) {
+        scheduledJobs.get(releaseId).cancel();
+        scheduledJobs.delete(releaseId);
       }
-      state.destroyListenerCallbacks.forEach((destroyListenerCallback) => {
-        destroyListenerCallback();
+      return scheduledJobs;
+    },
+    getAll() {
+      return scheduledJobs;
+    },
+    /**
+     * On bootstrap, we can use this function to make sure to sync the scheduled jobs from the database that are not yet released
+     * This is useful in case the server was restarted and the scheduled jobs were lost
+     * This also could be used to sync different Strapi instances in case of a cluster
+     */
+    async syncFromDatabase() {
+      const releases = await strapi2.db.query(RELEASE_MODEL_UID).findMany({
+        where: {
+          scheduledAt: {
+            $gte: /* @__PURE__ */ new Date()
+          },
+          releasedAt: null
+        }
       });
+      for (const release2 of releases) {
+        this.set(release2.id, release2.scheduledAt);
+      }
+      return scheduledJobs;
     }
   };
 };
 const services = {
   release: createReleaseService,
-  "release-action": createReleaseActionService,
   "release-validation": createReleaseValidationService,
-  "event-manager": createEventManagerService
+  ...strapi.features.future.isEnabled("contentReleasesScheduling") ? { scheduling: createSchedulingService } : {}
 };
 const RELEASE_SCHEMA = yup.object().shape({
-  name: yup.string().trim().required()
+  name: yup.string().trim().required(),
+  // scheduledAt is a date, but we always receive strings from the client
+  scheduledAt: yup.string().nullable(),
+  timezone: yup.string().when("scheduledAt", {
+    is: (scheduledAt) => !!scheduledAt,
+    then: yup.string().required(),
+    otherwise: yup.string().nullable()
+  })
 }).required().noUnknown();
 const validateRelease = validateYupSchema(RELEASE_SCHEMA);
 const releaseController = {
@@ -681,9 +873,7 @@ const releaseController = {
       const contentTypeUid = query.contentTypeUid;
       const entryId = query.entryId;
       const hasEntryAttached = typeof query.hasEntryAttached === "string" ? JSON.parse(query.hasEntryAttached) : false;
-      const data = await releaseService.findManyForContentTypeEntry(contentTypeUid, entryId, {
-        hasEntryAttached
-      });
+      const data = hasEntryAttached ? await releaseService.findManyWithContentTypeEntryAttached(contentTypeUid, entryId) : await releaseService.findManyWithoutContentTypeEntryAttached(contentTypeUid, entryId);
       ctx.body = { data };
     } else {
       const query = await permissionsManager.sanitizeQuery(ctx.query);
@@ -706,19 +896,18 @@ const releaseController = {
     const id = ctx.params.id;
     const releaseService = getService("release", { strapi });
     const release2 = await releaseService.findOne(id, { populate: ["createdBy"] });
-    const permissionsManager = strapi.admin.services.permission.createPermissionsManager({
-      ability: ctx.state.userAbility,
-      model: RELEASE_MODEL_UID
-    });
-    const sanitizedRelease = await permissionsManager.sanitizeOutput(release2);
+    if (!release2) {
+      throw new errors.NotFoundError(`Release not found for id: ${id}`);
+    }
     const count = await releaseService.countActions({
       filters: {
         release: id
       }
     });
-    if (!release2) {
-      throw new errors.NotFoundError(`Release not found for id: ${id}`);
-    }
+    const sanitizedRelease = {
+      ...release2,
+      createdBy: release2.createdBy ? strapi.admin.services.user.sanitizeUser(release2.createdBy) : null
+    };
     const data = {
       ...sanitizedRelease,
       actions: {
@@ -771,8 +960,27 @@ const releaseController = {
     const id = ctx.params.id;
     const releaseService = getService("release", { strapi });
     const release2 = await releaseService.publish(id, { user });
+    const [countPublishActions, countUnpublishActions] = await Promise.all([
+      releaseService.countActions({
+        filters: {
+          release: id,
+          type: "publish"
+        }
+      }),
+      releaseService.countActions({
+        filters: {
+          release: id,
+          type: "unpublish"
+        }
+      })
+    ]);
     ctx.body = {
-      data: release2
+      data: release2,
+      meta: {
+        totalEntries: countPublishActions + countUnpublishActions,
+        totalPublishedEntries: countPublishActions,
+        totalUnpublishedEntries: countUnpublishActions
+      }
     };
   }
 };
@@ -1040,19 +1248,15 @@ const routes = {
 };
 const { features } = require("@strapi/strapi/dist/utils/ee");
 const getPlugin = () => {
-  if (features.isEnabled("cms-content-releases") && strapi.features.future.isEnabled("contentReleases")) {
+  if (features.isEnabled("cms-content-releases")) {
     return {
       register,
       bootstrap,
+      destroy,
       contentTypes,
       services,
       controllers,
-      routes,
-      destroy() {
-        if (features.isEnabled("cms-content-releases") && strapi.features.future.isEnabled("contentReleases")) {
-          getService("event-manager").destroyAllListeners();
-        }
-      }
+      routes
     };
   }
   return {