perf: improve the performance of 'Static Content Page' component #1603
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
shauke
force-pushed
the
feature/static_content_page_component_improvements
branch
from
9b21daa to
87c4eb5
Compare
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
SGrueber
previously approved these changes
Mar 11, 2024
…erings by optimizing/limiting the '/pagetree' REST calls regarding the used 'depth' BREAKING CHANGES: An empty 'NavigationDepth' value of the 'Static Content Page' component now defaults to '0' instead of no depth limitation, that resulted in the whole content page tree being fetched and saved to the state (see [Migrations / From 5.0 to 5.1](https://github.com/intershop/intershop-pwa/blob/develop/docs/guides/migrations.md#from-50-to-51) for more details).
shauke
force-pushed
the
feature/static_content_page_component_improvements
branch
from
87c4eb5 to
b35c539
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
perf: improve the performance of 'Static Content Page' component renderings by optimizing/limiting the '/pagetree' REST calls regarding the used 'depth'
PR Type
[x] Other: performance improvement
What Is the Current Behavior?
To improve the performance of the 'Static Content Page' component the triggered
/pagetreeREST calls default behavior regarding the useddepthwas changed.In the past no given 'Navigation Depth' in the ICM backend configuration resulted in no limitation at all ("Define how many levels the navigation tree displays. To show all levels, leave the field empty.").
With the content model adaptions of
icm-as-customization-headless:1.7.0a depth default value of5was introduced and the description was changed accordingly.What Is the New Behavior?
In the PWA the rendering was adapted as well so that an empty
NavigationDepthvalue of the 'Static Content Page' component now defaults to0instead of no depth limitation, that resulted in the whole content page tree being fetched and saved to the state.Does this PR Introduce a Breaking Change?
[x] Yes
BREAKING CHANGES: An empty 'NavigationDepth' value of the 'Static Content Page' component now defaults to '0' instead of no depth limitation, that resulted in the whole content page tree being fetched and saved to the state (see Migrations / From 5.0 to 5.1 for more details).
To keep the current behavior in an existing project either adapt the
0default inpagelet.numberParam('NavigationDepth', 0)"to a reasonable number or set the 'Navigation Depth' values for all 'Static Content Page' component instances in the ICM backend to reasonable depth values instead of leaving them empty.Other Information
Note: Best fitting CMS content model comes with ICM 11 +
icm-as-customization-headless:1.7.0(and newer versions).AB#94810