sync (#1)

* Small repo chores (segmentio#1289)

* Migrate consent integration tests to Playwright (segmentio#1292)

Co-authored-by: Neelkanth Kaushik <[email protected]>

* Fix jira automation (segmentio#1301)

* Update Node.js version to ^20 across the repository (segmentio#1307)

* Expose BaseUserTraits (segmentio#1306)

* change to minor release (segmentio#1310)

* Version Packages (segmentio#1309)

* Update to use new signals specification (segmentio#1311)

* Move signals packages out of repo (segmentio#1315)

* Add architecture documentation (segmentio#1319)

* Update dependencies for snyk issues (segmentio#1321)

* Remove github signals docs folder (segmentio#1322)

* Fix filtering of non-consented device mode integrations (segmentio#1328)

* Version Packages (segmentio#1329)

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* Update RELEASING.md on how to rotate npm tokens (segmentio#1330)

---------

Co-authored-by: Seth Silesky <[email protected]>
Co-authored-by: Neelkanth Kaushik <[email protected]>
Co-authored-by: Chenxiang Zhang <[email protected]>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

Author: 5 people

.buildkite/pipeline.yml

@@ -149,29 +149,21 @@ steps:
     plugins:
       - ssh://[email protected]/segmentio/cache-buildkite-plugin#v2.0.0:
           key: "v1.1-cache-dev-{{ checksum 'yarn.lock' }}"
-
-  - label: '[Signals] Lint + Test'
+          
+  - label: '[Consent] Integration Tests'
     agents:
       queue: v1
     commands:
       - npm config set "//registry.npmjs.org/:_authToken" $${NPM_TOKEN}
       - echo "--- Install dependencies"
       - HUSKY=0 yarn install --immutable
-      - echo "--- Build bundles"
-      - yarn turbo run --filter='./packages/signals/*' build
-      - echo "+++ Assert Generated Files Up-to-Date"
-      - yarn turbo run --filter='./packages/signals/*' assert-generated
-      - echo "+++ Run Lint"
-      - yarn turbo run --filter='./packages/signals/*' lint
-      - echo "+++ Run Tests"
-      - yarn turbo run --filter='./packages/signals/*' test
-      - echo "+++ Run Integration Tests"
-      - yarn turbo run --filter='./packages/signals/*' test:int
+      - echo "--- Build + Test"
+      - yarn turbo run --filter='./packages/consent/consent-tools-integration-tests' test:int
+
     plugins:
       - ssh://[email protected]/segmentio/cache-buildkite-plugin#v2.0.0:
           key: "v1.1-cache-dev-{{ checksum 'yarn.lock' }}"
-          paths: ['.yarn/cache/']
-
+          
   - label: ':thisisfine: [Browser] Destinations QA / E2E'
     key: destinations
     agents:

.eslintrc.js

@@ -1,7 +1,9 @@
 /** @type { import('eslint').Linter.Config } */
 module.exports = {
   root: true,
-  ignorePatterns: ['node_modules', 'dist'],
+  ignorePatterns: require('eslint-gitignore').readGitignoreFiles({
+    cwd: __dirname,
+  }),
   parserOptions: {
     ecmaVersion: 2020,
   },

.github/workflows/ci.yml

@@ -10,7 +10,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [18]
+        node-version: [20]
     steps:
       - uses: actions/checkout@v3
       - uses: actions/setup-node@v3
@@ -39,7 +39,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [18]
+        node-version: [20]
     steps:
       - uses: actions/checkout@v3
       - uses: actions/setup-node@v3
@@ -55,23 +55,3 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-turbo-
       - run: yarn turbo run --filter='./packages/node-integration-tests' test:cloudflare-workers
-  consent-intg-tests:
-    name: Consent Integration Tests
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-
-      - uses: browser-actions/setup-chrome@v1
-      - uses: actions/setup-node@v3
-        with:
-          node-version: 16 # UPDATE TO NODE 20!!!
-          cache: 'yarn'
-      - run: yarn install --immutable
-      - name: Turbo cache
-        uses: actions/cache@v3
-        with:
-          path: node_modules/.cache/turbo
-          key: ${{ runner.os }}-turbo-${{ github.sha }}
-          restore-keys: |
-            ${{ runner.os }}-turbo-
-      - run: yarn turbo run --filter='./packages/consent/consent-tools-integration-tests' test:int

.github/workflows/create-jira.yml

@@ -19,23 +19,18 @@ jobs:
           JIRA_BASE_URL: ${{ secrets.JIRA_BASE_URL }}
           JIRA_USER_EMAIL: ${{ secrets.JIRA_USER_EMAIL }}
           JIRA_API_TOKEN: ${{ secrets.JIRA_TOKEN }}
-
       - name: Create
         id: create
         uses: atlassian/gajira-create@master
         with:
-          project: LIBRARIES
+          project: ${{ secrets.JIRA_PROJECT }}
           issuetype: Bug
           summary: |
             [${{ github.event.repository.name }}] (${{ github.event.issue.number }}): ${{ github.event.issue.title }}
           description: |
             Github Link: ${{ github.event.issue.html_url }}
             ${{ github.event.issue.body }}
-          # Parent and Epic Link fields (set to same)
-          fields: '{
-            "parent": {"key": "LIBRARIES-1963"},
-            "customfield_10002": "LIBRARIES-1963"
-            }'
-
+          fields: '{"parent": {"key": "${{ secrets.JIRA_EPIC_KEY }}"}}'
+      
       - name: Log created issue
         run: echo "Issue ${{ steps.create.outputs.issue }} was created"

.vscode/launch.json

@@ -4,76 +4,64 @@
     {
       "type": "node",
       "request": "launch",
-      "name": "Jest Current File",
-      "program": "${workspaceFolder}/node_modules/.bin/jest",
-      "args": ["--testTimeout=100000", "--findRelatedTests", "${relativeFile}"],
-      "console": "integratedTerminal",
-      "internalConsoleOptions": "neverOpen",
-      "skipFiles": ["<node_internals>/**"]
-    },
-    {
-      "type": "node",
-      "request": "launch",
-      "name": "Jest Watch Current File",
+      "name": "Jest - run only related tests for current file",
       "program": "${workspaceFolder}/node_modules/.bin/jest",
       "args": [
         "--testTimeout=100000",
-        "--watch",
         "--findRelatedTests",
-        "${relativeFile}"
+        "--runInBand",
+        "--verbose",
+        "${relativeFile}",
+        "${input:additionalJestArgs}"
       ],
       "console": "integratedTerminal",
       "internalConsoleOptions": "neverOpen",
       "skipFiles": ["<node_internals>/**"]
     },
     {
-      "name": "Run Jest Tests for Current Package",
+      "name": "Jest - run _all_ tests for current file's package",
       "type": "node",
       "request": "launch",
       "program": "${workspaceFolder}/node_modules/.bin/jest",
-      "args": ["--testTimeout=100000"],
-      "console": "integratedTerminal",
-      "internalConsoleOptions": "neverOpen",
-      "cwd": "${fileDirname}"
-    },
-    {
-      "type": "node",
-      "name": "Jest All",
-      "request": "launch",
-      "args": [
-        "--testTimeout=100000",
-        "-c",
-        "${workspaceFolder}/jest.config.js"
-      ],
-      "cwd": "${workspaceFolder}",
-      "console": "integratedTerminal",
-      "internalConsoleOptions": "neverOpen",
-      "program": "${workspaceFolder}/node_modules/jest/bin/jest",
-      "skipFiles": ["<node_internals>/**"]
-    },
-    {
-      "type": "node",
-      "name": "Jest All: Browser",
-      "request": "launch",
       "args": [
         "--testTimeout=100000",
-        "-c",
-        "${workspaceFolder}/packages/browser/jest.config.js"
+        "--runInBand",
+        "${input:additionalJestArgs}"
       ],
-      "cwd": "${workspaceFolder}",
       "console": "integratedTerminal",
       "internalConsoleOptions": "neverOpen",
-      "program": "${workspaceFolder}/node_modules/jest/bin/jest",
-      "skipFiles": ["<node_internals>/**"]
+      "skipFiles": ["<node_internals>/**"],
+      "cwd": "${fileDirname}"
     },
     {
-      "name": "ts-node Current File",
+      "name": "ts-node - execute current .ts file/script",
       "type": "node",
       "request": "launch",
       "args": ["${relativeFile}"],
       "runtimeArgs": ["-r", "ts-node/register"],
       "cwd": "${workspaceRoot}",
       "internalConsoleOptions": "openOnSessionStart"
     }
+  ],
+  "inputs": [
+    {
+      "id": "additionalJestArgs",
+      "type": "pickString",
+      "description": "(Optional) Select additional Jest arguments",
+      "options": [
+        { "label": "none", "value": "" },
+        { "label": "", "value": "--watch" },
+        { "label": "", "value": "--updateSnapshot" },
+        { "label": "", "value": "--coverage" },
+        { "label": "", "value": "--runInBand" }
+      ],
+      "default": ""
+    },
+    {
+      "id": "packageName",
+      "type": "pickString",
+      "description": "Select a package to debug",
+      "options": ["@segment/analytics-", "package-b", "package-c"]
+    }
   ]
 }

README.md

@@ -35,3 +35,4 @@ This library is one of Segment’s most popular Flagship libraries. It is active
 
 - Contribution guidelines: [CONTRIBUTING.md](CONTRIBUTING.md)
 - Development instructions: [DEVELOPMENT.md](DEVELOPMENT.md)
+- Releasing (to npm): [RELEASING.md](RELEASING.md)

RELEASING.md

@@ -80,3 +80,42 @@ yarn release
 Feature branches are automatically released under:
 
 - `http://cdn.segment.com/analytics-next/br/<branch>/<latest|sha>/standalone.js.gz`
+
+## NPM Token Management
+
+### How to Rotate/Update NPM Tokens
+
+The repository uses an NPM token stored in GitHub Actions secrets (`NPM_TOKEN`) to publish packages automatically. Due to npm's security updates, tokens now have a maximum 90-day lifetime and classic tokens will be revoked. You should use **Granular Access Tokens** for better security.
+
+#### Creating a New NPM Token
+
+1. **Generate a new token at npm**:
+   - Go to https://www.npmjs.com/settings/YOUR_USERNAME/tokens
+   - Click "Generate New Token" → "Granular Access Token"
+   - Configure the token:
+     - **Token Name**: Something descriptive like "analytics-next-ci"
+     - **Expiration**: 90 days (maximum)
+     - **Permissions**: Select "Read and write"
+     - **Packages and scopes**: Select packages in `@segment` organization
+   - Copy the token (starts with `npm_`)
+
+2. **Test the token locally**:
+   ```bash
+   # Add token to your ~/.npmrc
+   echo "//registry.npmjs.org/:_authToken=YOUR_NEW_TOKEN" > ~/.npmrc
+
+   # Verify authentication
+   npm whoami
+
+   # Build packages
+   yarn build
+
+   # Test dry-run publish (doesn't actually publish)
+   cd packages/core && npm publish --dry-run
+   cd ../browser && npm publish --dry-run
+   cd ../node && npm publish --dry-run
+   ```
+
+3. **Update GitHub Actions Secret**:
+   - Go to: https://github.com/segmentio/analytics-next/settings/secrets/actions
+   - Update secret for `NPM_TOKEN`

jest.config.js

@@ -17,7 +17,6 @@ module.exports = () =>
       '<rootDir>/packages/consent/consent-tools',
       '<rootDir>/packages/consent/consent-wrapper-onetrust',
       '<rootDir>/scripts',
-      '<rootDir>/packages/signals/signals',
       '<rootDir>/packages/test-helpers',
     ],
   })

meta-tests/check-dts.ts

@@ -2,6 +2,7 @@ import { exec } from 'child_process'
 import { promisify } from 'util'
 import path from 'path'
 import fs from 'fs'
+import getPackages from 'get-monorepo-packages'
 
 /**
  * This script is for extra typechecking of the built .d.ts files in {package_name}/dist/types/*.
@@ -11,13 +12,18 @@ import fs from 'fs'
  */
 const execa = promisify(exec)
 
-const allPublicPackageDirNames = [
-  'browser',
-  'core',
-  'node',
-  'signals/signals',
-  'signals/signals-runtime',
-] as const
+// Get public packages programmatically
+const packages = getPackages(path.join(__dirname, '..'))
+const publicPackageNames = [
+  '@segment/analytics-next',
+  '@segment/analytics-core',
+  '@segment/analytics-node',
+]
+
+const allPublicPackageDirNames = packages
+  .filter((pkg) => publicPackageNames.includes(pkg.package.name))
+  .map((pkg) => path.relative('packages', pkg.location))
+  .sort() as readonly string[]
 
 type PackageDirName = typeof allPublicPackageDirNames[number]
 

package.json

@@ -6,21 +6,21 @@
     "playgrounds/*",
     "packages/*",
     "packages/consent/*",
-    "packages/signals/*",
     "scripts"
   ],
   "engines": {
-    "node": "^20"
+    "node": ">=20"
   },
   "scripts": {
     "test": "jest",
     "test:check-dts": "yarn build && yarn ts-node meta-tests/check-dts.ts",
     "test:node-int": "turbo run --filter=node-integration-tests test",
     "lint": "yarn constraints && turbo run lint --continue",
+    "typecheck": "turbo run tsc --filter='./packages/**'",
     "build": "turbo run build --filter='./packages/**'",
     "watch": "turbo run watch --filter='./packages/**'",
     "dev": "yarn workspace @playground/next-playground run dev",
-    "prepush": "turbo run lint --filter='...[master...HEAD]'",
+    "prepush": "turbo run tsc --affected",
     "postinstall": "husky install",
     "changeset": "changeset",
     "update-versions-and-changelogs": "changeset version && yarn version-run-all && bash scripts/update-lockfile.sh",
@@ -49,6 +49,7 @@
     "concurrently": "^7.6.0",
     "eslint": "^8.14.0",
     "eslint-config-prettier": "^8.5.0",
+    "eslint-gitignore": "^0.1.0",
     "eslint-plugin-import": "^2.27.5",
     "eslint-plugin-jest": "^27.2.2",
     "eslint-plugin-prettier": "^4.0.0",