❇️ Template language (bluesky-social#2780)

* ✨ Throw specific error for duplicate template name * 🧹 Cleanup console * ✨ Throw duplicate template name error from update too * ✨ Add language to templates * 📝 Add changeset * ✨ Add missing event type * ✨ Add language format in lexicon and error checker in util * 🚨 fix linter issues
lindner · Sep 4, 2024 · e4d41d6 · e4d41d6
1 parent 8252c65
commit e4d41d6
Show file tree

Hide file tree

Showing 28 changed files with 229 additions and 30 deletions.
diff --git a/.changeset/forty-apricots-cough.md b/.changeset/forty-apricots-cough.md
@@ -0,0 +1,6 @@
+---
+"@atproto/ozone": patch
+"@atproto/api": patch
+---
+
+Add language property to communication templates
diff --git a/lexicons/tools/ozone/communication/createTemplate.json b/lexicons/tools/ozone/communication/createTemplate.json
@@ -23,6 +23,11 @@
               "type": "string",
               "description": "Subject of the message, used in emails."
             },
+            "lang": {
+              "type": "string",
+              "format": "language",
+              "description": "Message language."
+            },
             "createdBy": {
               "type": "string",
               "format": "did",
@@ -37,7 +42,8 @@
           "type": "ref",
           "ref": "tools.ozone.communication.defs#templateView"
         }
-      }
+      },
+      "errors": [{ "name": "DuplicateTemplateName" }]
     }
   }
 }
diff --git a/lexicons/tools/ozone/communication/defs.json b/lexicons/tools/ozone/communication/defs.json
@@ -25,6 +25,11 @@
           "description": "Subject of the message, used in emails."
         },
         "disabled": { "type": "boolean" },
+        "lang": {
+          "type": "string",
+          "format": "language",
+          "description": "Message language."
+        },
         "lastUpdatedBy": {
           "type": "string",
           "format": "did",

diff --git a/lexicons/tools/ozone/communication/updateTemplate.json b/lexicons/tools/ozone/communication/updateTemplate.json
@@ -19,6 +19,11 @@
               "type": "string",
               "description": "Name of the template."
             },
+            "lang": {
+              "type": "string",
+              "format": "language",
+              "description": "Message language."
+            },
             "contentMarkdown": {
               "type": "string",
               "description": "Content of the template, markdown supported, can contain variable placeholders."
@@ -44,7 +49,8 @@
           "type": "ref",
           "ref": "tools.ozone.communication.defs#templateView"
         }
-      }
+      },
+      "errors": [{ "name": "DuplicateTemplateName" }]
     }
   }
 }
diff --git a/lexicons/tools/ozone/moderation/emitEvent.json b/lexicons/tools/ozone/moderation/emitEvent.json
@@ -25,6 +25,7 @@
                 "tools.ozone.moderation.defs#modEventMuteReporter",
                 "tools.ozone.moderation.defs#modEventUnmuteReporter",
                 "tools.ozone.moderation.defs#modEventReverseTakedown",
+                "tools.ozone.moderation.defs#modEventResolveAppeal",
                 "tools.ozone.moderation.defs#modEventEmail",
                 "tools.ozone.moderation.defs#modEventTag"
               ]

diff --git a/packages/api/src/client/index.ts b/packages/api/src/client/index.ts
@@ -3415,12 +3415,11 @@ export class ToolsOzoneCommunicationNS {
     data?: ToolsOzoneCommunicationCreateTemplate.InputSchema,
     opts?: ToolsOzoneCommunicationCreateTemplate.CallOptions,
   ): Promise<ToolsOzoneCommunicationCreateTemplate.Response> {
-    return this._client.call(
-      'tools.ozone.communication.createTemplate',
-      opts?.qp,
-      data,
-      opts,
-    )
+    return this._client
+      .call('tools.ozone.communication.createTemplate', opts?.qp, data, opts)
+      .catch((e) => {
+        throw ToolsOzoneCommunicationCreateTemplate.toKnownErr(e)
+      })
   }
 
   deleteTemplate(
@@ -3451,12 +3450,11 @@ export class ToolsOzoneCommunicationNS {
     data?: ToolsOzoneCommunicationUpdateTemplate.InputSchema,
     opts?: ToolsOzoneCommunicationUpdateTemplate.CallOptions,
   ): Promise<ToolsOzoneCommunicationUpdateTemplate.Response> {
-    return this._client.call(
-      'tools.ozone.communication.updateTemplate',
-      opts?.qp,
-      data,
-      opts,
-    )
+    return this._client
+      .call('tools.ozone.communication.updateTemplate', opts?.qp, data, opts)
+      .catch((e) => {
+        throw ToolsOzoneCommunicationUpdateTemplate.toKnownErr(e)
+      })
   }
 }
 

diff --git a/packages/api/src/client/lexicons.ts b/packages/api/src/client/lexicons.ts
@@ -10466,6 +10466,11 @@ export const schemaDict = {
                 type: 'string',
                 description: 'Subject of the message, used in emails.',
               },
