WIP add ChatBot support

guardian · May 29, 2024 · 35a3b36 · 35a3b36
1 parent ac6978d
commit 35a3b36
Show file tree

Hide file tree

Showing 24 changed files with 1,291 additions and 118 deletions.
diff --git a/bootstrapping-lambda/src/server.ts b/bootstrapping-lambda/src/server.ts
@@ -44,6 +44,12 @@ const corsOptions: cors.CorsOptions = {
 server.use(express.json());
 server.use(cors(corsOptions));
 
+server.post("/bot/:pinboardId/:replyToItemId", (request, response) => {
+  //TODO check request for valid auth token
+  //TODO build CreateItemInput,
+  // TODO make http request to appsync endpoint using token from request (or possibly new token)
+});
+
 server.post("/search", getAuthMiddleware(), (_, response) => {
   response.setHeader("Access-Control-Allow-Credentials", "true");
   return response.json(Object.values(StageMetric));

diff --git a/cdk/lib/__snapshots__/stack.test.ts.snap b/cdk/lib/__snapshots__/stack.test.ts.snap
@@ -2275,7 +2275,7 @@ type Query {
   listItems(pinboardId: String!): [Item]
   listLastItemSeenByUsers(pinboardId: String!): [LastItemSeenByUser]
   getMyUser: MyUser
-  searchMentionableUsers(prefix: String!): UsersAndGroups
+  searchMentionableUsers(prefix: String!): UsersGroupsAndChatBots
   getUsers(emails: [String!]!): [User]
   getGroupPinboardIds: [PinboardIdWithClaimCounts!]!
   getItemCounts(pinboardIds: [String!]!): [PinboardIdWithItemCounts!]!
@@ -2320,7 +2320,8 @@ type Subscription {
 
 type MentionHandle {
   label: String!
-  isMe: Boolean!
+  isMe: Boolean
+  isBot: Boolean
 }
 
 type Item {
@@ -2333,6 +2334,7 @@ type Item {
   pinboardId: String!
   mentions: [MentionHandle!]
   groupMentions: [MentionHandle!]
+  chatBotMentions: [MentionHandle!]
   claimedByEmail: String
   claimable: Boolean!
   relatedItemId: String
@@ -2370,9 +2372,16 @@ type Group {
   memberEmails: [String!]!
 }
 
-type UsersAndGroups {
+type ChatBot {
+  shorthand: String!
+  description: String!
+  avatarUrl: String
+}
+
+type UsersGroupsAndChatBots {
   users: [User!]!
   groups: [Group!]!
+  chatBots: [ChatBot!]!
 }
 
 type WorkflowStub {
@@ -2410,6 +2419,7 @@ input CreateItemInput {
   pinboardId: String!
   mentions: [String!]
   groupMentions: [String!]
+  chatBotMentions: [String!]
   claimable: Boolean
   relatedItemId: String
 }
@@ -2492,7 +2502,7 @@ type PinboardIdWithItemCounts {
         "DataSourceName": "database_bridge_lambda_ds",
         "FieldName": "addManuallyOpenedPinboardIds",
         "Kind": "UNIT",
-        "ResponseMappingTemplate": "## schema checksum : aa02bae16942e48366fa36a1cd643d16
+        "ResponseMappingTemplate": "## schema checksum : 51a0add4d309eaf60c5fce1924e07115
 $util.toJson($ctx.result)",
         "TypeName": "Mutation",
       },
@@ -2513,7 +2523,7 @@ $util.toJson($ctx.result)",
         "DataSourceName": "database_bridge_lambda_ds",
         "FieldName": "claimItem",
         "Kind": "UNIT",
-        "ResponseMappingTemplate": "## schema checksum : aa02bae16942e48366fa36a1cd643d16
+        "ResponseMappingTemplate": "## schema checksum : 51a0add4d309eaf60c5fce1924e07115
 $util.toJson($ctx.result)",
         "TypeName": "Mutation",
       },
@@ -2534,7 +2544,7 @@ $util.toJson($ctx.result)",
         "DataSourceName": "database_bridge_lambda_ds",
         "FieldName": "createItem",
         "Kind": "UNIT",
-        "ResponseMappingTemplate": "## schema checksum : aa02bae16942e48366fa36a1cd643d16
+        "ResponseMappingTemplate": "## schema checksum : 51a0add4d309eaf60c5fce1924e07115
 $util.toJson($ctx.result)",
         "TypeName": "Mutation",
       },
@@ -2555,7 +2565,7 @@ $util.toJson($ctx.result)",
         "DataSourceName": "database_bridge_lambda_ds",
         "FieldName": "deleteItem",
         "Kind": "UNIT",
-        "ResponseMappingTemplate": "## schema checksum : aa02bae16942e48366fa36a1cd643d16
+        "ResponseMappingTemplate": "## schema checksum : 51a0add4d309eaf60c5fce1924e07115
 $util.toJson($ctx.result)",
         "TypeName": "Mutation",
       },
@@ -2576,7 +2586,7 @@ $util.toJson($ctx.result)",
         "DataSourceName": "database_bridge_lambda_ds",
         "FieldName": "editItem",
         "Kind": "UNIT",
-        "ResponseMappingTemplate": "## schema checksum : aa02bae16942e48366fa36a1cd643d16
+        "ResponseMappingTemplate": "## schema checksum : 51a0add4d309eaf60c5fce1924e07115
 $util.toJson($ctx.result)",
         "TypeName": "Mutation",
       },
@@ -2597,7 +2607,7 @@ $util.toJson($ctx.result)",
         "DataSourceName": "database_bridge_lambda_ds",
         "FieldName": "removeManuallyOpenedPinboardIds",
         "Kind": "UNIT",
-        "ResponseMappingTemplate": "## schema checksum : aa02bae16942e48366fa36a1cd643d16
+        "ResponseMappingTemplate": "## schema checksum : 51a0add4d309eaf60c5fce1924e07115
 $util.toJson($ctx.result)",
         "TypeName": "Mutation",
       },
@@ -2618,7 +2628,7 @@ $util.toJson($ctx.result)",
         "DataSourceName": "database_bridge_lambda_ds",
         "FieldName": "seenItem",
         "Kind": "UNIT",
-        "ResponseMappingTemplate": "## schema checksum : aa02bae16942e48366fa36a1cd643d16
+        "ResponseMappingTemplate": "## schema checksum : 51a0add4d309eaf60c5fce1924e07115
 $util.toJson($ctx.result)",
         "TypeName": "Mutation",
       },
@@ -2639,7 +2649,7 @@ $util.toJson($ctx.result)",
         "DataSourceName": "database_bridge_lambda_ds",
         "FieldName": "setWebPushSubscriptionForUser",
         "Kind": "UNIT",
-        "ResponseMappingTemplate": "## schema checksum : aa02bae16942e48366fa36a1cd643d16
+        "ResponseMappingTemplate": "## schema checksum : 51a0add4d309eaf60c5fce1924e07115
 $util.toJson($ctx.result)",
         "TypeName": "Mutation",
       },
@@ -2660,7 +2670,7 @@ $util.toJson($ctx.result)",
         "DataSourceName": "database_bridge_lambda_ds",
         "FieldName": "visitTourStep",
         "Kind": "UNIT",
-        "ResponseMappingTemplate": "## schema checksum : aa02bae16942e48366fa36a1cd643d16
+        "ResponseMappingTemplate": "## schema checksum : 51a0add4d309eaf60c5fce1924e07115
 $util.toJson($ctx.result)",
         "TypeName": "Mutation",
       },
@@ -2681,7 +2691,7 @@ $util.toJson($ctx.result)",
         "DataSourceName": "database_bridge_lambda_ds",
         "FieldName": "getGroupPinboardIds",
         "Kind": "UNIT",
-        "ResponseMappingTemplate": "## schema checksum : aa02bae16942e48366fa36a1cd643d16
+        "ResponseMappingTemplate": "## schema checksum : 51a0add4d309eaf60c5fce1924e07115
 $util.toJson($ctx.result)",
         "TypeName": "Query",
       },
