Add server webhooks populateRelations config variable #1430

Marc-Roig · 2023-01-19T14:09:18Z

What does it do?

We introduced a regression after the relations performance feature.

We were not populating relation fields when creating/updating/... an entity, and now the content manager handles relations fields in a separate (and paginated) way.

A side effect of that is the webhooks are not receiving populated relations, and this PR aims to provide a solution for it.

We introduced a configuration variable so, by default, webhooks receive populated relations. But for performance reasons we let users disable this configuration.

We should also recommend to disable it.

Why is it needed?

To fix the regression and let users disable this behaviour to get increased performance on the Content Manager when creating,updating,deleting entities.

Related issue(s)/PR(s)

strapi/strapi#15363

vercel · 2023-01-19T14:09:25Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated
documentation	✅ Ready (Inspect)	Visit Preview	💬 Add your feedback	Feb 6, 2023 at 4:58PM (UTC)
documentation-docu-mvp	❌ Failed (Inspect)			Feb 6, 2023 at 4:58PM (UTC)

docs/developer-docs/latest/setup-deployment-guides/configurations/required/server.md

pwizla · 2023-01-19T17:17:36Z

LGTM minus the formatting change. Thanks, Marc!
By next major release, you mean Strapi v5, right?

…ons/required/server.md Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>

Marc-Roig · 2023-01-20T08:42:50Z

LGTM minus the formatting change. Thanks, Marc! By next major release, you mean Strapi v5, right?

yes :), we plan on removing / setting to false by default in v5

docs/developer-docs/latest/setup-deployment-guides/configurations/required/server.md

pwizla · 2023-01-20T16:05:27Z

LGTM minus the formatting change. Thanks, Marc! By next major release, you mean Strapi v5, right?

yes :), we plan on removing / setting to false by default in v5

OK, thanks. So I suggest we explicitly mention Strapi v5 :)

…gin/dev/webhook-populated-relations"

Marc-Roig · 2023-01-23T14:40:07Z

LGTM minus the formatting change. Thanks, Marc! By next major release, you mean Strapi v5, right?

yes :), we plan on removing / setting to false by default in v5

OK, thanks. So I suggest we explicitly mention Strapi v5 :)

We discussed about this and finally we agreed we will not be removing this in v5, as it can be used in other features as Audit logs. So I removed that bit of text :D

Marc-Roig · 2023-01-25T14:36:15Z

I added a migration guide for people to know we encourage to disable having populated relations in the webhooks.
Disabling will increase API and Content manager performance.

pwizla

Thanks, @Marc-Roig.
I guess this should be merged for the v4.6 release? (we're releasing in a few minutes now)

Edit: Nevermind, I've just seen the corresponding strapi/strapi PR assigned to v4.6.1.

docs/developer-docs/latest/setup-deployment-guides/configurations/required/server.md

docs/developer-docs/latest/update-migration-guides/migration-guides.md

...er-docs/latest/update-migration-guides/migration-guides/v4/migration-guide-4.5.1-to-4.6.1.md

…ons/required/server.md Co-authored-by: Pierre Noël <petersg83@users.noreply.github.com>

…uides/v4/migration-guide-4.5.1-to-4.6.1.md Co-authored-by: Pierre Noël <petersg83@users.noreply.github.com>

* move sizeLimit one level above in upload provider * add sizeLimit deprecation warning * minor change * minor change * checkFileSize upload provider * Update docs/developer-docs/latest/update-migration-guides/migration-guides/v4/migration-guide-4.3.x-to-4.4.x.md Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com> * Update docs/developer-docs/latest/update-migration-guides/migration-guides/v4/migration-guide-4.3.x-to-4.4.x.md Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com> * Update docs/developer-docs/latest/update-migration-guides/migration-guides/v4/migration-guide-4.3.x-to-4.4.x.md Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com> * Update docs/developer-docs/latest/update-migration-guides/migration-guides/v4/migration-guide-4.3.x-to-4.4.x.md Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com> * Update docs/developer-docs/latest/update-migration-guides/migration-guides/v4/migration-guide-4.3.x-to-4.4.x.md Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com> * Update docs/developer-docs/latest/update-migration-guides/migration-guides/v4/migration-guide-4.3.x-to-4.4.x.md Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com> * Update docs/developer-docs/latest/update-migration-guides/migration-guides/v4/migration-guide-4.3.x-to-4.4.x.md Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com> * move migration steps to 4.5.1 to 4.6.1 --------- Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>

Proposed changes are implemented and we release this on wednesday :)

add server webhooks populateRelations config variable

b17f564

Marc-Roig requested review from petersg83 and pwizla January 19, 2023 14:09

pwizla reviewed Jan 19, 2023

View reviewed changes

docs/developer-docs/latest/setup-deployment-guides/configurations/required/server.md Outdated Show resolved Hide resolved

Update docs/developer-docs/latest/setup-deployment-guides/configurati…

d35bd7e

…ons/required/server.md Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>

vercel bot had a problem deploying to Preview – documentation-docu-mvp January 20, 2023 08:42 Failure

vercel bot deployed to Preview – documentation January 20, 2023 08:44 View deployment

pwizla reviewed Jan 20, 2023

View reviewed changes

