BUGFIX: Reduce nodetype schema size #4561

Sebobo · 2023-09-26T10:27:45Z

With this change the following optimisations are done to improve speed and reduce size of the schema generation:

Abstract nodetypes are not queried anymore for constraints as they are already resolved by the nodetype manager.
Entries in the inheritance map and constraints will be skipped if they don’t contain any data.

These optimisations reduce the size of the schema in the Neos.Demo from ~357KB to ~300KB and improve the response time by ~20% in my tests.

The more nodetypes a project has, the bigger the benefit is.

Review instructions

Everything should work the same, adding nodes, constraints, etc.

Checklist

Code follows the PSR-2 coding style
Tests have been created, run and adjusted as needed
The PR is created against the lowest maintained branch
Reviewer - PR Title is brief but complete and starts with FEATURE|TASK|BUGFIX
Reviewer - The first section explains the change briefly for change-logs
Reviewer - Breaking Changes are marked with !!! and have upgrade-instructions

With this change the following optimisations are done to improve speed and reduce size of the schema generation: * Abstract nodetypes are not queried anymore for constraints as they are already resolved by the nodetype manager. * Entries in the inheritance map and constraints will be skipped if they don’t contain any data. These optimisations reduce the size of the schema in the Neos.Demo from ~380KB to ~307KB and improve the response time by ~20%. The more nodetypes a project has, the bigger the benefit is.

Sebobo · 2023-09-26T10:29:52Z

I wanted to also skip the abstract types in the first loop, but the Neos.UI seems to need at least Neos.Neos:Document and Neos.Neos:Content in the inheritanceMap array.

Edit: I guess the entries in Neos.Neos.Ui.nodeTypeRoles are required.

Neos.Neos/Classes/Service/NodeTypeSchemaBuilder.php

Sebobo · 2023-10-13T12:14:58Z

Example from a customer project:

their schema was 23MB and with this change is 20MB.
response time was 4.1s and now is 3.2s.

Now their biggest chunk is broken nodetypes which are neither abstract nor have super types. Those are massively enriched by the schema builder with useless information.

kitsunet

This all makes sense to me, thanks! I kinda see the need to rethink how this schema works, or rather how we build it, seems super convoluted, but that's another task.

kdambekalns

Looks reasonable, I left just one small question inline…

Neos.Neos/Classes/Service/NodeTypeSchemaBuilder.php

Sebobo · 2023-10-23T14:29:46Z

Broke some tests, will check.

… nodetype anymore

Sebobo · 2023-10-25T11:56:27Z

@mhsdesign Tests run again, are you also ok with the change?

mhsdesign

yes ;)

reverts temporary #4561

mhsdesign · 2023-10-31T10:52:12Z

As we decided to move this either way to the neos ui, i eased the upmerge by ignoring your change for now.

See issue neos/neos-ui#3658

reverts temporary neos/neos-development-collection#4561

lorenzulrich · 2023-12-29T10:29:53Z

@Sebobo @mhsdesign It seems this breaks a feature of https://github.com/sitegeist/Sitegeist.Archaeopteryx and I'm not sure how exactly. In this package, I can configure the baseNodeType and allowedNodeTypes of a link.

In Neos 8.3.6, I could use Abstract Node Types in the configuration:

'Sitegeist.Archaeopteryx:Node':
  baseNodeType: 'FoobarCom.Site.Base:Document.Abstract.Page'
  allowedNodeTypes: ['FoobarCom.Site.Base:Document.Abstract.LinkablePage']

From 8.3.7, this does not work anymore.

In 8.3.6, the Node Type Schema returned abstract types including their children:

"FoobarCom.Site.Base:Document.Abstract.LinkablePage": [
	"FoobarCom.Site.Base:Document.KnowledgeBaseEntryPage",
	"FoobarCom.Site.Base:Document.RootPage",
	"FoobarCom.Site.Base:Document.Page",
	"FoobarCom.Site.Base:Document.KnowledgeBasePage",
	"FoobarCom.Site.Region:Document.RootPage",
	"FoobarCom.Site.Corporate:Document.RootPage"
],

In 8.3.7, this block is completely missing. Is there another way Sitegeist.Archaeopterix could resolve the node types beloging to such an Abstract type?

Sebobo · 2023-12-29T11:02:56Z

@Sebobo @mhsdesign It seems this breaks a feature of https://github.com/sitegeist/Sitegeist.Archaeopteryx and I'm not sure how exactly. In this package, I can configure the baseNodeType and allowedNodeTypes of a link.

In Neos 8.3.6, I could use Abstract Node Types in the configuration:
'Sitegeist.Archaeopteryx:Node':

  baseNodeType: 'FoobarCom.Site.Base:Document.Abstract.Page'

  allowedNodeTypes: ['FoobarCom.Site.Base:Document.Abstract.LinkablePage']
