refactor(logging): log additional info for debugging purposes

Author: danbucholtz

src/optimization/decorators.ts

@@ -7,7 +7,7 @@ export function purgeDecorators(filePath: string, fileContent: string) {
 
 export function purgeIndexDecorator(filePath: string, fileContent: string) {
   if (process.env[Constants.ENV_VAR_IONIC_ANGULAR_ENTRY_POINT] === filePath) {
-    Logger.debug(`Purging decorators for ${filePath}`);
+    Logger.debug(`Purging index file decorator for ${filePath}`);
     return fileContent.replace(DECORATORS_REGEX, '');
   }
   return fileContent;

src/optimization/treeshake.ts

@@ -35,9 +35,10 @@ function generateResults(dependencyMap: Map<string, Set<string>>) {
 
 function requiredModule(modulePath: string) {
   const mainJsFile = changeExtension(process.env[Constants.ENV_APP_ENTRY_POINT], '.js');
+  const mainTsFile = changeExtension(process.env[Constants.ENV_APP_ENTRY_POINT], '.ts');
   const appModule = changeExtension(process.env[Constants.ENV_APP_NG_MODULE_PATH], '.js');
   const appModuleNgFactory = getAppModuleNgFactoryPath();
-  return modulePath === mainJsFile || modulePath === appModule || modulePath === appModuleNgFactory;
+  return modulePath === mainJsFile || modulePath === mainTsFile || modulePath === appModule || modulePath === appModuleNgFactory;
 }
 
 function filterMap(dependencyMap: Map<string, Set<string>>) {
@@ -73,23 +74,37 @@ function processImportTree(dependencyMap: Map<string, Set<string>>, importee: st
 }
 
 function calculateUnusedIonicProviders(dependencyMap: Map<string, Set<string>>) {
+  Logger.debug(`[treeshake] calculateUnusedIonicProviders: beginning to purge providers`);
 
-
+  Logger.debug(`[treeshake] calculateUnusedIonicProviders: attempting to purge action sheet controller`);
   processIonicProviders(dependencyMap, process.env[Constants.ENV_ACTION_SHEET_CONTROLLER_PATH]);
+  Logger.debug(`[treeshake] calculateUnusedIonicProviders: attempting to purge alert controller`);
   processIonicProviders(dependencyMap, process.env[Constants.ENV_ALERT_CONTROLLER_PATH]);
+  Logger.debug(`[treeshake] calculateUnusedIonicProviders: attempting to loading controller`);
   processIonicProviders(dependencyMap, process.env[Constants.ENV_LOADING_CONTROLLER_PATH]);
+  Logger.debug(`[treeshake] calculateUnusedIonicProviders: attempting to modal controller`);
   processIonicProviders(dependencyMap, process.env[Constants.ENV_MODAL_CONTROLLER_PATH]);
+  Logger.debug(`[treeshake] calculateUnusedIonicProviders: attempting to picker controller`);
   processIonicProviders(dependencyMap, process.env[Constants.ENV_PICKER_CONTROLLER_PATH]);
+  Logger.debug(`[treeshake] calculateUnusedIonicProviders: attempting to popover controller`);
   processIonicProviders(dependencyMap, process.env[Constants.ENV_POPOVER_CONTROLLER_PATH]);
+  Logger.debug(`[treeshake] calculateUnusedIonicProviders: attempting to toast controller`);
   processIonicProviders(dependencyMap, process.env[Constants.ENV_TOAST_CONTROLLER_PATH]);
 
   // check if the controllers were deleted, if so, purge the component too
+  Logger.debug(`[treeshake] calculateUnusedIonicProviders: attempting to action sheet component`);
   processIonicProviderComponents(dependencyMap, process.env[Constants.ENV_ACTION_SHEET_CONTROLLER_PATH], process.env[Constants.ENV_ACTION_SHEET_COMPONENT_FACTORY_PATH]);
+  Logger.debug(`[treeshake] calculateUnusedIonicProviders: attempting to alert component`);
   processIonicProviderComponents(dependencyMap, process.env[Constants.ENV_ALERT_CONTROLLER_PATH], process.env[Constants.ENV_ALERT_COMPONENT_FACTORY_PATH]);
+  Logger.debug(`[treeshake] calculateUnusedIonicProviders: attempting to loading component`);
   processIonicProviderComponents(dependencyMap, process.env[Constants.ENV_LOADING_CONTROLLER_PATH], process.env[Constants.ENV_LOADING_COMPONENT_FACTORY_PATH]);
+  Logger.debug(`[treeshake] calculateUnusedIonicProviders: attempting to modal component`);
   processIonicProviderComponents(dependencyMap, process.env[Constants.ENV_MODAL_CONTROLLER_PATH], process.env[Constants.ENV_MODAL_COMPONENT_FACTORY_PATH]);
+  Logger.debug(`[treeshake] calculateUnusedIonicProviders: attempting to picker component`);
   processIonicProviderComponents(dependencyMap, process.env[Constants.ENV_PICKER_CONTROLLER_PATH], process.env[Constants.ENV_PICKER_COMPONENT_FACTORY_PATH]);
+  Logger.debug(`[treeshake] calculateUnusedIonicProviders: attempting to popover component`);
   processIonicProviderComponents(dependencyMap, process.env[Constants.ENV_POPOVER_CONTROLLER_PATH], process.env[Constants.ENV_POPOVER_COMPONENT_FACTORY_PATH]);
+  Logger.debug(`[treeshake] calculateUnusedIonicProviders: attempting to toast component`);
   processIonicProviderComponents(dependencyMap, process.env[Constants.ENV_TOAST_CONTROLLER_PATH], process.env[Constants.ENV_TOAST_COMPONENT_FACTORY_PATH]);
 
 }
@@ -110,8 +125,10 @@ export function getAppModuleNgFactoryPath() {
 function processIonicProviders(dependencyMap: Map<string, Set<string>>, providerPath: string) {
   const importeeSet = dependencyMap.get(providerPath);
   const appModuleNgFactoryPath = getAppModuleNgFactoryPath();
+
   // we can only purge an ionic provider if it is imported from one module, which is the AppModuleNgFactory
   if (importeeSet && importeeSet.size === 1 && importeeSet.has(appModuleNgFactoryPath)) {
+    Logger.debug(`[treeshake] processIonicProviders: Purging ${providerPath}`);
     importeeSet.delete(appModuleNgFactoryPath);
     // loop over the dependency map and remove this provider from importee sets
     processImportTreeForProviders(dependencyMap, providerPath);
@@ -141,12 +158,15 @@ export function isNgFactory(modulePath: string) {
 }
 
 export function purgeUnusedImportsAndExportsFromIndex(indexFilePath: string, indexFileContent: string, modulePathsToPurge: string[] ) {
+  Logger.debug(`[treeshake] purgeUnusedImportsFromIndex: Starting to purge import/exports ... `);
   for (const modulePath of modulePathsToPurge) {
     // I cannot get the './' prefix to show up when using path api
     Logger.debug(`[treeshake] purgeUnusedImportsFromIndex: Removing ${modulePath} from ${indexFilePath}`);
+
     const extensionless = changeExtension(modulePath, '');
     const relativeImportPath = './' + relative(dirname(indexFilePath), extensionless);
     const importPath = toUnixPath(relativeImportPath);
+    Logger.debug(`[treeshake] purgeUnusedImportsFromIndex: Removing imports with path ${importPath}`);
     const importRegex = generateImportRegex(importPath);
     // replace the import if it's found
     let results: RegExpExecArray = null;
@@ -156,10 +176,13 @@ export function purgeUnusedImportsAndExportsFromIndex(indexFilePath: string, ind
 
     results = null;
     const exportRegex = generateExportRegex(importPath);
+    Logger.debug(`[treeshake] purgeUnusedImportsFromIndex: Removing exports with path ${importPath}`);
     while ((results = exportRegex.exec(indexFileContent)) && results.length) {
       indexFileContent = indexFileContent.replace(exportRegex, '');
     }
   }
+
+  Logger.debug(`[treeshake] purgeUnusedImportsFromIndex: Starting to purge import/exports ... DONE`);
   return indexFileContent;
 }
 
@@ -174,29 +197,35 @@ function generateExportRegex(relativeExportPath: string) {
 }
 
 export function purgeComponentNgFactoryImportAndUsage(appModuleNgFactoryPath: string, appModuleNgFactoryContent: string, componentFactoryPath: string) {
+  Logger.debug(`[treeshake] purgeComponentNgFactoryImportAndUsage: Starting to purge component ngFactory import/export ...`);
   const extensionlessComponentFactoryPath = changeExtension(componentFactoryPath, '');
   const relativeImportPath = relative(dirname(appModuleNgFactoryPath), extensionlessComponentFactoryPath);
   const importPath = toUnixPath(relativeImportPath);
+  Logger.debug(`[treeshake] purgeComponentNgFactoryImportAndUsage: Purging imports from ${importPath}`);
   const importRegex = generateWildCardImportRegex(importPath);
   const results = importRegex.exec(appModuleNgFactoryContent);
   if (results && results.length >= 2) {
     appModuleNgFactoryContent = appModuleNgFactoryContent.replace(importRegex, '');
     const namedImport = results[1].trim();
+    Logger.debug(`[treeshake] purgeComponentNgFactoryImportAndUsage: Purging code using named import ${namedImport}`);
     const purgeFromConstructor = generateRemoveComponentFromConstructorRegex(namedImport);
     appModuleNgFactoryContent = appModuleNgFactoryContent.replace(purgeFromConstructor, '');
   }
+  Logger.debug(`[treeshake] purgeComponentNgFactoryImportAndUsage: Starting to purge component ngFactory import/export ... DONE`);
   return appModuleNgFactoryContent;
 }
 
 export function purgeProviderControllerImportAndUsage(appModuleNgFactoryPath: string, appModuleNgFactoryContent: string, providerPath: string) {
+  Logger.debug(`[treeshake] purgeProviderControllerImportAndUsage: Starting to purge provider controller and usage ...`);
   const extensionlessComponentFactoryPath = changeExtension(providerPath, '');
   const relativeImportPath = relative(dirname(process.env[Constants.ENV_VAR_IONIC_ANGULAR_DIR]), extensionlessComponentFactoryPath);
   const importPath = toUnixPath(relativeImportPath);
+  Logger.debug(`[treeshake] purgeProviderControllerImportAndUsage: Looking for imports from ${importPath}`);
   const importRegex = generateWildCardImportRegex(importPath);
   const results = importRegex.exec(appModuleNgFactoryContent);
   if (results && results.length >= 2) {
-    appModuleNgFactoryContent = appModuleNgFactoryContent.replace(importRegex, '');
     const namedImport = results[1].trim();
+
     // purge the getter
     const purgeGetterRegEx = generateRemoveGetterFromImportRegex(namedImport);
     const purgeGetterResults = purgeGetterRegEx.exec(appModuleNgFactoryContent);
@@ -205,21 +234,31 @@ export function purgeProviderControllerImportAndUsage(appModuleNgFactoryPath: st
     const purgeIfResults = purgeIfRegEx.exec(appModuleNgFactoryContent);
 
     if (purgeGetterResults && purgeIfResults) {
+
+      Logger.debug(`[treeshake] purgeProviderControllerImportAndUsage: Purging imports ${namedImport}`);
+      appModuleNgFactoryContent = appModuleNgFactoryContent.replace(importRegex, '');
+
+      Logger.debug(`[treeshake] purgeProviderControllerImportAndUsage: Purging getter logic using ${namedImport}`);
       const getterContentToReplace = purgeGetterResults[0];
       const newGetterContent = `/*${getterContentToReplace}*/`;
       appModuleNgFactoryContent = appModuleNgFactoryContent.replace(getterContentToReplace, newGetterContent);
 
+      Logger.debug(`[treeshake] purgeProviderControllerImportAndUsage: Purging additional logic using ${namedImport}`);
       const purgeIfContentToReplace = purgeIfResults[0];
       const newPurgeIfContent = `/*${purgeIfContentToReplace}*/`;
       appModuleNgFactoryContent = appModuleNgFactoryContent.replace(purgeIfContentToReplace, newPurgeIfContent);
     }
   }
+
+  Logger.debug(`[treeshake] purgeProviderControllerImportAndUsage: Starting to purge provider controller and usage ... DONE`);
   return appModuleNgFactoryContent;
 }
 
 export function purgeProviderClassNameFromIonicModuleForRoot(indexFileContent: string, providerClassName: string) {
+  Logger.debug(`[treeshake] purgeProviderClassNameFromIonicModuleForRoot: Purging reference in the ionicModule forRoot method ...`);
   const regex = generateIonicModulePurgeProviderRegex(providerClassName);
   indexFileContent = indexFileContent.replace(regex, '');
+  Logger.debug(`[treeshake] purgeProviderClassNameFromIonicModuleForRoot: Purging reference in the ionicModule forRoot method ... DONE`);
   return indexFileContent;
 }