Add optimized selects #1626
There are no files selected for viewing
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| <?php | ||
|
|
||
| namespace Nuwave\Lighthouse\Select; | ||
|
|
||
| use Nuwave\Lighthouse\Schema\Directives\BaseDirective; | ||
|
|
||
| class SelectDirective extends BaseDirective | ||
| { | ||
| public static function definition(): string | ||
| { | ||
| return /** @lang GraphQL */ <<<'GRAPHQL' | ||
| """ | ||
| Specify the SQL column dependencies of this field. | ||
| """ | ||
| directive @select( | ||
| """ | ||
| SQL columns names to pass to the Eloquent query builder | ||
| """ | ||
| columns: [String!] | ||
| ) on FIELD_DEFINITION | ||
| GRAPHQL; | ||
| } | ||
| } | ||
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
| Original file line number | Diff line number | Diff line change | ||||||
|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,99 @@ | ||||||||
| <?php | ||||||||
|
|
||||||||
| namespace Nuwave\Lighthouse\Select; | ||||||||
|
|
||||||||
| use GraphQL\Language\AST\Node; | ||||||||
| use GraphQL\Language\AST\UnionTypeDefinitionNode; | ||||||||
| use Illuminate\Database\Eloquent\Model; | ||||||||
| use Nuwave\Lighthouse\Schema\AST\ASTBuilder; | ||||||||
| use Nuwave\Lighthouse\Schema\AST\ASTHelper; | ||||||||
|
|
||||||||
| class SelectHelper | ||||||||
| { | ||||||||
| /** | ||||||||
| * Given a field definition node, resolve info, and a model name, return the SQL columns that should be selected. | ||||||||
| * Accounts for relationships and the rename and select directives. | ||||||||
| * | ||||||||
| * @param mixed[] $fieldSelection | ||||||||
| * @return string[] | ||||||||
| */ | ||||||||
| public static function getSelectColumns(Node $definitionNode, array $fieldSelection, string $modelName): array | ||||||||
| { | ||||||||
| $returnTypeName = ASTHelper::getUnderlyingTypeName($definitionNode); | ||||||||
|
|
||||||||
| /** @var \Nuwave\Lighthouse\Schema\AST\DocumentAST $documentAST */ | ||||||||
| $documentAST = app(ASTBuilder::class)->documentAST(); | ||||||||
|
|
||||||||
| $type = $documentAST->types[$returnTypeName]; | ||||||||
| // error_log(print_r($type, true)); | ||||||||
|
|
||||||||
| if ($type instanceof UnionTypeDefinitionNode) { | ||||||||
| $type = $documentAST->types[ASTHelper::getUnderlyingTypeName($type->types[0])]; | ||||||||
| } | ||||||||
|
|
||||||||
|
|
||||||||
| /** @var iterable<\GraphQL\Language\AST\FieldDefinitionNode> $fieldDefinitions */ | ||||||||
| $fieldDefinitions = $type->fields; | ||||||||
|
|
||||||||
| $model = new $modelName; | ||||||||
|
|
||||||||
| $selectColumns = []; | ||||||||
|
|
||||||||
| foreach ($fieldSelection as $field) { | ||||||||
| $fieldDefinition = ASTHelper::firstByName($fieldDefinitions, $field); | ||||||||
|
|
||||||||
| if ($fieldDefinition) { | ||||||||
| $directivesRequiringLocalKey = ['hasOne', 'hasMany', 'count']; | ||||||||
| $directivesRequiringForeignKey = ['belongsTo', 'belongsToMany', 'morphTo']; | ||||||||
| $directivesRequiringKeys = array_merge($directivesRequiringLocalKey, $directivesRequiringForeignKey); | ||||||||
|
There was a problem hiding this comment. Since we are trying to optimize performance here: Those should all be |
||||||||
|
|
||||||||
| foreach ($directivesRequiringKeys as $directiveType) { | ||||||||
| if (ASTHelper::hasDirective($fieldDefinition, $directiveType)) { | ||||||||
| $directive = ASTHelper::directiveDefinition($fieldDefinition, $directiveType); | ||||||||
|
|
||||||||
| if (in_array($directiveType, $directivesRequiringLocalKey)) { | ||||||||
| $relationName = ASTHelper::directiveArgValue($directive, 'relation', $field); | ||||||||
|
|
||||||||
| if (method_exists($model, $relationName)) { | ||||||||
| array_push($selectColumns, $model->{$relationName}()->getLocalKeyName()); | ||||||||
| } | ||||||||
| } | ||||||||
|
|
||||||||
| if (in_array($directiveType, $directivesRequiringForeignKey)) { | ||||||||
| $relationName = ASTHelper::directiveArgValue($directive, 'relation', $field); | ||||||||
|
|
||||||||
| if (method_exists($model, $relationName)) { | ||||||||
| array_push($selectColumns, $model->{$relationName}()->getForeignKeyName()); | ||||||||
| } | ||||||||
| } | ||||||||
|
|
||||||||
| continue 2; | ||||||||
| } | ||||||||
| } | ||||||||
|
|
||||||||
| if (ASTHelper::hasDirective($fieldDefinition, 'select')) { | ||||||||
| // append selected columns in select directive to seletion | ||||||||
| $directive = ASTHelper::directiveDefinition($fieldDefinition, 'select'); | ||||||||
|
|
||||||||
| if ($directive) { | ||||||||
| $selectFields = ASTHelper::directiveArgValue($directive, 'columns') ?? []; | ||||||||
| $selectColumns = array_merge($selectColumns, $selectFields); | ||||||||
| } | ||||||||
| } elseif (ASTHelper::hasDirective($fieldDefinition, 'rename')) { | ||||||||
| // append renamed attribute to selection | ||||||||
| $directive = ASTHelper::directiveDefinition($fieldDefinition, 'rename'); | ||||||||
|
|
||||||||
| if ($directive) { | ||||||||
| $renamedAttribute = ASTHelper::directiveArgValue($directive, 'attribute'); | ||||||||
| array_push($selectColumns, $renamedAttribute); | ||||||||
| } | ||||||||
| } else { | ||||||||
| // fallback to selecting the field name | ||||||||
| array_push($selectColumns, $field); | ||||||||
| } | ||||||||
| } | ||||||||
| } | ||||||||
|
|
||||||||
| return array_unique($selectColumns); | ||||||||
|
There was a problem hiding this comment. I'm not sure, but if I need an accessor that is not in the table columns, we will get a "Column not found" SQL error.
Suggested change
|
||||||||
| } | ||||||||
| } | ||||||||
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
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This directive has no use without this argument.