Merge pull request #122 from Perlmint/feature/errors-plugin

Author: dahlia

deno.json

@@ -42,6 +42,7 @@
     "@pothos/core": "npm:@pothos/core@^4.7.3",
     "@pothos/plugin-complexity": "npm:@pothos/[email protected]",
     "@pothos/plugin-drizzle": "npm:@pothos/plugin-drizzle@^0.11.1",
+    "@pothos/plugin-errors": "npm:@pothos/plugin-errors@^4.4.2",
     "@pothos/plugin-relay": "npm:@pothos/plugin-relay@^4.6.2",
     "@pothos/plugin-scope-auth": "npm:@pothos/plugin-scope-auth@^4.1.5",
     "@pothos/plugin-simple-objects": "npm:@pothos/plugin-simple-objects@^4.1.3",

deno.lock

@@ -9,6 +9,7 @@ import type { Uuid } from "@hackerspub/models/uuid";
 import SchemaBuilder from "@pothos/core";
 import ComplexityPlugin from "@pothos/plugin-complexity";
 import DrizzlePlugin from "@pothos/plugin-drizzle";
+import ErrorsPlugin from "@pothos/plugin-errors";
 import RelayPlugin from "@pothos/plugin-relay";
 import ScopeAuthPlugin from "@pothos/plugin-scope-auth";
 import SimpleObjectsPlugin from "@pothos/plugin-simple-objects";
