fix: debugging is not working when app path is changed

Debugging is not working when project has `nsconfig.json` and the path to `app` directory is changed. The problem is that on device the directory is always called `app`, but NativeScript projects can rename it locally to `src` for example.
In order to fix the issue, check if there's nsconfig.json file and replace the `app` from the device path with the local name of the app directory.

This fixes debugging for new Angular templates.

Author: rosen-vladimirov

src/debug-adapter/nativeScriptPathTransformer.ts

@@ -42,6 +42,21 @@ export class NativeScriptPathTransformer extends UrlPathTransformer {
 
         relativePath = relativePath.replace('tns_modules', nodePath);
 
+        const pathToNsconfig = path.join(webRoot, 'nsconfig.json');
+
+        if (fs.existsSync(pathToNsconfig)) {
+            try {
+                const content = fs.readFileSync(pathToNsconfig).toString();
+                const jsonContent = JSON.parse(content);
+
+                if (jsonContent.appPath) {
+                    relativePath = relativePath.replace('app', jsonContent.appPath);
+                }
+            } catch (err) {
+                // Ignore the error for the moment
+            }
+        }
+
         const absolutePath = path.resolve(path.join(webRoot, relativePath));
 
         if (fs.existsSync(absolutePath)) {

src/tests/nativeScriptPathTransformer.tests.ts

@@ -8,6 +8,7 @@ import * as tests from './pathTransformData';
 describe('NativeScriptPathTransformer', () => {
     let nativeScriptPathTransformer: any;
     let existsSyncStub;
+    let readFileSyncStub;
 
     before(() => {
         nativeScriptPathTransformer = new NativeScriptPathTransformer();
@@ -17,11 +18,21 @@ describe('NativeScriptPathTransformer', () => {
         const webRoot = 'C:\\projectpath';
 
         for (const test of tests as any) {
-            it(`should transform [${test.platform}] device path ${test.scriptUrl} -> ${test.expectedResult}`, async () => {
+            const nsConfigPartInTestName = test.nsconfig ? " when there's nsconfig" : '';
+
+            it(`should transform [${test.platform}] device path ${test.scriptUrl} -> ${test.expectedResult}${nsConfigPartInTestName}`, async () => {
                 (path as any).join = path.win32.join;
                 (path as any).resolve = path.win32.resolve;
+                (path as any).basename = path.win32.basename;
                 nativeScriptPathTransformer.setTargetPlatform(test.platform);
-                existsSyncStub = sinon.stub(fs, 'existsSync').callsFake((arg: string) => arg === test.existingPath);
+                const isNsconfigFilePath = (filePath: string) => path.basename(filePath) === 'nsconfig.json';
+
+                existsSyncStub = sinon
+                    .stub(fs, 'existsSync')
+                    .callsFake((arg: string) => arg === test.existingPath || (test.nsconfig && isNsconfigFilePath(arg)));
+                readFileSyncStub = sinon
+                    .stub(fs, 'readFileSync')
+                    .callsFake((filePath: string) => (isNsconfigFilePath(filePath) && test.nsconfig) ? JSON.stringify(test.nsconfig) : null);
 
                 const result = await nativeScriptPathTransformer.targetUrlToClientPath(webRoot, test.scriptUrl);
 
@@ -31,6 +42,7 @@ describe('NativeScriptPathTransformer', () => {
 
         afterEach(() => {
             existsSyncStub.restore();
+            readFileSyncStub.restore();
         });
     });
 

src/tests/pathTransformData.ts

@@ -15,6 +15,9 @@ const tests = [
     { platform: 'android', scriptUrl: 'file:///data/data/org.nativescript.TabNavigation/files/app/tns_modules/tns-core-modules/ui/page/page.js', expectedResult: 'C:\\projectpath\\node_modules\\tns-core-modules\\ui\\page\\page.android.js', existingPath: 'C:\\projectpath\\node_modules\\tns-core-modules\\ui\\page\\page.android.js' },
     { platform: 'android', scriptUrl: 'file:///data/data/org.nativescript.TabNavigation/files/app/tns_modules/tns-core-modules/ui/layouts/layout-base.js', expectedResult: 'C:\\projectpath\\node_modules\\tns-core-modules\\ui\\layouts\\layout-base.android.js', existingPath: 'C:\\projectpath\\node_modules\\tns-core-modules\\ui\\layouts\\layout-base.android.js' },
     { platform: 'android', scriptUrl: 'ng:///css/0/data/data/org.nativescript.TabNavigation/files/app/tabs/tabs.component.scss.ngstyle.js', expectedResult: 'ng:///css/0/data/data/org.nativescript.TabNavigation/files/app/tabs/tabs.component.scss.ngstyle.js' },
+    { platform: 'android', scriptUrl: 'file:///data/data/org.nativescript.TabNavigation/files/app/main.js', expectedResult: 'C:\\projectpath\\src\\main.js', nsconfig: { appPath: 'src' },  existingPath: 'C:\\projectpath\\src\\main.js' },
+    { platform: 'android', scriptUrl: 'file:///data/data/org.nativescript.TabNavigation/files/app/app/main.js', expectedResult: 'C:\\projectpath\\src\\app\\main.js', nsconfig: { appPath: 'src' },  existingPath: 'C:\\projectpath\\src\\app\\main.js' },
+    { platform: 'android', scriptUrl: 'file:///data/data/org.nativescript.app1/files/app/app/main.js', expectedResult: 'C:\\projectpath\\src\\app\\main.js', nsconfig: { appPath: 'src' },  existingPath: 'C:\\projectpath\\src\\app\\main.js' },
 ];
 
 export = tests;