+              lang: {
+                type: 'string',
+                format: 'language',
+                description: 'Message language.',
+              },
               createdBy: {
                 type: 'string',
                 format: 'did',
@@ -10481,6 +10486,11 @@ export const schemaDict = {
             ref: 'lex:tools.ozone.communication.defs#templateView',
           },
         },
+        errors: [
+          {
+            name: 'DuplicateTemplateName',
+          },
+        ],
       },
     },
   },
@@ -10519,6 +10529,11 @@ export const schemaDict = {
           disabled: {
             type: 'boolean',
           },
+          lang: {
+            type: 'string',
+            format: 'language',
+            description: 'Message language.',
+          },
           lastUpdatedBy: {
             type: 'string',
             format: 'did',
@@ -10606,6 +10621,11 @@ export const schemaDict = {
                 type: 'string',
                 description: 'Name of the template.',
               },
+              lang: {
+                type: 'string',
+                format: 'language',
+                description: 'Message language.',
+              },
               contentMarkdown: {
                 type: 'string',
                 description:
@@ -10633,6 +10653,11 @@ export const schemaDict = {
             ref: 'lex:tools.ozone.communication.defs#templateView',
           },
         },
+        errors: [
+          {
+            name: 'DuplicateTemplateName',
+          },
+        ],
       },
     },
   },
@@ -11432,6 +11457,7 @@ export const schemaDict = {
                   'lex:tools.ozone.moderation.defs#modEventMuteReporter',
                   'lex:tools.ozone.moderation.defs#modEventUnmuteReporter',
                   'lex:tools.ozone.moderation.defs#modEventReverseTakedown',
+                  'lex:tools.ozone.moderation.defs#modEventResolveAppeal',
                   'lex:tools.ozone.moderation.defs#modEventEmail',
                   'lex:tools.ozone.moderation.defs#modEventTag',
                 ],

