Enum handling #213

affanshahid · 2018-10-28T12:28:47Z

If I add an enum to my gql schema with a matching enum in my models file, the tool throws an error saying a model was not found. If I change the type of the enum (in my models) to interface, then it works but obviously is broken.

TL;DR: The tool expects an interface model for an enum in the schema

Weakky · 2018-10-29T14:54:37Z

Hey 👋,

We're indeed currently not supporting enums defined in typescript files.

One current workaround would be to define your enums using union types based on string literals instead of TS interfaces.

Given such an enum defined in your GraphQL schema:

enum Color {
  RED,
  GREEN,
  BLUE
}

You could define such a type in your typescript file:
(Which is not perfect but better than an using an interface)

type Color = 'RED' | 'GREEN' | 'BLUE'

Bottom line: This is a known limitation that we'll have to fix 🙏

affanshahid · 2018-10-29T14:58:12Z

Thanks for the help! This excellent tool btw, great work.

arielschiavoni · 2018-10-29T20:20:46Z

Hi, I have a very similar issue. I use the config from the typescript-graphql
prisma examples.

In order to make my resolver typecheck I have to use the following config defaultName: '${typeName}Node' in my graphqlgen.yml file.

models:
  files:
    - path: ./src/generated/prisma-client
      defaultName: '${typeName}Node'

Without defaultName: '${typeName}Node'

With defaultName: '${typeName}Node'

So far so good, however when I added enums to my schema I couldn't manage to make it work anymore.

The enum types are correctly generated by prisma.

schema.graphql

enum LANG {
  EN
  DE
}

prisma-client/index.ts

export type LANG = "EN" | "DE";

However I get the error that the types are not defined.

I tried copy pasting the union type from the prisma-client/index.ts file into my own models.ts and added them to the graphqlgen config without the defaultName prop. But it does not work either.

models:
  files:
    - path: ./src/generated/prisma-client
      defaultName: '${typeName}Node'
    - path: ./src/models.ts

sidroopdaska · 2018-10-30T14:29:49Z

Is there a timeline on this being fixed?

Weakky · 2018-10-30T14:38:06Z

Hey 👋,

The reason for this behavior at the moment is because of the defaultName: '${typeName}Node' property. Enums generated by prisma-client do not have this pattern name and are therefore ignored. Although this is technically not a bug, we need to find a way make this clearer and simpler.

Workaround

Suggestion 1

Configure your models property of your graphqlgen.yml file in the following way:

models:
  files:
    - ./src/generated/prisma-client
    - path: ./src/generated/prisma-client
      defaultName: '${typeName}Node'

This way, graphqlgen is going to proceed like this:

Look for typescript models that have the same names as your graphql types (eg: Role model mapping to Role graphql type)
If none found, look for typescript models that matches graphql type names following the pattern ${typeName}Node (eg: UserNode model mapping to User graphql type).

Suggestion 2

Configure your models property of your graphqlgen.yml file in the following way:

models:
  files:
    - path: ./src/generated/prisma-client
      defaultName: '${typeName}Node'
  override:
    graphqlEnumName: ./src/generated/prisma-client:modelName

The override property allows you to define a mapping between a graphql type and a model, in case you're using some special convention for some types.
You could also use this property so enumerate all your enums, that doesn't follow the ${typeName}Node pattern.

sidroopdaska · 2018-10-30T14:53:47Z

So I could handle Enums as an edge case to this by doing the following:

IN schema.graphql

enum SessionType {
    Control,
    Perception
}

In my ts types, I do:

export const enum SessionTypeEnum { ... }

and add the defaultName as ${typeName}Enum

Also, how can I handle custom scalars like scalar Date ?

Weakky · 2018-10-30T15:09:49Z

You could indeed do that or look at the second suggestion I shared after editing the comment.

For scalars, please take a look at #165 but do not cross issues and topics so that we can keep discussions clean 🙏

Weakky · 2018-11-02T14:38:35Z

Update

We decided to give enums a special treatment. Enum types will always be inferred from your GraphQL schema, and will be inlined automatically in your graphqlgen.ts file.