From 8.3.7, this does not work anymore.

In 8.3.6, the Node Type Schema returned abstract types including their children:
"FoobarCom.Site.Base:Document.Abstract.LinkablePage": [

	"FoobarCom.Site.Base:Document.KnowledgeBaseEntryPage",

	"FoobarCom.Site.Base:Document.RootPage",

	"FoobarCom.Site.Base:Document.Page",

	"FoobarCom.Site.Base:Document.KnowledgeBasePage",

	"FoobarCom.Site.Region:Document.RootPage",

	"FoobarCom.Site.Corporate:Document.RootPage"

],
In 8.3.7, this block is completely missing. Is there another way Sitegeist.Archaeopterix could resolve the node types beloging to such an Abstract type?

Yes there is a workaround in neos/neos-ui#3677 documented.
We weren't aware of any use of the API and I'm surprised that the plugin needs that as the backend should resolve the nodetypes 🧐

Sebobo added P: Node Types 8.3 labels Sep 26, 2023

github-actions bot added the Bug label Sep 26, 2023

mhsdesign reviewed Oct 12, 2023

View reviewed changes

Neos.Neos/Classes/Service/NodeTypeSchemaBuilder.php Outdated Show resolved Hide resolved

TASK: Ignore abstract nodetypes except the ones required by the Neos.UI

4289980

Sebobo marked this pull request as ready for review October 13, 2023 12:11

Sebobo requested a review from mhsdesign October 13, 2023 12:12

kitsunet approved these changes Oct 17, 2023

View reviewed changes

kdambekalns approved these changes Oct 23, 2023

View reviewed changes

Neos.Neos/Classes/Service/NodeTypeSchemaBuilder.php Outdated Show resolved Hide resolved

TASK: Unset postprocessors for abstract nodetypes too

f0d9b6f

TASK: Adjust tests now that the schema doesn’t contain every abstract…

49da2da

… nodetype anymore

mhsdesign approved these changes Oct 25, 2023

View reviewed changes

Sebobo merged commit c7306eb into 8.3 Oct 25, 2023
7 checks passed

Sebobo deleted the bugfix/reduce-nodetype-schema-size branch October 25, 2023 14:47

mhsdesign added a commit that referenced this pull request Oct 31, 2023

Merge remote-tracking branch 'origin/8.3' into 9.0

316d3c6

reverts temporary #4561

mhsdesign mentioned this pull request Oct 31, 2023

TASK: Move NodeTypeSchemaBuilder from Neos.Neos to ui neos/neos-ui#3658

Open

neos-bot pushed a commit to neos/content-repository that referenced this pull request Oct 31, 2023

Merge remote-tracking branch 'origin/8.3' into 9.0

f189df4

reverts temporary neos/neos-development-collection#4561

neos-bot pushed a commit to neos/neos that referenced this pull request Oct 31, 2023

Merge remote-tracking branch 'origin/8.3' into 9.0

821322b

reverts temporary neos/neos-development-collection#4561

mhsdesign mentioned this pull request Dec 20, 2023

nodeTypesRegistry.getSubTypesOf doesnt work for abstract node types neos/neos-ui#3677

Closed

lorenzulrich mentioned this pull request Dec 29, 2023

Abstract node type constraints not working in Neos 8.3.7+ sitegeist/Sitegeist.Archaeopteryx#54

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

BUGFIX: Reduce nodetype schema size #4561

BUGFIX: Reduce nodetype schema size #4561

Sebobo commented Sep 26, 2023 •

edited

Sebobo commented Sep 26, 2023 •

edited

Sebobo commented Oct 13, 2023 •

edited

kitsunet left a comment

kdambekalns left a comment

Sebobo commented Oct 23, 2023

Sebobo commented Oct 25, 2023

mhsdesign left a comment

mhsdesign commented Oct 31, 2023

lorenzulrich commented Dec 29, 2023

Sebobo commented Dec 29, 2023

BUGFIX: Reduce nodetype schema size #4561

BUGFIX: Reduce nodetype schema size #4561

Conversation

Sebobo commented Sep 26, 2023 • edited

Sebobo commented Sep 26, 2023 • edited

Sebobo commented Oct 13, 2023 • edited

kitsunet left a comment

Choose a reason for hiding this comment

kdambekalns left a comment

Choose a reason for hiding this comment

Sebobo commented Oct 23, 2023

Sebobo commented Oct 25, 2023

mhsdesign left a comment

Choose a reason for hiding this comment

mhsdesign commented Oct 31, 2023

lorenzulrich commented Dec 29, 2023

Sebobo commented Dec 29, 2023

Sebobo commented Sep 26, 2023 •

edited

Sebobo commented Sep 26, 2023 •

edited

Sebobo commented Oct 13, 2023 •

edited