feat(book): webhook for compilation updates from Shapeshift

Author: jakeaturner

client/src/types/Book.ts

@@ -16,6 +16,8 @@ export type Book = {
   thumbnail: string;
   thumbnailIsAnimated?: boolean;
   summary: string;
+  isCompiled?: boolean;
+  lastCompiled?: number;
   rating: number;
   links: BookLinks;
   lastUpdated: string;

server/api.js

@@ -3219,6 +3219,12 @@ router.route('/shapeshift/job').post(
   catchInternal((req, res) => shapeshiftAPI.createJob(req, res)),
 );
 
+router.route("/shapeshift/webhook").post(
+  middleware.checkShapeshiftWebhookKey,
+  middleware.validateZod(ShapeshiftValidators.WebhookValidator),
+  catchInternal((req, res) => shapeshiftAPI.handleWebhook(req, res))
+);
+
 router.route('/book-bots/editor-preprocess').post(
   authAPI.verifyRequest,
   authAPI.getUserAttributes,

server/api/services/shapeshift-service.ts

@@ -1,6 +1,7 @@
-import {ShapeshiftJob, ShapeshiftJobStatus} from "../../types/Shapeshift";
-import axios, {AxiosInstance} from "axios";
-import {debugError} from "../../debug";
+import { ShapeshiftJob, ShapeshiftJobStatus } from "../../types/Shapeshift";
+import axios, { AxiosInstance } from "axios";
+import { debugError } from "../../debug";
+import Book from "../../models/book";
 
 export default class ShapeshiftService {
   private instance: AxiosInstance;
@@ -65,4 +66,38 @@ export default class ShapeshiftService {
       return emptyResponse;
     }
   }
+
+  /**
+   * Handle a webhook from Shapeshift to update the book's compilation status.
+   * @param bookID - The ID of the book to update.
+   * @param timestamp - The timestamp of the webhook event.
+   * @returns - A string indicating the result of the operation: 'success', 'not_found', 'invalid_timestamp', or 'error'.
+   */
+  public async handleWebhook(bookID: string, timestamp: number): Promise<'success' | 'not_found' | 'invalid_timestamp' | 'error'> {
+    try {
+      const acceptedSkew = 5 * 60 * 1000; // 5 minutes in milliseconds
+      const currentTime = Date.now();
+
+      // Accept the webhook if the timestamp is plus or minus 5 minutes from the current time
+      if (Math.abs(currentTime - timestamp) > acceptedSkew) {
+        debugError(`Timestamp for Shapeshift webhook is too skewed. Received: ${timestamp}, Current: ${currentTime}`);
+        return 'invalid_timestamp';
+      }
+
+      const book = await Book.updateOne({ bookID: { $eq: bookID } }, {
+        $set: { isCompiled: true },
+        $max: { lastCompiled: timestamp }, // Only update lastCompiled if the new timestamp is greater than the existing value
+      });
+
+      if (!book || book.matchedCount === 0) {
+        debugError(`Book with bookID ${bookID} not found for Shapeshift webhook.`);
+        return 'not_found';
+      }
+
+      return 'success';
+    } catch (error) {
+      debugError(error);
+      return 'error';
+    }
+  }
 }

server/api/shapeshift.ts

@@ -1,7 +1,7 @@
 import { Response } from "express";
 import { z } from "zod";
 import { ZodReqWithUser } from "../types";
-import { CreateJobValidator, GetJobsValidator } from "./validators/shapeshift";
+import { CreateJobValidator, GetJobsValidator, WebhookValidator } from "./validators/shapeshift";
 import ShapeshiftService from "./services/shapeshift-service";
 
 export async function createJob(
@@ -40,3 +40,38 @@ export async function getJobs(
     jobs,
   });
 }
+
+export async function handleWebhook(
+  req: z.infer<typeof WebhookValidator>,
+  res: Response
+) {
+  const service = new ShapeshiftService();
+  const { bookID, timestamp } = req.body;
+  const result = await service.handleWebhook(bookID, timestamp);
+
+  if (result === 'not_found') {
+    return res.status(404).json({
+      err: true,
+      msg: 'Book not found for webhook.',
+    });
+  }
+
+  if (result === 'invalid_timestamp') {
+    return res.status(400).json({
+      err: true,
+      msg: 'Invalid timestamp for webhook.',
+    });
+  }
+
+  if (result === 'error') {
+    return res.status(500).json({
+      err: true,
+      msg: 'Error processing webhook.',
+    });
+  }
+
+  return res.status(200).json({
+    err: false,
+    msg: 'Webhook processed.',
+  });
+}

server/api/validators/shapeshift.ts

@@ -1,4 +1,5 @@
 import { z } from "zod";
+import { bookIDSchema } from "./book.js";
 
 export const CreateJobValidator = z.object({
   body: z.object({
@@ -20,3 +21,11 @@ export const GetJobsValidator = z.object({
       .optional(),
   }),
 });
+
+
+export const WebhookValidator = z.object({
+  body: z.object({
+    bookID: bookIDSchema,
+    timestamp: z.number().int().nonnegative(), // Unix timestamp in seconds
+  }),
+});

server/middleware.ts

@@ -104,6 +104,23 @@ const checkEventBridgeAPIKey = (req: Request, res: Response, next: NextFunction)
   return res.status(401).send({ errMsg: conductorErrors.err5 });
 };
 
+/**
+ * Verifies that a request has provided a valid key from a Shapeshift webhook.
+ * @param {object} req - The Express.js request object.
+ * @param {object} res - The Express.js response object.
+ * @param {function} next - The next function in the middleware chain.
+ */
+const checkShapeshiftWebhookKey = (req: Request, res: Response, next: NextFunction) => {
+  if (typeof req.headers?.authorization === "string") {
+    const foundToken = req.headers.authorization.replace("Bearer ", "");
+    if (!process.env.SHAPESHIFT_WEBHOOK_KEY || process.env.SHAPESHIFT_WEBHOOK_KEY.length === 0) {
+      return res.status(500).send({ errMsg: conductorErrors.err6 });
+    }
+    if (process.env.SHAPESHIFT_WEBHOOK_KEY === foundToken) return next();
+  }
+  return res.status(401).send({ errMsg: conductorErrors.err5 });
+};
+
 /**
  * Reconstructs the Authorization header from cookies, if not already present.
  *
@@ -481,6 +498,7 @@ export default {
   checkLibreCommons,
   checkLibreAPIKey,
   checkEventBridgeAPIKey,
+  checkShapeshiftWebhookKey,
   authSanitizer,
   middlewareFilter,
   checkCentralIdentityConfig,

server/models/book.ts

@@ -14,6 +14,8 @@ export interface BookInterface extends Document {
   license?: string;
   thumbnail?: string;
   summary?: string;
+  isCompiled?: boolean;
+  lastCompiled?: number;
   rating?: number;
   links?: {
     online?: string;
@@ -99,6 +101,14 @@ const BookSchema = new Schema<BookInterface>(
      * The Book's overview/description/summary.
      */
     summary: String,
+    /**
+     * Whether the Book has, at any point, been successfully compiled by Shapeshift.
+     */
+    isCompiled: Boolean,
+    /**
+     * Timestamp of the most recent successful compilation by Shapeshift (Unix timestamp in seconds).
+     */
+    lastCompiled: Number,
     /**
      * The overall quality, on a scale of 0-5. Value is the average of all Peer Review
      * overall ratings submitted on the Book.