.github/actions/smoke-tests/action.yml

@@ -0,0 +1,55 @@
+name: Smoke test
+description: 'Execute smoke tests'
+
+inputs:
+    submit-url:
+        description: 'Submit layer url'
+        required: true
+    direct-submit-url:
+        description: 'Direct submission URL to Backtrace instance'
+        required: true
+    sauce-username:
+        description: 'Sauce labs user name'
+        required: true
+    sauce-access-key:
+        description: 'Sauce labs secret'
+        required: true
+    ignore-browser:
+        description: 'Ignore browser smoke-tests'
+        required: false
+        default: 'false'
+    ignore-node:
+        description: 'Ignore node smoke-tests'
+        required: false
+        default: 'false'
+
+runs:
+    using: 'composite'
+    steps:
+        - uses: dorny/paths-filter@v3
+          id: filter
+          with:
+              filters: |
+                  browser:
+                      - 'packages/browser/**'
+                      - 'packages/react/**'
+                      - 'packages/sdk-core/**'
+                  node:
+                      - 'packages/sdk-core/**'
+                      - 'packages/node/**'
+
+        - run: npm run smoketest:node
+          shell: bash
+          if: steps.filter.outputs.node == 'true' && inputs.ignore-node == 'false'
+          env:
+              SMOKETESTS_SUBMIT_LAYER_URL: ${{ inputs.submit-url }}
+              SMOKETESTS_DIRECT_SUBMIT_URL: ${{ inputs.direct-submit-url }}
+
+        - run: npm run smoketest:browser
+          shell: bash
+          if: steps.filter.outputs.browser == 'true' && inputs.ignore-browser == 'false'
+          env:
+              SMOKETESTS_SUBMIT_LAYER_URL: ${{ inputs.submit-url }}
+              SMOKETESTS_DIRECT_SUBMIT_URL: ${{ inputs.direct-submit-url }}
+              SMOKETESTS_SAUCE_USERNAME: ${{ inputs.sauce-username }}
+              SMOKETESTS_SAUCE_ACCESS_KEY: ${{ inputs.sauce-access-key }}

.github/workflows/test.yml

@@ -5,42 +5,119 @@ on:
         branches: [main, dev]
     pull_request:
 
+concurrency:
+    group: ${{ github.workflow }}-${{ github.head_ref || github.ref }}
+    cancel-in-progress: true
+
 jobs:
-    build:
+    test_linux_all:
         runs-on: ubuntu-latest
 
         strategy:
             matrix:
-                node-version: [16.x, 18.x, 20.x]
+                node-version: [20.x]
 
         steps:
-            - uses: actions/checkout@v3
+            - uses: actions/checkout@v4
             - name: Use Node.js ${{ matrix.node-version }}
-              uses: actions/setup-node@v3
+              uses: actions/setup-node@v4
               with:
                   node-version: ${{ matrix.node-version }}
             - run: npm ci
             - run: npm run build
             - run: npm run lint
             - run: npm run format:check
             - run: npm test
+            - name: smoke-test
+              uses: ./.github/actions/smoke-tests
+              with:
+                  submit-url: ${{ secrets.SMOKETESTS_SUBMIT_LAYER_URL }}
+                  direct-submit-url: ${{ secrets.SMOKETESTS_DIRECT_SUBMIT_URL }}
+                  sauce-username: ${{ secrets.SMOKETESTS_SAUCE_USERNAME }}
+                  sauce-access-key: ${{ secrets.SMOKETESTS_SAUCE_ACCESS_KEY }}
 
-    build_pre_workspaces:
+    test_linux:
         runs-on: ubuntu-latest
 
         strategy:
             matrix:
+                build-version: [20.x]
+                node-version: [16.x, 18.x]
+
+        steps:
+            - uses: actions/checkout@v4
+            - name: Build using Node.js ${{ matrix.build-version }}
+              uses: actions/setup-node@v4
+              with:
+                  node-version: ${{ matrix.build-version }}
+            - run: npm ci
+            - run: npm run build
+            - name: Test using Node.js ${{ matrix.node-version }}
+              uses: actions/setup-node@v4
+              with:
+                  node-version: ${{ matrix.node-version }}
+            - run: npm test
+            - name: smoke-test
+              uses: ./.github/actions/smoke-tests
+              with:
+                  submit-url: ${{ secrets.SMOKETESTS_SUBMIT_LAYER_URL }}
+                  direct-submit-url: ${{ secrets.SMOKETESTS_DIRECT_SUBMIT_URL }}
+                  sauce-username: ${{ secrets.SMOKETESTS_SAUCE_USERNAME }}
+                  sauce-access-key: ${{ secrets.SMOKETESTS_SAUCE_ACCESS_KEY }}
+                  ignore-browser: 'true'
+
+    test_linux_pre_workspaces:
+        runs-on: ubuntu-latest
+
+        strategy:
+            matrix:
+                build-version: [20.x]
                 node-version: [14.x]
 
         steps:
