Merge pull request #967 from LAION-AI/865-storbook-mock-service-worker

Copying from #769 to implement mock service worker

website/.prettierignore

@@ -1,3 +1,4 @@
 .eslintrc.json
 tailwind.config.js
 .storybook/*
+public/mockServiceWorker.js

website/.storybook/preview.js

@@ -1,5 +1,38 @@
 import "!style-loader!css-loader!postcss-loader!tailwindcss/tailwind.css";
 import { RouterContext } from "next/dist/shared/lib/router-context";
+import { initialize, mswDecorator } from "msw-storybook-addon";
+import { rest } from "msw";
+
+// Initialize MSW
+initialize();
+
+// Provide the MSW addon decorator globally
+export const decorators = [mswDecorator];
+
+const MOCK_VALID_LABELS= [
+  {
+    name: "spam",
+    display_text: "Seems to be intentionally low-quality or irrelevant",
+    help_text: null,
+  },
+  {
+    name: "fails_task",
+    display_text:
+      "Fails to follow the correct instruction / task",
+    help_text: null,
+  },
+  {
+    name: "not_appropriate",
+    display_text: "Inappropriate for customer assistant",
+    help_text: null,
+  },
+  {
+    name: "violence",
+    display_text:
+      "Encourages or fails to discourage violence/abuse/terrorism/self-harm",
+    help_text: null,
+  },
+];
 
 export const parameters = {
   actions: { argTypesRegex: "^on[A-Z].*" },
@@ -12,6 +45,19 @@ export const parameters = {
   nextRouter: {
     Provider: RouterContext.Provider,
   },
+  msw: {
+    handlers: {
+      labels: [
+        rest.get("/api/valid_labels", (req, res, ctx) => {
+          return res(
+            ctx.json({
+              valid_labels: MOCK_VALID_LABELS
+            })
+          );
+        }),
+      ],
+    },
+  },
 };
 
 // Hacky solution to get Images in next to work

website/package.json

@@ -95,9 +95,14 @@
     "eslint-plugin-unused-imports": "^2.0.0",
     "jest": "^29.3.1",
     "jest-environment-jsdom": "^29.3.1",
+    "msw": "^0.49.3",
+    "msw-storybook-addon": "^1.7.0",
     "prettier": "2.8.1",
     "prisma": "^4.7.1",
     "ts-node": "^10.9.1",
     "typescript": "^4.9.4"
+  },
+  "msw": {
+    "workerDirectory": "public"
   }
 }

website/public/mockServiceWorker.js

@@ -0,0 +1,303 @@
+/* eslint-disable */
+/* tslint:disable */
+
+/**
+ * Mock Service Worker (0.49.3).
+ * @see https://github.com/mswjs/msw
+ * - Please do NOT modify this file.
+ * - Please do NOT serve this file on production.
+ */
+
+const INTEGRITY_CHECKSUM = '3d6b9f06410d179a7f7404d4bf4c3c70'
+const activeClientIds = new Set()
+
+self.addEventListener('install', function () {
+  self.skipWaiting()
+})
+
+self.addEventListener('activate', function (event) {
+  event.waitUntil(self.clients.claim())
+})
+
+self.addEventListener('message', async function (event) {
+  const clientId = event.source.id
+
+  if (!clientId || !self.clients) {
+    return
+  }
+
+  const client = await self.clients.get(clientId)
+
+  if (!client) {
+    return
+  }
+
+  const allClients = await self.clients.matchAll({
+    type: 'window',
+  })
+
+  switch (event.data) {
+    case 'KEEPALIVE_REQUEST': {
+      sendToClient(client, {
+        type: 'KEEPALIVE_RESPONSE',
+      })
+      break
+    }
+
+    case 'INTEGRITY_CHECK_REQUEST': {
+      sendToClient(client, {
+        type: 'INTEGRITY_CHECK_RESPONSE',
+        payload: INTEGRITY_CHECKSUM,
+      })
+      break
+    }
+
+    case 'MOCK_ACTIVATE': {
+      activeClientIds.add(clientId)
+
+      sendToClient(client, {
+        type: 'MOCKING_ENABLED',
+        payload: true,
+      })
+      break
+    }
+
+    case 'MOCK_DEACTIVATE': {
+      activeClientIds.delete(clientId)
+      break
+    }
+
+    case 'CLIENT_CLOSED': {
+      activeClientIds.delete(clientId)
+
+      const remainingClients = allClients.filter((client) => {
+        return client.id !== clientId
+      })
+
+      // Unregister itself when there are no more clients
+      if (remainingClients.length === 0) {
+        self.registration.unregister()
+      }
+
+      break
+    }
+  }
+})
+
+self.addEventListener('fetch', function (event) {
+  const { request } = event
+  const accept = request.headers.get('accept') || ''
+
+  // Bypass server-sent events.
+  if (accept.includes('text/event-stream')) {
+    return
+  }
+
+  // Bypass navigation requests.
+  if (request.mode === 'navigate') {
+    return
+  }
+
+  // Opening the DevTools triggers the "only-if-cached" request
+  // that cannot be handled by the worker. Bypass such requests.
+  if (request.cache === 'only-if-cached' && request.mode !== 'same-origin') {
+    return
+  }
+
+  // Bypass all requests when there are no active clients.
+  // Prevents the self-unregistered worked from handling requests
+  // after it's been deleted (still remains active until the next reload).
+  if (activeClientIds.size === 0) {
+    return
+  }
+
+  // Generate unique request ID.
+  const requestId = Math.random().toString(16).slice(2)
+
+  event.respondWith(
+    handleRequest(event, requestId).catch((error) => {
+      if (error.name === 'NetworkError') {
+        console.warn(
+          '[MSW] Successfully emulated a network error for the "%s %s" request.',
+          request.method,
+          request.url,
+        )
+        return
+      }
+
+      // At this point, any exception indicates an issue with the original request/response.
+      console.error(
+        `\
+[MSW] Caught an exception from the "%s %s" request (%s). This is probably not a problem with Mock Service Worker. There is likely an additional logging output above.`,
+        request.method,
+        request.url,
+        `${error.name}: ${error.message}`,
+      )
+    }),
+  )
+})
+
+async function handleRequest(event, requestId) {
+  const client = await resolveMainClient(event)
+  const response = await getResponse(event, client, requestId)
+
+  // Send back the response clone for the "response:*" life-cycle events.
+  // Ensure MSW is active and ready to handle the message, otherwise
+  // this message will pend indefinitely.
+  if (client && activeClientIds.has(client.id)) {
+    ;(async function () {
+      const clonedResponse = response.clone()
+      sendToClient(client, {
+        type: 'RESPONSE',
+        payload: {
+          requestId,
+          type: clonedResponse.type,
+          ok: clonedResponse.ok,
+          status: clonedResponse.status,
+          statusText: clonedResponse.statusText,
+          body:
+            clonedResponse.body === null ? null : await clonedResponse.text(),
+          headers: Object.fromEntries(clonedResponse.headers.entries()),
+          redirected: clonedResponse.redirected,
+        },
+      })
+    })()
+  }
+
+  return response
+}
+
+// Resolve the main client for the given event.
+// Client that issues a request doesn't necessarily equal the client
+// that registered the worker. It's with the latter the worker should
+// communicate with during the response resolving phase.
+async function resolveMainClient(event) {
+  const client = await self.clients.get(event.clientId)
+
+  if (client?.frameType === 'top-level') {
+    return client
+  }
+
+  const allClients = await self.clients.matchAll({
+    type: 'window',
+  })
+
+  return allClients
+    .filter((client) => {
+      // Get only those clients that are currently visible.
+      return client.visibilityState === 'visible'
+    })
+    .find((client) => {
+      // Find the client ID that's recorded in the
+      // set of clients that have registered the worker.
+      return activeClientIds.has(client.id)
+    })
+}
+
+async function getResponse(event, client, requestId) {
+  const { request } = event
+  const clonedRequest = request.clone()
+
+  function passthrough() {
+    // Clone the request because it might've been already used
+    // (i.e. its body has been read and sent to the client).
+    const headers = Object.fromEntries(clonedRequest.headers.entries())
+
+    // Remove MSW-specific request headers so the bypassed requests
+    // comply with the server's CORS preflight check.
+    // Operate with the headers as an object because request "Headers"
+    // are immutable.
+    delete headers['x-msw-bypass']
+
+    return fetch(clonedRequest, { headers })
+  }
+
+  // Bypass mocking when the client is not active.
+  if (!client) {
+    return passthrough()
+  }
+
+  // Bypass initial page load requests (i.e. static assets).
+  // The absence of the immediate/parent client in the map of the active clients
+  // means that MSW hasn't dispatched the "MOCK_ACTIVATE" event yet
+  // and is not ready to handle requests.
+  if (!activeClientIds.has(client.id)) {
+    return passthrough()
+  }
+
+  // Bypass requests with the explicit bypass header.
+  // Such requests can be issued by "ctx.fetch()".
+  if (request.headers.get('x-msw-bypass') === 'true') {
+    return passthrough()
+  }
+
+  // Notify the client that a request has been intercepted.
+  const clientMessage = await sendToClient(client, {
+    type: 'REQUEST',
+    payload: {
+      id: requestId,
+      url: request.url,
+      method: request.method,
+      headers: Object.fromEntries(request.headers.entries()),
+      cache: request.cache,
+      mode: request.mode,
+      credentials: request.credentials,
+      destination: request.destination,
+      integrity: request.integrity,
+      redirect: request.redirect,
+      referrer: request.referrer,
+      referrerPolicy: request.referrerPolicy,
+      body: await request.text(),
+      bodyUsed: request.bodyUsed,
+      keepalive: request.keepalive,
+    },
+  })
+
+  switch (clientMessage.type) {
+    case 'MOCK_RESPONSE': {
+      return respondWithMock(clientMessage.data)
+    }
+
+    case 'MOCK_NOT_FOUND': {
+      return passthrough()
+    }
+
+    case 'NETWORK_ERROR': {
+      const { name, message } = clientMessage.data
+      const networkError = new Error(message)
+      networkError.name = name
+
+      // Rejecting a "respondWith" promise emulates a network error.
+      throw networkError
+    }
+  }
+
+  return passthrough()
+}
+
+function sendToClient(client, message) {
+  return new Promise((resolve, reject) => {
+    const channel = new MessageChannel()
+
+    channel.port1.onmessage = (event) => {
+      if (event.data && event.data.error) {
+        return reject(event.data.error)
+      }
+
+      resolve(event.data)
+    }
+
+    client.postMessage(message, [channel.port2])
+  })
+}
+
+function sleep(timeMs) {
+  return new Promise((resolve) => {
+    setTimeout(resolve, timeMs)
+  })
+}
+
+async function respondWithMock(response) {
+  await sleep(response.delay)
+  return new Response(response.body, response)
+}