diff --git a/packages/api/src/client/types/tools/ozone/communication/createTemplate.ts b/packages/api/src/client/types/tools/ozone/communication/createTemplate.ts
@@ -17,6 +17,8 @@ export interface InputSchema {
   contentMarkdown: string
   /** Subject of the message, used in emails. */
   subject: string
+  /** Message language. */
+  lang?: string
   /** DID of the user who is creating the template. */
   createdBy?: string
   [k: string]: unknown
@@ -37,6 +39,17 @@ export interface Response {
   data: OutputSchema
 }
 
+export class DuplicateTemplateNameError extends XRPCError {
+  constructor(src: XRPCError) {
+    super(src.status, src.error, src.message, src.headers, { cause: src })
+  }
+}
+
 export function toKnownErr(e: any) {
+  if (e instanceof XRPCError) {
+    if (e.error === 'DuplicateTemplateName')
+      return new DuplicateTemplateNameError(e)
+  }
+
   return e
 }
diff --git a/packages/api/src/client/types/tools/ozone/communication/defs.ts b/packages/api/src/client/types/tools/ozone/communication/defs.ts
@@ -15,6 +15,8 @@ export interface TemplateView {
   /** Subject of the message, used in emails. */
   contentMarkdown: string
   disabled: boolean
+  /** Message language. */
+  lang?: string
   /** DID of the user who last updated the template. */
   lastUpdatedBy: string
   createdAt: string

diff --git a/packages/api/src/client/types/tools/ozone/communication/updateTemplate.ts b/packages/api/src/client/types/tools/ozone/communication/updateTemplate.ts
@@ -15,6 +15,8 @@ export interface InputSchema {
   id: string
   /** Name of the template. */
   name?: string
+  /** Message language. */
+  lang?: string
   /** Content of the template, markdown supported, can contain variable placeholders. */
   contentMarkdown?: string
   /** Subject of the message, used in emails. */
@@ -40,6 +42,17 @@ export interface Response {
   data: OutputSchema
 }
 
+export class DuplicateTemplateNameError extends XRPCError {
+  constructor(src: XRPCError) {
+    super(src.status, src.error, src.message, src.headers, { cause: src })
+  }
+}
+
 export function toKnownErr(e: any) {
+  if (e instanceof XRPCError) {
+    if (e.error === 'DuplicateTemplateName')
+      return new DuplicateTemplateNameError(e)
+  }
+
   return e
 }
diff --git a/packages/api/src/client/types/tools/ozone/moderation/emitEvent.ts b/packages/api/src/client/types/tools/ozone/moderation/emitEvent.ts
@@ -25,6 +25,7 @@ export interface InputSchema {
     | ToolsOzoneModerationDefs.ModEventMuteReporter
     | ToolsOzoneModerationDefs.ModEventUnmuteReporter
     | ToolsOzoneModerationDefs.ModEventReverseTakedown
+    | ToolsOzoneModerationDefs.ModEventResolveAppeal
     | ToolsOzoneModerationDefs.ModEventEmail
     | ToolsOzoneModerationDefs.ModEventTag
     | { $type: string; [k: string]: unknown }

diff --git a/packages/ozone/src/api/communication/createTemplate.ts b/packages/ozone/src/api/communication/createTemplate.ts
@@ -1,14 +1,15 @@
 import { AuthRequiredError, InvalidRequestError } from '@atproto/xrpc-server'
 import { Server } from '../../lexicon'
 import AppContext from '../../context'
+import { isDuplicateTemplateNameError } from '../../communication-service/util'
 
 export default function (server: Server, ctx: AppContext) {
   server.tools.ozone.communication.createTemplate({
     auth: ctx.authVerifier.modOrAdminToken,
     handler: async ({ input, auth }) => {
       const access = auth.credentials
       const db = ctx.db
-      const { createdBy, ...template } = input.body
+      const { createdBy, lang, ...template } = input.body
 
       if (!access.isModerator) {
         throw new AuthRequiredError(
@@ -22,15 +23,28 @@ export default function (server: Server, ctx: AppContext) {
       }
 
       const communicationTemplate = ctx.communicationTemplateService(db)
-      const newTemplate = await communicationTemplate.create({
-        ...template,
-        disabled: false,
-        lastUpdatedBy: createdBy,
-      })
 
-      return {
-        encoding: 'application/json',
-        body: communicationTemplate.view(newTemplate),
+      try {
+        const newTemplate = await communicationTemplate.create({
+          ...template,
+          // We are not using ?? here because we want to use null instead of potentially empty string
+          lang: lang || null,
+          disabled: false,
+          lastUpdatedBy: createdBy,
+        })
+
+        return {
+          encoding: 'application/json',
+          body: communicationTemplate.view(newTemplate),
+        }
+      } catch (err) {
+        if (isDuplicateTemplateNameError(err)) {
+          throw new InvalidRequestError(
+            `${template.name} already exists. Please choose a different name.`,
+            'DuplicateTemplateName',
+          )
+        }
+        throw err
       }
     },
   })

diff --git a/packages/ozone/src/api/communication/updateTemplate.ts b/packages/ozone/src/api/communication/updateTemplate.ts
@@ -1,6 +1,7 @@
 import { AuthRequiredError, InvalidRequestError } from '@atproto/xrpc-server'
 import { Server } from '../../lexicon'
 import AppContext from '../../context'
+import { isDuplicateTemplateNameError } from '../../communication-service/util'
 
 export default function (server: Server, ctx: AppContext) {
   server.tools.ozone.communication.updateTemplate({
@@ -26,14 +27,24 @@ export default function (server: Server, ctx: AppContext) {
       }
 
       const communicationTemplate = ctx.communicationTemplateService(db)
-      const updatedTemplate = await communicationTemplate.update(Number(id), {
-        ...template,
-        lastUpdatedBy: updatedBy,
-      })
+      try {
+        const updatedTemplate = await communicationTemplate.update(Number(id), {
+          ...template,
+          lastUpdatedBy: updatedBy,
+        })
 
-      return {
-        encoding: 'application/json',
-        body: communicationTemplate.view(updatedTemplate),
+        return {
+          encoding: 'application/json',
+          body: communicationTemplate.view(updatedTemplate),
+        }
+      } catch (err) {
+        if (isDuplicateTemplateNameError(err)) {
+          throw new InvalidRequestError(
+            `${template.name} already exists. Please choose a different name.`,
+            'DuplicateTemplateName',
+          )
+        }
+        throw err
       }
     },
   })

diff --git a/packages/ozone/src/communication-service/template.ts b/packages/ozone/src/communication-service/template.ts
@@ -27,6 +27,7 @@ export class CommunicationTemplateService {
     name,
     contentMarkdown,
     subject,
+    lang,
     disabled,
     updatedAt,
     createdAt,
@@ -44,6 +45,7 @@ export class CommunicationTemplateService {
         name,
         contentMarkdown,
         subject,
+        lang,
         disabled,
         lastUpdatedBy,
         updatedAt: updatedAt || new Date(),
@@ -62,6 +64,7 @@ export class CommunicationTemplateService {
       contentMarkdown,
       subject,
       disabled,
+      lang,
       updatedAt,
       lastUpdatedBy,
     }: Partial<Omit<Selectable<CommunicationTemplate>, 'id' | 'createdAt'>>,
@@ -73,6 +76,7 @@ export class CommunicationTemplateService {
         name,
         contentMarkdown,
         subject,
+        lang,
         disabled,
         lastUpdatedBy,
         updatedAt: updatedAt || new Date(),
@@ -96,6 +100,7 @@ export class CommunicationTemplateService {
       name: template.name,
       contentMarkdown: template.contentMarkdown,
       disabled: template.disabled,
+      lang: template.lang || undefined,
       subject: template.subject || undefined,
       createdAt: template.createdAt.toISOString(),
       updatedAt: template.updatedAt.toISOString(),

diff --git a/packages/ozone/src/communication-service/util.ts b/packages/ozone/src/communication-service/util.ts
@@ -0,0 +1,8 @@
+// Postgresql will throw a specific error code with the constraint when trying to create a template with duplicate name
+// see https://www.postgresql.org/docs/current/errcodes-appendix.html
+export const isDuplicateTemplateNameError = (err: any) => {
+  return (
+    err?.['code'] === '23505' &&
+    err?.['constraint'] === 'communication_template_unique_name'
+  )
+}