feat: clean up legacy nsconfig if created for bw compat (#5380)

Author: rigor789

lib/controllers/prepare-controller.ts

@@ -133,7 +133,7 @@ export class PrepareController extends EventEmitter {
 		this.$logger.info("Preparing project...");
 
 		if (this.$mobileHelper.isAndroidPlatform(prepareData.platform)) {
-			this.$projectConfigService.writeLegacyNSConfigIfNeeded(
+			await this.$projectConfigService.writeLegacyNSConfigIfNeeded(
 				projectData.projectDir,
 				this.$projectDataService.getRuntimePackage(
 					projectData.projectDir,

lib/definitions/project.d.ts

@@ -375,7 +375,7 @@ interface IProjectConfigService {
 	writeLegacyNSConfigIfNeeded(
 		projectDir: string,
 		runtimePackage: IBasePluginData
-	): void;
+	): Promise<void>;
 }
 
 interface IAssetItem {

lib/services/project-config-service.ts

@@ -30,6 +30,7 @@ import {
 import { cache } from "../common/decorators";
 import { IOptions } from "../declarations";
 import semver = require("semver/preload");
+import { ICleanupService } from "../definitions/cleanup-service";
 
 export class ProjectConfigService implements IProjectConfigService {
 	private forceUsingNewConfig: boolean = false;
@@ -39,7 +40,8 @@ export class ProjectConfigService implements IProjectConfigService {
 		private $fs: IFileSystem,
 		private $logger: ILogger,
 		private $injector: IInjector,
-		private $options: IOptions
+		private $options: IOptions,
+		private $cleanupService: ICleanupService
 	) {}
 
 	public setForceUsingNewConfig(force: boolean) {
@@ -329,7 +331,7 @@ export default {
 		// return Object.assign({}, ...additionalData, NSConfig);
 	}
 
-	public writeLegacyNSConfigIfNeeded(
+	public async writeLegacyNSConfigIfNeeded(
 		projectDir: string,
 		runtimePackage: IBasePluginData
 	) {
@@ -370,6 +372,9 @@ You may add \`nsconfig.json\` to \`.gitignore\` as the CLI will regenerate it as
 			appPath: this.getValue("appPath"),
 			appResourcesPath: this.getValue("appResourcesPath"),
 		});
+
+		// mark the file for cleanup after the CLI exits
+		await this.$cleanupService.addCleanupDeleteAction(nsConfigPath);
 	}
 
 	// todo: move into config manipulation

test/project-service.ts

@@ -53,6 +53,7 @@ describe("projectService", () => {
 				ensureValidName: async () => opts.projectName,
 			});
 			testInjector.register("projectConfigService", ProjectConfigService);
+			testInjector.register("cleanupService", {});
 			testInjector.register("projectTemplatesService", {
 				prepareTemplate: async () => ({
 					templateName: constants.RESERVED_TEMPLATE_NAMES["default"],
@@ -170,6 +171,7 @@ describe("projectService", () => {
 			testInjector.register("projectData", {});
 			testInjector.register("projectNameService", {});
 			testInjector.register("projectConfigService", ProjectConfigService);
+			testInjector.register("cleanupService", {});
 			testInjector.register("projectTemplatesService", {});
 			testInjector.register("staticConfig", {});
 			testInjector.register("projectHelper", {});

test/services/project-config-service.ts

@@ -58,6 +58,7 @@ const createTestInjector = (
 	testInjector.register("logger", LoggerStub);
 	testInjector.register("injector", testInjector);
 	testInjector.register("projectConfigService", ProjectConfigService);
+	testInjector.register("cleanupService", {});
 
 	return testInjector;
 };

test/services/project-data-service.ts

@@ -133,6 +133,7 @@ const createTestInjector = (
 	});
 
 	testInjector.register("options", {});
+	testInjector.register("cleanupService", {});
 
 	return testInjector;
 };

test/stubs.ts

@@ -636,10 +636,10 @@ export class ProjectConfigServiceStub implements IProjectConfigService {
 		return true;
 	}
 
-	writeLegacyNSConfigIfNeeded(
+	async writeLegacyNSConfigIfNeeded(
 		projectDir: string,
 		runtimePackage: IBasePluginData
-	): void {}
+	): Promise<void> {}
 }
 
 export class AndroidPluginBuildServiceStub