@@ -2702,7 +2712,7 @@ $util.toJson($ctx.result)",
         "DataSourceName": "database_bridge_lambda_ds",
         "FieldName": "getItemCounts",
         "Kind": "UNIT",
-        "ResponseMappingTemplate": "## schema checksum : aa02bae16942e48366fa36a1cd643d16
+        "ResponseMappingTemplate": "## schema checksum : 51a0add4d309eaf60c5fce1924e07115
 $util.toJson($ctx.result)",
         "TypeName": "Query",
       },
@@ -2723,7 +2733,7 @@ $util.toJson($ctx.result)",
         "DataSourceName": "database_bridge_lambda_ds",
         "FieldName": "getMyUser",
         "Kind": "UNIT",
-        "ResponseMappingTemplate": "## schema checksum : aa02bae16942e48366fa36a1cd643d16
+        "ResponseMappingTemplate": "## schema checksum : 51a0add4d309eaf60c5fce1924e07115
 $util.toJson($ctx.result)",
         "TypeName": "Query",
       },
@@ -2744,7 +2754,7 @@ $util.toJson($ctx.result)",
         "DataSourceName": "database_bridge_lambda_ds",
         "FieldName": "getUsers",
         "Kind": "UNIT",
-        "ResponseMappingTemplate": "## schema checksum : aa02bae16942e48366fa36a1cd643d16
+        "ResponseMappingTemplate": "## schema checksum : 51a0add4d309eaf60c5fce1924e07115
 $util.toJson($ctx.result)",
         "TypeName": "Query",
       },
