Use OSMesa for macOS core tests

Author: raub

.github/workflows/test.yml

@@ -62,6 +62,15 @@ jobs:
       - name: Install Modules
         run: npm ci
 
+      - name: Install MacOS OpenGL Runtime
+        if: matrix.target == 'darwin-x64' || matrix.target == 'darwin-arm64'
+        run: |
+          brew install mesa
+          mesa_prefix="$(brew --prefix mesa)"
+          echo "DYLD_LIBRARY_PATH=$mesa_prefix/lib:${DYLD_LIBRARY_PATH:-}" >> "$GITHUB_ENV"
+          echo "DYLD_FALLBACK_LIBRARY_PATH=$mesa_prefix/lib:${DYLD_FALLBACK_LIBRARY_PATH:-}" >> "$GITHUB_ENV"
+          find "$mesa_prefix/lib" -maxdepth 1 \( -name '*OSMesa*' -o -name '*EGL*' -o -name '*GL*' \) -print
+
       - name: Tests - Linux
         if: matrix.target == 'linux-x64' || matrix.target == 'linux-arm64'
         run: xvfb-run --auto-servernum npm run test:ci

test/init.ts

@@ -1,6 +1,33 @@
 import { platform } from 'node:process';
-import { init, addThreeHelpers, glfw } from '../ts/index.ts';
 import * as three from 'three';
+import type { TGlfw, TInitOpts } from '../ts/types.ts';
+
+const bootstrapMacosGlfw = async (): Promise<TGlfw | null> => {
+	if (platform !== 'darwin') {
+		return null;
+	}
+
+	const nodeGlobal = globalThis as unknown as Record<string, unknown>;
+
+	// @node-3d/glfw normally initializes on import. The macOS CI path needs
+	// glfwInitHint before glfwInit so it can use the Null platform.
+	nodeGlobal['__isGlfwInited'] = true;
+	const { glfw: bootstrappedGlfw } = await import('@node-3d/glfw');
+	bootstrappedGlfw.initHint(bootstrappedGlfw.PLATFORM, bootstrappedGlfw.PLATFORM_NULL);
+
+	if (!bootstrappedGlfw.init()) {
+		throw new Error('Failed to initialize GLFW for macOS tests');
+	}
+
+	bootstrappedGlfw.defaultWindowHints();
+	nodeGlobal['__isGlfwInited'] = true;
+
+	return bootstrappedGlfw;
+};
+
+const macosGlfw = await bootstrapMacosGlfw();
+const core = await import('../ts/index.ts');
+const { init, addThreeHelpers, glfw } = core;
 
 const initOptsLinux = {
 	width: 400,
@@ -15,21 +42,44 @@ const initOpts = {
 	major: 2,
 	minor: 1,
 };
+const initOptsMacos: TInitOpts = {
+	...initOpts,
+	isVisible: false,
+	onBeforeWindow(_window, currentGlfw) {
+		const windowGlfw = currentGlfw as TGlfw;
+		windowGlfw.windowHint(windowGlfw.CONTEXT_CREATION_API, windowGlfw.OSMESA_CONTEXT_API);
+		windowGlfw.windowHint(windowGlfw.STENCIL_BITS, 8);
+		windowGlfw.windowHint(windowGlfw.DEPTH_BITS, 0);
+		windowGlfw.windowHint(windowGlfw.SAMPLES, 0);
+	},
+};
 
 if (platform === 'darwin') {
-	glfw.windowHint(glfw.STENCIL_BITS, 8);
+	(macosGlfw ?? glfw).windowHint(glfw.STENCIL_BITS, 8);
 	// this would be nice... - https://github.com/glfw/glfw/pull/2571
 	// glfw.windowHint(glfw.CONTEXT_RENDERER, glfw.SOFTWARE_RENDERER);
 }
 
-const inited = init(platform === 'linux' ? initOptsLinux : initOpts);
+const getInitOpts = (): TInitOpts => {
+	if (platform === 'linux') {
+		return initOptsLinux;
+	}
+
+	if (platform === 'darwin') {
+		return initOptsMacos;
+	}
+
+	return initOpts;
+};
+
+const inited = init(getInitOpts());
 addThreeHelpers(three);
 
 const { doc } = inited;
 const window = doc;
 const document = doc;
 
-export { Image } from '../ts/index.ts';
+export const { Image } = core;
 
 export { doc, window, document };