fix: detect core version before including inspector_modules on android (#10520)

rigor789 · web-flow · commit ccee8e8166d8 · 2024-04-16T14:20:14.000+02:00
diff --git a/packages/webpack5/__tests__/configuration/__snapshots__/angular.spec.ts.snap b/packages/webpack5/__tests__/configuration/__snapshots__/angular.spec.ts.snap
@@ -435,9 +435,6 @@ exports[`angular configuration for android 1`] = `
       '__jest__/src/app.js',
       '@nativescript/core/ui/frame',
       '@nativescript/core/ui/frame/activity'
-    ],
-    'tns_modules/inspector_modules': [
-      '@nativescript/core/inspector_modules'
     ]
   }
 }"
diff --git a/packages/webpack5/__tests__/configuration/__snapshots__/base.spec.ts.snap b/packages/webpack5/__tests__/configuration/__snapshots__/base.spec.ts.snap
@@ -323,9 +323,6 @@ exports[`base configuration for android 1`] = `
       '__jest__/src/app.js',
       '@nativescript/core/ui/frame',
       '@nativescript/core/ui/frame/activity'
-    ],
-    'tns_modules/inspector_modules': [
-      '@nativescript/core/inspector_modules'
     ]
   }
 }"
diff --git a/packages/webpack5/__tests__/configuration/__snapshots__/javascript.spec.ts.snap b/packages/webpack5/__tests__/configuration/__snapshots__/javascript.spec.ts.snap
@@ -322,9 +322,6 @@ exports[`javascript configuration for android 1`] = `
       '__jest__/src/app.js',
       '@nativescript/core/ui/frame',
       '@nativescript/core/ui/frame/activity'
-    ],
-    'tns_modules/inspector_modules': [
-      '@nativescript/core/inspector_modules'
     ]
   }
 }"
diff --git a/packages/webpack5/__tests__/configuration/__snapshots__/react.spec.ts.snap b/packages/webpack5/__tests__/configuration/__snapshots__/react.spec.ts.snap
@@ -352,9 +352,6 @@ exports[`react configuration > android > adds ReactRefreshWebpackPlugin when HMR
       '__jest__/src/app.js',
       '@nativescript/core/ui/frame',
       '@nativescript/core/ui/frame/activity'
-    ],
-    'tns_modules/inspector_modules': [
-      '@nativescript/core/inspector_modules'
     ]
   }
 }"
@@ -683,9 +680,6 @@ exports[`react configuration > android > base config 1`] = `
       '__jest__/src/app.js',
       '@nativescript/core/ui/frame',
       '@nativescript/core/ui/frame/activity'
-    ],
-    'tns_modules/inspector_modules': [
-      '@nativescript/core/inspector_modules'
     ]
   }
 }"
diff --git a/packages/webpack5/__tests__/configuration/__snapshots__/svelte.spec.ts.snap b/packages/webpack5/__tests__/configuration/__snapshots__/svelte.spec.ts.snap
@@ -344,9 +344,6 @@ exports[`svelte configuration for android 1`] = `
       '__jest__/src/app.js',
       '@nativescript/core/ui/frame',
       '@nativescript/core/ui/frame/activity'
-    ],
-    'tns_modules/inspector_modules': [
-      '@nativescript/core/inspector_modules'
     ]
   }
 }"
diff --git a/packages/webpack5/__tests__/configuration/__snapshots__/typescript.spec.ts.snap b/packages/webpack5/__tests__/configuration/__snapshots__/typescript.spec.ts.snap
@@ -322,9 +322,6 @@ exports[`typescript configuration for android 1`] = `
       '__jest__/src/app.js',
       '@nativescript/core/ui/frame',
       '@nativescript/core/ui/frame/activity'
-    ],
-    'tns_modules/inspector_modules': [
-      '@nativescript/core/inspector_modules'
     ]
   }
 }"
diff --git a/packages/webpack5/__tests__/configuration/__snapshots__/vue.spec.ts.snap b/packages/webpack5/__tests__/configuration/__snapshots__/vue.spec.ts.snap
@@ -357,9 +357,6 @@ exports[`vue configuration for android 1`] = `
       '__jest__/src/app.js',
       '@nativescript/core/ui/frame',
       '@nativescript/core/ui/frame/activity'
-    ],
-    'tns_modules/inspector_modules': [
-      '@nativescript/core/inspector_modules'
     ]
   }
 }"
