Usage with strict GraphQL clients

[sfriedel]

I'm trying to use graphjin as the API backend for a SvelteKit application using the houdini GraphQL client and am running into numerous problems with the generated GraphQL schema. The houdini client is rather strict about GraphQL schemas because it uses the schema for generating Typescript types and supporting JS code for SvelteKit.

I'm using graphjin in service mode via the dosco/graphjin:latest image and have defined the following table structure:

create table profiles (
  id uuid not null primary key,
  updated_at timestamp with time zone,
  username text unique,
  full_name text,
  avatar_url text,
  website text,

  constraint username_length check (char_length(username) >= 3)
);

and I try to query it with the following query:

query getProfile {
	profiles {
		id
	}
}

I can run the query via graphiql interface of graphjin but it marks the query with an error:

Field "profiles" argument "id" of type "ID!" is required, but it was not provided

Besides the error I can submit the query and graphjin responds without issues.

When I try the same with the houdini client though it fails because it detects that the query is not valid according to the schema and it aborts code generation.

Some other things I found:

• the Query.profiles field can respond with both a list or a single item based on parameterization. In the schema the field is not define d as a list type though
• the "@object" directive does not appear to be defined in the introspected schema

I'm starting to wonder if graphjin is just not a good fit to use with a client lib like houdini that does strict schema validation. Is there anything I could be doing differently or how are others dealing with it?

[dosco]

if you want to fetch by id you can

query getProfile(id: ID!) {
	profilesById(id: $id) {
		id
	}
}

[federico-hv]

Hi @dosco, first of all thanks for this really nice project! What I think @sfriedel meant here is how to fetch all profiles SELECT * FROM PROFILES; and not just one by ID SELECT * PROFILES WHERE ID = <argumentID> without having this schema validation issue. In my case I'm seeing this similar error argument "id" of type "ID!" is required, but it was not provided on graphiQL and insomnia when I tried to fetch all records. The query still works and brings all the users as expected but an error is displayed since the schema shows ID field as required and it was not provided. Now, this doesn't seem to be an issue for a client that does not have strict validation but I was wondering if it may be some configuration that I'm missing on my .yml files or something like that?

[dosco]

That could be a bug with the introspection schema intro.go technically it's not an error it's just how the introspection schema is being processed and interpreted by the Insomia and the Webui (graphiql). What I mean by not an error is that GraphJin itself is not throwing an error your query is being handled properly.

I suspect its got something to do with the fact we have some behaviours that might not be considered strict GraphQL. For example we have the ByID suffix to allow you to do things like productsByID(id: 5) and you can also do the same without ByID as so products(id: 3) this was originally for backward compatibility. And somehow this could be reflected in the introspection schema as not strict GraphQL. I'm not sure just a guess.