Add types parameter to BuildSchema#1872
Open
spawnia wants to merge 6 commits into
Open
Conversation
…nstances from SDL Enables users to supply custom type instances (e.g., scalars with serialize/parseValue, enums with PHP values) when building a schema from SDL, without having to use the more awkward typeConfigDecorator callback pattern. Types whose names match SDL definitions replace the SDL-built instances. Types whose names are absent from the SDL are registered as extra types. Closes #681
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a types parameter to the SDL schema build path (BuildSchema) so callers can inject pre-built type instances (e.g., custom scalars/enums) in the same way Schema/SchemaConfig already support via types.
Changes:
- Extend
BuildSchema::build()/BuildSchema::buildAST()(and constructor) with an optionaliterable $types = []parameter. - Add override support in
ASTDefinitionBuilderso provided named types can replace SDL-defined types by name (without mutating user instances). - Ensure “extra” provided types (not present in SDL) are still discoverable via
Schema::getType()/getTypeMap(), and add coverage + docs/changelog updates.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
src/Utils/BuildSchema.php |
Plumbs a new types parameter through SDL build, wires override/extra type behavior into SchemaConfig’s type loader and types list. |
src/Utils/ASTDefinitionBuilder.php |
Adds a typeOverrides map and short-circuits type building to return provided instances for matching SDL names. |
tests/Utils/BuildSchemaTest.php |
Adds a test validating SDL-defined type overrides (scalar/enum) and registration of extra types, including end-to-end scalar serialization. |
docs/class-reference.md |
Documents the new types parameter for BuildSchema::build() and BuildSchema::buildAST(). |
CHANGELOG.md |
Notes the new capability in the Unreleased “Added” section. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
# Conflicts: # CHANGELOG.md
spawnia
changed the title
types parameter to BuildSchema
Comment on lines
+215
to
+225
| /** @var array<string, Type&NamedType> $typeOverrides */ | ||
| $typeOverrides = []; | ||
| /** @var array<string, Type&NamedType> $extraTypesMap */ | ||
| $extraTypesMap = []; | ||
| foreach ($this->types as $type) { | ||
| if (isset($typeDefinitionsMap[$type->name])) { | ||
| $typeOverrides[$type->name] = $type; | ||
| } else { | ||
| $extraTypesMap[$type->name] = $type; | ||
| } | ||
| } |
Comment on lines
+219
to
+225
| foreach ($this->types as $type) { | ||
| if (isset($typeDefinitionsMap[$type->name])) { | ||
| $typeOverrides[$type->name] = $type; | ||
| } else { | ||
| $extraTypesMap[$type->name] = $type; | ||
| } | ||
| } |
Comment on lines
+273
to
+275
| if (isset($this->typeOverrides[$typeName])) { | ||
| return $this->cache[$typeName] = $this->typeOverrides[$typeName]; | ||
| } |
Comment on lines
+73
to
+76
| $schema = BuildSchema::build( | ||
| file_get_contents('schema.graphql'), | ||
| types: [$dateType], | ||
| ); |
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
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.
The existing workaround for custom scalar behavior in SDL-first schemas is typeConfigDecorator, which forces users to manually merge config arrays and cannot return a pre-built type instance at all. This creates unnecessary friction for a common need.
This PR brings the same types API that Schema/SchemaConfig already accepts to the SDL build path so both approaches are consistent.
Closes #681