diff --git a/packages/webpack5/__tests__/configuration/base.spec.ts b/packages/webpack5/__tests__/configuration/base.spec.ts
@@ -4,6 +4,7 @@ import fs from 'fs';
 import base from '../../src/configuration/base';
 import { init } from '../../src';
 import { applyFileReplacements } from '../../src/helpers/fileReplacements';
+import * as dependenciesHelpers from '../../src/helpers/dependencies';
 import { additionalCopyRules } from '../../src/helpers/copyRules';
 
 describe('base configuration', () => {
@@ -221,4 +222,30 @@ describe('base configuration', () => {
 		expect(config.output.get('sourceMapFilename')).toMatchSnapshot();
 		expect(config.get('devtool')).toBe('hidden-source-map');
 	});
+
+	it('includes inspector_modules on android when @nativescript/core version is >= 8.7.0', () => {
+		const getDependencyVersionSpy = jest.spyOn(
+			dependenciesHelpers,
+			'getDependencyVersion'
+		);
+		getDependencyVersionSpy.withImplementation(
+			(name) => {
+				if (name === '@nativescript/core') {
+					return '8.7.0';
+				}
+				return null;
+			},
+			() => {
+				init({
+					android: true,
+				});
+
+				const config = base(new Config());
+				const entry = config.entryPoints.get('tns_modules/inspector_modules');
+
+				expect(entry).toBeDefined();
+				expect(entry.values().length).toBe(1);
+			}
+		);
+	});
 });
diff --git a/packages/webpack5/package.json b/packages/webpack5/package.json
@@ -41,6 +41,7 @@
 		"sass": "^1.0.0",
 		"sass-loader": "^13.0.0",
 		"sax": "^1.0.0",
+		"semver": "^7.0.0 || ^6.0.0",
 		"source-map": "^0.7.0",
 		"terser-webpack-plugin": "^5.0.0",
 		"ts-dedent": "^2.0.0",
diff --git a/packages/webpack5/src/configuration/angular.ts b/packages/webpack5/src/configuration/angular.ts
@@ -1,9 +1,10 @@
 import { extname, resolve } from 'path';
 import Config from 'webpack-chain';
+import { satisfies } from 'semver';
 import { existsSync } from 'fs';
 
 import { getTypescript, readTsConfig } from '../helpers/typescript';
-import { getDependencyPath } from '../helpers/dependencies';
+import { getDependencyVersion } from '../helpers/dependencies';
 import { getProjectTSConfigPath } from '../helpers/project';
 import { env as _env, IWebpackEnv } from '../index';
 import { warnOnce } from '../helpers/log';
@@ -187,13 +188,16 @@ export default function (config: Config, env: IWebpackEnv = _env): Config {
 				.loader('angular-hot-loader');
 		});
 