@@ -2765,7 +2775,7 @@ $util.toJson($ctx.result)",
         "DataSourceName": "database_bridge_lambda_ds",
         "FieldName": "listItems",
         "Kind": "UNIT",
-        "ResponseMappingTemplate": "## schema checksum : aa02bae16942e48366fa36a1cd643d16
+        "ResponseMappingTemplate": "## schema checksum : 51a0add4d309eaf60c5fce1924e07115
 $util.toJson($ctx.result)",
         "TypeName": "Query",
       },
@@ -2786,7 +2796,7 @@ $util.toJson($ctx.result)",
         "DataSourceName": "database_bridge_lambda_ds",
         "FieldName": "listLastItemSeenByUsers",
         "Kind": "UNIT",
-        "ResponseMappingTemplate": "## schema checksum : aa02bae16942e48366fa36a1cd643d16
+        "ResponseMappingTemplate": "## schema checksum : 51a0add4d309eaf60c5fce1924e07115
 $util.toJson($ctx.result)",
         "TypeName": "Query",
       },
@@ -2807,7 +2817,7 @@ $util.toJson($ctx.result)",
         "DataSourceName": "database_bridge_lambda_ds",
         "FieldName": "searchMentionableUsers",
         "Kind": "UNIT",
-        "ResponseMappingTemplate": "## schema checksum : aa02bae16942e48366fa36a1cd643d16
+        "ResponseMappingTemplate": "## schema checksum : 51a0add4d309eaf60c5fce1924e07115
 $util.toJson($ctx.result)",
         "TypeName": "Query",
       },
@@ -2932,7 +2942,7 @@ $util.toJson($ctx.result)",
         "DataSourceName": "grid_bridge_lambda_ds",
         "FieldName": "asGridPayload",
         "Kind": "UNIT",
-        "ResponseMappingTemplate": "## schema checksum : aa02bae16942e48366fa36a1cd643d16
+        "ResponseMappingTemplate": "## schema checksum : 51a0add4d309eaf60c5fce1924e07115
 $util.toJson($ctx.result)",
         "TypeName": "Query",
       },
@@ -2953,7 +2963,7 @@ $util.toJson($ctx.result)",
         "DataSourceName": "grid_bridge_lambda_ds",
         "FieldName": "getGridSearchSummary",
         "Kind": "UNIT",
-        "ResponseMappingTemplate": "## schema checksum : aa02bae16942e48366fa36a1cd643d16
+        "ResponseMappingTemplate": "## schema checksum : 51a0add4d309eaf60c5fce1924e07115
 $util.toJson($ctx.result)",
         "TypeName": "Query",
       },
@@ -3078,7 +3088,7 @@ $util.toJson($ctx.result)",
         "DataSourceName": "workflow_bridge_lambda_ds",
         "FieldName": "getPinboardByComposerId",
         "Kind": "UNIT",
-        "ResponseMappingTemplate": "## schema checksum : aa02bae16942e48366fa36a1cd643d16
+        "ResponseMappingTemplate": "## schema checksum : 51a0add4d309eaf60c5fce1924e07115
 $util.toJson($ctx.result)",
         "TypeName": "Query",
       },
@@ -3099,7 +3109,7 @@ $util.toJson($ctx.result)",
         "DataSourceName": "workflow_bridge_lambda_ds",
         "FieldName": "getPinboardsByIds",
         "Kind": "UNIT",
-        "ResponseMappingTemplate": "## schema checksum : aa02bae16942e48366fa36a1cd643d16
+        "ResponseMappingTemplate": "## schema checksum : 51a0add4d309eaf60c5fce1924e07115
 $util.toJson($ctx.result)",
         "TypeName": "Query",
       },
@@ -3120,7 +3130,7 @@ $util.toJson($ctx.result)",
         "DataSourceName": "workflow_bridge_lambda_ds",
         "FieldName": "listPinboards",
         "Kind": "UNIT",
-        "ResponseMappingTemplate": "## schema checksum : aa02bae16942e48366fa36a1cd643d16
+        "ResponseMappingTemplate": "## schema checksum : 51a0add4d309eaf60c5fce1924e07115
 $util.toJson($ctx.result)",
         "TypeName": "Query",
       },
