feat(metadata-generator): Filter according to specified black/white lists

Each text file contains a list of patterns of the form `moduleGlob:symbolGlob`,
where `?` and `*` special symbols treated as `any symbol` and `zero or
more symbols`.

A symbol is whitelisted if it's module name and native name pair matches a
pattern in the whitelist, or if a whitelist file is not passed as an argument. All
symbols which are not whitelisted or match a pattern in the blacklist are
excluded from the global table of metadata symbols.

* Update metadata-generator submodule
* Add a `blacklist.mdg` file to TestRunner and symlink from the root (because
SRCROOT of TestRunner points to the directory of the main CMakeLists.txt)
* Add a unit test which checks for the correct filtering of metadata according to
the rules in `blacklist.mdg`

Author: mbektchiev

blacklist.mdg

@@ -0,0 +1 @@
+tests/TestRunner/blacklist.mdg

build/scripts/build-step-metadata-generator.py

@@ -37,6 +37,7 @@ def map_and_list(func, iterable):
 # process environment variables
 conf_build_dir = env("CONFIGURATION_BUILD_DIR")
 sdk_root = env("SDKROOT")
+src_root = env("SRCROOT")
 deployment_target_flag_name = env("DEPLOYMENT_TARGET_CLANG_FLAG_NAME")
 deployment_target = env(env("DEPLOYMENT_TARGET_CLANG_ENV_NAME"))
 std = env("GCC_C_LANGUAGE_STANDARD")
@@ -97,6 +98,14 @@ def generate_metadata(arch):
         generator_call.extend(["-output-yaml", current_yaml_output_folder])
         print("Generating debug metadata in: \"{}\"".format(current_yaml_output_folder))
 
+    whitelist_file_name = os.path.join(src_root, "whitelist.mdg")
+    if os.path.exists(whitelist_file_name):
+      generator_call.extend(["--whitelist-modules-file", whitelist_file_name])
+
+    blacklist_file_name = os.path.join(src_root, "blacklist.mdg")
+    if os.path.exists(blacklist_file_name):
+      generator_call.extend(["--blacklist-modules-file", blacklist_file_name])
+
     # clang arguments
     generator_call.extend(["Xclang",
                            "-isysroot", sdk_root,

src/metadata-generator

@@ -522,12 +522,12 @@ describe(module.id, function () {
             // structures have all members initialized to zero.
             expect(arr.count).toBe(0);
         });
-        
+
         it("exceptions", function () {
             expect(() => __releaseNativeCounterpart(1, 2, 3)).toThrowError(/Actual arguments count: "3". Expected: "1". \(evaluating '__releaseNativeCounterpart\(1, 2, 3\)'\)/);
             const getNotANativeWrapperRegex2 = (obj, objParam) => new RegExp(`${obj} is an object which is not a native wrapper. \\(evaluating '__releaseNativeCounterpart\\(${objParam}\\)'\\)`);
             const getNotANativeWrapperRegex = obj => getNotANativeWrapperRegex2(obj, JSON.stringify(obj));
-           
+
             expect(() => __releaseNativeCounterpart(0)).toThrowError(getNotANativeWrapperRegex(0));
             expect(() => __releaseNativeCounterpart("")).toThrowError(getNotANativeWrapperRegex(""));
             expect(() => __releaseNativeCounterpart([])).toThrowError(getNotANativeWrapperRegex2("Array", "\\[\\]"));
@@ -732,6 +732,32 @@ describe(module.id, function () {
         }
     });
 
+    it("Metadata blacklist APIs", function() {
+        const symbolsRemovedByBlacklisting = {
+            "HealthKit.HKClinicalType": ["HKClinicalTypeIdentifierAllergyRecord", "HKClinicalTypeIdentifierConditionRecord", "HKClinicalTypeIdentifierImmunizationRecord", "HKClinicalTypeIdentifierLabResultRecord", "HKClinicalTypeIdentifierMedicationRecord", "HKClinicalTypeIdentifierProcedureRecord", "HKClinicalTypeIdentifierVitalSignRecord", "ClinicalType", "HKClinicalType"],
+            "HealthKit.HKSampleQuery:": ["HKObjectQueryNoLimit", "HKSampleQuery"],
+            "CloudKit.CKReference:*": ["CKReferenceAction", "CKReferenceActionNone", "CKReferenceActionDeleteSelf", "CKReference"],
+            "Darwin.POSIX.*:*_info_v*": ["rusage_info_v0", "rusage_info_v1", "rusage_info_v2", "rusage_info_v3", "rusage_info_v4"],
+            "CoreFoundation.CFCh*:k*SetNe?line": ["kCFCharacterSetNewline"],
+        };
+        const symbolsRemainingAfterBlacklisting = {
+            "Darwin.POSIX.*:*_info_v*": ["task_power_info_v2"],
+            "CoreFoundation:kCFCharacterSetWhitespaceAndNewline": ["kCFCharacterSetWhitespaceAndNewline"],
+        };
+
+        for (let rule in symbolsRemovedByBlacklisting) {
+            for (let symbol of symbolsRemovedByBlacklisting[rule]) {
+                expect(global[symbol]).toBeUndefined(`Rule ${rule} should have removed symbol ${symbol}`);
+            }
+        }
+
+        for (let rule in symbolsRemainingAfterBlacklisting) {
+            for (let symbol of symbolsRemainingAfterBlacklisting[rule]) {
+                expect(global[symbol]).toBeDefined(`Rule ${rule} should have removed symbol ${symbol}`);
+            }
+        }
+    });
+
     // Metal is unavailable on iOS Simulator and devices with processors before A7 (arm64 on iPhone 5s)
     if (!isSimulator && interop.sizeof(interop.types.id) == 8) {
         it("MetalKit private interface members can be accessed", function() {

tests/TestRunner/app/ApiTests.js

@@ -0,0 +1,26 @@
+# Metadata Generator filtering tests. Strip well-known symbols to perform checks at runtime with TestRunner.
+
+# should exclude everything from HealthKit.HKClinicalType:
+# HKClinicalTypeIdentifierAllergyRecord HKClinicalTypeIdentifierConditionRecord
+# HKClinicalTypeIdentifierImmunizationRecord HKClinicalTypeIdentifierLabResultRecord
+# HKClinicalTypeIdentifierMedicationRecord HKClinicalTypeIdentifierProcedureRecord
+# HKClinicalTypeIdentifierVitalSignRecord ClinicalType HKClinicalType
+HealthKit.HKClinicalType
+
+# should exclude everything from HealthKit.HKSampleQuery:
+# HKObjectQueryNoLimit HKSampleQuery
+HealthKit.HKSampleQuery:
+
+# should exclude everything from CloudKit.CKReference
+# CKReferenceAction CKReferenceActionNone CKReferenceActionDeleteSelf CKReference
+CloudKit.CKReference:*
+
+# should exclude rusage_info_v0 to _v4 from Darwin.POSIX.sys.resource
+# but should leave task_power_info_v2 from Darwin.Mach.task_info
+Darwin.POSIX.*:*_info_v*
+
+# should exclude kCFCharacterSetNewline from CoreFoundation.CFCharacterSet
+CoreFoundation.CFCh*:k*SetNe?line
+
+# shouldn't exclude kCFCharacterSetWhitespaceAndNewline because it resides in the CoreFoundation.CFCharacterSet submodule
+CoreFoundation:kCFCharacterSetWhitespaceAndNewline