website/src/components/Messages/MessageTableEntry.tsx

@@ -36,7 +36,10 @@ export function MessageTableEntry({ message, enabled, highlight }: MessageTableE
   const router = useRouter();
   const [emojiState, setEmojis] = useState<MessageEmojis>({ emojis: {}, user_emojis: [] });
   useEffect(() => {
-    setEmojis({ emojis: message.emojis || {}, user_emojis: message.user_emojis || [] });
+    setEmojis({
+      emojis: message?.emojis || {},
+      user_emojis: message?.user_emojis || [],
+    });
   }, [message.emojis, message.user_emojis]);
 
   const goToMessage = useCallback(() => router.push(`/messages/${message.id}`), [router, message.id]);
@@ -158,7 +161,7 @@ const MessageActions = ({
         <MenuGroup title={t("reactions")}>
           <SimpleGrid columns={4}>
             {["+1", "-1"].map((emoji) => (
-              <EmojiMenuItem key={emoji} emoji={emoji} checked={userEmoji.includes(emoji)} react={react} />
+              <EmojiMenuItem key={emoji} emoji={emoji} checked={userEmoji?.includes(emoji)} react={react} />
             ))}
           </SimpleGrid>
         </MenuGroup>

website/src/components/Messages/MessageWithChildren.stories.tsx

@@ -0,0 +1,99 @@
+import { rest } from "msw";
+import { MessageWithChildren } from "./MessageWithChildren";
+
+// eslint-disable-next-line import/no-anonymous-default-export
+export default {
+  title: "Messages/MessageWithChildren",
+  component: MessageWithChildren,
+  parameters: {
+    layout: "fullscreen",
+    msw: {
+      handlers: {
+        messagesDefault: [
+          rest.get("/api/messages/id-1", (req, res, ctx) => {
+            return res(
+              ctx.json({
+                text: "Some message Text",
+                is_assistant: false,
+                id: "id-1",
+              })
+            );
+          }),
+          rest.get("/api/messages/id-1/children", (req, res, ctx) => {
+            return res(ctx.json([]));
+          }),
+        ],
+      },
+    },
+  },
+};
+
+const Template = (args) => <MessageWithChildren {...args} />;
+
+export const NoChildren = Template.bind({});
+NoChildren.args = {
+  id: "id-1",
+  maxDepth: 2,
+};
+
+export const WithChildren = Template.bind({});
+WithChildren.args = {
+  id: "id-1",
+  maxDepth: 1,
+};
+WithChildren.parameters = {
+  msw: {
+    handlers: {
+      additionalMessages: [
+        rest.get("/api/messages/id-2", (req, res, ctx) => {
+          return res(
+            ctx.json({
+              text: "Some child message Text",
+              is_assistant: false,
+              id: "id-2",
+            })
+          );
+        }),
+        rest.get("/api/messages/id-3", (req, res, ctx) => {
+          return res(
+            ctx.json({
+              text: "Some child message Text",
+              is_assistant: false,
+              id: "id-3",
+            })
+          );
+        }),
+        rest.get("/api/messages/id-1/children", (req, res, ctx) => {
+          return res(
+            ctx.json([
+              {
+                text: "Some child message Text",
+                is_assistant: false,
+                id: "id-2",
+              },
+              {
+                text: "another child message Text",
+                is_assistant: false,
+                id: "id-3",
+              },
+            ])
+          );
+        }),
+        rest.get("/api/messages/id-2/children", (req, res, ctx) => {
+          return res(
+            ctx.json([
+              {
+                text: "another message Text",
+                is_assistant: false,
+                id: "id-4",
+              },
+            ])
+          );
+        }),
+        rest.get("/api/messages/id-3/children", (req, res, ctx) => {
+          return res(ctx.json([]));
+        }),
+      ],
+    },
+  },
+};