fix(e2e): wait for the Notes API before running the Playwright tests

playwright.config.ts

@@ -48,8 +48,8 @@ export default defineConfig({
 		url: "http://127.0.0.1:8089/index.php/apps/notes/",
 		timeout: 5 * 60 * 1000, // max. 5 minutes for creating the container
 		wait: {
-			// we wait for this line to appear in the output of the webserver until consider it done
-			stdout: /Nextcloud is now ready to use/,
+			// the start script prints this line once the Notes API answers requests
+			stdout: /Notes API is ready/,
 		},
 	},
 

playwright/start-nextcloud-server.mjs

@@ -31,6 +31,35 @@ async function start() {
 	})
 }
 
+/**
+ * Poll the Notes API until it answers. The web workers cache the app config and
+ * the compiled routes in APCu for a few seconds, and `occ app:enable` runs in a
+ * separate process that cannot invalidate them, so requests sent right after
+ * enabling the app are answered with 404 until those caches expire.
+ *
+ * @param {string} ip Host and port the Nextcloud container is reachable at
+ */
+async function waitOnNotesApi(ip) {
+	const user = process.env.NC_USER ?? 'admin'
+	const password = process.env.NC_PASS ?? 'admin'
+	const headers = { Authorization: `Basic ${btoa(`${user}:${password}`)}` }
+	const deadline = Date.now() + 60_000
+
+	process.stdout.write('\nWaiting for the Notes API… ⏳\n')
+	while (true) {
+		const status = await fetch(`http://${ip}/index.php/apps/notes/api/v1/settings`, { headers })
+			.then((response) => response.status, () => 0)
+		if (status === 200) {
+			break
+		}
+		if (Date.now() > deadline) {
+			throw new Error(`Notes API is not reachable, last status: ${status}`)
+		}
+		await new Promise((resolve) => setTimeout(resolve, 500))
+	}
+	process.stdout.write('└─ Notes API is ready 🎉\n')
+}
+
 async function stop() {
 	process.stderr.write('Stopping Nextcloud server…\n')
 	await stopNextcloud()
@@ -44,6 +73,7 @@ process.on('SIGINT', stop)
 const ip = await start()
 await waitOnNextcloud(ip)
 await configureNextcloud(['notes'])
+await waitOnNotesApi(ip)
 
 // Idle to wait for shutdown
 while (true) {