For instance, given the following graphql schema:

type User {
  penColor: Color!
}

enum Color {
 RED,
 GREEN,
 BLUE 
}

Your graphqlgen.ts file should roughly look like this:

import { User } from '../types.ts'

type Color = 'RED' | 'GREEN' | 'BLUE'

export type PenColorResolver = (
  parent: User,
  args: {},
  ctx: any,
  info: GraphQLResolveInfo,
) => Color | Promise<Color>

sidroopdaska · 2018-11-02T17:37:20Z

When will this update be released?

schickling · 2018-11-05T00:52:06Z

I've released a first version which can be installed via graphqlgen@beta. Please report if you run into any problems 🙏

impowski · 2018-11-05T05:38:32Z

I've released a first version which can be installed via graphqlgen@beta. Please report if you run into any problems 🙏

Just installed it and ran graphqlgen

internal/modules/cjs/loader.js:589
    throw err;
    ^

Error: Cannot find module '@babel/types'
    at Function.Module._resolveFilename (internal/modules/cjs/loader.js:587:15)
    at Function.Module._load (internal/modules/cjs/loader.js:513:25)
    at Module.require (internal/modules/cjs/loader.js:643:17)
    at require (internal/modules/cjs/helpers.js:22:18)
    at Object.<anonymous> (/Users/impowski/.config/yarn/global/node_modules/graphqlgen/dist/introspection/ts-ast.js:15:15)
    at Module._compile (internal/modules/cjs/loader.js:707:30)
    at Object.Module._extensions..js (internal/modules/cjs/loader.js:718:10)
    at Module.load (internal/modules/cjs/loader.js:605:32)
    at tryModuleLoad (internal/modules/cjs/loader.js:544:12)
    at Function.Module._load (internal/modules/cjs/loader.js:536:3)

Victorkangsh · 2018-11-05T06:17:20Z

@impowski npm i -g @babel/types

impowski · 2018-11-05T14:50:42Z

@impowski npm i -g @babel/types

@Victorkangsh I guess I should not do that :)

schickling · 2018-11-05T16:16:38Z

Please retry with [email protected]

impowski · 2018-11-05T18:36:52Z

Please retry with [email protected]

@schickling Can you give a sample example of what it should look like?

Right now I have something like that in my datamodel.graphql:

type User {
  gender: Gender!
}

enum Gender {
  NONE
  MALE
  FEMALE
}

And inside schema.graphql I have this:

type User {
  gender: Gender!
}

When I run graphqlgen it gives me this:

Error occurred while reading schema: Error: Field gender: Couldn't find type Gender in any of the schemas.

When I add to my schema.graphql this:

enum Gender {
  NONE,
  MALE,
  FEMALE
}

I receive this output:

WARNING: Unsupported type TSIntersectionType (Line 10 in /Users/impowski/Projects/heart-advisor-server/src/generated/prisma-client/index.ts). Please file an issue at https://github.com/prisma/graphqlgen/issues
WARNING: Unsupported type TSFunctionType (Line 14 in /Users/impowski/Projects/heart-advisor-server/src/generated/prisma-client/index.ts). Please filean issue at https://github.com/prisma/graphqlgen/issues
WARNING: Unsupported type TSIntersectionType (Line 19 in /Users/impowski/Projects/heart-advisor-server/src/generated/prisma-client/index.ts). Please file an issue at https://github.com/prisma/graphqlgen/issues
(node:63709) UnhandledPromiseRejectionWarning: Error: Unsupported notation for fields: Line 22 in /Users/impowski/Projects/heart-advisor-server/src/generated/prisma-client/index.ts
    at throwIfUnsupportedFields (/Users/impowski/Projects/heart-advisor-server/node_modules/graphqlgen/dist/introspection/ts-ast.js:100:15)
    at extractInterfaceFields (/Users/impowski/Projects/heart-advisor-server/node_modules/graphqlgen/dist/introspection/ts-ast.js:106:5)
    at extractInterface (/Users/impowski/Projects/heart-advisor-server/node_modules/graphqlgen/dist/introspection/ts-ast.js:118:27)
    at /Users/impowski/Projects/heart-advisor-server/node_modules/graphqlgen/dist/introspection/ts-ast.js:163:59
    at Array.reduce (<anonymous>)
    at Object.buildTSTypesMap (/Users/impowski/Projects/heart-advisor-server/node_modules/graphqlgen/dist/introspection/ts-ast.js:154:45)
    at buildTypesMapByLanguage (/Users/impowski/Projects/heart-advisor-server/node_modules/graphqlgen/dist/introspection/index.js:21:29)
    at buildTypesMap (/Users/impowski/Projects/heart-advisor-server/node_modules/graphqlgen/dist/introspection/index.js:31:20)
    at /Users/impowski/Projects/heart-advisor-server/node_modules/graphqlgen/dist/introspection/index.js:44:60
    at Array.reduce (<anonymous>)