-		const buildAngularMajorVersion = getBuildAngularMajorVersion();
-		if (buildAngularMajorVersion) {
+		const buildAngularVersion = getDependencyVersion(
+			'@angular-devkit/build-angular'
+		);
+
+		if (buildAngularVersion) {
 			const buildAngularOptions: any = {
 				aot: !disableAOT,
 			};
 
-			if (buildAngularMajorVersion < 15) {
+			if (satisfies(buildAngularVersion, '<15.0.0')) {
 				const tsConfig = readTsConfig(tsConfigPath);
 				const { ScriptTarget } = getTypescript();
 				buildAngularOptions.scriptTarget =
@@ -315,27 +319,6 @@ function getAngularWebpackPlugin(): any {
 	return AngularWebpackPlugin;
 }
 
-const MAJOR_VER_RE = /^(\d+)\./;
-function getBuildAngularMajorVersion() {
-	const buildAngularPath = getDependencyPath('@angular-devkit/build-angular');
-	if (!buildAngularPath) {
-		return null;
-	}
-
-	try {
-		const buildAngularVersion =
-			require(`${buildAngularPath}/package.json`).version;
-
-		const [_, majorStr] = buildAngularVersion.match(MAJOR_VER_RE);
-
-		return Number(majorStr);
-	} catch (err) {
-		// ignore
-	}
-
-	return null;
-}
-
 function tryRequireResolve(path: string) {
 	try {
 		return require.resolve(path);
@@ -348,10 +331,10 @@ function getWebpackLoaderPath() {
 	return (
 		tryRequireResolve(
 			'@angular-devkit/build-angular/src/babel/webpack-loader'
-		) ||
+		) ??
 		tryRequireResolve(
 			'@angular-devkit/build-angular/src/tools/babel/webpack-loader'
-		) ||
+		) ??
 		// fallback to angular 16.1+
 		'@angular-devkit/build-angular/src/tools/babel/webpack-loader'
 	);
diff --git a/packages/webpack5/src/configuration/base.ts b/packages/webpack5/src/configuration/base.ts
@@ -5,18 +5,19 @@ import {
 	HotModuleReplacementPlugin,
 } from 'webpack';
 import Config from 'webpack-chain';
+import { satisfies } from 'semver';
 import { existsSync } from 'fs';
 
 import ForkTsCheckerWebpackPlugin from 'fork-ts-checker-webpack-plugin';
 import { BundleAnalyzerPlugin } from 'webpack-bundle-analyzer';
 import TerserPlugin from 'terser-webpack-plugin';
 
 import { getProjectFilePath, getProjectTSConfigPath } from '../helpers/project';
+import { getDependencyVersion, hasDependency } from '../helpers/dependencies';
 import { PlatformSuffixPlugin } from '../plugins/PlatformSuffixPlugin';
 import { applyFileReplacements } from '../helpers/fileReplacements';
 import { addCopyRule, applyCopyRules } from '../helpers/copyRules';
 import { WatchStatePlugin } from '../plugins/WatchStatePlugin';
-import { hasDependency } from '../helpers/dependencies';
 import { applyDotEnvPlugin } from '../helpers/dotEnv';
 import { env as _env, IWebpackEnv } from '../index';
 import { getValue } from '../helpers/config';
@@ -86,7 +87,7 @@ export default function (config: Config, env: IWebpackEnv = _env): Config {
 		const sourceMapAbsolutePath = getProjectFilePath(
 			`./${
 				env.buildPath ?? 'platforms'
-			}/${platform}-sourceMaps/[file].map[query]`,
+			}/${platform}-sourceMaps/[file].map[query]`
 		);
 		const sourceMapRelativePath = relative(outputPath, sourceMapAbsolutePath);
 		config.output.sourceMapFilename(sourceMapRelativePath);
@@ -272,7 +273,7 @@ export default function (config: Config, env: IWebpackEnv = _env): Config {
 	const configFile = tsConfigPath
 		? {
 				configFile: tsConfigPath,
-			}
+		  }
 		: undefined;
 
 	// set up ts support
@@ -451,7 +452,7 @@ export default function (config: Config, env: IWebpackEnv = _env): Config {
 			 * +-----------------------------------------------------------------------------------------+
 			 */
 			/System.import\(\) is deprecated/,
-		]),
+		])
 	);
 
 	// todo: refine defaults
@@ -516,7 +517,11 @@ export default function (config: Config, env: IWebpackEnv = _env): Config {
 
 function shouldIncludeInspectorModules(): boolean {
 	const platform = getPlatformName();
-	// todo: check if core modules are external
-	// todo: check if we are testing
-	return platform === 'ios' || platform === 'android';
+	const coreVersion = getDependencyVersion('@nativescript/core');
+
+	if (coreVersion && satisfies(coreVersion, '>=8.7.0')) {
+		return platform === 'ios' || platform === 'android';
+	}
+
+	return platform === 'ios';
 }
diff --git a/packages/webpack5/src/helpers/dependencies.ts b/packages/webpack5/src/helpers/dependencies.ts
@@ -47,3 +47,23 @@ export function getDependencyPath(dependencyName: string): string | null {
 		return null;
 	}
 }
+
+/**
+ * Utility to get the version of a dependency.
+ *
+ * @param dependencyName
+ * @returns string | null - version of the dependency or null if not found
+ */
+export function getDependencyVersion(dependencyName: string): string | null {
+	const dependencyPath = getDependencyPath(dependencyName);
+	if (!dependencyPath) {
+		return null;
+	}
+
+	try {
+		return require(`${dependencyPath}/package.json`).version;
+	} catch (err) {
+		// ignore
+	}
+	return null;
+}

Original file line number	Diff line number	Diff line change
@@ -435,9 +435,6 @@ exports[`angular configuration for android 1`] = `
`435`	`435`	`'__jest__/src/app.js',`
`436`	`436`	`'@nativescript/core/ui/frame',`
`437`	`437`	`'@nativescript/core/ui/frame/activity'`
`438`		`- ],`
`439`		`- 'tns_modules/inspector_modules': [`
`440`		`- '@nativescript/core/inspector_modules'`
`441`	`438`	`]`
`442`	`439`	`}`
`443`	`440`	`}"`
Original file line number	Diff line number	Diff line change
@@ -323,9 +323,6 @@ exports[`base configuration for android 1`] = `
`323`	`323`	`'__jest__/src/app.js',`
`324`	`324`	`'@nativescript/core/ui/frame',`
`325`	`325`	`'@nativescript/core/ui/frame/activity'`
`326`		`- ],`
`327`		`- 'tns_modules/inspector_modules': [`
`328`		`- '@nativescript/core/inspector_modules'`
`329`	`326`	`]`
`330`	`327`	`}`
`331`	`328`	`}"`
Original file line number	Diff line number	Diff line change
@@ -322,9 +322,6 @@ exports[`javascript configuration for android 1`] = `
`322`	`322`	`'__jest__/src/app.js',`
`323`	`323`	`'@nativescript/core/ui/frame',`
`324`	`324`	`'@nativescript/core/ui/frame/activity'`
`325`		`- ],`
`326`		`- 'tns_modules/inspector_modules': [`
`327`		`- '@nativescript/core/inspector_modules'`
`328`	`325`	`]`
`329`	`326`	`}`
`330`	`327`	`}"`
Original file line number	Diff line number	Diff line change
@@ -352,9 +352,6 @@ exports[`react configuration > android > adds ReactRefreshWebpackPlugin when HMR
`352`	`352`	`'__jest__/src/app.js',`
`353`	`353`	`'@nativescript/core/ui/frame',`
`354`	`354`	`'@nativescript/core/ui/frame/activity'`
`355`		`- ],`
`356`		`- 'tns_modules/inspector_modules': [`
`357`		`- '@nativescript/core/inspector_modules'`
`358`	`355`	`]`
`359`	`356`	`}`
`360`	`357`	`}"`
@@ -683,9 +680,6 @@ exports[`react configuration > android > base config 1`] = `
`683`	`680`	`'__jest__/src/app.js',`
`684`	`681`	`'@nativescript/core/ui/frame',`
`685`	`682`	`'@nativescript/core/ui/frame/activity'`
`686`		`- ],`
`687`		`- 'tns_modules/inspector_modules': [`
`688`		`- '@nativescript/core/inspector_modules'`
`689`	`683`	`]`
`690`	`684`	`}`
`691`	`685`	`}"`
Original file line number	Diff line number	Diff line change
@@ -344,9 +344,6 @@ exports[`svelte configuration for android 1`] = `
`344`	`344`	`'__jest__/src/app.js',`
`345`	`345`	`'@nativescript/core/ui/frame',`
`346`	`346`	`'@nativescript/core/ui/frame/activity'`
`347`		`- ],`
`348`		`- 'tns_modules/inspector_modules': [`
`349`		`- '@nativescript/core/inspector_modules'`
`350`	`347`	`]`
`351`	`348`	`}`
`352`	`349`	`}"`
Original file line number	Diff line number	Diff line change
@@ -322,9 +322,6 @@ exports[`typescript configuration for android 1`] = `
`322`	`322`	`'__jest__/src/app.js',`
`323`	`323`	`'@nativescript/core/ui/frame',`
`324`	`324`	`'@nativescript/core/ui/frame/activity'`
`325`		`- ],`
`326`		`- 'tns_modules/inspector_modules': [`
`327`		`- '@nativescript/core/inspector_modules'`
`328`	`325`	`]`
`329`	`326`	`}`
`330`	`327`	`}"`
Original file line number	Diff line number	Diff line change
@@ -357,9 +357,6 @@ exports[`vue configuration for android 1`] = `
`357`	`357`	`'__jest__/src/app.js',`
`358`	`358`	`'@nativescript/core/ui/frame',`
`359`	`359`	`'@nativescript/core/ui/frame/activity'`
`360`		`- ],`
`361`		`- 'tns_modules/inspector_modules': [`
`362`		`- '@nativescript/core/inspector_modules'`
`363`	`360`	`]`
`364`	`361`	`}`
`365`	`362`	`}"`