Migrating from Prisma+Nexus to Prisma+Pothos

[baconcheese113]

Hey, thanks for all your work on pothos!
I've been trying to migrate to Pothos for a couple days and reading through all the docs but I'm a bit stuck in a few places.

Unable to change context shape

All Query entrypoints require an Auth token, so all prismaObjects should be using my IAuthContext instead of the IContext. Before I would just cast the context to IAuthContext in the resolvers, but it seems like there's a better way if I use ScopeAuth. So I tried this:

export const builder = new SchemaBuilder<{
    Context: IContext;
    AuthScopes: { loggedIn: boolean }
    AuthContexts: { loggedIn: IAuthContext }
    ...
}>({
    plugins: [ScopeAuth, PrismaPlugin],
    ...
    scopeAuthOptions: {
        runScopesOnType: true,
    },
    authScopes: (context) => ({
        loggedIn: !!context.user || !!context.hub
    })
})

along with copy pasting this across all my prismaObjects

builder.prismaObject('Hub', {
    authScopes: {loggedIn: true},
    runScopesOnType: true,
    fields: (t) => ({
    ...
})

But I can't get the context to change from IContext

Exposing ID

Just a question about exposeID, will it expose an Int! type if that's what id is defined as in the schema?

Viewer field (non-prisma models)

One of my Query entrypoints is Query->viewer->user->etc... like this:

builder.queryType({
    fields: (t) => ({
        ....
        viewer: t.field({
            type: Viewer,
            resolve(_root, _args, { user }) {
                if (!user) throw new AuthenticationError("User does not have permission")
                
                return ({}) // <--------------is this correct?
            } 
        }),
    })
})

export class Viewer {
    constructor(
        user: User,
        hubs: Hub[],
        networks: Network[],
        latestSensorVersion: string,
    ) {}
}
builder.objectType(Viewer, {
    fields: (t) => ({
        user: t.prismaField({
            type: "User",
            resolve: (query, _root, _args, { user }) => {
                return user
            },
        }),
        ...
    })
})

but I get this error for the viewer object fields

Argument of type '{ fields: (t: ObjectFieldBuilder<ExtendDefaultTypes<{ Context: IContext; AuthScopes: { loggedIn: boolean; }; AuthContexts: { loggedIn: IAuthContext; }; PrismaTypes: PrismaTypes; Scalars: { ...; }; }>, Viewer>) => { ...; }; }' is not assignable to parameter of type 'ObjectTypeOptions<ExtendDefaultTypes<{ Context: IContext; AuthScopes: { loggedIn: boolean; }; AuthContexts: { loggedIn: IAuthContext; }; PrismaTypes: PrismaTypes; Scalars: { DateTime: { ...; }; }; }>, typeof Viewer, Viewer, InterfaceParam<...>[]>'.
  Type '{ fields: (t: ObjectFieldBuilder<ExtendDefaultTypes<{ Context: IContext; AuthScopes: { loggedIn: boolean; }; AuthContexts: { loggedIn: IAuthContext; }; PrismaTypes: PrismaTypes; Scalars: { ...; }; }>, Viewer>) => { ...; }; }' is missing the following properties from type '{ name: string; interfaces: InterfaceParam<ExtendDefaultTypes<{ Context: IContext; AuthScopes: { loggedIn: boolean; }; AuthContexts: { loggedIn: IAuthContext; }; PrismaTypes: PrismaTypes; Scalars: { ...; }; }>>[] | (() => InterfaceParam<...>[]); ... 7 more ...; skipInterfaceScopes?: boolean | undefined; }': name, interfaces

[hayes]

All Query entrypoints require an Auth token, so all prismaObjects should be using my IAuthContext instead of the IContext. Before I would just cast the context to IAuthContext in the resolvers, but it seems like there's a better way if I use ScopeAuth. So I tried this:

If all entrypoints guarantee a user, you can use just make your auth context the default context:

export const builder = new SchemaBuilder<{
    Context: IAuthContext;
    AuthScopes: { loggedIn: boolean }
}>({...})

The plugin isn't currently changing the context type automatically for fields of a type that have defined scopes. To change the context based on scopes you need to use either the t.authField method, or the t.withAuth method so that the field definitions become aware of scopes being used and can automatically type the context based on the scopes.

also, just a note: if you have runScopesOnType: true, set in the builder option, you don't need to repeat it on every type.

Just a question about exposeID, will it expose an Int! type if that's what id is defined as in the schema?

No, this will be exoised as in ID field (nullability can be changed, defaults to nonnullable). You can use t.exposeInt if you want to create an Int field in your schema.

One of my Query entrypoints is Query->viewer->user->etc... like this:

When you use a class for an object type like: builder.objectType(Viewer, { fields that return that type (like the viewer query) need to return an instance of that class. In this case, you resolver should return something like new Viewer((user, hubs, networks, latestSensorVersion)

[hayes]

That's a weird error, if there is any more info you can provide that might be helpful. From the stack trace it looks like you are defining a prismaObject, and calling t.withAuth, which exists, but returns undefined. As far as I can tell, it should be returning the builder.

[hayes]

Actually, this looks like a bug. I just reproduced it, looking into it now

[hayes]

Just pushed a fix, should be published in a few minutes

[baconcheese113]

Thanks for fixing that so quickly! After upgrading to

"@pothos/plugin-prisma": "^3.21.2",
"@pothos/plugin-scope-auth": "^3.11.2",

I'm now able to start the server without errors with everything migrated from Nexus 🙌

[hayes]

nice!