PCF Debugger: Add initial debugger code (#231)

* add experimental pcf debugger feature flag * add debugger code * use regex for bundle matching * only show error if no retry left * use instance props to store manager instances * add is disposed flag * use sleep instead of setTimeout * constants cleanup & general tidiness * extract BundleLoader * adding tests * add test packages * remove console * cleanup * adding tests * add more tests * use DI-like pattern for easier tests * add gulp tasks for testing the debugger * separate unit and integration tests * adding util tests * update headers * replace any * format package json * revert gulpfile to previous format * add dom.iterable to support .entries * format extension.ts * add readme * fix header * fix package lock registry resolution * remove attachToExistingBrowser * use xvfb action to execute integration tests * add optional dependencies Co-authored-by: Felix Schober <[email protected]>
microsoft · Jul 18, 2022 · 6ce12e8 · 6ce12e8
1 parent 723cdf1
commit 6ce12e8
Show file tree

Hide file tree

Showing 58 changed files with 4,403 additions and 184 deletions.
diff --git a/.github/workflows/PullRequest.yml b/.github/workflows/PullRequest.yml
@@ -32,10 +32,17 @@ jobs:
       with:
         node-version: 14.x
 
-    - name: Build and test
+    - name: Install dependencies
+      run: npm i -g npm
+
+    - name: Build and unit test
       run: |
-        npm i -g npm
         npm ci
         npm run dist
       env:
         AZ_DevOps_Read_PAT: ${{ secrets.AZ_DevOps_Read_PAT }}
+
+    - name: Run integration tests
+      uses: GabrielBB/[email protected]
+      with:
+        run: npm run test-integration
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -2,52 +2,65 @@
   "version": "0.2.0",
   "configurations": [
     {
-      "args": [
-        "--extensionDevelopmentPath=${workspaceFolder}"
-      ],
+      "args": ["--extensionDevelopmentPath=${workspaceFolder}"],
       "name": "Launch VSCode Extension",
-      "outFiles": [
-				"${workspaceFolder}/dist/**/*.js"
-      ],
+      "outFiles": ["${workspaceFolder}/dist/**/*.js"],
       "sourceMaps": true,
       "runtimeExecutable": "${execPath}",
       "preLaunchTask": "gulp: compile",
       "request": "launch",
       "type": "pwa-extensionHost",
       "trace": true
     },
-		{
-			"type": "node",
-			"request": "attach",
-			"name": "Attach to Server",
-			"port": 6009,
-			"restart": true,
-			"outFiles": ["${workspaceFolder}/dist/**/*.js"]
-		},
+    {
+      "type": "node",
+      "request": "attach",
+      "name": "Attach to Server",
+      "port": 6009,
+      "restart": true,
+      "outFiles": ["${workspaceFolder}/dist/**/*.js"]
+    },
     {
       "type": "node",
       "request": "launch",
       "name": "Mocha All Unit tests",
       "program": "${workspaceFolder}/node_modules/mocha/bin/mocha",
       "cwd": "${workspaceFolder}",
       "args": [
-        "--require", "ts-node/register",
-        "-u", "bdd",
-        "--timeout", "999999",
+        "--require",
+        "ts-node/register",
+        "-u",
+        "bdd",
+        "--timeout",
+        "999999",
         "src/client/test/unit/**/*.ts"
       ],
       "internalConsoleOptions": "neverOpen"
     },
+    {
+      "name": "Integration Tests",
+      "type": "extensionHost",
+      "request": "launch",
+      "runtimeExecutable": "${execPath}",
+      "args": [
+        "--extensionDevelopmentPath=${workspaceFolder}",
+        "--extensionTestsPath=${workspaceFolder}/out/debugger/test/unit/index"
+      ],
+      "outFiles": ["${workspaceFolder}/out/debugger/test/**/*.js"]
+    },
     {
       "type": "node",
       "request": "launch",
       "name": "Mocha Current File",
       "program": "${workspaceFolder}/node_modules/mocha/bin/mocha",
       "cwd": "${workspaceFolder}",
       "args": [
-        "--require", "ts-node/register",
-        "-u", "bdd",
-        "--timeout", "999999",
+        "--require",
+        "ts-node/register",
+        "-u",
+        "bdd",
+        "--timeout",
+        "999999",
         "${file}"
       ],
       "internalConsoleOptions": "neverOpen"
@@ -58,9 +71,7 @@
       "name": "Launch current TypeScript src",
       "program": "${file}",
       "cwd": "${workspaceFolder}",
-      "outFiles": [
-        "${workspaceFolder}/out/**/*.js"
-      ],
+      "outFiles": ["${workspaceFolder}/out/**/*.js"],
       "preLaunchTask": "gulp: compile",
       "sourceMaps": true
     },
@@ -70,32 +81,26 @@
       "name": "Gulp task",
       "program": "${workspaceFolder}/node_modules/gulp/bin/gulp.js",
       "cwd": "${workspaceFolder}",
-      "args": [
-        "recompile"
-      ],
-      "skipFiles": [
-        "<node_internals>/**"
-      ]
+      "args": ["recompile"],
+      "skipFiles": ["<node_internals>/**"]
     },
     {
-			"name": "Run Web Extension in VS Code",
-			"type": "pwa-extensionHost",
-			"debugWebWorkerHost": true,
-			"request": "launch",
-			"args": [
-				"--extensionDevelopmentPath=${workspaceFolder}",
-				"--extensionDevelopmentKind=web"
-			],
-			"outFiles": [
-				"${workspaceFolder}/dist/web/**/*.js"
-			],
-			"preLaunchTask": "gulp: compileWeb"
-		}
+      "name": "Run Web Extension in VS Code",
+      "type": "pwa-extensionHost",
+      "debugWebWorkerHost": true,
+      "request": "launch",
+      "args": [
+        "--extensionDevelopmentPath=${workspaceFolder}",
+        "--extensionDevelopmentKind=web"
+      ],
+      "outFiles": ["${workspaceFolder}/dist/web/**/*.js"],
+      "preLaunchTask": "gulp: compileWeb"
+    }
   ],
   "compounds": [
-		{
-			"name": "Client + Server",
-			"configurations": ["Launch VSCode Extension", "Attach to Server"]
-		}
-	]
+    {
+      "name": "Client + Server",
+      "configurations": ["Launch VSCode Extension", "Attach to Server"]
+    }
+  ]
 }
