react-native-webgpu 0.5.17 → 0.5.18

package/README.md

@@ -8,6 +8,20 @@ WebGPU for React Native, powered by Dawn.
 
 [Installation instructions](https://wcandillon.github.io/react-native-webgpu/docs/getting-started/installation)
 
+## Expo config plugin
+
+The package ships with an Expo config plugin that disables Metal API validation in the iOS Xcode scheme, which is required to run WebGPU on the iOS Simulator (Metal API validation reports false positives for Dawn that do not occur on device). Because the plugin is part of the package, plugin and package versions are always aligned.
+
+```json
+{
+  "expo": {
+    "plugins": ["react-native-webgpu"]
+  }
+}
+```
+
+See the [Expo guide](https://wcandillon.github.io/react-native-webgpu/docs/getting-started/expo#config-plugin) for details.
+
 ## Contributing
 
 For detailed information on library development, building, testing, and contributing guidelines, please see [CONTRIBUTING.md](packages/webgpu/CONTRIBUTING.md).

package/app.plugin.js

@@ -0,0 +1 @@
+module.exports = require("./plugin/build").default;

package/lib/typescript/app.plugin.d.ts

@@ -0,0 +1,3 @@
+declare const _exports: any;
+export = _exports;
+//# sourceMappingURL=app.plugin.d.ts.map

package/lib/typescript/app.plugin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"app.plugin.d.ts","sourceRoot":"","sources":["../../app.plugin.js"],"names":[],"mappings":""}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-webgpu",
-  "version": "0.5.17",
+  "version": "0.5.18",
   "description": "React Native WebGPU",
   "main": "lib/commonjs/index",
   "module": "lib/module/index",
@@ -18,15 +18,19 @@
     "cpp/**/*.{h,cpp}",
     "apple/**",
     "libs/**",
-    "*.podspec"
+    "*.podspec",
+    "app.plugin.js",
+    "plugin/build/**"
   ],
   "dawn": "chromium/7849",
   "scripts": {
     "test": "NODE_OPTIONS='--experimental-require-module' jest -i",
     "test:ref": "REFERENCE=true NODE_OPTIONS='--experimental-require-module' jest -i",
+    "test:plugin": "jest -c plugin/jest.config.js",
     "lint": "eslint . --ext .ts,.tsx  --max-warnings 0 --cache --fix",
     "tsc": "tsc --noEmit",
-    "build": "bob build",
+    "build": "bob build && yarn build:plugin",
+    "build:plugin": "tsc -p plugin/tsconfig.build.json",
     "release": "semantic-release",
     "build-dawn": "tsx scripts/build/dawn.ts",
     "clean-dawn": "rimraf ./libs && rimraf ../../externals/dawn/out",
@@ -41,7 +45,9 @@
   "keywords": [
     "react-native",
     "ios",
-    "android"
+    "android",
+    "expo",
+    "expo-config-plugin"
   ],
   "repository": {
     "type": "git",
@@ -59,6 +65,7 @@
     "provenance": true
   },
   "devDependencies": {
+    "@expo/config-plugins": "^57.0.3",
     "@semantic-release/commit-analyzer": "^13.0.0",
     "@semantic-release/exec": "^7.0.3",
     "@semantic-release/github": "^10.3.3",

package/plugin/build/index.d.ts

@@ -0,0 +1,3 @@
+import type { ConfigPlugin } from "@expo/config-plugins";
+declare const _default: ConfigPlugin<void>;
+export default _default;

package/plugin/build/index.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const config_plugins_1 = require("@expo/config-plugins");
+const withMetalApiValidation_1 = require("./withMetalApiValidation");
+const pkg = require("../../package.json");
+const withWebGPU = (config) => (0, withMetalApiValidation_1.withMetalApiValidationDisabled)(config);
+// Expo resolves config plugins through their default export (re-exported by
+// app.plugin.js at the package root).
+// eslint-disable-next-line import/no-default-export
+exports.default = (0, config_plugins_1.createRunOncePlugin)(withWebGPU, pkg.name, pkg.version);

package/plugin/build/setMetalApiValidation.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Rewrites an Xcode scheme (.xcscheme XML) so that Metal API validation is
+ * disabled for the Run action — the same effect as unchecking
+ * Product → Scheme → Edit Scheme → Run → Diagnostics → Metal API Validation.
+ *
+ * Xcode encodes the setting as the `enableGPUValidationMode` attribute on the
+ * <LaunchAction> element: the attribute is absent when validation is enabled
+ * (the default) and set to "1" when disabled. This mirrors how Flutter
+ * disables Metal API validation in its templates
+ * (https://github.com/flutter/flutter/pull/159228).
+ */
+export declare const setMetalApiValidationDisabled: (xcscheme: string) => string;

package/plugin/build/setMetalApiValidation.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setMetalApiValidationDisabled = void 0;
+/**
+ * Rewrites an Xcode scheme (.xcscheme XML) so that Metal API validation is
+ * disabled for the Run action — the same effect as unchecking
+ * Product → Scheme → Edit Scheme → Run → Diagnostics → Metal API Validation.
+ *
+ * Xcode encodes the setting as the `enableGPUValidationMode` attribute on the
+ * <LaunchAction> element: the attribute is absent when validation is enabled
+ * (the default) and set to "1" when disabled. This mirrors how Flutter
+ * disables Metal API validation in its templates
+ * (https://github.com/flutter/flutter/pull/159228).
+ */
+const setMetalApiValidationDisabled = (xcscheme) => xcscheme.replace(/<LaunchAction([^>]*)>/, (launchAction, attributes) => {
+    if (attributes.includes("enableGPUValidationMode")) {
+        return launchAction.replace(/enableGPUValidationMode\s*=\s*"[^"]*"/, 'enableGPUValidationMode = "1"');
+    }
+    return `<LaunchAction${attributes}\n      enableGPUValidationMode = "1">`;
+});
+exports.setMetalApiValidationDisabled = setMetalApiValidationDisabled;

package/plugin/build/withMetalApiValidation.d.ts

@@ -0,0 +1,9 @@
+import type { ConfigPlugin } from "@expo/config-plugins";
+/**
+ * Disables Metal API validation in every shared Xcode scheme of the iOS
+ * project. Dawn (the WebGPU implementation) triggers false-positive
+ * validation errors on the iOS Simulator that do not occur on device.
+ * Manually unchecking the setting in Xcode does not survive
+ * `npx expo prebuild --clean`, which is why this is a config plugin.
+ */
+export declare const withMetalApiValidationDisabled: ConfigPlugin;

package/plugin/build/withMetalApiValidation.js

@@ -0,0 +1,73 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.withMetalApiValidationDisabled = void 0;
+const fs = __importStar(require("fs"));
+const path = __importStar(require("path"));
+const config_plugins_1 = require("@expo/config-plugins");
+const setMetalApiValidation_1 = require("./setMetalApiValidation");
+const getSharedSchemes = (platformProjectRoot) => {
+    if (!fs.existsSync(platformProjectRoot)) {
+        return [];
+    }
+    return fs
+        .readdirSync(platformProjectRoot)
+        .filter((entry) => entry.endsWith(".xcodeproj"))
+        .map((entry) => path.join(platformProjectRoot, entry, "xcshareddata", "xcschemes"))
+        .filter((schemesDir) => fs.existsSync(schemesDir))
+        .flatMap((schemesDir) => fs
+        .readdirSync(schemesDir)
+        .filter((file) => file.endsWith(".xcscheme"))
+        .map((file) => path.join(schemesDir, file)));
+};
+/**
+ * Disables Metal API validation in every shared Xcode scheme of the iOS
+ * project. Dawn (the WebGPU implementation) triggers false-positive
+ * validation errors on the iOS Simulator that do not occur on device.
+ * Manually unchecking the setting in Xcode does not survive
+ * `npx expo prebuild --clean`, which is why this is a config plugin.
+ */
+const withMetalApiValidationDisabled = (config) => (0, config_plugins_1.withDangerousMod)(config, [
+    "ios",
+    async (cfg) => {
+        const schemes = getSharedSchemes(cfg.modRequest.platformProjectRoot);
+        for (const scheme of schemes) {
+            const contents = fs.readFileSync(scheme, "utf8");
+            fs.writeFileSync(scheme, (0, setMetalApiValidation_1.setMetalApiValidationDisabled)(contents));
+        }
+        return cfg;
+    },
+]);
+exports.withMetalApiValidationDisabled = withMetalApiValidationDisabled;