@@ -29,6 +30,9 @@ import {
 import { createGraphQLError } from "graphql-yoga";
 import type Keyv from "keyv";
 
+export type ValuesOfEnumType<T> = T extends
+  PothosSchemaTypes.EnumRef<never, unknown, infer V> ? V : never;
+
 export interface ServerContext {
   db: Database;
   kv: Keyv;
@@ -114,6 +118,7 @@ export const builder = new SchemaBuilder<PothosTypes>({
     SimpleObjectsPlugin,
     TracingPlugin,
     WithInputPlugin,
+    ErrorsPlugin,
   ],
   complexity: {
     defaultComplexity: 1,
@@ -148,6 +153,16 @@ export const builder = new SchemaBuilder<PothosTypes>({
   relay: {
     clientMutationId: "optional",
   },
+  errors: {
+    directResult: true,
+    defaultUnionOptions: {
+      name(options) {
+        return `${options.fieldName.charAt(0).toUpperCase()}${
+          options.fieldName.slice(1)
+        }Result`;
+      },
+    },
+  },
 });
 
 builder.addScalarType("Date", DateResolver);

graphql/builder.ts

@@ -20,11 +20,24 @@ import { sql } from "drizzle-orm";
 import { parseTemplate } from "url-template";
 import { Account } from "./account.ts";
 import { builder } from "./builder.ts";
-import { SessionRef } from "./session.ts";
 import { EMAIL_FROM } from "./email.ts";
+import { SessionRef } from "./session.ts";
 
 const logger = getLogger(["hackerspub", "graphql", "login"]);
 
+class AccountNotFoundError extends Error {
+  public constructor(public readonly query: string) {
+    super(`Account not found`);
+  }
+}
+
+builder.objectType(AccountNotFoundError, {
+  name: "AccountNotFoundError",
+  fields: (t) => ({
+    query: t.exposeString("query"),
+  }),
+});
+
 interface LoginChallenge {
   accountId: Uuid;
   token: Uuid;
@@ -54,7 +67,15 @@ LoginChallengeRef.implement({
 builder.mutationFields((t) => ({
   loginByUsername: t.field({
     type: LoginChallengeRef,
-    nullable: true,
+    errors: {
+      types: [AccountNotFoundError],
+      union: {
+        name: "LoginResult",
+      },
+      result: {
+        name: "LoginSuccess",
+      },
+    },
     args: {
       username: t.arg.string({
         required: true,
@@ -80,7 +101,9 @@ builder.mutationFields((t) => ({
         with: { emails: true },
         where: { username: args.username },
       });
-      if (account == null) return null;
+      if (account == null) {
+        throw new AccountNotFoundError(args.username);
+      }
       const token = await createSigninToken(ctx.kv, account.id);
       const messages: Message[] = [];
       for (const { email } of account.emails) {
@@ -110,7 +133,15 @@ builder.mutationFields((t) => ({
 
   loginByEmail: t.field({
     type: LoginChallengeRef,
-    nullable: true,
+    errors: {
+      types: [AccountNotFoundError],
+      union: {
+        name: "LoginResult",
+      },
+      result: {
+        name: "LoginSuccess",
+      },
+    },
     args: {
       email: t.arg.string({
         required: true,
@@ -150,7 +181,9 @@ builder.mutationFields((t) => ({
           with: { emails: true },
         });
       }
-      if (account == null) return null;
+      if (account == null) {
+        throw new AccountNotFoundError(args.email);
+      }
       const token = await createSigninToken(ctx.kv, account.id);
       const messages: Message[] = [];
       for (const { email } of account.emails) {

graphql/login.ts

@@ -11,6 +11,7 @@ import { Account } from "./account.ts";
 import { Actor } from "./actor.ts";
 import { builder, Node } from "./builder.ts";
 import { Reactable } from "./reactable.ts";
+import { NotAuthenticatedError } from "./session.ts";
 
 const PostVisibility = builder.enumType("PostVisibility", {
   values: [
@@ -22,6 +23,19 @@ const PostVisibility = builder.enumType("PostVisibility", {
   ] as const,
 });
 
+class InvalidInputError extends Error {
+  public constructor(public readonly inputPath: string) {
+    super(`Invalid input - ${inputPath}`);
+  }
+}
+
+builder.objectType(InvalidInputError, {
+  name: "InvalidInputError",
+  fields: (t) => ({
+    inputPath: t.expose("inputPath", { type: "String" }),
+  }),
+});
+
 export const Post = builder.drizzleInterface("postTable", {
   variant: "Post",
   interfaces: [Reactable, Node],
@@ -458,10 +472,16 @@ builder.relayMutationField(
     }),
   },
   {
+    errors: {
+      types: [
+        NotAuthenticatedError,
+        InvalidInputError,
+      ],
+    },
     async resolve(_root, args, ctx) {
       const session = await ctx.session;
       if (session == null) {
-        throw new Error("Not authenticated.");
+        throw new NotAuthenticatedError();
       }
       const { visibility, content, language, replyTargetId, quotedPostId } =
         args.input;
@@ -472,7 +492,7 @@ builder.relayMutationField(
           where: { id: replyTargetId.id },
         });
         if (replyTarget == null) {
-          throw new Error("Reply target not found.");
+          throw new InvalidInputError("replyTargetId");
         }
       }
       let quotedPost: schema.Post & { actor: schema.Actor } | undefined;
@@ -482,7 +502,7 @@ builder.relayMutationField(
           where: { id: quotedPostId.id },
         });
         if (quotedPost == null) {
-          throw new Error("Quoted post not found.");
+          throw new InvalidInputError("quotedPostId");
         }
       }
       return await withTransaction(ctx.fedCtx, async (context) => {
@@ -511,7 +531,7 @@ builder.relayMutationField(
           { replyTarget, quotedPost },
         );
         if (note == null) {
-          throw new Error("Failed to create note.");
+          throw new Error("Failed to create note");
         }
         return note;
       });

graphql/post.ts

@@ -78,6 +78,10 @@ input AccountLinkInput {
   url: URL!
 }
 
+type AccountNotFoundError {
+  query: String!
+}
+
 type AccountNotificationsConnection {
   edges: [AccountNotificationsConnectionEdge!]!
   pageInfo: PageInfo!
@@ -284,6 +288,8 @@ type CreateNotePayload {
   note: Note!
 }
 
+union CreateNoteResult = CreateNotePayload | InvalidInputError | NotAuthenticatedError
+
 type CustomEmoji implements Node {
   id: ID!
   imageUrl: String!
@@ -360,6 +366,10 @@ type Instance implements Node {
   updated: DateTime!
 }
 
+type InvalidInputError {
+  inputPath: String!
+}
+
 """
 The `JSON` scalar type represents JSON values as specified by [ECMA-404](http://www.ecma-international.org/publications/files/ECMA-ST/ECMA-404.pdf).
 """
@@ -375,6 +385,8 @@ type LoginChallenge {
   token: UUID!
 }
 
+union LoginResult = AccountNotFoundError | LoginChallenge
+
 """A Hackers' Pub-flavored Markdown text."""
 scalar Markdown
 
@@ -409,7 +421,7 @@ type Mutation {
     """The signup token."""
     token: UUID!
   ): SignupResult!
-  createNote(input: CreateNoteInput!): CreateNotePayload!
+  createNote(input: CreateNoteInput!): CreateNoteResult!
   loginByEmail(
     """The email of the account to sign in."""
     email: String!
@@ -421,7 +433,7 @@ type Mutation {
     The RFC 6570-compliant URI Template for the verification link.  Available variabvles: `{token}` and `{code}`.
     """
     verifyUrl: URITemplate!
-  ): LoginChallenge
+  ): LoginResult!
   loginByUsername(
     """The locale for the sign-in email."""
     locale: Locale!
@@ -433,7 +445,7 @@ type Mutation {
     The RFC 6570-compliant URI Template for the verification link.  Available variabvles: `{token}` and `{code}`.
     """
     verifyUrl: URITemplate!
-  ): LoginChallenge
+  ): LoginResult!
 
   """Revoke a session by its ID."""
   revokeSession(
@@ -447,6 +459,10 @@ interface Node {
   id: ID!
 }
 
+type NotAuthenticatedError {
+  notAuthenticated: String!
+}
+
 type Note implements Node & Post & Reactable {
   actor: Actor!
   content: HTML!

graphql/schema.graphql

@@ -2,6 +2,21 @@ import type { Session } from "@hackerspub/models/session";
 import { Account } from "./account.ts";
 import { builder } from "./builder.ts";
 
+export class NotAuthenticatedError extends Error {
+  public constructor() {
+    super("Not authenticated");
+  }
+}
+
+builder.objectType(NotAuthenticatedError, {
+  name: "NotAuthenticatedError",
+  fields: (t) => ({
+    notAuthenticated: t.string({
+      resolve: () => "",
+    }),
+  }),
+});
+
 export const SessionRef = builder.objectRef<Session>("Session");
 
 SessionRef.implement({