Fix: build sanitise schema per item to restore subclass dispatch#99
Closed
Fix: build sanitise schema per item to restore subclass dispatch#99
Conversation
PR #97 hoisted the getSchema call out of the per-item loop on the basis that getSchema is idempotent for a given schemaName. That holds for the base implementation here but not for subclasses that override getSchema to dispatch on the item itself (notably ContentModule, which returns a different schema per content type / component / enabled- plugin set). With the hoisted call, ContentModule's getSchema received the array as its data argument, fell back to the base content schema, and dropped all component-specific and extension fields when sanitising GET responses. Restoring per-item getSchema fixes the dispatch. The cost is bounded by DataCache (find/findOne) and ContentModule's own _schemaCache, which between them keep extra DB hits to one per unique component type per request.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Fix
getSchemacall insidesanitise()so subclasses that overridegetSchemato dispatch on the data argument (notablyContentModule) get the right schema for each item.Background
PR #97 hoisted the
getSchemacall out of the per-item loop on the basis thatgetSchemais idempotent for a givenschemaName. That holds forAbstractApiModule.getSchemabut not for subclasses that override it to vary by data —ContentModule.getSchemareturns a different schema per content type /_component/ enabled-plugin set.With the hoisted call,
ContentModule.getSchemareceived the array as itsdataargument, fell back to the basecontentschema, and dropped all component-specific and extension fields when sanitising GET responses. Concretely, GETting a graphic component returned only base fields —_graphic,_vanilla,_pageLevelProgressetc. were stripped, so the editor lost the asset thumbnail on revisit.PR #97's stated rationale ("
schema.sanitise()is now synchronous") is correct but didn't actually motivate removing the loop — theawaitin the previous code was forgetSchema(still async), notsanitise.Cost
Bounded by:
AbstractApiModule.find/findOne— already DataCached (AbstractApiModule.js:650).ContentModule._schemaCache— already keys built schemas byschemaName + enabledPlugins.Worst case for a 100-item batch with 10 unique component types: ~11 DB hits and ~10 schema builds on a cold cache; subsequent items hit the cache. Same shape as pre-PR-97 behaviour.
Testing
npm testadapt-authoring-content,GET /api/content/<componentId>for a graphic component and confirm_graphic,_vanilla,_pageLevelProgress, etc. appear in the response.