Package the latest version of extension for smoke test (#2405)

EzioLi01 · EzioLi1123 · web-flow · commit 3016b3b0a1ee · 2025-09-08T16:23:45.000+08:00
* Package the latest version of extension for smoke test

* Update

* Update

* Update

* Update

* Update

* Update

* Update

* Update

* Update

---------

Co-authored-by: EzioLi &lt;eziolyk3@outlook.com&gt;
diff --git a/.ci/common-validation.yml b/.ci/common-validation.yml
@@ -1,12 +1,14 @@
 steps:
   - task: NodeTool@0
-    displayName: "Use Node 18.x"
+    displayName: "Use Node 20.x"
     inputs:
-      versionSpec: 18.x
-  - bash: npm install gulp react-devtools @vscode/vsce -g --force
-    displayName: "npm install gulp react-devtools @vscode/vsce -g"
+      versionSpec: 20.x
+  - bash: npm install gulp @vscode/vsce -g --force
+    displayName: "npm install gulp @vscode/vsce -g"
   - bash: npm ci
     displayName: "npm ci"
+  - bash: gulp
+    displayName: "gulp"
   - bash: npm run build
     displayName: "npm run build"
   - bash: |
diff --git a/.ci/smoke-tests-common-validation.yml b/.ci/smoke-tests-common-validation.yml
@@ -1,4 +1,12 @@
 steps:
+  - script: gulp release --nightly --no-yarn --no-prepublish
+    displayName: "gulp release"
+  - task: CopyFiles@2
+    displayName: "Copy Files to: $(Build.ArtifactStagingDirectory)"
+    inputs:
+      Contents: |
+        $(System.DefaultWorkingDirectory)/*.vsix
+      TargetFolder: "$(System.DefaultWorkingDirectory)/test/smoke/resources/extension"
   - bash: npm run prepare-smoke-tests
     displayName: "Prepare smoke tests"
   - bash: npm run smoke-tests --verbose
@@ -8,6 +16,6 @@ steps:
   - task: PublishBuildArtifacts@1
     displayName: "Publish screenshots"
     inputs:
-      PathtoPublish: '$(System.DefaultWorkingDirectory)/test/smoke/screenshots'
+      PathtoPublish: "$(System.DefaultWorkingDirectory)/test/smoke/screenshots"
       ArtifactName: 'smoke-test-screenshots'
       publishLocation: 'Container'
diff --git a/gulp_scripts/cleaner.js b/gulp_scripts/cleaner.js
@@ -1,6 +1,7 @@
 const del = require("del");
+const GulpExtras = require("../tools/gulp-extras");
 
-function clean() {
+async function clean() {
     const pathsToDelete = [
         "src/**/*.js",
         "src/**/*.js.map",
@@ -14,7 +15,17 @@ function clean() {
         "nls.*.json",
         "!test/smoke/**/*",
     ];
-    return del(pathsToDelete, { force: true });
+
+    const TIMEOUT_MS = 5000;
+
+    return await GulpExtras.withTimeout(
+        del(pathsToDelete, { force: true }),
+        TIMEOUT_MS,
+        {
+            onTimeout: () => console.log("Timeout for clean up, will try on next step, but may cause other failures."),
+            fallbackValue: [],
+        }
+    );
 }
 
 module.exports = {
diff --git a/gulp_scripts/release.js b/gulp_scripts/release.js
@@ -7,6 +7,7 @@ const GulpExtras = require("../tools/gulp-extras");
 
 const isNightly = process.argv.includes("--nightly");
 const useNpm = process.argv.includes("--no-yarn");
+const isPrepublish = process.argv.includes("--no-prepublish");
 const extensionName = isNightly ? "vscode-react-native-preview" : "vscode-react-native";
 const executeCommand = GulpExtras.executeCommand;
 
@@ -46,6 +47,13 @@ function prepareLicenses() {
         .then(() => {
             let packageJson = readJson("/package.json");
             packageJson.main = "/dist/rn-extension";
+
+            if (isPrepublish) {
+                log("Ignore vscode:prepublish script before vsce package");
+                const scripts = packageJson.scripts;
+                delete scripts["vscode:prepublish"];
+            }
+
             if (isNightly) {
                 log("Performing gulp release...");
                 packageJson.version = getVersionNumber();
diff --git a/package.json b/package.json
@@ -30,6 +30,7 @@
   ],
   "activationEvents": [
     "workspaceContains:node_modules/react-native",
+    "workspaceContains:metro.config.js",
     "onDebugResolve:reactnative",
     "onDebugResolve:reactnativedirect",
     "onDebugDynamicConfigurations:reactnative",
diff --git a/test/smoke/resources/extension/extension.vsix b/test/smoke/resources/extension/extension.vsix
diff --git a/test/smoke/suites/commands.test.ts b/test/smoke/suites/commands.test.ts
@@ -29,6 +29,7 @@ export function startCommandPaletteTests(): void {
         it("Verify react native command is visible in command palette", async () => {
             await initApp();
             const page = app.getMainPage();
+
             const cmdKey = process.platform === "darwin" ? "Meta" : "Control";
 
             await page.keyboard.press(`${cmdKey}+Shift+P`);
@@ -44,7 +45,7 @@ export function startCommandPaletteTests(): void {
             try {
                 assert.ok(value?.includes("React Native: Start Packager"));
             } catch {
-                await screenshots.takeScreenshots("CommandVisibleTest");
+                await screenshots.takeScreenshots("CommandPaletteTest", "VerifyCommandVisible");
             }
         });
     });
diff --git a/test/smoke/suites/helper/application.ts b/test/smoke/suites/helper/application.ts
@@ -59,6 +59,14 @@ export class Application {
             SmokeTestLogger.info("Cannot clean up user data, will try it again in test setup.");
         }
 
+        try {
+            await this.cleanExtensionData();
+        } catch {
+            SmokeTestLogger.info(
+                "Cannot clean up extension data, will try it again in test setup.",
+            );
+        }
+
         if (this.app) {
             await this.app.close();
             this.app = null;
@@ -76,7 +84,12 @@ export class Application {
 
         extensionFile = path.join(this.vsixDirectory, extensionFile);
         args.push(`--install-extension=${extensionFile}`);
-        utilities.spawnSync(cliPath, args, { stdio: "inherit", shell: true });
+
+        if (process.platform == "win32") {
+            utilities.spawnSync(cliPath, args, { stdio: "inherit", shell: true });
+        } else {
+            utilities.spawnSync(cliPath, args, { stdio: "inherit" });
+        }
 
         this.extension = new Extension();
         return this.extension;
@@ -97,4 +110,11 @@ export class Application {
             rimraf.sync(this.userDataDirectory);
         }
     }
+
+    async cleanExtensionData(): Promise<void> {
+        if (fs.existsSync(this.extensionDirectory)) {
+            SmokeTestLogger.info(`*** Deleting VS Code extension dir: ${this.extensionDirectory}`);
+            rimraf.sync(this.extensionDirectory);
+        }
+    }
 }
diff --git a/test/smoke/suites/helper/screenshot.ts b/test/smoke/suites/helper/screenshot.ts
@@ -7,18 +7,34 @@ export class Screenshots {
     private application = app;
     private screenshotFolder = path.join(__dirname, "..", "..", "screenshots");
 
-    async createScreenshotsFolder(): Promise<void> {
+    async createScreenshotsFolder(platform: string): Promise<void> {
         if (!fs.existsSync(this.screenshotFolder)) {
-            mkdirp.sync(this.screenshotFolder);
+            mkdirp.sync(path.join(this.screenshotFolder, platform));
         }
     }
 
-    async takeScreenshots(fileName: string): Promise<void> {
-        await this.createScreenshotsFolder();
+    async prepareScreenshotFolderForPlatform(): Promise<string> {
+        switch (process.platform) {
+            case "win32":
+                await this.createScreenshotsFolder("windows");
+                return "windows";
+            case "linux":
+                await this.createScreenshotsFolder("linux");
+                return "linux";
+            case "darwin":
+                await this.createScreenshotsFolder("macos");
+                return "macos";
+            default:
+                return "other";
+        }
+    }
+
+    async takeScreenshots(suiteName: string, fileName: string): Promise<void> {
+        const platform = await this.prepareScreenshotFolderForPlatform();
 
         const mainPage = this.application.getMainPage();
         await mainPage.screenshot({
-            path: `screenshots/commandPaletteTest/${fileName}.jpg`,
+            path: `screenshots/${platform}/${suiteName}/${fileName}.jpg`,
             fullPage: true,
         });
     }
diff --git a/test/smoke/suites/main.ts b/test/smoke/suites/main.ts
@@ -13,8 +13,9 @@ startSmokeTests(setUp, cleanUp);
 async function setUp(): Promise<void> {
     const vscodeExecutablePath = await app.downloadVSCodeExecutable();
     await app.cleanUserData();
+    await app.cleanExtensionData();
     await app.installExtensionFromVSIX(vscodeExecutablePath);
-    await screenshots.createScreenshotsFolder();
+    await screenshots.prepareScreenshotFolderForPlatform();
 }
 
 async function cleanUp(): Promise<void> {
diff --git a/tools/gulp-extras.js b/tools/gulp-extras.js
@@ -4,10 +4,10 @@
 
 const child_process = require("child_process");
 const fs = require("fs");
-const log = require('fancy-log');
-const colors = require('ansi-colors');
+const log = require("fancy-log");
+const colors = require("ansi-colors");
 const path = require("path");
-const PluginError = require('plugin-error');
+const PluginError = require("plugin-error");
 const through = require("through2");
 
 /**
@@ -27,29 +27,35 @@ function logError(pluginName, file, message) {
 function checkCopyright() {
     const pluginName = "check-copyright";
     let hadErrors = false;
-    const copyrightNotice = "// Copyright (c) Microsoft Corporation. All rights reserved.\n// Licensed under the MIT license. See LICENSE file in the project root for details.";
-
-    return through.obj(function (file, encoding, callback) {
-        if (file.isBuffer()) {
-            let fileContents = file.contents.toString(encoding);
-            fileContents = fileContents.replace("\r\n", "\n");
-            fileContents = fileContents.replace("\"use strict\";\n", "");
-            fileContents = fileContents.replace("Object.defineProperty(exports, \"__esModule\", { value: true });\n", "");
-
-            if (fileContents.indexOf(copyrightNotice) !== 0) {
-                logError(pluginName, file, "missing copyright notice");
-                hadErrors = true;
+    const copyrightNotice =
+        "// Copyright (c) Microsoft Corporation. All rights reserved.\n// Licensed under the MIT license. See LICENSE file in the project root for details.";
+
+    return through.obj(
+        function (file, encoding, callback) {
+            if (file.isBuffer()) {
+                let fileContents = file.contents.toString(encoding);
+                fileContents = fileContents.replace("\r\n", "\n");
+                fileContents = fileContents.replace('"use strict";\n', "");
+                fileContents = fileContents.replace(
+                    'Object.defineProperty(exports, "__esModule", { value: true });\n',
+                    "",
+                );
+
+                if (fileContents.indexOf(copyrightNotice) !== 0) {
+                    logError(pluginName, file, "missing copyright notice");
+                    hadErrors = true;
+                }
             }
-        }
 
-        callback(null, file);
-    },
+            callback(null, file);
+        },
         function (callback) {
             if (hadErrors) {
                 return this.emit("error", new PluginError(pluginName, "Failed copyright check"));
             }
             callback();
-        });
+        },
+    );
 }
 
 /**
@@ -67,25 +73,29 @@ function existsCaseSensitive(filePath) {
 }
 
 function executeCommand(command, args, callback, opts) {
-    const proc = child_process.spawn(command + (process.platform === "win32" ? ".cmd" : ""), args, Object.assign({}, opts, { shell: true }));
+    const proc = child_process.spawn(
+        command + (process.platform === "win32" ? ".cmd" : ""),
+        args,
+        Object.assign({}, opts, { shell: true }),
+    );
     let errorSignaled = false;
 
-    proc.stdout.on("data", (data) => {
+    proc.stdout.on("data", data => {
         log(`${data}`);
     });
 
-    proc.stderr.on("data", (data) => {
+    proc.stderr.on("data", data => {
         log.error(`${data}`);
     });
 
-    proc.on("error", (error) => {
+    proc.on("error", error => {
         if (!errorSignaled) {
             callback(`An error occurred. ${error}`);
             errorSignaled = true;
         }
     });
 
-    proc.on("exit", (code) => {
+    proc.on("exit", code => {
         if (code === 0) {
             callback();
         } else if (!errorSignaled) {
@@ -95,7 +105,29 @@ function executeCommand(command, args, callback, opts) {
     });
 }
 
+async function withTimeout(promise, ms, { onTimeout, fallbackValue } = {}) {
+    let timer;
+    const guarded = promise
+        .then(value => ({ kind: "ok", value }))
+        .catch(error => ({ kind: "error", error }));
+
+    const timed = new Promise(resolve => {
+        timer = setTimeout(() => {
+            if (onTimeout) onTimeout();
+            resolve({ kind: "timeout", value: fallbackValue });
+        }, ms);
+    });
+
+    const result = await Promise.race([guarded, timed]);
+    clearTimeout(timer);
+
+    if (result.kind === "error") throw result.error;
+    if (result.kind === "timeout") return result.value;
+    return result.value;
+}
+
 module.exports = {
     checkCopyright,
-    executeCommand
-}
+    executeCommand,
+    withTimeout,
+};
