Handle DC Chat Feedback Submission (#226)

* Handler for chat feedback

* Address PR comments

layers/api_dependencies/package.json

@@ -8,16 +8,18 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "^2.0.1",
     "@aws-sdk/client-sfn": "^3.563.0",
+    "@aws-sdk/client-sns": "^3.606.0",
     "@aws-sdk/credential-provider-node": "^3.563.0",
+    "@honeybadger-io/js": "^4.9.3",
     "@smithy/node-http-handler": "^2.5.0",
     "@smithy/protocol-http": "^3.3.0",
     "@smithy/signature-v4": "^2.3.0",
-    "@honeybadger-io/js": "^4.9.3",
     "axios": ">=0.21.1",
     "cookie": "^0.5.0",
     "debug": "^4.3.4",
     "http-status-codes": "^2.2.0",
     "iiif-builder": "^1.0.7",
+    "jsonschema": "^1.4.1",
     "jsonwebtoken": "^8.5.1",
     "lodash": "^4.17.21",
     "lz-string": "^1.4.4",

node/package.json

@@ -19,6 +19,7 @@
   },
   "devDependencies": {
     "@openapitools/openapi-generator-cli": "^2.5.2",
+    "aws-sdk-client-mock": "^4.0.1",
     "chai": "^4.2.0",
     "chai-http": "^4.3.0",
     "choma": "^1.2.1",

node/src/handlers/post-chat-feedback.js

@@ -0,0 +1,125 @@
+const { wrap } = require("./middleware");
+const { PutObjectCommand, S3Client } = require("@aws-sdk/client-s3");
+const { SNSClient, PublishCommand } = require("@aws-sdk/client-sns");
+
+const Validator = require("jsonschema").Validator;
+
+const feedbackSchema = {
+  type: "object",
+  properties: {
+    sentiment: { enum: ["positive", "negative"] },
+    context: {
+      type: "object",
+      properties: {
+        ref: { type: "string" },
+        question: { type: "string" },
+        answer: { type: "string" },
+        source_documents: {
+          type: "array",
+          items: { type: "string" },
+        },
+      },
+      required: ["ref", "question", "answer", "source_documents"],
+      additionalProperties: false,
+    },
+    feedback: {
+      type: "object",
+      properties: {
+        options: { type: "array", items: { type: "string" } },
+        text: { type: "string" },
+        email: { type: "string" },
+      },
+      required: ["options", "text", "email"],
+      additionalProperties: false,
+    },
+  },
+  required: ["sentiment", "context", "feedback"],
+  additionalProperties: false,
+};
+
+const handler = wrap(async (event, context) => {
+  if (!event.userToken.isLoggedIn() && !event.userToken.isSuperUser()) {
+    return {
+      statusCode: 401,
+      headers: { "Content-Type": "text/plain" },
+      body: "Authorization Required",
+    };
+  }
+
+  // Pass in the S3 and SNS clients if they are injected
+  // to workound an issue with the mocking library
+  // https://github.com/m-radzikowski/aws-sdk-client-mock
+  const s3Client = context?.injections?.s3Client
+    ? context.injections.s3Client
+    : new S3Client({});
+  const snsClient = context?.injections?.snsClient
+    ? context.injections.snsClient
+    : new SNSClient({});
+
+  try {
+    const content = JSON.parse(event.body);
+    const v = new Validator();
+    var result = v.validate(content, feedbackSchema);
+
+    const errors = result.errors.map((e) => e.stack.replace("instance.", ""));
+    if (errors.length > 0) {
+      return {
+        statusCode: 400,
+        headers: { "Content-Type": "text/plain" },
+        body: JSON.stringify(errors.join(", ")),
+      };
+    }
+    await uploadToS3(
+      s3Client,
+      `${content.sentiment}/${content.context.ref}.json`,
+      content
+    );
+
+    await sendNotification(
+      snsClient,
+      `Chat feedback: ${content.sentiment} response (${
+        process.env.HONEYBADGER_ENV || process.env.DEV_PREFIX || "dev"
+      })`,
+      JSON.stringify(content, null, 2)
+    );
+
+    return {
+      statusCode: 200,
+      headers: { "content-type": "text/plain" },
+      body: JSON.stringify({
+        message: `Feedback received. Thank you.`,
+      }),
+    };
+  } catch (err) {
+    console.error(err);
+    return {
+      statusCode: 500,
+      headers: { "content-type": "text/plain" },
+      body: "Internal Server Error",
+    };
+  }
+});
+
+const uploadToS3 = async (s3Client, key, body) => {
+  const command = new PutObjectCommand({
+    Bucket: process.env.CHAT_FEEDBACK_BUCKET,
+    Key: key,
+    Body: JSON.stringify(body, null, 2),
+    ContentType: "application/json",
+  });
+
+  return await s3Client.send(command);
+};
+
+const sendNotification = async (snsClient, subject, message) => {
+  const command = new PublishCommand({
+    TopicArn: process.env.CHAT_FEEDBACK_TOPIC_ARN,
+    Subject: subject,
+    Message: message,
+  });
+  const response = await snsClient.send(command);
+  console.log(response);
+  return response;
+};
+
+module.exports = { handler };