@@ -4121,6 +4131,11 @@ $util.toJson($ctx.result)",
       "Properties": Object {
         "PolicyDocument": Object {
           "Statement": Array [
+            Object {
+              "Action": "ram:GetResourceShareAssociations",
+              "Effect": "Allow",
+              "Resource": "*",
+            },
             Object {
               "Action": "rds-db:connect",
               "Effect": "Allow",

diff --git a/cdk/lib/stack.ts b/cdk/lib/stack.ts
@@ -296,7 +296,14 @@ export class PinBoardStack extends GuStack {
           deployBucket,
           `${this.stack}/${this.stage}/${DATABASE_BRIDGE_LAMBDA_BASENAME}/${DATABASE_BRIDGE_LAMBDA_BASENAME}.zip`
         ),
-        initialPolicy: [],
+        initialPolicy: [
+          // to lookup chatbots shared from other accounts
+          new iam.PolicyStatement({
+            effect: iam.Effect.ALLOW,
+            actions: ["ram:GetResourceShareAssociations"],
+            resources: ["*"],
+          }),
+        ],
         vpc: accountVpc,
         securityGroups: [databaseSecurityGroup],
       }

diff --git a/client/gql.ts b/client/gql.ts
@@ -63,6 +63,10 @@ const itemReturnFields = `
     label
     isMe
   }
+  chatBotMentions {
+    label
+    isMe
+  }
   claimedByEmail
   claimable
   relatedItemId
@@ -133,6 +137,11 @@ export const gqlSearchMentionableUsers = (prefix: string) => gql`
                 name
                 memberEmails
             }
+            chatBots {
+                shorthand
+                description
+                avatarUrl
+            }
         }
     }
 `;

diff --git a/client/src/avatarRoundel.tsx b/client/src/avatarRoundel.tsx
@@ -1,31 +1,37 @@
 import { css } from "@emotion/react";
 import { neutral } from "@guardian/source-foundations";
 import React from "react";
-import { Group, User } from "../../shared/graphql/graphql";
+import { ChatBot, Group, User } from "../../shared/graphql/graphql";
 import { composer } from "../colours";
 import { agateSans } from "../fontNormaliser";
-import { isUser } from "../../shared/graphql/extraTypes";
+import {
+  hasAvatarUrl,
+  isChatBot,
+  isGroup,
+  isUser,
+} from "../../shared/graphql/extraTypes";
 
 interface AvatarRoundelProps {
-  maybeUserOrGroup: User | Group | undefined;
+  maybeUserOrGroupOrChatBot: User | Group | ChatBot | undefined;
   size: number;
   fallback: string;
 }
 
 export const AvatarRoundel = ({
-  maybeUserOrGroup,
+  maybeUserOrGroupOrChatBot,
   size,
   fallback,
 }: AvatarRoundelProps) =>
-  maybeUserOrGroup && isUser(maybeUserOrGroup) && maybeUserOrGroup.avatarUrl ? (
+  hasAvatarUrl(maybeUserOrGroupOrChatBot) &&
+  maybeUserOrGroupOrChatBot.avatarUrl ? (
     <img
       key={fallback}
       css={css`
         border-radius: 50%;
         width: ${size}px;
         height: ${size}px;
       `}
-      src={maybeUserOrGroup.avatarUrl}
+      src={maybeUserOrGroupOrChatBot.avatarUrl}
       draggable={false}
     />
   ) : (
@@ -35,7 +41,9 @@ export const AvatarRoundel = ({
         height: ${size}px;
         border-radius: 50%;
         box-shadow: 0 0 1px ${neutral[93]};
-        background-color: ${composer.primary[300]};
+        background-color: ${isChatBot(maybeUserOrGroupOrChatBot)
+          ? "none"
+          : composer.primary[300]};
         color: ${neutral[100]};
         display: flex;
         flex-shrink: 0;
@@ -47,17 +55,17 @@ export const AvatarRoundel = ({
         line-height: ${size}px;
       `}
     >
-      {maybeUserOrGroup ? (
-        isUser(maybeUserOrGroup) ? (
-          <React.Fragment>
-            {maybeUserOrGroup.firstName.charAt(0).toUpperCase()}
-            {maybeUserOrGroup.lastName?.charAt(0).toUpperCase()}
-          </React.Fragment>
-        ) : (
-          maybeUserOrGroup.memberEmails?.length
-        )
-      ) : (
-        fallback.charAt(0).toUpperCase()
+      {isUser(maybeUserOrGroupOrChatBot) && (
+        <React.Fragment>
+          {maybeUserOrGroupOrChatBot.firstName.charAt(0).toUpperCase()}
+          {maybeUserOrGroupOrChatBot.lastName?.charAt(0).toUpperCase()}
+        </React.Fragment>
       )}
+      {isGroup(maybeUserOrGroupOrChatBot) &&
+        maybeUserOrGroupOrChatBot.memberEmails?.length}
+      {isChatBot(maybeUserOrGroupOrChatBot) && (
+        <span>🤖</span> /* TODO replace with actual bot SVG */
+      )}
+      {!maybeUserOrGroupOrChatBot && fallback.charAt(0).toUpperCase()}
     </span>
   );