test(e2e): create fixtures for creating documents and deleting them at the end of a run (#559)

Author: cngonzalez

packages/@repo/e2e/package.json

@@ -33,6 +33,8 @@
     "prepare": "pnpm build"
   },
   "dependencies": {
+    "@sanity/client": "^6.12.5",
+    "@sanity/uuid": "^3.0.0",
     "dotenv": "^16.5.0"
   },
   "devDependencies": {

packages/@repo/e2e/src/fixtures.ts

@@ -1,12 +1,35 @@
 import {test as base} from '@playwright/test'
+import {type MultipleMutationResult, SanityClient} from '@sanity/client'
+
+import {getClient} from './helpers/clients'
+import {cleanupDocuments, createDocuments, type DocumentStub} from './helpers/documents'
+
+interface SanityFixtures {
+  createDocuments: (
+    data: DocumentStub[],
+    options?: {asDraft?: boolean},
+    dataset?: string,
+  ) => Promise<MultipleMutationResult>
+  getClient: (dataset?: string) => SanityClient
+}
 
 /**
  * @internal
  * Playwright test configuration for SDK E2E tests
- * (If different apps diverge dramatically, we can move this logic)
  */
-export const test = base.extend({
-  // We'll add custom fixtures shortly
+export const test = base.extend<SanityFixtures>({
+  // Playwright will error if we don't pass an object to destructure
+  // eslint-disable-next-line no-empty-pattern
+  createDocuments: async ({}, use) => {
+    await use(createDocuments)
+
+    // cleanup documents after each test
+    await cleanupDocuments()
+  },
+  // eslint-disable-next-line no-empty-pattern
+  getClient: async ({}, use) => {
+    await use(getClient)
+  },
 })
 
 export {expect} from '@playwright/test'

packages/@repo/e2e/src/helpers/clients.ts

@@ -0,0 +1,26 @@
+import {createClient, type SanityClient} from '@sanity/client'
+
+import {getE2EEnv} from './getE2EEnv'
+
+const env = getE2EEnv()
+
+const baseConfig = {
+  projectId: env.SDK_E2E_PROJECT_ID,
+  token: env.SDK_E2E_SESSION_TOKEN,
+  useCdn: false,
+  apiVersion: '2021-08-31',
+  apiHost: 'https://api.sanity.work',
+}
+
+const clients: Record<string, SanityClient> = {}
+
+export function getClient(dataset: string = env.SDK_E2E_DATASET_0): SanityClient {
+  if (!clients[dataset]) {
+    clients[dataset] = createClient({
+      ...baseConfig,
+      dataset,
+    })
+  }
+
+  return clients[dataset]
+}

packages/@repo/e2e/src/helpers/documents.ts

@@ -0,0 +1,63 @@
+import {type MultipleMutationResult, type SanityDocumentStub} from '@sanity/client'
+import {uuid} from '@sanity/uuid'
+
+import {getClient} from './clients'
+import {getE2EEnv} from './getE2EEnv'
+
+const env = getE2EEnv()
+
+export type DocumentStub = Omit<SanityDocumentStub, '_id'>
+
+// Keep track of document IDs created during tests
+const documentIds = new Set<string>()
+
+function getUniqueDocumentId(): string {
+  const documentId = uuid()
+  documentIds.add(documentId)
+  return documentId
+}
+
+export async function createDocuments<T extends DocumentStub>(
+  data: T[],
+  options?: {asDraft?: boolean},
+  dataset?: string,
+): Promise<MultipleMutationResult> {
+  const client = getClient(dataset)
+  const asDraft = options?.asDraft ?? true // Default to draft if not specified
+
+  const docs = data.map((doc) => {
+    const documentId = getUniqueDocumentId()
+    return {
+      ...doc,
+      _type: doc['_type'],
+      _id: asDraft ? `drafts.${documentId}` : documentId,
+    }
+  })
+
+  const transaction = client.transaction()
+  docs.forEach((doc) => transaction.create(doc))
+  return transaction.commit()
+}
+
+export async function cleanupDocuments(): Promise<void> {
+  if (documentIds.size === 0) return
+
+  // Clean up documents in both datasets
+  await Promise.all(
+    [env.SDK_E2E_DATASET_0, env.SDK_E2E_DATASET_1].map(async (dataset) => {
+      try {
+        const client = getClient(dataset)
+        await client.delete({
+          query: '*[_id in $ids]',
+          params: {ids: [...[...documentIds].map((id) => `drafts.${id}`), ...documentIds]},
+        })
+      } catch (error) {
+        // Log error but don't fail teardown
+        // eslint-disable-next-line no-console
+        console.error(`Failed to clean up documents in ${dataset}:`, error)
+      }
+    }),
+  )
+
+  documentIds.clear()
+}