(node:63709) UnhandledPromiseRejectionWarning: Unhandled promise rejection. This error originated either by throwing inside of an async function without a catch block, or by rejecting a promise which was not handled with .catch(). (rejection id: 1)
(node:63709) [DEP0018] DeprecationWarning: Unhandled promise rejections are deprecated. In the future, promise rejections that are not handled will terminate the Node.js process with a non-zero exit code.

Weakky · 2018-11-05T19:12:35Z

Oh, good that we put it in beta first. I didn't think about testing it with prisma-client, which uses quite a few special types. These are:

export interface Fragmentable {
  $fragment<T>(fragment: string | DocumentNode): Promise<T>; // <--- This
}

and this (admittedly less special)

views: (where?: ViewsWhereInput) => Promise<boolean>; // <--- This

I see a few things here:

As you might have guessed, FunctionType and IntersectionType not yet handled, which is the reason for these warnings
I'm not sure how to proceed with these warnings. They're super relevant if we want to progressively support more and more language syntaxes and have people reporting us there use-cases. But at the same time, they're super cumbersome especially considering the fact that you're supposed to run graphqlgen quite often.
Lastly, I'm gonna add support for these types and will come back to you as soon as it's done 🙏

Weakky · 2018-11-05T22:26:54Z

We just released [email protected] which should fix your issues @impowski.

To answer a bit more your previous question, this is how it is supposed to be done:

Given the following GraphQL schema:

type User {
  gender: Gender!
}

enum Gender {
  FEMALE
  MALE
}

The field gender of your model can have whatever type you want, but if you want it go be generated within the defaultResolvers, then the type of gender must be either equal to the GraphQL enum Gender, or be a subset of it.

eg:

interface User {
  gender: Gender
}

// Will go to defaultResolvers
enum Gender {
  FEMALE,
  MALE
}

//or
enum Gender { // Will go to defaultResolvers
  MALE
}

// or
type Gender = 'FEMALE' | 'MALE' // Will go to defaultResolvers

// or
interface User {
  gender: 'FEMALE' | 'MALE' // Will go to defaultResolvers
}

//or
enum Gender { // Will NOT got to defaultResolvers
  NONE,
  MALE,
  FEMALE
}

impowski · 2018-11-05T22:57:51Z

@Weakky yep, that works, but should I always add types to schema.graphql? Because before that with codegen there was no need to do such thing as I remember it was importing types from prisma,graphql generated file. If I don't add anything it gives a error but when I add it it works fine.

Weakky · 2018-11-05T23:06:10Z

Unless I don't understand what you mean, there are no way for us not to make you declare your enums in your GraphQL schema. The error you're getting comes from graphql-js:parse() function, which yells at you because it cannot find the type of one of your fields.

Instead of redeclaring your enum by hand, what you can do is to import the enum from the GraphQL schema generated by prisma.

This can be done using graphql-import, which is supported by graphqlgen

# import YourEnum from "path-to-your-generated-prisma-schema"

type User {
  enum: YourEnum!
}

victory1908 · 2018-11-06T08:25:23Z

Looking forward to proper enum handling in the next release of graphqlgen. Could make a simple example of project which handling of enum combine with prisma client (Or just graphQL file + graphqlgen.yml). Thanks

