Error "Table Definition for <entity> has not been inferred."

[yorek]

When trying to execute a query via GraphQL I get the following error:

{
  "errors": [
    {
      "message": "Table Definition for Todo has not been inferred.",
      "locations": [
        {
          "line": 2,
          "column": 3
        }
      ],
      "path": [
        "todos"
      ]
    }
  ]
}

the stack dump is:

Table Definition for Todo has not been inferred.
   at Azure.DataGateway.Service.Services.SqlMetadataProvider`3.GetSchemaName(String entityName) in w:\_git\_hawaii\hawaii-engine\DataGateway.Service\Services\MetadataProviders\SqlMetadataProvider.cs:line 101
   at Azure.DataGateway.Service.Resolvers.SqlQueryStructure..ctor(IResolverContext ctx, IDictionary`2 queryParams, ISqlMetadataProvider sqlMetadataProvider, IObjectField schemaField, FieldNode queryField, IncrementingInteger counter, String entityName) in w:\_git\_hawaii\hawaii-engine\DataGateway.Service\Resolvers\Sql Query Structures\SqlQueryStructure.cs:line 297
   at Azure.DataGateway.Service.Resolvers.SqlQueryStructure..ctor(IResolverContext ctx, IDictionary`2 queryParams, ISqlMetadataProvider sqlMetadataProvider) in w:\_git\_hawaii\hawaii-engine\DataGateway.Service\Resolvers\Sql Query Structures\SqlQueryStructure.cs:line 103
   at Azure.DataGateway.Service.Resolvers.SqlQueryEngine.ExecuteAsync(IMiddlewareContext context, IDictionary`2 parameters) in w:\_git\_hawaii\hawaii-engine\DataGateway.Service\Resolvers\SqlQueryEngine.cs:line 68
   at Azure.DataGateway.Service.Services.ResolverMiddleware.InvokeAsync(IMiddlewareContext context) in w:\_git\_hawaii\hawaii-engine\DataGateway.Service\Services\ResolverMiddleware.cs:line 71
   at HotChocolate.Utilities.MiddlewareCompiler`1.ExpressionHelper.AwaitTaskHelper(Task task)
   at HotChocolate.Execution.Processing.Tasks.ResolverTask.ExecuteResolverPipelineAsync(CancellationToken cancellationToken)
   at HotChocolate.Execution.Processing.Tasks.ResolverTask.TryExecuteAsync(CancellationToken cancellationToken)

everything works fine if I execute a REST request.

The configuration schema is

{
    "$schema": "hawaii.draft-01.schema.json",
    "data-source": {
        "database-type": "mssql",
        "connection-string": "Server=localhost;Database=HawaiiTest;User ID=sa;Password=Passw0rd!;TrustServerCertificate=true"
    },
    "runtime": {
        "host": {
            "mode": "development",
            "authentication": {
                "provider": "AzureAD",
                "jwt": {
                  "audience": "e98794ab-cdaa-4ed3-ad08-0552c47254e2",
                  "issuer": "https://login.microsoftonline.com/72f988bf-86f1-41af-91ab-2d7cd011db47/v2.0"
                }
            }
        },
        "rest": {
            "enabled": true
        },
        "graphql": {
            "enabled": true
        }
    },
    "entities": {
        "todo": {
            "source": "s002.todos",
            "relationships": {
                "category": {
                    "cardinality": "one",                    
                    "target.entity": "category"                    
                }
            },
            "permissions": [
                {
                    "role": "anonymous",
                    "actions": [
                        "*"
                    ]
                }
            ]
        },
        "category": {
            "source": "s002.categories",
            "relationships": {
                "todos": {
                    "cardinality": "many",                    
                    "target.entity": "todo"
                }
            },
            "permissions": [
                {
                    "role": "anonymous",
                    "actions": [
                        "*"
                    ]
                }
            ]
        }
    }
}

and the database

drop table if exists s002.todos
drop table if exists s002.categories
drop sequence if exists s002.globalId
go

create sequence s002.globalId
as int start with 10000
go

create table s002.categories
(
	id int not null primary key default (next value for s002.globalId),
	category nvarchar(100) not null unique
)
go

create table s002.todos
(
	id int not null 
		default (next value for s002.globalId)
		constraint pk__s002_todos primary key,
	category_id int not null 
		constraint fk__s002_todos2__s002_categories references s002.categories(id),
	title nvarchar(100) not null,
	[description] nvarchar(1000) null,
	completed bit not null default(0)
)
go

insert into s002.categories
	(id, category)
values
	(1, 'Family'),
	(2, 'Work'),
	(3, 'Hobby'),
	(4, 'Car'),
	(5, 'Bike')
go

insert into s002.todos
	(title, completed, category_id)
values
	('item-001', 0, 1),
	('item-002', 1, 1),
	('item-003', 1, 2),
	('item-004', 0, 3),
	('item-005', 1, 4),
	('item-006', 0, 3),
	('item-007', 0, 4),
	('item-008', 1, 4),
	('item-009', 1, 1),
	('item-010', 0, 2),
	('item-011', 1, 3),
	('item-012', 0, 4),
	('item-013', 1, 5),
	('item-015', 1, 1),
	('item-016', 0, 2),
	('item-017', 0, 4),
	('item-018', 1, 5),
	('item-019', 1, 3),
	('item-019', 1, 1),
	('item-020', 0, 2)

[seantleonard]

What happens when you add the "graphQL": true to the entity?
I don't see in the https://github.com/Azure/project-hawaii/blob/main/rfcs/configuration-file.md#graphql-type specification that there should be a default.

{
    "$schema": "hawaii.draft-01.schema.json",
    "data-source": {
        "database-type": "mssql",
        "connection-string": "Server=localhost;Database=HawaiiTest;User ID=sa;Password=Passw0rd!;TrustServerCertificate=true"
    },
    "runtime": {
        "host": {
            "mode": "development",
            "authentication": {
                "provider": "AzureAD",
                "jwt": {
                  "audience": "e98794ab-cdaa-4ed3-ad08-0552c47254e2",
                  "issuer": "https://login.microsoftonline.com/72f988bf-86f1-41af-91ab-2d7cd011db47/v2.0"
                }
            }
        },
        "rest": {
            "enabled": true
        },
        "graphql": {
            "enabled": true
        }
    },
    "entities": {
        "todo": {
            "source": "s002.todos",
            "graphql": true,
            "relationships": {
                "category": {
                    "cardinality": "one",                    
                    "target.entity": "category"                    
                }
            },
            "permissions": [
                {
                    "role": "anonymous",
                    "actions": [
                        "*"
                    ]
                }
            ]
        },
        "category": {
            "source": "s002.categories",
            "graphql": true,
            "relationships": {
                "todos": {
                    "cardinality": "many",                    
                    "target.entity": "todo"
                }
            },
            "permissions": [
                {
                    "role": "anonymous",
                    "actions": [
                        "*"
                    ]
                }
            ]
        }
    }
}

[seantleonard]

Perhaps we're not honoring: https://github.com/Azure/project-hawaii/blob/main/rfcs/configuration-file.md#graphql

GraphQL
enabled: defines, at runtime level, if the GraphQL endpoint is enabled. If set to true, the defined GraphQL entities will be exposed unless the graphql property within an entity configuration is set false. Optional. Default is true.

[seantleonard]

progress: this is due to

public Dictionary<string, DatabaseObject> EntityToDatabaseObject { get; set; } =
            new(StringComparer.InvariantCulture);

in SqlMetadataProvider having casesensitive matching on keys, for which we capitalize the first letter of the entity. Looking into where.

[seantleonard]

Processing of the config verbatim is here: https://github.com/Azure/hawaii-engine/blob/3dc7cbe5baabe54b0930e5046711335f0e89225f/DataGateway.Service/Services/MetadataProviders/SqlMetadataProvider.cs#L216-L248

GraphQL Schema builder does some case changes here on the last line of this helper method to capitalize the first letter:
https://github.com/Azure/hawaii-engine/blob/3dc7cbe5baabe54b0930e5046711335f0e89225f/DataGateway.Service.GraphQLBuilder/GraphQLNaming.cs#L39-L49

[seantleonard]

however, per GraphQL specification, GraphQL names are case sensitive https://spec.graphql.org/June2018/#sec-Names

[Aniruddh25]

@yorek, a workaround could be naming your entity todo to be Todo in the config file since the gql names are case sensitive.

Like @seantleonard mentioned, we are modifying the entity name provided in the config to follow GraphQL type name convention when autogenerating the schema - this goes against the requirement of keeping the entity names case sensitive in the configuration file.

What is the preference?

• Follow GraphQL convention when autogenerating the schema OR
• Stick to the names specified in the config.

[yorek]

Thanks! The issue is that I have specified "todo" as lowercase name in the configuration file, but the engine is trying to search for a "Todo" entity, which is, correctly, not found, as JSON is case sensitive.
My understanding is that also the REST endpoint is case sensitive. Let's keep everything consistent - so everything is case sensitive, both REST and GraphQL - for now. There may be some feedback around having the REST endpoint case sensitive - I feel the majority of the people will prefer to have it case insensitive - but I really want to get some feedback on this, before making a final decision.

[Aniruddh25]

Alright, we can keep everything case SENSITIVE. In that case, if you specify "todo" in the config file, would you like us to name the GraphQL type as "todo" as well? instead of automatically modifying the entity name to be "Todo" when we generate the GraphQL type?

[yorek]

Let's generate the entity name using the same casing used in the configuration file

[seantleonard]

One thing to keep in mind when handling entities and fields for GraphQL is the GraphQL Specification requirements for names: http://spec.graphql.org/draft/#sec-Names

This means that we will need make sure to enforce those constraints in our config when naming entities and fields.