-            - uses: actions/checkout@v3
-            - name: Use Node.js ${{ matrix.node-version }}
-              uses: actions/setup-node@v3
+            - uses: actions/checkout@v4
+            - name: Build using Node.js ${{ matrix.build-version }}
+              uses: actions/setup-node@v4
+              with:
+                  node-version: ${{ matrix.build-version }}
+            - run: npm ci
+            - run: npm run build
+            - name: Test using Node.js ${{ matrix.node-version }}
+              uses: actions/setup-node@v4
               with:
                   node-version: ${{ matrix.node-version }}
             - run: npm i -g npm@8
+            - run: npm test
+            - name: smoke-test
+              uses: ./.github/actions/smoke-tests
+              with:
+                  submit-url: ${{ secrets.SMOKETESTS_SUBMIT_LAYER_URL }}
+                  direct-submit-url: ${{ secrets.SMOKETESTS_DIRECT_SUBMIT_URL }}
+                  sauce-username: ${{ secrets.SMOKETESTS_SAUCE_USERNAME }}
+                  sauce-access-key: ${{ secrets.SMOKETESTS_SAUCE_ACCESS_KEY }}
+                  ignore-browser: 'true'
+
+    test_windows:
+        runs-on: windows-latest
+
+        strategy:
+            matrix:
+                node-version: [18.x]
+
+        steps:
+            - uses: actions/checkout@v4
+            - name: Use Node.js ${{ matrix.node-version }}
+              uses: actions/setup-node@v4
+              with:
+                  node-version: ${{ matrix.node-version }}
             - run: npm ci
             - run: npm run build
-            - run: npm run lint
-            - run: npm run format:check
             - run: npm test
+            - name: smoke-test
+              uses: ./.github/actions/smoke-tests
+              with:
+                  submit-url: ${{ secrets.SMOKETESTS_SUBMIT_LAYER_URL }}
+                  direct-submit-url: ${{ secrets.SMOKETESTS_DIRECT_SUBMIT_URL }}
+                  sauce-username: ${{ secrets.SMOKETESTS_SAUCE_USERNAME }}
+                  sauce-access-key: ${{ secrets.SMOKETESTS_SAUCE_ACCESS_KEY }}
+                  ignore-browser: 'true'

.gitignore

@@ -139,3 +139,4 @@ dist/
 # VSCode settings
 settings.json
 
+.rollup.cache/

.husky/commit-msg

@@ -0,0 +1,3 @@
+#!/usr/bin/env sh
+message="$(cat "$1")"
+node .husky/scripts/commit-msg.js "$message"

.husky/pre-commit

@@ -0,0 +1,13 @@
+#!/usr/bin/env sh
+
+# Format modified files
+prettier $(git diff --cached --name-only --diff-filter=ACMR | grep -e ".ts$" | sed 's| |\\ |g') --write --ignore-unknown
+
+# Update index with modified files
+git update-index --again
+
+# Run lint on modified files
+eslint $(git diff --cached --name-only --diff-filter=ACMR | grep -e ".ts$" | sed 's| |\\ |g')
+
+# Update index with modified files
+git update-index --again

.husky/scripts/commit-msg.js