diff --git a/gulpfile.js b/gulpfile.js
@@ -13,6 +13,7 @@ const exec = util.promisify(require('child_process').exec);
 const gulp = require('gulp');
 const filter = require('gulp-filter');
 const eslint = require('gulp-eslint');
+const gulpTs = require("gulp-typescript");
 const replace = require('gulp-replace');
 const mocha = require('gulp-mocha');
 const moment = require('moment');
@@ -144,31 +145,70 @@ function lint() {
         .pipe(eslint.failAfterError());
 }
 
-function test() {
+function testUnitTests() {
     return gulp
-        .src(['src/server/test/unit/**/*.ts','src/client/test/unit/**/*.ts'], { read: false })
-        .pipe(mocha({
-                require: [ "ts-node/register" ],
-                ui: 'bdd'
-            }));
+        .src(
+            [
+                "src/server/test/unit/**/*.ts",
+                "src/client/test/unit/**/*.ts",
+                "src/debugger/test/unit/**/*.ts",
+            ],
+            {
+                read: false,
+            }
+        )
+        .pipe(
+            mocha({
+                require: ["ts-node/register"],
+                ui: "bdd",
+            })
+        );
 }
 
+/**
+ * Compiles the integration tests and transpiles the results to /out
+ */
+function compileIntegrationTests() {
+    const tsProject = gulpTs.createProject("tsconfig.json", {
+        // to test puppeteer we need "dom".
+        // since "dom" overlaps with "webworker" we need to overwrite the lib property.
+        // This is a known ts issue (bot being able to have both webworker and dom): https://github.com/microsoft/TypeScript/issues/20595
+        lib: ["es2019", "dom", "dom.iterable"],
+    });
+    return gulp.src(["src/**/*.ts"]).pipe(tsProject()).pipe(gulp.dest("out"));
+}
+
+/**
+ * Tests the debugger integration tests after transpiling the source files to /out
+ */
+const testDebugger = gulp.series(compileIntegrationTests, async () => {
+    const testRunner = require("./out/debugger/test/runTest");
+    await testRunner.main();
+});
+
 function testWeb() {
-    return gulp
-        .src(['src/web/client/test/unit/**/*.ts'], { read: false })
-        .pipe(mocha({
-                require: [ "ts-node/register" ],
-                ui: 'bdd'
-            }));
+    return gulp.src(["src/web/client/test/unit/**/*.ts"], { read: false }).pipe(
+        mocha({
+            require: ["ts-node/register"],
+            ui: "bdd",
+        })
+    );
 }
 
+// unit tests without special test runner
+const test = gulp.series(testUnitTests, testWeb);
+
+// tests that require vscode-electron (which requires a display or xvfb)
+const testInt = gulp.series(testDebugger);
+
 async function packageVsix() {
     fs.emptyDirSync(packagedir);
     return vsce.createVSIX({
         packagePath: packagedir,
-    })
+    });
 }
 
+
 async function git(args) {
     args.unshift('git');
     const {stdout, stderr } = await exec(args.join(' '));
@@ -257,10 +297,8 @@ const dist = gulp.series(
     recompile,
     packageVsix,
     lint,
-    test,
-    testWeb
+    test
 );
-
 const translationExtensionName = "vscode-powerplatform";
 
 // Extract all the localizable strings from TS and package.nls.json, and package into
@@ -288,7 +326,7 @@ const languages = [
     { id: "it", folderName: "ita" },
     { id: "ja", folderName: "jpn" },
     { id: "ko", folderName: "kor" },
-    { id: "pt-BR", folderName: "ptb"},
+    { id: "pt-BR", folderName: "ptb" },
     { id: "ru", folderName: "rus" },
     { id: "tr", folderName: "trk" },
     { id: "zh-CN", folderName: "chs" },
@@ -346,6 +384,8 @@ exports.snapshot = snapshot;
 exports.lint = lint;
 exports.test = test;
 exports.testWeb = testWeb;
+exports.compileIntegrationTests = compileIntegrationTests;
+exports.testInt = testInt;
 exports.package = packageVsix;
 exports.ci = dist;
 exports.dist = dist;