Fix rush changelog; update changefile detection regex and add unit tests (#5315)

Author: JamesBurnside

.github/workflows/ci.yml

@@ -106,6 +106,9 @@ jobs:
       # Typescript version check
       - name: Typescript version compatibility check
         run: rush build --only @internal/check-typescript-regression
+      # Scripts tests
+      - name: Test scripts/ folder
+        run: rush test --only @internal/scripts
       # Ensure all downstream packlet versions are consitent with the base packlet version
       - name: Ensure all package versions are consistent
         run: rush ensure-consistent-versions

common/config/rush/pnpm-lock.yaml

@@ -1,11 +1,19 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
+// Returns the filename in group1 of the regex match
+const CHANGE_FILE_REGEX = /(?:change|change-beta)\/(@azure-communication-react[^\/]*\.json)(?:.*)?$/;
+
 export function parseNewChangeFiles(stdout) {
-    // Split the output into lines
-    const lines = stdout.split('\n');
-    // Filter out the empty lines (`lines` list might have empty lines as part of the output)
-    const matches = lines.filter(line => line && line.toString().trim().length > 0);
+    // Split the output into lines and filter out the empty lines
+    const stdoutLines = stdout.split('\n').filter(line => line && line.toString().trim().length > 0);
+
     // Parse the change file name from the output (remove the status and return only file information)
-    return matches.map(line => line.split('\t')[1]);
-}
+    const matches = stdoutLines.map(line => {
+        const match = line.match(CHANGE_FILE_REGEX);
+        return match ? match[1] : undefined // Access group 1 (the filename);
+    }
+    ).filter(Boolean); // Filter out nulls
+
+    return matches;
+}

common/config/rush/variants/stable/pnpm-lock.yaml

@@ -0,0 +1,38 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+import { parseNewChangeFiles } from './utils';
+
+describe('parseNewChangeFiles', () => {
+  const testFilename = '@azure-communication-react-3ba4c269-8d22-48da-b905-091fdbaf2f98.json';
+  const testStrings = [
+    `A	change-beta/${testFilename}`,
+    `A       change/${testFilename}`,
+    `randomfolder/change-beta/${testFilename}random text that should be ignored`,
+    `\n\nchange/${testFilename}\s \n \t`
+  ];
+
+  test('parseNewChangeFiles should return the filenames without folder prefixes or other space characters', () => {
+    for (const testString of testStrings) {
+      expect(parseNewChangeFiles(testString)).toStrictEqual([testFilename]);
+    }
+  });
+
+  test('parseNewChangeFiles should return the filenames when multiple files are seperated by newline characters', () => {
+    const test = testStrings.join('\n');
+    const expectedMatch = new Array(testStrings.length).fill(testFilename);
+
+    expect(parseNewChangeFiles(test)).toStrictEqual(expectedMatch);
+  });
+
+  test('parseNewChangeFiles should not return unrecognized lines in amonst legitmate changefiles', () => {
+    const testShouldnotMatch = 'change/randomfile.json';
+    const tests = [
+      testStrings[0],
+      testShouldnotMatch,
+      testStrings[1]
+    ].join('\n');
+    
+    expect(parseNewChangeFiles(tests)).toStrictEqual([testFilename, testFilename]);
+  });
+});

common/scripts/changelog/utils.mjs

@@ -0,0 +1,7 @@
+
+module.exports = {
+  transform: {
+      '^.+\\.jsx?$': ['babel-jest', { configFile: './scripts-tests-setup/babel-config-jest.js' }],
+      '^.+\\.mjs$': ['babel-jest', { configFile: './scripts-tests-setup/babel-config-jest.js' }],
+  },
+};

common/scripts/changelog/utils.test.js

@@ -9,14 +9,18 @@
     "build": "",
     "build:stable": "",
     "clean": "",
-    "test": "",
+    "test": "jest",
     "test:ci-coverage": "",
     "test:stable": "",
     "prettier": "",
     "prettier:check": ""
   },
   "devDependencies": {
+    "@babel/preset-env": "7.23.9",
+    "@jest/transform": "29.7.0",
     "@types/yargs": "^17.0.29",
+    "babel-jest": "^29.5.0",
+    "jest": "29.7.0",
     "yargs": "^17.7.2"
   }
 }

common/scripts/jest.config.js

@@ -0,0 +1,5 @@
+module.exports = {
+    presets: [
+        '@babel/preset-env' // to support `import` syntax in test files
+    ]
+};