chore(tests): swap to @simulacrum/github-api-simulator (#330)

Author: jbolda

package.json

@@ -24,6 +24,7 @@
   "devDependencies": {
     "@jsdevtools/ez-spawn": "^3.0.4",
     "@types/node": "^20.14.2",
+    "@simulacrum/github-api-simulator": "^0.5.3",
     "@vitejs/release-scripts": "^1.3.1",
     "cross-env": "^7.0.3",
     "esbuild": "^0.20.2",

packages/backend/e2e.test.ts

@@ -5,51 +5,43 @@ import ezSpawn from "@jsdevtools/ez-spawn"
 import pushWorkflowRunInProgressFixture from './fixtures/workflow_run.in_progress.json'
 import prWorkflowRunRequestedFixture from './fixtures/pr.workflow_run.requested.json'
 import prPullRequestSynchronizeFixture from './fixtures/pr.pull_request.json'
-import { setupServer } from 'msw/node'
-import { http, HttpResponse } from 'msw'
-
-const server = setupServer(
-  // Mock the GitHub API installation endpoint
-  http.get('https://api.github.com/repos/:owner/:repo/installation', (ctx) => {
-    return HttpResponse.json({
-        id: 1234567,
-        access_tokens_url: 'https://api.github.com/app/installations/1234567/access_tokens',
-      })
-  }),
+import { simulation } from '@simulacrum/github-api-simulator'
 
-  // Mock the GitHub API token endpoint
-  http.post('https://api.github.com/app/installations/:installation_id/access_tokens', (ctx) => {
-    return HttpResponse.json({
-      token: 'ghs_mock_token',
-      expires_at: '2024-03-22T00:00:00Z',
-    })
-  })
-)
+let server;
+let workerUrl: string;
 
 let worker: UnstableDevWorker
-
 beforeAll(async () => {
-  // Start MSW server
-  server.listen()
+  const app = simulation({
+    initialState: {
+      users: [],
+      organizations: [{ login: "stackblitz-labs" }],
+      repositories: [{ owner: "stackblitz-labs", name: "temporary-test" }],
+      branches: [{ name: "main" }],
+      blobs: [],
+    },
+  });
+  server = await app.listen(3300);
 
   await ezSpawn.async('pnpm cross-env TEST=true pnpm --filter=backend run build', [], {
     stdio: "inherit",
     shell: true,
   });
-  worker = await unstable_dev('dist/_worker.js', {
-    config: './wrangler.toml',
+  worker = await unstable_dev(`${import.meta.dirname}/dist/_worker.js`, {
+    config: `${import.meta.dirname}/wrangler.toml`,
   })
   const url = `${worker.proxyData.userWorkerUrl.protocol}//${worker.proxyData.userWorkerUrl.hostname}:${worker.proxyData.userWorkerUrl.port}` 
   console.log(url)
+  workerUrl = url
   await ezSpawn.async(`pnpm cross-env TEST=true API_URL=${url} pnpm --filter=pkg-pr-new run build`, [], {
     stdio: "inherit",
     shell: true,
   });
 })
 
-afterAll(() => {
-  server.close()
-})
+afterAll(async () => {
+  await server.ensureClose();
+});
 
 describe.sequential.each([
   [pushWorkflowRunInProgressFixture],
@@ -135,7 +127,7 @@ describe.sequential.each([
     expect(shaBlobSize).toEqual(refBlobSize);
 
     // Test installation
-    const url = `/${owner}/${repo}/playground-a@${sha}?id=${Date.now()}`
+    const url = new URL(`/${owner}/${repo}/playground-a@${sha}?id=${Date.now()}`,workerUrl)
     const installProcess = await ezSpawn.async(`pnpm cross-env CI=true npx -f playground-a@${url}`, {
       stdio: "overlapped",
       shell: true,
@@ -152,7 +144,7 @@ describe.sequential.each([
     expect(response.status).toBe(200)
 
     // Test installation
-    const url = `/${owner}/${repo}/playground-b@${sha}?id=${Date.now()}`
+    const url = new URL(`/${owner}/${repo}/playground-b@${sha}?id=${Date.now()}`,workerUrl)
     const installProcess = await ezSpawn.async(`pnpm cross-env CI=true npx -f playground-b@${url}`, {
       stdio: "overlapped",
       shell: true,

packages/backend/fixtures/pr.pull_request.json

@@ -27,6 +27,7 @@ export default defineNitroConfig({
   srcDir: "server",
   runtimeConfig: {
     appId: "",
+    ghBaseUrl: "https://api.github.com",
     webhookSecret: "",
     privateKey: "",
     rmStaleKey: "",

packages/backend/fixtures/pr.workflow_run.completed.json

@@ -25,10 +25,10 @@
     "@octokit/webhooks": "^12.2.0",
     "@octokit/webhooks-types": "^7.4.0",
     "@pkg-pr-new/utils": "workspace:^",
+    "@simulacrum/github-api-simulator": "^0.5.3",
     "dotenv": "^16.4.5",
     "fast-jwt": "^4.0.2",
     "h3": "^1.11.1",
-    "msw": "^2.7.0",
     "nitro-cloudflare-dev": "0.1.2",
     "nitropack": "^2.9.6",
     "octokit": "^3.2.1",

packages/backend/fixtures/pr.workflow_run.requested.json

@@ -1,14 +1,18 @@
 import type { H3Event } from "h3";
 import type { App as AppType } from "octokit";
-import { App } from "../../vendor/octokit.build.mjs";
+import { App, Octokit } from "../../vendor/octokit.build.mjs";
 
 export function useOctokitApp(event: H3Event): AppType {
-  const { appId, privateKey, webhookSecret } = useRuntimeConfig(event);
+  const { appId, privateKey, webhookSecret, ghBaseUrl } =
+    useRuntimeConfig(event);
 
   return new App({
     appId,
     privateKey,
     webhooks: { secret: webhookSecret },
+    Octokit: Octokit.defaults({
+      baseUrl: ghBaseUrl,
+    }),
   }) as unknown as AppType;
 }
 
@@ -20,10 +24,7 @@ export async function useOctokitInstallation(
   const app = useOctokitApp(event);
   const { data: installationData } = await app.octokit.request(
     "GET /repos/{owner}/{repo}/installation",
-    {
-      owner: owner,
-      repo: repo,
-    },
+    { owner, repo },
   );
 
   return app.getInstallationOctokit(installationData.id);