docker is flaky. ci is broken. but it works locally i guess

Author: Ethan-Arrowood

.dockerignore

@@ -1,4 +1,4 @@
-name: Test
+name: Test Next.js v14
 
 on:
   push:
@@ -22,6 +22,9 @@ jobs:
       - name: Install dependencies
         run: npm ci
 
+      - name: Install HarperDB
+        run: npm i -g [email protected]
+
       - name: Install Playwright Browsers
         run: npx playwright install --with-deps
 

.github/workflows/test.yaml

@@ -3,16 +3,9 @@ const dogs = [
 	{ id: '1', name: 'Max', breed: 'Cocker Spaniel' },
 	{ id: '2', name: 'Bella', breed: 'Lab' },
 	{ id: '3', name: 'Charlie', breed: 'Great Dane' },
-	{ id: '4', name: 'Lucy', breed: 'Newfoundland' },
-	{ id: '5', name: 'Cooper', breed: 'Pug' },
-	{ id: '6', name: 'Daisy', breed: 'Bull Dog' },
-	{ id: '7', name: 'Rocky', breed: 'Akita' },
-	{ id: '8', name: 'Luna', breed: 'Wolf' },
-	{ id: '9', name: 'Buddy', breed: 'Border Collie' },
-	{ id: '10', name: 'Bailey', breed: 'Golden Retriever' },
-	{ id: '11', name: 'Sadie', breed: 'Belgian Malinois' },
+	{ id: '4', name: 'Lucy', breed: 'Newfoundland' }
 ];
-console.log('testing');
+
 for (const dog of dogs) {
-	await tables.Dog.put(dog);
+	tables.Dog.put(dog);
 }

fixtures/harperdb-base-component/resources.js

@@ -1,8 +1,3 @@
-rest: true
-graphqlSchema:
-  files: './schema.graphql'
-jsResource:
-  files: './resources.mjs'
 '@harperdb/nextjs':
   package: '@harperdb/nextjs'
   files: '/*'

fixtures/next-14/.dockerignore

@@ -0,0 +1,9 @@
+import { NextResponse, NextRequest } from 'next/server';
+
+export function middleware(request) {
+	return new NextResponse('Hello from middleware', { headers: { 'x-middleware': 'true' } });
+}
+
+export const config = {
+	matcher: '/test-middleware'
+}

fixtures/next-14/config.yaml

@@ -6,17 +6,17 @@
 		"build": "next build",
 		"start": "next start",
 		"lint": "next lint",
-		"postinstall": "npm link @harperdb/nextjs",
+		"postinstall": "npm link harperdb",
 		"test": "playwright test"
 	},
 	"dependencies": {
-		"@harperdb/nextjs": "*",
-		"harperdb": "^4.4.8",
+		"@harperdb/nextjs": "file:../../",
 		"next": "^14",
 		"react": "^18",
 		"react-dom": "^18"
 	},
 	"devDependencies": {
-		"@playwright/test": "^1.49.0"
+		"@playwright/test": "^1.49.0",
+		"test-utils": "file:../../test-utils/"
 	}
 }

fixtures/next-14/middleware.js

@@ -1,15 +1,18 @@
 const { defineConfig, devices } = require('@playwright/test');
-const { join } = require('node:path');
 
 module.exports = defineConfig({
-	testDir: 'test',
 	fullyParallel: true,
 	forbidOnly: !!process.env.CI,
+	retries: 2,
+	expect: {
+		timeout: 30000,
+	},
 	projects: [
 		{
-			use: { ...devices['Desktop Chrome'] },
+			name: 'chromium',
+			use: { ...devices['Desktop Chrome'], channel: 'chromium' },
 		}
 	],
-	globalSetup: join(__dirname, './util/global-setup.js'),
-	globalTeardown: join(__dirname, './util/global-teardown.js'),
+	globalSetup: require.resolve('test-utils/global-setup.js'),
+	globalTeardown: require.resolve('test-utils/global-teardown.js'),
 });

fixtures/next-14/package.json

@@ -1,6 +1,5 @@
 import { test, expect } from '@playwright/test';
 
-// test.describe.configure({ mode: 'serial' });
 const baseURL = 'http://localhost:9926';
 
 test('home page', async ({ page }) => {
@@ -95,3 +94,10 @@ test.describe('caching', () => {
 		expect(when1).not.toBe(when2);
 	});
 });
+
+test('middleware', async ({ page }) => {
+	const response = await fetch(`${baseURL}/test-middleware`);
+	expect(response.headers.get('x-middleware')).toBe('true');
+	const text = await response.text();
+	expect(text).toBe('Hello from middleware');
+});

fixtures/next-14/playwright.config.js

@@ -0,0 +1,15 @@
+const { defineConfig, devices } = require('@playwright/test');
+const { join } = require('node:path');
+
+module.exports = defineConfig({
+	testDir: 'test',
+	fullyParallel: true,
+	forbidOnly: !!process.env.CI,
+	projects: [
+		{
+			use: { ...devices['Desktop Chrome'] },
+		}
+	],
+	globalSetup: join(__dirname, './util/global-setup.js'),
+	globalTeardown: join(__dirname, './util/global-teardown.js'),
+});

fixtures/next-14/resources.mjs

@@ -0,0 +1,19 @@
+import { test, expect } from '@playwright/test';
+
+const baseURL = 'http://localhost:9926';
+
+test('home page', async ({ page }) => {
+	await page.goto(baseURL);
+	await expect(page.locator('h1')).toHaveText('Next.js v9');
+});
+
+test('title', async ({ page }) => {
+	await page.goto(baseURL);
+	await expect(page).toHaveTitle('HarperDB - Next.js v9 App');
+});
+
+test('page 2', async ({ page }) => {
+	await page.goto(baseURL);
+	await page.locator('a').click();
+	await expect(page.locator('h1')).toHaveText('Page 2');
+});

