Unhelpful error message when a query is defined twice

[lexmes]

Lets assume we have to following setup:

class ControllerA {
  /**
   * @Query()
   * @returns string[]
   */
  allPosts() : array;
}

...

class ControllerB {
  /**
   * @Query()
   * @returns string[]
   */
  allPosts() : array;
}

Right now the error message that i get is: assert($firstDuplicate instanceof FieldDefinition). Thats not very helpful. I would suggest something along the lines of cannot redeclare query "allPosts" in controller "<FQDN>\ControllerB" as it was already defined in <FQDN>\ControllerA.

I don't know if its my setup that is causing this error. But even then its not very helpful.

The error is generated in AggregateControllerQueryProvider.php:98.

[moufmouf]

Interesting!
Do you think you could write an integration test to showcase the problem?

For instance by duplicating this test (

graphqlite/tests/Integration/EndToEndTest.php

Lines 1533 to 1547 in c617743

	public function testInputOutputNameConflict(): void
	{
	$arrayAdapter = new ArrayAdapter();
	$arrayAdapter->setLogger(new ExceptionLogger());
	$schemaFactory = new SchemaFactory(new Psr16Cache($arrayAdapter), new BasicAutoWiringContainer(new EmptyContainer()));
	$schemaFactory->addControllerNamespace('TheCodingMachine\\GraphQLite\\Fixtures\\InputOutputNameConflict\\Controllers');
	$schemaFactory->addTypeNamespace('TheCodingMachine\\GraphQLite\\Fixtures\\InputOutputNameConflict\\Types');
	$schema = $schemaFactory->createSchema();
	$this->expectException(CannotMapTypeException::class);
	$this->expectExceptionMessage('For parameter $inAndOut, in TheCodingMachine\\GraphQLite\\Fixtures\\InputOutputNameConflict\\Controllers\\InAndOutController::testInAndOut, type "InAndOut" must be an input type (if you declared an input type with the name "InAndOut", make sure that there are no output type with the same name as this is forbidden by the GraphQL spec).');
	$schema->validate();
	}

) and creating a new namespace with both controllers?

[lexmes]

Yep, will give it a go :)

[lexmes]

I've tried to recreate the issue here: lexmes@49274e3

But the error message there is correct. Can you think of any Circumstance under which the assert($firstDuplicate instanceof FieldDefinition) expression in https://github.com/lexmes/graphqlite/blob/master/src/AggregateControllerQueryProvider.php#L98 will yield false?

[oojacoboo]

@lexmes I'm assuming you confirmed that assertions are enabled in the environment in which you tested? That's a PHP config setting. I not really sure that we should be using assert in this particular case.

[aszenz]

I have seen some errors from asserts in development, it's usually when queries/fields/names are duplicated

[oojacoboo]

Assert can be problematic b/c it doesn't provide any context to the assertion. And you took the time to write it. Just take a few seconds more to throw an exception with an intelligible message that helps the developer, or yourself later on.

[oojacoboo]

@lexmes can you create a PR for this please.