chore: add comments when generating whitelist.mdg

Add comments from where is each line in whitelist.mdg file.

Author: rosen-vladimirov

lib/definitions/metadata-filtering-service.ts

@@ -1,5 +1,5 @@
 /**
- * Describes the content of the native-api-usage.json file located in `<path to project's App_Resources>/<platform> directory.
+ * Describes service used to generate necessary files to filter the native metadata generation.
  */
 interface INativeApiUsageConfiguartion {
 	/**

lib/services/metadata-filtering-service.ts

@@ -29,16 +29,28 @@ export class MetadataFilteringService implements IMetadataFilteringService {
 					const pathToPluginsMetadataConfig = path.join(pathToPlatformsDir, MetadataFilteringConstants.NATIVE_API_USAGE_FILE_NAME);
 					if (this.$fs.exists(pathToPluginsMetadataConfig)) {
 						const pluginConfig: INativeApiUsagePluginConfiguration = this.$fs.readJson(pathToPluginsMetadataConfig) || {};
-						this.$logger.trace(`Adding content of ${pathToPluginsMetadataConfig} to whitelisted items of metadata filtering.`);
-						whitelistedItems.push(...(pluginConfig.uses || []));
+						this.$logger.trace(`Adding content of ${pathToPluginsMetadataConfig} to whitelisted items of metadata filtering: ${JSON.stringify(pluginConfig, null, 2)}`);
+						const itemsToAdd = pluginConfig.uses || [];
+						if (itemsToAdd.length) {
+							whitelistedItems.push(`// Added from: ${pathToPluginsMetadataConfig}`);
+							whitelistedItems.push(...itemsToAdd);
+							whitelistedItems.push(`// Finished part from ${pathToPluginsMetadataConfig}${os.EOL}`);
+						}
 					}
 				}
 			}
 
-			whitelistedItems.push(...(nativeApiConfiguration.whitelist || []));
+			const applicationWhitelistedItems = nativeApiConfiguration.whitelist || [];
+			if (applicationWhitelistedItems.length) {
+				this.$logger.trace(`Adding content from application to whitelisted items of metadata filtering: ${JSON.stringify(applicationWhitelistedItems, null, 2)}`);
+
+				whitelistedItems.push(`// Added from application`);
+				whitelistedItems.push(...applicationWhitelistedItems);
+				whitelistedItems.push(`// Finished part from application${os.EOL}`);
+			}
 
 			if (whitelistedItems.length) {
-				this.$fs.writeFile(pathToWhitelistFile, _.uniq(whitelistedItems).sort().join(os.EOL));
+				this.$fs.writeFile(pathToWhitelistFile, whitelistedItems.join(os.EOL));
 			}
 		}
 	}
@@ -53,7 +65,7 @@ export class MetadataFilteringService implements IMetadataFilteringService {
 			const blacklistedItems: string[] = nativeApiConfiguration.blacklist || [];
 
 			if (blacklistedItems.length) {
-				this.$fs.writeFile(pathToBlacklistFile, _.uniq(blacklistedItems).sort().join(os.EOL));
+				this.$fs.writeFile(pathToBlacklistFile, blacklistedItems.join(os.EOL));
 			}
 		} else {
 			this.$logger.trace(`There's no application configuration for metadata filtering for platform ${platform}. Full metadata will be generated.`);

test/services/metadata-filtering-service.ts

@@ -18,7 +18,7 @@ describe("metadataFilteringService", () => {
 	const appResourcesNativeApiUsageFilePath = path.join(projectData.appResourcesDirectoryPath, platform, MetadataFilteringConstants.NATIVE_API_USAGE_FILE_NAME);
 	const pluginPlatformsDir = path.join("pluginDir", platform);
 	const pluginNativeApiUsageFilePath = path.join(pluginPlatformsDir, MetadataFilteringConstants.NATIVE_API_USAGE_FILE_NAME);
-	const pluginsUses: string[] = ["whitelisted1", "pluginUses1", "pluginUses2"];
+	const pluginsUses: string[] = ["pluginUses1", "pluginUses2"];
 
 	const createTestInjector = (input?: { hasPlugins: boolean }): IInjector => {
 		const testInjector = new Yok();
@@ -98,6 +98,23 @@ describe("metadataFilteringService", () => {
 			assert.deepEqual(dataWritten, { [path.join(projectRoot, MetadataFilteringConstants.BLACKLIST_FILE_NAME)]: blacklistArray.join(EOL) });
 		});
 
+		const getExpectedWhitelistContent = (input: { applicationWhitelist?: string[], pluginWhitelist?: string[] }): string => {
+			let finalContent = "";
+			if (input.pluginWhitelist) {
+				finalContent += `// Added from: ${pluginNativeApiUsageFilePath}${EOL}${input.pluginWhitelist.join(EOL)}${EOL}// Finished part from ${pluginNativeApiUsageFilePath}${EOL}`;
+			}
+
+			if (input.applicationWhitelist) {
+				if (finalContent !== "") {
+					finalContent += EOL;
+				}
+
+				finalContent += `// Added from application${EOL}${input.applicationWhitelist.join(EOL)}${EOL}// Finished part from application${EOL}`;
+			}
+
+			return finalContent;
+		};
+
 		it(`generates ${MetadataFilteringConstants.WHITELIST_FILE_NAME} when the file ${MetadataFilteringConstants.NATIVE_API_USAGE_FILE_NAME} exists in App_Resources/<platform>`, () => {
 			const testInjector = createTestInjector();
 			const metadataFilteringService: IMetadataFilteringService = testInjector.resolve(MetadataFilteringService);
@@ -108,7 +125,7 @@ describe("metadataFilteringService", () => {
 			});
 
 			metadataFilteringService.generateMetadataFilters(projectData, platform);
-			assert.deepEqual(dataWritten, { [path.join(projectRoot, MetadataFilteringConstants.WHITELIST_FILE_NAME)]: whitelistArray.join(EOL) });
+			assert.deepEqual(dataWritten, { [path.join(projectRoot, MetadataFilteringConstants.WHITELIST_FILE_NAME)]: getExpectedWhitelistContent({ applicationWhitelist: whitelistArray }) });
 		});
 
 		it(`generates ${MetadataFilteringConstants.WHITELIST_FILE_NAME} with content from plugins when the file ${MetadataFilteringConstants.NATIVE_API_USAGE_FILE_NAME} exists in App_Resources/<platform> and whitelist-plugins-usages is true`, () => {
@@ -124,7 +141,7 @@ describe("metadataFilteringService", () => {
 			});
 
 			metadataFilteringService.generateMetadataFilters(projectData, platform);
-			assert.deepEqual(dataWritten, { [path.join(projectRoot, MetadataFilteringConstants.WHITELIST_FILE_NAME)]: whitelistArray.join(EOL) });
+			assert.deepEqual(dataWritten, { [path.join(projectRoot, MetadataFilteringConstants.WHITELIST_FILE_NAME)]: getExpectedWhitelistContent({ pluginWhitelist: whitelistArray }) });
 		});
 
 		it(`generates all files when both plugins and applications filters are included`, () => {
@@ -144,11 +161,7 @@ describe("metadataFilteringService", () => {
 			});
 
 			metadataFilteringService.generateMetadataFilters(projectData, platform);
-			const expectedWhitelist = [
-				"pluginUses1",
-				"pluginUses2",
-				...whitelistArray
-			].join(EOL);
+			const expectedWhitelist = getExpectedWhitelistContent({ pluginWhitelist: pluginsUses, applicationWhitelist: whitelistArray });
 
 			assert.deepEqual(dataWritten, {
 				[path.join(projectRoot, MetadataFilteringConstants.WHITELIST_FILE_NAME)]: expectedWhitelist,
@@ -173,9 +186,7 @@ describe("metadataFilteringService", () => {
 			});
 
 			metadataFilteringService.generateMetadataFilters(projectData, "platform");
-			const expectedWhitelist = [
-				...whitelistArray
-			].join(EOL);
+			const expectedWhitelist = getExpectedWhitelistContent({ applicationWhitelist: whitelistArray });
 
 			assert.deepEqual(dataWritten, {
 				[path.join(projectRoot, MetadataFilteringConstants.WHITELIST_FILE_NAME)]: expectedWhitelist,