fixtures/next-14/schema.graphql

@@ -11,8 +11,7 @@ module.exports = function globalSetup(config) {
 
 		harperdbProcess.stdout.pipe(new Transform({
 			transform(chunk, encoding, callback) {
-				const data = chunk.toString();
-				if (/HarperDB \d+.\d+.\d+ successfully started/.test(data)) {
+				if (/HarperDB \d+.\d+.\d+ successfully started/.test(chunk.toString())) {
 					resolve();
 				}
 				callback(null, chunk);

fixtures/next-14/test/next-14.test.js renamed to fixtures/next-14/test/index.test.js

@@ -0,0 +1,53 @@
+const { spawn, execSync, exec } = require('node:child_process');
+const { Transform } = require('node:stream');
+const { join } = require('node:path');
+const { symlinkSync } = require('node:fs');
+const { setTimeout } = require('node:timers/promises');
+
+const ROOT = join(__dirname, '..');
+
+function getComponents() {
+	const componentsString = execSync(`npx harperdb get_components json=true`, { encoding: 'utf-8' });
+	return JSON.parse(componentsString);
+}
+
+function getConfiguration() {
+	const configurationString = execSync(`npx harperdb get_configuration json=true`, { encoding: 'utf-8' });
+	return JSON.parse(configurationString);
+}
+
+module.exports = async function globalSetup(config) {
+	execSync('npx harperdb start', { stdio: 'inherit' });
+	await setTimeout(2000);
+
+	const components = getComponents();
+	if (!components.entries.some(({ name }) => name === 'harperdb-base-component')) {
+		const configuration = getConfiguration();
+		const componentsRoot = configuration.componentsRoot;
+
+		symlinkSync(join(ROOT, 'fixtures', 'harperdb-base-component'), join(componentsRoot, 'harperdb-base-component'));
+
+		execSync(`npx harperdb restart`);
+
+		await setTimeout(5000);
+	}
+
+	execSync('npx harperdb stop', { stdio: 'inherit' });
+
+	await new Promise((resolve, reject) => {
+		console.log('npx harperdb run', config.rootDir);
+		const harperdbProcess = spawn('npx', ['harperdb', 'run', config.rootDir]);
+	
+		harperdbProcess.on('error', reject);
+		harperdbProcess.on('exit', resolve);
+	
+		harperdbProcess.stdout.pipe(new Transform({
+			transform(chunk, encoding, callback) {
+				if (/HarperDB \d+.\d+.\d+ successfully started/.test(chunk.toString())) {
+					resolve();
+				}
+				callback(null, chunk);
+			}
+		})).pipe(process.stdout);
+	});
+}

fixtures/next-9/playwright.config.js

@@ -0,0 +1,9 @@
+const { spawn } = require('node:child_process');
+
+module.exports = function globalTeardown(config) {
+	return new Promise((resolve, reject) => {
+		const harperdbProcess = spawn('npx', ['harperdb', 'stop']);
+		harperdbProcess.on('error', reject);
+		harperdbProcess.on('exit', resolve);
+	});
+}

fixtures/next-9/test/next-9.test.js

@@ -0,0 +1,8 @@
+{
+	"name": "test-utils",
+	"private": true,
+	"files": [
+		"global-setup.js",
+		"global-teardown.js"
+	]
+}

fixtures/next-14/util/global-setup.js renamed to fixtures/next-9/util/global-setup.js

@@ -1,10 +1,8 @@
 ARG NODE_VERSION=22
-FROM docker.io/node:${NODE_VERSION}-slim
+FROM docker.io/node:${NODE_VERSION}-slim as base
 
 EXPOSE 9925 9926
 
-RUN npx -y playwright install --with-deps
-
 # Install HarperDB Globally
 RUN npm install -g [email protected]
 
@@ -20,20 +18,31 @@ ENV LOGGING_STDSTREAMS=true
 ENV LOGGING_LEVEL=debug
 ENV AUTHENTICATION_AUTHORIZELOCAL=false
 
+RUN harperdb start && sleep 5
+
+COPY /fixtures/harperdb-base-component/ /hdb/components/harperdb-base-component/
+
+RUN harperdb start && sleep 5
+
+COPY /test-utils/ /test-utils/
+
 # Create the @harperdb/nextjs module directory so it can be linked locally
-RUN mkdir -p /@harperdb/nextjs
+RUN mkdir -p /@harperdb/nextjs/
 COPY config.yaml extension.js cli.js package.json /@harperdb/nextjs/
-WORKDIR /@harperdb/nextjs
+WORKDIR /@harperdb/nextjs/
 # Install dependencies for the @harperdb/nextjs module
 RUN npm install --omit=dev
 # Create link to the @harperdb/nextjs module
 RUN npm link
 
 WORKDIR /
 
+FROM base as test
+
 ARG FIXTURE
-COPY /fixtures/${FIXTURE} /fixture
-WORKDIR /fixture
+COPY /fixtures/${FIXTURE}/ /fixtures/${FIXTURE}/
+WORKDIR /fixtures/${FIXTURE}/
 RUN npm install
+RUN npx -y playwright install chromium --with-deps
 
 CMD npm run test

fixtures/next-14/util/global-teardown.js renamed to fixtures/next-9/util/global-teardown.js

@@ -0,0 +1,3 @@
+**/.next
+**/test-results
+**/node_modules