Skip to content

add queryplan #436

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Mar 9, 2019
Merged

add queryplan #436

merged 1 commit into from
Mar 9, 2019

Conversation

keulinho
Copy link
Contributor

@keulinho keulinho commented Feb 1, 2019

Provide the possibility to lookahead the Query Execution.
This one adds the API proposed in #65.
From #65:

  1. What sub-fields were requested (regardless of fragment types)? -> still possible
  2. What types were referenced by fragments? -> could be added
  3. What sub-fields were requested for given type? -> possible
  4. What args/directives were set for given field? -> possible for args, directives could be added

mfn
mfn reviewed Feb 1, 2019
View reviewed changes
tests/Type/QueryPlanTest.php Outdated
self::assertEquals($expectedReferencedFields, $queryPlan->referencedFields());
self::assertEquals(['url', 'width', 'height'], $queryPlan->subFields('Image'));

static::assertTrue($queryPlan->hasField('url'));
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What's up with the self:: vs. static:: calls here?

Maybe it's through out the codebase and I just didn't notice it before 🤔

Copy link
Contributor Author

@keulinho keulinho Feb 1, 2019 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good catch 👍
the convention seems to be self:: but i'm used to static::

fixed it

@keulinho keulinho force-pushed the add-queryplan branch 2 times, most recently from 85bdb8b to 3e8d848 Compare February 1, 2019 20:29
simPod
simPod requested changes Feb 1, 2019
View reviewed changes
src/Type/Definition/QueryPlan.php Outdated
* @param mixed[] $variableValues
* @param FragmentDefinitionNode[] $fragments
*
* @throws Error
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IMO the @throws anotation can be dropped. I have never found a way how to sustainably maintain those across the whole project.

src/Type/Definition/QueryPlan.php Outdated

public function hasType(string $type) : bool
{
return count(array_filter($this->referencedTypes(), static function ($element) use ($type) {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess we can typehint string $element. And then change variable name to $referencedType

src/Type/Definition/QueryPlan.php Outdated
/**
* @return string[]
*/
public function referencedTypes() : array
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd prefix with get

src/Type/Definition/QueryPlan.php Outdated
/**
* @return string[]
*/
public function referencedFields() : array
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

prefix get as well.

src/Type/Definition/QueryPlan.php Outdated

public function hasField(string $field) : bool
{
return count(array_filter($this->referencedFields(), static function ($element) use ($field) {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
return count(array_filter($this->referencedFields(), static function ($element) use ($field) {
return count(array_filter($this->referencedFields(), static function (string $referencedField) use ($field) {

src/Type/Definition/QueryPlan.php Outdated
} elseif ($selectionNode instanceof FragmentSpreadNode) {
$spreadName = $selectionNode->name->value;
if (isset($this->fragments[$spreadName])) {
/** @var FragmentDefinitionNode $fragment */
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this can be dropped, no?

src/Type/Definition/ResolveInfo.php Outdated
@@ -99,6 +99,13 @@ class ResolveInfo
*/
public $variableValues = [];

/**
* @internal
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the var is private so I guess we can drop this

src/Type/Definition/ResolveInfo.php Outdated
*
* @var QueryPlan
*/
private $queryPlan = null;
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

null is default, can be dropped

src/Type/Definition/ResolveInfo.php Outdated
@@ -179,6 +186,22 @@ public function getFieldSelection($depth = 0)

return $fields;
}

public function lookahead() : QueryPlan
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If meant as verb, the proper camel case is lookAhead

tests/Type/QueryPlanTest.php Outdated
use GraphQL\Type\Schema;
use PHPUnit\Framework\TestCase;

class QueryPlanTest extends TestCase
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
class QueryPlanTest extends TestCase
final class QueryPlanTest extends TestCase

@vladar
Copy link
Member

vladar commented Feb 4, 2019

This is great! I need some time to digest it before I can post any feedback or merge. Thanks!

vladar
vladar reviewed Feb 19, 2019
View reviewed changes
tests/Executor/ExecutorTest.php
],
array_keys((array) $info)
);

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why deleting this? Can't you just add queryPlan key to this list?

Copy link
Contributor Author

@keulinho keulinho Feb 26, 2019 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

queryPlan is declared private because it should only be loaded lazy when you call lookAhead()
When you cast the resolveInfo to array now it cpontains some binary string instead of queryPlan because it is private.
Furthermore i really saw no value added by this test, because every key mentionied there would be used for own assertions, so the test will fail anyway if you remove one of the public properties.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, missed your reply. Makes sense.

@vladar vladar mentioned this pull request Mar 6, 2019
Closed
@vladar vladar merged commit 29eba82 into webonyx:master Mar 9, 2019
@vladar vladar mentioned this pull request Jul 1, 2019
Merged
@yura3d yura3d mentioned this pull request Jul 25, 2019
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mfn mfn mfn left review comments

@vladar vladar vladar left review comments

@simPod simPod simPod requested changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@keulinho @vladar @mfn @simPod