Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

enhancement: migrate bulk publish & unpublish to v5 #20184

Merged
merged 16 commits into from May 7, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Expand Up @@ -411,7 +411,7 @@ export default {
const { userAbility } = ctx.state;
const { model } = ctx.params;
const { body } = ctx.request;
const { ids } = body;
const { documentIds } = body;

await validateBulkActionInput(body);

Expand All @@ -422,36 +422,35 @@ export default {
return ctx.forbidden();
}

const permissionQuery = await permissionChecker.sanitizedQuery.publish(ctx.query);
const populate = await getService('populate-builder')(model)
.populateFromQuery(permissionQuery)
.populateDeep(Infinity)
.countRelations()
.build();
const { locale } = getDocumentLocaleAndStatus(body);

const entityPromises = ids.map((id: any) => documentManager.findOne(id, model, { populate }));
const entities = await Promise.all(entityPromises);
const documentLocales = await documentManager.findLocales(documentIds, model, {
Feranchz marked this conversation as resolved.
Show resolved Hide resolved
locale,
});

for (const entity of entities) {
if (!entity) {
return ctx.notFound();
}
if (documentLocales.length === 0) {
return ctx.notFound();
}

if (permissionChecker.cannot.publish(entity)) {
for (const document of documentLocales) {
if (permissionChecker.cannot.publish(document)) {
return ctx.forbidden();
}
}

Feranchz marked this conversation as resolved.
Show resolved Hide resolved
// @ts-expect-error - publish many should not return null
const { count } = await documentManager.publishMany(entities, model);
const localeDocumentsIds = documentLocales
.filter((document) => !document.publishedAt)
.map((document) => document.documentId);

const { count } = await documentManager.publishMany(localeDocumentsIds, model, { locale });
ctx.body = { count };
},

async bulkUnpublish(ctx: any) {
const { userAbility } = ctx.state;
const { model } = ctx.params;
const { body } = ctx.request;
const { ids } = body;
const { documentIds } = body;

await validateBulkActionInput(body);

Expand All @@ -462,26 +461,28 @@ export default {
return ctx.forbidden();
}

const permissionQuery = await permissionChecker.sanitizedQuery.publish(ctx.query);
const populate = await getService('populate-builder')(model)
.populateFromQuery(permissionQuery)
.build();
const { locale } = getDocumentLocaleAndStatus(body);

const entityPromises = ids.map((id: any) => documentManager.findOne(id, model, { populate }));
const entities = await Promise.all(entityPromises);
const documentLocales = await documentManager.findLocales(documentIds, model, {
locale,
});

for (const entity of entities) {
if (!entity) {
return ctx.notFound();
}
if (documentLocales.length === 0) {
return ctx.notFound();
}

if (permissionChecker.cannot.publish(entity)) {
for (const document of documentLocales) {
if (permissionChecker.cannot.unpublish(document)) {
return ctx.forbidden();
}
}

// @ts-expect-error - unpublish many should not return null
const { count } = await documentManager.unpublishMany(entities, model);
const localeDocumentsIds = documentLocales
.filter((document) => !!document.publishedAt)
.map((document) => document.documentId);

const { count } = await documentManager.unpublishMany(localeDocumentsIds, model, { locale });

ctx.body = { count };
},

Expand Down
Expand Up @@ -12,7 +12,7 @@ const kindSchema = yup.string().oneOf(TYPES).nullable();

const bulkActionInputSchema = yup
.object({
ids: yup.array().of(yup.strapiID()).min(1).required(),
documentIds: yup.array().of(yup.strapiID()).min(1).required(),
})
.required();

Expand Down
Expand Up @@ -196,85 +196,30 @@ const documentManager = ({ strapi }: { strapi: Core.Strapi }) => {
.then((result) => result?.versions.at(0));
},

async publishMany(entities: Document[], uid: UID.ContentType) {
if (!entities.length) {
return null;
}

// Validate entities before publishing, throw if invalid
await Promise.all(
entities.map((document: Document) => {
return strapi.entityValidator.validateEntityCreation(
strapi.getModel(uid),
document,
undefined,
// @ts-expect-error - FIXME: entity here is unnecessary
document
);
})
);

// Only publish entities without a published_at date
const entitiesToPublish = entities
.filter((doc: Document) => !doc[PUBLISHED_AT_ATTRIBUTE])
.map((doc: Document) => doc.id);

const filters = { id: { $in: entitiesToPublish } };
const data = { [PUBLISHED_AT_ATTRIBUTE]: new Date() };
const populate = await buildDeepPopulate(uid);

// Everything is valid, publish
const publishedEntitiesCount = await strapi.db.query(uid).updateMany({
where: filters,
data,
});
// Get the updated entities since updateMany only returns the count
const publishedEntities = await strapi.db.query(uid).findMany({
where: filters,
populate,
async publishMany(
Marc-Roig marked this conversation as resolved.
Show resolved Hide resolved
documentIds: Modules.Documents.ID[],
uid: UID.ContentType,
opts: Omit<DocServiceParams<'publish'>, 'documentId'> = {} as any
) {
const publishedEntries = await strapi.db.transaction(async () => {
return Promise.all(documentIds.map((id) => this.publish(id, uid, opts)));
});
// Emit the publish event for all updated entities
await Promise.all(
publishedEntities!.map((doc: Document) => emitEvent(uid, ENTRY_PUBLISH, doc))
);

// Return the number of published entities
return publishedEntitiesCount;
return { count: publishedEntries.length };
Feranchz marked this conversation as resolved.
Show resolved Hide resolved
},

async unpublishMany(documents: Document[], uid: UID.CollectionType) {
if (!documents.length) {
return null;
}

// Only unpublish entities with a published_at date
const entitiesToUnpublish = documents
.filter((doc: Document) => doc[PUBLISHED_AT_ATTRIBUTE])
.map((doc: Document) => doc.id);

const filters = { id: { $in: entitiesToUnpublish } };
const data = { [PUBLISHED_AT_ATTRIBUTE]: null };
const populate = await buildDeepPopulate(uid);

// No need to validate, unpublish
const unpublishedEntitiesCount = await strapi.db.query(uid).updateMany({
where: filters,
data,
});

// Get the updated entities since updateMany only returns the count
const unpublishedEntities = await strapi.db.query(uid).findMany({
where: filters,
populate,
async unpublishMany(
documentIds: Modules.Documents.ID[],
uid: UID.CollectionType,
opts: Omit<DocServiceParams<'unpublish'>, 'documentId'> = {} as any
) {
const unpublishedEntries = await strapi.db.transaction(async () => {
return Promise.all(documentIds.map((id) => this.unpublish(id, uid, opts)));
Feranchz marked this conversation as resolved.
Show resolved Hide resolved
});

// Emit the unpublish event for all updated entities
await Promise.all(
unpublishedEntities!.map((doc: Document) => emitEvent(uid, ENTRY_UNPUBLISH, doc))
);

// Return the number of unpublished entities
return unpublishedEntitiesCount;
return { count: unpublishedEntries.length };
},

async unpublish(
Expand Down
4 changes: 2 additions & 2 deletions tests/api/core/content-manager/api/basic-dp-compo.test.api.js
Expand Up @@ -247,7 +247,7 @@ describe('CM API - Basic + compo', () => {
});

// TODO: Implement bulk publish
test.skip('Can bulk publish product with compo - required', async () => {
test('Can bulk publish product with compo - required', async () => {
const product = {
name: 'Product 1',
description: 'Product description',
Expand All @@ -266,7 +266,7 @@ describe('CM API - Basic + compo', () => {
method: 'POST',
url: `/content-manager/collection-types/api::product-with-compo-and-dp.product-with-compo-and-dp/actions/bulkPublish`,
body: {
ids: [res.body.documentId],
documentIds: [res.body.data.documentId],
Feranchz marked this conversation as resolved.
Show resolved Hide resolved
},
});

Expand Down