feat(ios): support disabling metal validation

Author: Saadnajmi

docs/ios.metalAPIValidation.md

@@ -0,0 +1,15 @@
+The API Validation layer checks for code that calls the Metal API incorrectly,
+including errors in creating resources, encoding Metal commands, and performing
+other common tasks.
+
+> **_NOTE:_** The API Validation layer has a small, but measureable, impact on
+> CPU performance.
+
+By default, a `PrivacyInfo.xcprivacy` is on,
+
+For more details, read Apple's documentation on
+[Validating your app’s Metal API usage](https://developer.apple.com/documentation/xcode/validating-your-apps-metal-api-usage/).
+
+<details>
+<summary>History</summary>
+</details>

example/app.json

@@ -13,6 +13,9 @@
       "presentationStyle": "modal"
     }
   ],
+  "ios": {
+    "metalAPIValidation": true
+  },
   "resources": {
     "android": [
       "dist/res",

example/ios/Podfile.lock

@@ -1712,11 +1712,11 @@ EXTERNAL SOURCES:
 
 SPEC CHECKSUMS:
   boost: 4cb898d0bf20404aab1850c656dcea009429d6c1
-  DoubleConversion: 76ab83afb40bddeeee456813d9c04f67f78771b5
+  DoubleConversion: fea03f2699887d960129cc54bba7e52542b6f953
   Example-Tests: fc629729804712c34ae6c28b9fc1c45619f6636d
   FBLazyVector: 430e10366de01d1e3d57374500b1b150fe482e6d
   fmt: 4c2741a687cc09f0634a2e2c72a838b99f1ff120
-  glog: 69ef571f3de08433d766d614c73a9838a06bf7eb
+  glog: c5d68082e772fa1c511173d6b30a9de2c05a69a2
   RCT-Folly: 4464f4d875961fce86008d45f4ecf6cef6de0740
   RCTDeprecation: 726d24248aeab6d7180dac71a936bbca6a994ed1
   RCTRequired: a94e7febda6db0345d207e854323c37e3a31d93b
@@ -1780,4 +1780,4 @@ SPEC CHECKSUMS:
 
 PODFILE CHECKSUM: c9e179d1d59e47eaa6fef9316a7e039dbb9b0c0b
 
-COCOAPODS: 1.14.3
+COCOAPODS: 1.15.2

ios/ReactTestApp.xcodeproj/xcshareddata/xcschemes/ReactTestApp.xcscheme

@@ -59,6 +59,7 @@
       ignoresPersistentStateOnLaunch = "NO"
       debugDocumentVersioning = "YES"
       debugServiceExtension = "internal"
+      enableGPUValidationMode = "1"
       allowLocationSimulation = "YES">
       <BuildableProductRunnable
          runnableDebuggingMode = "0">

ios/test_app.rb

@@ -160,12 +160,27 @@ def make_project!(xcodeproj, project_root, target_platform, options)
   FileUtils.mkdir_p(destination)
   FileUtils.cp_r(xcodeproj_src, destination)
   name, display_name, version, single_app = app_config(project_root)
+  xcschemes_path = File.join(xcodeproj_dst, 'xcshareddata', 'xcschemes')
+
+  # Read "metalAPIValidation from the app config and apply it to the xcscheme"
+  metal_api_validation = platform_config('metalAPIValidation', project_root, target_platform)
+  puts "metalAPIValidation: #{metal_api_validation}"
+  
+  if metal_api_validation
+    xcscheme = File.join(xcschemes_path, "ReactTestApp.xcscheme")
+    puts "xcscheme: #{xcscheme}"
+    xcscheme_content = File.read(xcscheme)
+    new_content = xcscheme_content.gsub(/^\s*enableGPUValidationMode\s*=\s*"1"\s*$/, '')
+    puts "new_content: #{new_content}"
+    File.write(xcscheme, new_content)
+  end
+
   unless name.nil?
-    xcschemes_path = File.join(xcodeproj_dst, 'xcshareddata', 'xcschemes')
     FileUtils.cp(File.join(xcschemes_path, 'ReactTestApp.xcscheme'),
                  File.join(xcschemes_path, "#{name}.xcscheme"))
   end
 
+
   # Link source files
   %w[ReactTestApp ReactTestAppTests ReactTestAppUITests].each do |file|
     FileUtils.ln_sf(project_path(file, target_platform), destination)

schema.json

@@ -84,6 +84,11 @@
           "markdownDescription": "Sets the\n<a href='https://help.apple.com/xcode/mac/current/#/dev23aab79b4'>development\nteam</a> that the app should be assigned to.\n\nThis is the same as setting `DEVELOPMENT_TEAM` in Xcode.\n\n<details>\n<summary>History</summary>\n\n- [[0.9.7](https://github.com/microsoft/react-native-test-app/releases/tag/0.9.7)]\n  Added\n\n</details>",
           "type": "string"
         },
+        "metalAPIValidation": {
+          "description": "Whether to enable Metal API validation.",
+          "markdownDescription":"Whether to enable Metal API validation.",
+          "type": "boolean"
+        },
         "privacyManifest": {
           "description": "The privacy manifest is a property list that records the information regarding the types of data collected and the required reasons APIs your app or third-party SDK use.",
           "markdownDescription": "The privacy manifest is a property list that records the information regarding\nthe types of data collected and the required reasons APIs your app or\nthird-party SDK use.\n\n- The types of data collected by your app or third-party SDK must be provided on\n  all platforms.\n- The required reasons APIs your app or third-party SDK uses must be provided on\n  iOS, iPadOS, tvOS, visionOS, and watchOS.\n\nBy default, a `PrivacyInfo.xcprivacy` is always generated with the following\nvalues:\n\n<!-- prettier-ignore-start -->\n```json\n{\n  \"NSPrivacyTracking\": false,\n  \"NSPrivacyTrackingDomains\": [],\n  \"NSPrivacyCollectedDataTypes\": [],\n  \"NSPrivacyAccessedAPITypes\": [\n    {\n      \"NSPrivacyAccessedAPIType\":\n        \"NSPrivacyAccessedAPICategoryFileTimestamp\",\n      \"NSPrivacyAccessedAPITypeReasons\": [\"C617.1\"]\n    },\n    {\n      \"NSPrivacyAccessedAPIType\":\n        \"NSPrivacyAccessedAPICategorySystemBootTime\",\n      \"NSPrivacyAccessedAPITypeReasons\": [\"35F9.1\"]\n    },\n    {\n      \"NSPrivacyAccessedAPIType\":\n        \"NSPrivacyAccessedAPICategoryUserDefaults\",\n      \"NSPrivacyAccessedAPITypeReasons\": [\"CA92.1\"]\n    }\n  ]\n}\n```\n<!-- prettier-ignore-end -->\n\nFor more details, read Apple's documentation on\n[Privacy manifest files](https://developer.apple.com/documentation/bundleresources/privacy_manifest_files).\n\n<details>\n<summary>History</summary>\n\n- [[3.6.0](https://github.com/microsoft/react-native-test-app/releases/tag/3.6.0)]\n  Added\n\n</details>",

scripts/internal/generate-schema.mts

@@ -52,6 +52,7 @@ export async function readDocumentation(): Promise<Partial<Docs>> {
     "ios.icons",
     "ios.icons.primaryIcon",
     "ios.icons.alternateIcons",
+    "ios.metalAPIValidation",
     "ios.privacyManifest",
     "macos.applicationCategoryType",
     "macos.humanReadableCopyright",

scripts/schema.mjs

@@ -93,6 +93,11 @@ export function generateSchema(docs = {}) {
             markdownDescription: docs["ios.developmentTeam"],
             type: "string",
           },
+          metalAPIValidation: {
+            description: extractBrief(docs["ios.metalAPIValidation"]),
+            markdownDescription: docs["ios.metalAPIValidation"],
+            type: "boolean",
+          },
           privacyManifest: {
             description: extractBrief(docs["ios.privacyManifest"]),
             markdownDescription: docs["ios.privacyManifest"],

scripts/types.ts

@@ -217,6 +217,7 @@ export type Docs = {
   "ios.icons": string;
   "ios.icons.primaryIcon": string;
   "ios.icons.alternateIcons": string;
+  "ios.metalAPIValidation": string;
   "ios.privacyManifest": string;
   "macos.applicationCategoryType": string;
   "macos.humanReadableCopyright": string;