@@ -0,0 +1,173 @@
+/**
+ * This script verifies if the commit message contains a valid prefix
+ * if files have been modified in the following directories:
+ * - packages/** - message must contain the package name prefix (e.g. "sdk-core"),
+ * - tools/** - message must contain the tool name prefix (e.g. "cli"),
+ * - scripts/** - message must contain the "scripts" prefix,
+ * - smoketests/** - message must contain the "smoketests" prefix.
+ *
+ * The list can be extended by modifying VALID_PREFIXES constant.
+ */
+
+const { execSync } = require('child_process');
+const path = require('path');
+const chalk = require('chalk');
+
+/**
+ * Returns `true` if any function of `fns` returns `true`.
+ */
+const oneOf =
+    (...fns) =>
+    (...args) =>
+        fns.some((fn) => fn(...args));
+
+const startsWith = (what) => (str) => str.startsWith(what);
+
+/**
+ * Returns n-th part from left of path.
+ *
+ * @example
+ * console.log(nthPathPart(2)('a/b/c/d')) // 'c'
+ */
+const nthPathPart = (n) => (pathStr) => path.normalize(pathStr).split(path.sep)[n];
+
+/**
+ * Returns array as comma-separated string.
+ */
+const csv = (array) => (array.length ? array.join(', ') : '<none>');
+
+/**
+ * Case-insensitive string equality check.
+ */
+const ciEquals = (a, b) => a.localeCompare(b, undefined, { sensitivity: 'accent' }) === 0;
+
+/**
+ * Expected change prefixes, in form of `[predicate, getPrefix]` functions:
+ * - `predicate`: `(modifiedFile: string) => boolean` - should return `true` if `modifiedFile` should have the prefix
+ * - `getPrefix`: `(modifiedFile: string) => string` - should return prefix value
+ */
+const VALID_PREFIXES = [
+    // packages/sdk-core/file.ts => sdk-core
+    // tools/cli/file.ts => cli
+    [oneOf(startsWith('packages/'), startsWith('tools/')), nthPathPart(1)],
+
+    // smoketests/dir/file.ts => smoketests
+    // scripts/dir/file.ts => scripts
+    [oneOf(startsWith('smoketests/'), startsWith('scripts/')), nthPathPart(0)],
+];
+
+/**
+ * Retrieves change prefix from file path, e.g. "sdk-core" for "packages/sdk-core/file.ts".
+ */
+function getChangePrefix(filePath) {
+    for (const [test, prefix] of VALID_PREFIXES) {
+        if (test(filePath)) {
+            return prefix(filePath);
+        }
+    }
+}
+
+/**
+ * Returns unique values of `values`.
+ */
+function unique(...values) {
+    return [...new Set(...values)];
+}
+
+/**
+ * Returns all expected prefixes for `modifiedFiles`.
+ */
+function getExpectedPrefixes(modifiedFiles) {
+    return unique(modifiedFiles.split('\n').map(getChangePrefix)).filter((f) => !!f);
+}
+
+/**
+ * Returns all used prefixes in `message`.
+ */
+function getActualPrefixes(message) {
+    if (!message.includes(':')) {
+        return [[], message];
+    }
+
+    const [prefix, rest] = message.split(':');
+    if (!prefix) {
+        return [[], message];
+    }
+
+    return [prefix.split(', '), (rest && rest.trim()) || ''];
+}
+
+/**
+ * Returns all prefixes that are in `expected`, but not in `actual`.
+ */
+function getMissingPrefixes(expected, actual) {
+    const missing = [];
+
+    for (const prefix of expected) {
+        if (!actual.includes(prefix)) {
+            missing.push(prefix);
+        }
+    }
+
+    return missing;
+}
+
+/**
+ * Returns normalized expected prefixes based on what is missing and what was provided.
+ * Normalization changes the case to match expected.
+ */
+function normalizeExpectedPrefixes(expected, missing, actual) {
+    const normalizedActual = actual.map((a) => expected.find((e) => ciEquals(a, e)) || a);
+    const missingFromNormalized = missing.filter((m) => !normalizedActual.includes(m));
+    return [...normalizedActual, ...missingFromNormalized];
+}
+
+/**
+ * Displays error banner in format of:
+ * ```
+ * ===============
+ * ==== error ====
+ * ===============
+ * ```
+ */
+function banner(str) {
+    const repeat = (n, what) => [...new Array(n)].map(() => what).join('');
+
+    console.error(chalk.red(repeat(str.length + 10, '=')));
+    console.error(chalk.red(`${repeat(4, '=')} ${str.toUpperCase()} ${repeat(4, '=')}`));
+    console.error(chalk.red(repeat(str.length + 10, '=')));
+}
+
+const message = process.argv[2];
+const modifiedFiles = execSync('git diff --cached --name-only').toString('utf-8');
+const expected = getExpectedPrefixes(modifiedFiles);
+const [actual, rest] = getActualPrefixes(message);
+
+if (!actual.length) {
+    banner('Commit message is invalid - missing prefix');
+
+    console.error('To better describe commit messages, we require including prefixes based on file changes:');
+    console.error('');
+    console.error(chalk.gray('>'), 'prefix1, prefix2: brief description of change');
+    console.error('');
+    console.error('Suggested message:');
+    console.error('');
+    console.error(chalk.red(`- ${message}`));
+    console.error(chalk.green(`+ ${expected.length ? csv(expected) : 'prefix'}: ${message}`));
+
+    process.exit(1);
+}
+
+const missing = getMissingPrefixes(expected, actual);
+if (missing.length) {
+    banner('Commit message is invalid - invalid prefixes');
+
+    console.error('Some prefixes are missing based on changed files:');
+    console.error(chalk.red(`- ${csv(missing)}`));
+    console.error('');
+    console.error('Suggested message:');
+    console.error(chalk.red(`- ${csv(actual)}: ${rest}`));
+    console.error(chalk.green(`+ ${csv(normalizeExpectedPrefixes(expected, missing, actual))}: ${rest}`));
+
+    process.exit(1);
+}

.prettierrc → .prettierrc.json

@@ -1,8 +1,8 @@
 {
   "printWidth": 120,
-  "proseWrap": "always",
   "singleQuote": true,
   "trailingComma": "all",
   "arrowParens": "always",
-  "tabWidth": 4
+  "tabWidth": 4,
+  "endOfLine": "auto"
 }