impowski · 2018-11-06T13:44:32Z

@Weakky This is what I meant

# import YourEnum from "path-to-your-generated-prisma-schema"

How do I get this generated schema file?

schickling · 2018-11-07T16:15:11Z

It's now released in version 0.3.0.

gustawdaniel · 2020-06-04T19:37:46Z

How about enum in prisma 2.0? Any docs?

Rydez · 2020-09-19T17:14:47Z

@gustawdaniel Did you end up getting this to work with prisma 2?

My graphql schema has:

enum Category {
  bug
  feature
}

type Thread {
  category: Category!
}

which ends up as this in the generated file:

export enum Category {
  Bug = 'bug',
  Feature = 'feature'
}

In prisma schema I have:

enum category_enum {
  bug
  feature
}

Which results with this error in my resolvers:
Type '"bug" | "feature"' is not assignable to type 'Category'

zakthedev · 2020-10-10T03:47:09Z

@Rydez did you solve this?

mdurakovic · 2020-11-09T15:31:54Z

@Rydez do you have solution for this? I have same issue as you 😞

Rydez · 2020-11-09T16:34:26Z

@zakthedev, @mdurakovic, I took a look at the project I was working on at the time, and I switched to this:

type Thread {
  ...
  category: String! # Why not Category? https://github.com/prisma-labs/graphqlgen/issues/213
  ...
}

instead of this:

type Thread {
  ...
  category: Category!
  ...
}

schickling added the bug/2-confirmed label Oct 29, 2018

arielschiavoni mentioned this issue Oct 29, 2018

Enums in prisma generated file are not being picked up #197

Closed

schickling closed this as completed Nov 7, 2018

nklayman mentioned this issue Feb 28, 2019

[typescript] Add option to use string unions instead of arrays dotansimha/graphql-code-generator#1379

Closed

Enum handling #213

Enum handling #213

Comments

affanshahid commented Oct 28, 2018

Weakky commented Oct 29, 2018 • edited by schickling Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

affanshahid commented Oct 29, 2018

Uh oh!

arielschiavoni commented Oct 29, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

sidroopdaska commented Oct 30, 2018

Uh oh!

Weakky commented Oct 30, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Workaround

Suggestion 1

Suggestion 2

Uh oh!

sidroopdaska commented Oct 30, 2018

Uh oh!

Weakky commented Oct 30, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Weakky commented Nov 2, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Update

Uh oh!

sidroopdaska commented Nov 2, 2018

Uh oh!

schickling commented Nov 5, 2018

Uh oh!

impowski commented Nov 5, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Victorkangsh commented Nov 5, 2018

Uh oh!

impowski commented Nov 5, 2018

Uh oh!

schickling commented Nov 5, 2018

Uh oh!

impowski commented Nov 5, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Weakky commented Nov 5, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Weakky commented Nov 5, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

impowski commented Nov 5, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Weakky commented Nov 5, 2018

Uh oh!

victory1908 commented Nov 6, 2018

Uh oh!

impowski commented Nov 6, 2018

Uh oh!

schickling commented Nov 7, 2018

Uh oh!

gustawdaniel commented Jun 4, 2020

Uh oh!

Rydez commented Sep 19, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

zakthedev commented Oct 10, 2020

Uh oh!

mdurakovic commented Nov 9, 2020

Uh oh!

Rydez commented Nov 9, 2020

Uh oh!

Weakky commented Oct 29, 2018 •

edited by schickling

Loading

arielschiavoni commented Oct 29, 2018 •

edited

Loading

Weakky commented Oct 30, 2018 •

edited

Loading

Weakky commented Oct 30, 2018 •

edited

Loading

Weakky commented Nov 2, 2018 •

edited

Loading

impowski commented Nov 5, 2018 •

edited

Loading

impowski commented Nov 5, 2018 •

edited

Loading

Weakky commented Nov 5, 2018 •

edited

Loading

Weakky commented Nov 5, 2018 •

edited

Loading

impowski commented Nov 5, 2018 •

edited

Loading

Rydez commented Sep 19, 2020 •

edited

Loading