Creating connections in Pothos coming from Nexus #1022
-
|
Hello. I can't seem to figure out how to convert connection plugin (relay plugin) from Nexus to Pothos based on this setup: https://pothos-graphql.dev/docs/plugins/relay#setup So in Nexus, you can create multiple relay plugins when creating a schema like so: export const schema = makeSchema({
features: {
abstractTypeStrategies: {
isTypeOf: true,
},
abstractTypeRuntimeChecks: true,
},
types: schemaTypes,
plugins: [
connectionPlugin({}),
connectionPlugin({
nexusFieldName: 'basicConnectionField',
disableBackwardPagination: true,
extendConnection: {
meta: {
requireResolver: false,
type: 'SearchMeta',
},
},
}),
connectionPlugin({
typePrefix: 'Complex',
nexusFieldName: 'complexConnectionField',
extendConnection: {
cacheID: {
type: 'String',
},
totalCount: { type: 'Int', description: 'The total count of results.' },
pageCursors: { type: 'PageCursors', description: 'The page cursors for pagination of the results.' },
},
additionalArgs: {
cacheID: nullable(
stringArg({
description:
'Reuse IDs it has saved for filter.',
})
),
},
}),
],
outputs: {
schema: path.join(__dirname, 'generated', 'schema.graphql'),
typegen: path.join(__dirname, 'generated', 'nexus.ts'),
},
contextType: {
export: 'ContextType',
module: 'context-absolute-path-here',
},
});and can be used this way: export const ThingsQuery = queryField(t => {
t.complexConnectionField('things', {
type: 'Thing',
...
});
});Is there a guide with regards to Nexus to Pothos conversion or maybe if someone experience moving away from Nexus to Pothos? Thanks for the help. |
Beta Was this translation helpful? Give feedback.
Replies: 2 comments 9 replies
-
|
I don't know of anything that covers migrations from Nexus in depth like this. Unfortunately Pothos doesn't have support for multiple instances of a plugin like you are describing, but there is an example here for handling windowed pagination: https://github.com/hayes/pothos/tree/main/examples/relay-windowed-pagination/src |
Beta Was this translation helpful? Give feedback.
-
|
t.connection implementations all the args, but you can easily implement this without t.connection: const MyConnection = builder.connectionObject(...)
...
t.field({ type: MyConnection, args: first: t.arg.int(), after: t.ag.string() }, resolve: () => ... }) |
Beta Was this translation helpful? Give feedback.
-
|
Hey! So I've been trying to figure this Pothos to Nexus migration for our project again after a halt for more than a year 😅 So far, I was able to have queries from Pothos and Nexus but the one with connection is having typings issue. I followed this bit (I saw from another discussion) and unsure what I missed: https://stackblitz.com/edit/typescript-wrj4wo?file=index.ts Pothos schema builder setup import SchemaBuilder from '@pothos/core';
import AddGraphQLPlugin from '@pothos/plugin-add-graphql';
import RelayPlugin from '@pothos/plugin-relay';
import { schema } from '../schema';
import { ContextType } from '../types/context';
// interface PageCursor {
// startCursor: string;
// endCursor: string;
// previousPageEndCursor: string;
// pageNumber: number;
// isCurrentPage: number;
// }
export const schemaViaPothosBuilder = new SchemaBuilder<{
Context: ContextType;
Scalars: {
PlainText: {
Input: string;
Output: string;
};
RichText: {
Input: string;
Output: string;
};
};
// Connection: {
// totalCount: number;
// filterCacheID: string;
// pageCursors: {
// first: PageCursor;
// last: PageCursor;
// neighbours: PageCursor[];
// };
// };
}>({
plugins: [AddGraphQLPlugin, RelayPlugin],
relay: {},
add: {
schema: schema,
},
notStrict: 'Pothos may not work correctly when strict mode is not enabled in tsconfig.json',
});Experiments import { schemaViaPothosBuilder as builder } from '../../utils/pothos';
builder.queryField('accessContext', t => // this works
t.string({
resolve: (_, __, ctx) => {
return ctx.testThis;
},
})
);
builder.queryField('testConnection', t => // adding this won't compile - followed https://stackblitz.com/edit/typescript-wrj4wo?file=index.ts
t.connection({
type: TestObject,
resolve: (_) => {
return {
pageInfo: {
hasNextPage: false,
hasPreviousPage: false,
startCursor: '1',
endCursor: '2',
totalCount: 2,
},
edges: [
{
cursor: '1',
node: {
id: '1',
fieldOnObject: '1',
},
},
],
};
}
})
);
export const TestObject = builder.objectRef<{ id: string; fieldOnObject: string }>('TestObject').implement({
fields: t => ({
customField: t.string({
resolve: parent => parent.fieldOnObject,
}),
}),
});Error src/schema-pothos/queries/Project.query.ts:14:3 - error TS2322: Type '(_: unknown) => { pageInfo: { hasNextPage: false; hasPreviousPage: false; startCursor: string; endCursor: string; totalCount: number; }; edges: { cursor: string; node: { id: string; fieldOnObject: string; }; }[]; }' is not assignable to type 'Resolver<unknown, DefaultConnectionArguments & { [x: string]: unknown; } & {}, ContextType, ConnectionResultShape<ExtendDefaultTypes<{ Context: ContextType; Scalars: { PlainText: { ...; }; RichText: { ...; }; }; }>, { ...; }, DefaultEdgesNullability, false>, { ...; }>'.
Type '{ pageInfo: { hasNextPage: false; hasPreviousPage: false; startCursor: string; endCursor: string; totalCount: number; }; edges: { cursor: string; node: { id: string; fieldOnObject: string; }; }[]; }' is not assignable to type 'MaybePromise<ConnectionResultShape<ExtendDefaultTypes<{ Context: ContextType; Scalars: { PlainText: { Input: string; Output: string; }; RichText: { Input: string; Output: string; }; }; }>, { ...; }, DefaultEdgesNullability, false>>'.
Type '{ pageInfo: { hasNextPage: false; hasPreviousPage: false; startCursor: string; endCursor: string; totalCount: number; }; edges: { cursor: string; node: { id: string; fieldOnObject: string; }; }[]; }' is not assignable to type 'ConnectionResultShape<ExtendDefaultTypes<{ Context: ContextType; Scalars: { PlainText: { Input: string; Output: string; }; RichText: { Input: string; Output: string; }; }; }>, { ...; }, DefaultEdgesNullability, false>'.
Types of property 'edges' are incompatible.
Type '{ cursor: string; node: { id: string; fieldOnObject: string; }; }[]' is not assignable to type 'MaybePromise<readonly ExtendDefaultTypes<{ Context: ContextType; Scalars: { PlainText: { Input: string; Output: string; }; RichText: { Input: string; Output: string; }; }; }>[]>'.
Type '{ cursor: string; node: { id: string; fieldOnObject: string; }; }[]' is not assignable to type 'readonly ExtendDefaultTypes<{ Context: ContextType; Scalars: { PlainText: { Input: string; Output: string; }; RichText: { Input: string; Output: string; }; }; }>[]'.
Type '{ cursor: string; node: { id: string; fieldOnObject: string; }; }' is missing the following properties from type 'ExtendDefaultTypes<{ Context: ContextType; Scalars: { PlainText: { Input: string; Output: string; }; RichText: { Input: string; Output: string; }; }; }>': Scalars, Objects, Inputs, Interfaces, and 9 more.
14 resolve: (_) => {
~~~~~~~
node_modules/@pothos/plugin-relay/dts/global-types.d.ts:101:13
101 resolve: Resolver<ParentShape, DefaultConnectionArguments & InputShapeFromFields<Args>, Types['Context'], ConnectionShapeForType<Types, Type, Nullable, EdgeNullability, NodeNullability, ConnectionResult>, ResolveReturnShape>;
~~~~~~~
The expected type comes from property 'resolve' which is declared here on type 'ConnectionFieldOptions<ExtendDefaultTypes<{ Context: ContextType; Scalars: { PlainText: { Input: string; Output: string; }; RichText: { Input: string; Output: string; }; }; }>, ... 7 more ..., ConnectionResultShape<...>> & Omit<...>'
Found 1 error in src/schema-pothos/queries/Project.query.ts:14
How connections are coded in Nexus export const AddProjectsByFilters = queryField(t => {
t.filteredConnectionField('projects', {
type: 'Project',
description: 'Returns projects in accordance with filters provided by the user.',
filterCacheID: <T extends NodeRoot>(data: PaginationResponse<T>) => data.filterCacheID,
totalCount: <T extends NodeRoot>(data: PaginationResponse<T>) => data.totalCount,
pageCursors: <T extends NodeRoot>(data: PaginationResponse<T>) => data.pageCursors,
additionalArgs: {
...filterArg.generateArgs(),
...sortArg.generateArgs(),
},
inheritAdditionalArgs: true,
resolve: (_, args, ctx) => {
const paginationArgs = Pagination.mapToSource(args);
const convertedFilters = filterArg.mapToSource(args.filters);
const convertedSort = sortArg.mapToSource(args.sort);
return ctx.source.getPaginatedProjectsByFilters(
paginationArgs,
convertedFilters,
convertedSort
);
/* The response would look like this
{
"totalCount": 98,
"filterCacheID": "CACHE_ID_HERE_21313",
"pageInfo": {
"hasNextPage": true,
"hasPreviousPage": false,
"startCursor": "5",
"endCursor": "9"
},
"pageCursors": {
"first": {
"startCursor": "5",
"endCursor": "9",
"previousPageEndCursor": null,
"pageNumber": 1,
"isCurrentPage": 1
},
"last": {
"startCursor": "58",
"endCursor": "88",
"previousPageEndCursor": "96",
"pageNumber": 20,
"isCurrentPage": 0
},
"neighbours": [
{
"startCursor": "10",
"endCursor": "14",
"previousPageEndCursor": "9",
"pageNumber": 2,
"isCurrentPage": 0
},
{
"startCursor": "15",
"endCursor": "19",
"previousPageEndCursor": "14",
"pageNumber": 3,
"isCurrentPage": 0
},
{
"startCursor": "20",
"endCursor": "24",
"previousPageEndCursor": "19",
"pageNumber": 4,
"isCurrentPage": 0
}
]
},
"edges": [
{
"cursor": "5",
"node": {
"id": "5",
"title": "This is my project"
}
}
]
}
*/
},
});
});Any tips on how to proceed with resolving typings/doing something similar to Nexus? Thank you. 😅 |
Beta Was this translation helpful? Give feedback.
-
|
Does this happen if you enable strict mode? I see that you are disabling it? |
Beta Was this translation helpful? Give feedback.
-
|
I wasn't able to reproduce the error you described, but here's a working version: https://stackblitz.com/edit/typescript-trjw3s4c?file=index.ts,tsconfig.json,index.html |
Beta Was this translation helpful? Give feedback.
-
|
@hayes Thanks. Got rid of the TS errors reported here: #1022 (reply in thread) by making sure my package version are similar to yours in #1022 (reply in thread). From "@pothos/core": "^3.38.0",
"@pothos/plugin-add-graphql": "^3.1.1",
"@pothos/plugin-relay": "^4.4.2",To "@pothos/core": "^4.6.2",
"@pothos/plugin-add-graphql": "^4.2.3",
"@pothos/plugin-relay": "^4.4.2",I got into another issue wherein the Nexus PageInfo is conflicting with Pothos PageInfo. Is there a way in Pothos to exclude the existing PageInfo just before combining Nexus and Pothos via |
Beta Was this translation helpful? Give feedback.
-
|
@hayes I finally got it. Just want to say thanks for all your support and samples that has greatly helped me figure out how to go about nexus and pothos connection fields. Hopefully that's the last issue I'd encounter regarding relay during this migration. To prevent Nexus PageInfo and Pothos PageInfo from "duplicate typename" issue, I deleted the PageInfo before passing it in pothos schema builder like so // Remove the PageInfo type to prevent Duplicate typename (Nexus has its own relay plugin which conflicts with Pothos relay plugin)
const modifiedSchema = schema;
const schemaTypes = modifiedSchema.getTypeMap();
if (schemaTypes['PageInfo']) {
delete schemaTypes['PageInfo'];
}
export const schemaViaPothosBuilder = new SchemaBuilder<{
Context: ContextType;
Scalars: {
PlainText: {
Input: string;
Output: string;
};
RichText: {
Input: string;
Output: string;
};
};
Connection: {
totalCount: number;
filterCacheID: string;
pageCursors: {
first: PageCursor;
last: PageCursor;
neighbours: PageCursor[];
};
};
}>({
plugins: [AddGraphQLPlugin, RelayPlugin],
relay: {},
add: {
schema: modifiedSchema,
},
notStrict: 'Pothos may not work correctly when strict mode is not enabled in tsconfig.json',
}); |
Beta Was this translation helpful? Give feedback.
@hayes I finally got it. Just want to say thanks for all your support and samples that has greatly helped me figure out how to go about nexus and pothos connection fields. Hopefully that's the last issue I'd encounter regarding relay during this migration.
To prevent Nexus PageInfo and Pothos PageInfo from "duplicate typename" issue, I deleted the PageInfo before passing it in pothos schema builder like so