[cherrypick:main] Internal Task: Update npm pack sequence (#2244) (#2314

)

[cherrypick:main] remove node 14 (#2308)
[release-3.0] Update publishConfig to use release3

.github/workflows/ci.yml

@@ -16,7 +16,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [ 14, 16, 18, 20 ]
+        node-version: [ 16, 18, 20 ]
 
     steps:
     - uses: actions/checkout@v4

.gitignore

@@ -180,6 +180,7 @@ browser/
 types/
 dist/
 dest/
+drop/
 
 # Don't commit the sub resource integrity generated files
 **/*.integrity.json

examples/AISKU/package.json

@@ -54,5 +54,8 @@
         "@microsoft/applicationinsights-web": "3.0.9",
         "@microsoft/applicationinsights-core-js": "3.0.9",
         "@nevware21/ts-utils": ">= 0.10.5 < 2.x"
+    },
+    "publishConfig": {
+        "tag": "example"
     }
 }

examples/cfgSync/package.json

@@ -67,5 +67,8 @@
         "@microsoft/applicationinsights-web": "3.0.9",
         "@microsoft/applicationinsights-core-js": "3.0.9",
         "@nevware21/ts-utils": ">= 0.10.5 < 2.x"
+    },
+    "publishConfig": {
+        "tag": "example"
     }
 }

examples/dependency/package.json

@@ -55,5 +55,8 @@
         "@microsoft/applicationinsights-dependencies-js": "3.0.9",
         "@microsoft/applicationinsights-core-js": "3.0.9",
         "@nevware21/ts-utils": ">= 0.10.5 < 2.x"
+    },
+    "publishConfig": {
+        "tag": "example"
     }
 }

examples/shared-worker/package.json

@@ -67,5 +67,8 @@
         "@microsoft/applicationinsights-web-snippet": "1.1.7",
         "@microsoft/applicationinsights-core-js": "3.0.9",
         "@nevware21/ts-utils": ">= 0.10.5 < 2.x"
+    },
+    "publishConfig": {
+        "tag": "example"
     }
 }

package.json

@@ -29,6 +29,7 @@
         "ai-min": "node common/scripts/install-run-rush.js ai-min",
         "ai-restore": "node common/scripts/install-run-rush.js ai-restore",
         "npm-pack": "node common/scripts/install-run-rush.js npm-pack --verbose",
+        "npm-package": "node ./tools/release-tools/npm_package.js",
         "npm-publish": "node ./tools/release-tools/npm_publish.js",
         "npm-set-latest": "node ./tools/release-tools/npm_set_latest.js",
         "gh-status": "node ./tools/status-tools/github-status.js"

tools/chrome-debug-extension/manifest.json

@@ -2,8 +2,8 @@
     "name": "Telemetry Viewer",
     "short_name": "Telemetry Viewer",
     "description": "A browser extension that provides a real time view of what's happening in Application Insights including what telemetry is being logged by the web application",
-    "version": "0.4.8",
-    "version_name": "0.4.8",
+    "version": "0.4.9",
+    "version_name": "0.4.9",
     "manifest_version": 2,
     "icons": {
         "16": "images/icon-16.png",

tools/release-tools/npm_package.js

@@ -0,0 +1,166 @@
+const fs = require("fs");
+const child_process = require("child_process");
+
+const packageGroupDef = "./tools/release-tools/package_groups.json";
+let packageGroup;
+let dropFolder;
+let dryRun = "";
+
+function showHelp() {
+    var scriptParts;
+    var scriptName = process.argv[1];
+    if (scriptName.indexOf("\\") !== -1) {
+        scriptParts = scriptName.split("\\");
+        scriptName = scriptParts[scriptParts.length - 1];
+    } else if (scriptName.indexOf("/") !== -1) {
+        scriptParts = scriptName.split("/");
+        scriptName = scriptParts[scriptParts.length - 1];
+    }
+
+    console.log("");
+    console.log(scriptName + " <group> ");
+    console.log("--------------------------");
+    console.log(" <group>      - Identifies the group to publish, identifies folders, the group must be defined in package_groups.json");
+    console.log(" <dropFolder> - Identifies the base folder to drop the packages into, defaults to ./drop/packages/<group>");
+}
+
+function parseArgs() {
+    console.log("Parsing args - " + process.argv.join(" "));
+    if (process.argv.length < 2) {
+        console.error("!!! Invalid number of arguments -- " + process.argv.length);
+        return false;
+    }
+
+    let idx = 2;
+    while (idx < process.argv.length) {
+        let theArg = process.argv[idx];
+        if (theArg.startsWith("-")) {
+            if (theArg === "-test") {
+                dryRun = "--dry-run";
+            } else {
+                console.error("!!! Unknown switch [" + theArg + "] detected");
+                return false;
+            }
+        } else if (!packageGroup) {
+            packageGroup = theArg;
+        } else if (!dropFolder) {
+            dropFolder = theArg;
+        } else {
+            console.error("!!! Invalid Argument [" + theArg + "] detected");
+            return false;
+        }
+
+        idx++;
+    }
+
+    // Check for required arguments
+    if (!packageGroup) {
+        console.error("!!! Missing package group");
+        return false;
+    }
+
+    return true;
+}
+
+function removeTrailingComma(text) {
+    return text.replace(/,(\s*[}\],])/g, "$1");
+}
+
+function removeComments(text) {
+    return text.replace(/^\s*\/\/\s.*$/gm, "");
+}
+
+function getPackage(packageJsonFile) {
+    var packageText = removeTrailingComma(fs.readFileSync(packageJsonFile, "utf-8"));
+
+    return JSON.parse(packageText);
+}
+
+function getNpmPackageName(packageJson) {
+    let packageName = packageJson.name;
+    let packageVersion = packageJson.version;
+
+    let theNpmPackageName = packageName + "-" + packageVersion;
+
+    theNpmPackageName = theNpmPackageName.replace("@", "").replace("/", "-");
+
+    return theNpmPackageName + ".tgz";
+}
+
+function getGroupProjects() {
+    if (!fs.existsSync(packageGroupDef)) {
+        console.error("!!! Unable to locate package group definitions [" + packageGroupDef + "]");
+        throw new Error("!!! Unable to locate package group definitions.");
+    }
+
+    var groupText = removeComments(removeTrailingComma(fs.readFileSync(packageGroupDef, "utf-8")));
+
+    let groupJson = JSON.parse(groupText);
+    return groupJson[packageGroup] || [];
+}
+
+function movePackage(npmPackageName, packageName) {
+    let packageFolder = dropFolder;
+    if (!packageFolder) {
+        packageFolder = "./drop/packages";
+        packageFolder += "/" + packageGroup;
+    }
+
+    if (!fs.existsSync(packageFolder)) {
+        fs.mkdirSync(packageFolder, { recursive: true });
+    }
+
+    let packageFile = packageFolder + "/" + packageName;
+    if (fs.existsSync(packageFile)) {
+        console.log(` -- Removing existing package ${packageFile}`);
+        fs.unlinkSync(packageFile);
+    }
+
+    console.log(` -- Moving ${npmPackageName} to ${packageFile}`);
+    fs.renameSync(npmPackageName, packageFile);
+}
+
+if (parseArgs()) {
+    var packages = getGroupProjects();
+
+    console.log(`Creating [${packageGroup}] packages => ${packages.length}`);
+    packages.forEach((packageRoot) => {
+        let packageJsonFile = packageRoot + "/package.json";
+
+        if (!fs.existsSync(packageJsonFile)) {
+            console.error("!!! Source package.json doesn't exist [" + packageJsonFile + "]");
+            throw new Error("!!! Source package.json doesn't exist [" + packageJsonFile + "]");
+        }
+
+        const packageJson = getPackage(packageJsonFile);
+
+        const packageName = getNpmPackageName(packageJson);
+        console.log("\n\n##################################################################");
+        console.log("Packaging - " + packageName);
+        console.log("##################################################################");
+
+        let npmPackageName = packageRoot + "/" + packageName;
+        if (fs.existsSync(npmPackageName)) {
+            console.log(` -- Removing existing package ${npmPackageName}`);
+            fs.unlinkSync(npmPackageName);
+        }
+
+        const cwd = process.cwd();
+        process.chdir(packageRoot);
+        try {
+            let npmCmd = `npm pack ${dryRun}`;
+            console.log(`Running: \"${npmCmd}\"`);
+            child_process.execSync(npmCmd);
+        } finally {
+            process.chdir(cwd);
+        }
+
+        if (!dryRun) {
+            // Move the package to the package folder
+            movePackage(npmPackageName, packageName);
+        }
+    });
+} else {
+    showHelp();
+    process.exit(1);
+}

tools/release-tools/npm_publish.js

@@ -48,6 +48,12 @@ function parseArgs() {
         idx++;
     }
 
+    // Check for required arguments
+    if (!packageGroup) {
+        console.error("!!! Missing package group");
+        return false;
+    }
+
     return true;
 }
 

tools/release-tools/package_groups.json

@@ -53,5 +53,11 @@
     // Snippet packages
     "snippet": [
         "./tools/applicationinsights-web-snippet"
+    ],
+    "examples": [
+        "./examples/AISKU",
+        "./examples/cfgSync",
+        "./examples/dependency",
+        "./examples/shared-worker"
     ]
 }

tools/release-tools/setVersion.js

@@ -395,16 +395,18 @@ function updatePublishConfig(package, newVersion) {
     let details = getVersionDetails(newVersion);
     let majorVersion = package.version.split(".")[0];
 
+    if (!package.publishConfig) {
+        package.publishConfig = {};
+    }
+
     if (!details.type || details.type === "release") {
-        if (package.publishConfig && package.publishConfig.tag) {
-            // remove any previous tag
-            delete package.publishConfig.tag;
+        // Set the publishing release tag
+        if (majorVersion !== "0") {
+            package.publishConfig.tag = "release" + majorVersion;
+        } else {
+            package.publishConfig.tag = "alpha";
         }
     } else {
-        if (!package.publishConfig) {
-            package.publishConfig = {};
-        }
-
         // Set the publishing tag
         if (details.type === "nightly" || details.type === "dev" || details.type === "beta" || details.type === "alpha") {
             console.log(`   Type - [${details.type}] - ${majorVersion}`);