docs/developer-docs/latest/setup-deployment-guides/configurations/required/server.md Outdated Show resolved Hide resolved

Auto stash before merge of "dev/webhook-populated-relations" and "ori…

1072693

…gin/dev/webhook-populated-relations"

vercel bot had a problem deploying to Preview – documentation-docu-mvp January 23, 2023 14:39 Failure

Marc-Roig requested a review from pwizla January 23, 2023 14:40

vercel bot deployed to Preview – documentation January 23, 2023 14:40 View deployment

pwizla approved these changes Jan 23, 2023

View reviewed changes

add 4.6.1 migration guide

c44bab5

vercel bot deployed to Preview – documentation January 25, 2023 14:34 View deployment

vercel bot had a problem deploying to Preview – documentation-docu-mvp January 25, 2023 14:34 Failure

Marc-Roig requested a review from pwizla January 25, 2023 14:36

pwizla approved these changes Jan 25, 2023

View reviewed changes

pwizla added this to the 4.6.0 milestone Jan 25, 2023

pwizla self-assigned this Jan 25, 2023

pwizla added the internal PRs created by the Strapi core team label Jan 25, 2023

petersg83 previously requested changes Jan 25, 2023

View reviewed changes

pwizla modified the milestones: 4.6.0, 4.6.1 Jan 25, 2023

Marc-Roig and others added 3 commits February 1, 2023 12:24

Update docs/developer-docs/latest/setup-deployment-guides/configurati…

cb0e27a

…ons/required/server.md Co-authored-by: Pierre Noël <petersg83@users.noreply.github.com>

Update docs/developer-docs/latest/update-migration-guides/migration-g…

5ffc58c

…uides/v4/migration-guide-4.5.1-to-4.6.1.md Co-authored-by: Pierre Noël <petersg83@users.noreply.github.com>

Update docs/developer-docs/latest/update-migration-guides/migration-g…

d131813

…uides/v4/migration-guide-4.5.1-to-4.6.1.md Co-authored-by: Pierre Noël <petersg83@users.noreply.github.com>

vercel bot deployed to Preview – documentation February 1, 2023 11:29 View deployment

vercel bot had a problem deploying to Preview – documentation-docu-mvp February 1, 2023 11:29 Failure

Update docs/developer-docs/latest/update-migration-guides/migration-g…

c4a58ea

…uides/v4/migration-guide-4.5.1-to-4.6.1.md Co-authored-by: Pierre Noël <petersg83@users.noreply.github.com>

vercel bot had a problem deploying to Preview – documentation-docu-mvp February 1, 2023 13:12 Failure

vercel bot deployed to Preview – documentation February 1, 2023 13:14 View deployment

improve explanation of webhooks populate relations usage

fccb023

vercel bot had a problem deploying to Preview – documentation-docu-mvp February 1, 2023 13:29 Failure

vercel bot deployed to Preview – documentation February 1, 2023 13:31 View deployment

Marc-Roig requested a review from petersg83 February 1, 2023 13:34

Merge branch 'main' into dev/webhook-populated-relations

217c002

Marc-Roig mentioned this pull request Feb 1, 2023

Move sizeLimit one level above in upload provider #1133

Merged

vercel bot deployed to Preview – documentation February 1, 2023 15:21 View deployment

vercel bot had a problem deploying to Preview – documentation-docu-mvp February 1, 2023 15:24 Failure

vercel bot had a problem deploying to Preview – documentation-docu-mvp February 6, 2023 16:55 Failure

Marc-Roig merged commit 8dbed9b into main Feb 6, 2023

Marc-Roig deleted the dev/webhook-populated-relations branch February 6, 2023 16:57

vercel bot deployed to Preview – documentation February 6, 2023 16:58 View deployment

pwizla added the replicate with docu label Feb 8, 2023

pwizla removed the replicate with docu label Feb 21, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add server webhooks populateRelations config variable #1430

Add server webhooks populateRelations config variable #1430

Uh oh!

Marc-Roig commented Jan 19, 2023

Uh oh!

vercel bot commented Jan 19, 2023 •

edited

Loading

Uh oh!

Uh oh!

pwizla commented Jan 19, 2023

Uh oh!

Marc-Roig commented Jan 20, 2023

Uh oh!

Uh oh!

pwizla commented Jan 20, 2023

Uh oh!

Marc-Roig commented Jan 23, 2023

Uh oh!

Marc-Roig commented Jan 25, 2023

Uh oh!

pwizla left a comment •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Add server webhooks populateRelations config variable #1430

Add server webhooks populateRelations config variable #1430

Uh oh!

Conversation

Marc-Roig commented Jan 19, 2023

What does it do?

Why is it needed?

Related issue(s)/PR(s)

Uh oh!

vercel bot commented Jan 19, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

pwizla commented Jan 19, 2023

Uh oh!

Marc-Roig commented Jan 20, 2023

Uh oh!

Uh oh!

pwizla commented Jan 20, 2023

Uh oh!

Marc-Roig commented Jan 23, 2023

Uh oh!

Marc-Roig commented Jan 25, 2023

Uh oh!

pwizla left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

vercel bot commented Jan 19, 2023 •

edited

Loading

pwizla left a comment •

edited

Loading