ci: Streamline browser & node unit tests#13307

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mydea merged 3 commits into from
Aug 14, 2024
Merged

ci: Streamline browser & node unit tests #13307

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4af1d6a
ci: Streamline browser & node unit tests
mydea Aug 12, 2024
6b76889
add to checklist
mydea Aug 12, 2024
b1a6966
skip eslint test in node 14
mydea Aug 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/new-sdk-release-checklist.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -45,8 +45,8 @@ differ slightly for other SDKs depending on how they are structured and how they

- [ ] Make sure `build.yml` CI script is correctly set up to cover tests for the new package

- [ ] Ensure dependent packages are correctly set for “Determine changed packages”
- [ ] Ensure unit tests run correctly
- [ ] If it is a browser SDK, add it to `BROWSER_TEST_PACKAGES` in `scripts/ci-unit-tests.ts`

- [ ] Make sure the file paths in the
["Upload Artifacts" job](https://github.com/getsentry/sentry-javascript/blob/e5c1486eed236b878f2c49d6a04be86093816ac9/.github/workflows/build.yml#L314-L349)
Expand Down
8 changes: 4 additions & 4 deletions package.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -35,10 +35,10 @@
"test:unit": "lerna run --ignore \"@sentry-internal/{browser-integration-tests,e2e-tests,integration-shims,node-integration-tests,overhead-metrics}\" test:unit",
"test:update-snapshots": "lerna run test:update-snapshots",
"test:pr": "nx affected -t test --exclude \"@sentry-internal/{browser-integration-tests,e2e-tests,integration-shims,node-integration-tests,overhead-metrics}\"",
"test:pr:browser": "yarn test:pr --exclude \"@sentry/{core,utils,opentelemetry,bun,deno,node,profiling-node,aws-serverless,google-cloud-serverless,nextjs,nestjs,astro,cloudflare,solidstart,nuxt,remix,gatsby,sveltekit,vercel-edge}\"",
"test:pr:node": "ts-node ./scripts/node-unit-tests.ts --affected",
"test:ci:browser": "lerna run test --ignore \"@sentry/{core,utils,opentelemetry,bun,deno,node,profiling-node,aws-serverless,google-cloud-serverless,nextjs,nestjs,astro,cloudflare,solidstart,nuxt,remix,gatsby,sveltekit,vercel-edge}\" --ignore \"@sentry-internal/{browser-integration-tests,e2e-tests,integration-shims,node-integration-tests,overhead-metrics}\"",
"test:ci:node": "ts-node ./scripts/node-unit-tests.ts",
"test:pr:browser": "UNIT_TEST_ENV=browser ts-node ./scripts/ci-unit-tests.ts --affected",
"test:pr:node": "UNIT_TEST_ENV=node ts-node ./scripts/ci-unit-tests.ts --affected",
"test:ci:browser": "UNIT_TEST_ENV=browser ts-node ./scripts/ci-unit-tests.ts",
"test:ci:node": "UNIT_TEST_ENV=node ts-node ./scripts/ci-unit-tests.ts",
"test:ci:bun": "lerna run test --scope @sentry/bun",
"yalc:publish": "lerna run yalc:publish"
},
Expand Down
92 changes: 65 additions & 27 deletions scripts/node-unit-tests.ts → scripts/ci-unit-tests.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,24 @@
import * as childProcess from 'child_process';
import * as fs from 'fs';
import * as path from 'path';

type NodeVersion = '14' | '16' | '18' | '20' | '21';

interface VersionConfig {
ignoredPackages: Array<`@${'sentry' | 'sentry-internal'}/${string}`>;
}

const UNIT_TEST_ENV = process.env.UNIT_TEST_ENV as 'node' | 'browser' | undefined;

const CURRENT_NODE_VERSION = process.version.replace('v', '').split('.')[0] as NodeVersion;

const RUN_AFFECTED = process.argv.includes('--affected');

const DEFAULT_SKIP_TESTS_PACKAGES = [
'@sentry-internal/eslint-plugin-sdk',
// These packages are tested separately in CI, so no need to run them here
const DEFAULT_SKIP_PACKAGES = ['@sentry/profiling-node', '@sentry/bun', '@sentry/deno'];

// All other packages are run for multiple node versions
const BROWSER_TEST_PACKAGES = [
'@sentry/ember',
'@sentry/browser',
'@sentry/vue',
Expand All@@ -26,10 +33,9 @@ const DEFAULT_SKIP_TESTS_PACKAGES = [
'@sentry-internal/replay-worker',
'@sentry-internal/feedback',
'@sentry/wasm',
'@sentry/bun',
'@sentry/deno',
];

// These are Node-version specific tests that need to be skipped because of support
const SKIP_TEST_PACKAGES: Record<NodeVersion, VersionConfig> = {
'14': {
ignoredPackages: [
Expand All@@ -40,6 +46,7 @@ const SKIP_TEST_PACKAGES: Record<NodeVersion, VersionConfig> = {
'@sentry/astro',
'@sentry/nuxt',
'@sentry/nestjs',
'@sentry-internal/eslint-plugin-sdk',

@AbhiPrasadAbhiPrasadAug 12, 2024

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A micro optimization here is to change eslint-plugin-sdk to only run test for whatever the node version of the local env is.

We can effectively treat it as a browser test then.

@mydeamydeaAug 12, 2024

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

actually I guess we should technically run this in multiple node versions, as this is published? 🤔 and actually probably bump the min. node version of this to 16+ as it does not seem to work on 14... 😅 it's internal so I wouild not care about this too much 🤔 WDYT?

],
},
'16': {
Expand All@@ -56,6 +63,50 @@ const SKIP_TEST_PACKAGES: Record<NodeVersion, VersionConfig> = {
},
};

function getAllPackages(): string[] {
const { workspaces }: { workspaces: string[] } = JSON.parse(
fs.readFileSync(path.join(process.cwd(), 'package.json'), 'utf-8'),
);

return workspaces.map(workspacePath => {
const { name }: { name: string } = JSON.parse(
fs.readFileSync(path.join(process.cwd(), workspacePath, 'package.json'), 'utf-8'),
);
return name;
});
}

/**
* Run the tests, accounting for compatibility problems in older versions of Node.
*/
function runTests(): void {
const ignores = new Set<string>(DEFAULT_SKIP_PACKAGES);

const packages = getAllPackages();

if (UNIT_TEST_ENV === 'browser') {
// Since we cannot "include" for affected mode, we instead exclude all other packages
packages.forEach(pkg => {
if (!BROWSER_TEST_PACKAGES.includes(pkg)) {
ignores.add(pkg);
}
});
} else if (UNIT_TEST_ENV === 'node') {
BROWSER_TEST_PACKAGES.forEach(pkg => ignores.add(pkg));
}

const versionConfig = SKIP_TEST_PACKAGES[CURRENT_NODE_VERSION];
if (versionConfig) {
versionConfig.ignoredPackages.forEach(dep => ignores.add(dep));
}

if (RUN_AFFECTED) {
runAffectedTests(ignores);
} else {
runAllTests(ignores);
}
}

/**
* Run the given shell command, piping the shell process's `stdin`, `stdout`, and `stderr` to that of the current
* process. Returns contents of `stdout`.
Expand All@@ -67,41 +118,28 @@ function run(cmd: string, options?: childProcess.ExecSyncOptions): void {
/**
* Run tests, ignoring the given packages
*/
function runWithIgnores(skipPackages: string[] = []): void {
const ignoreFlags = skipPackages.map(dep => `--ignore="${dep}"`).join(' ');
function runAllTests(ignorePackages: Set<string>): void {
const ignoreFlags = Array.from(ignorePackages)
.map(dep => `--ignore="${dep}"`)
.join(' ');

run(`yarn test ${ignoreFlags}`);
}

/**
* Run affected tests, ignoring the given packages
*/
function runAffectedWithIgnores(skipPackages: string[] = []): void {
function runAffectedTests(ignorePackages: Set<string>): void {
const additionalArgs = process.argv
.slice(2)
.filter(arg => arg !== '--affected')
.join(' ');
const ignoreFlags = skipPackages.map(dep => `--exclude="${dep}"`).join(' ');
run(`yarn test:pr ${ignoreFlags} ${additionalArgs}`);
}

/**
* Run the tests, accounting for compatibility problems in older versions of Node.
*/
function runTests(): void {
const ignores = new Set<string>();

DEFAULT_SKIP_TESTS_PACKAGES.forEach(pkg => ignores.add(pkg));

const versionConfig = SKIP_TEST_PACKAGES[CURRENT_NODE_VERSION];
if (versionConfig) {
versionConfig.ignoredPackages.forEach(dep => ignores.add(dep));
}
const excludeFlags = Array.from(ignorePackages)
.map(dep => `--exclude="${dep}"`)
.join(' ');

if (RUN_AFFECTED) {
runAffectedWithIgnores(Array.from(ignores));
} else {
runWithIgnores(Array.from(ignores));
}
run(`yarn test:pr ${excludeFlags} ${additionalArgs}`);
}

runTests();
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
ci: Streamline browser & node unit tests#13307

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

mydea
merged 3 commits into

from

Aug 14, 2024
 Merged


ci: Streamline browser & node unit tests
#13307
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
4af1d6a

ci: Streamline browser & node unit tests


mydea Aug 12, 2024
6b76889

add to checklist


mydea Aug 12, 2024
b1a6966

skip eslint test in node 14


mydea Aug 12, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
docs/new-sdk-release-checklist.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -45,8 +45,8 @@ differ slightly for other SDKs depending on how they are structured and how they

- [ ] Make sure `build.yml` CI script is correctly set up to cover tests for the new package

 - [ ] Ensure dependent packages are correctly set for “Determine changed packages”
 - [ ] Ensure unit tests run correctly
 - [ ] If it is a browser SDK, add it to `BROWSER_TEST_PACKAGES` in `scripts/ci-unit-tests.ts`

- [ ] Make sure the file paths in the
 ["Upload Artifacts" job](https://github.com/getsentry/sentry-javascript/blob/e5c1486eed236b878f2c49d6a04be86093816ac9/.github/workflows/build.yml#L314-L349)
Expand Down

8 changes: 4 additions & 4 deletions
package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,10 +35,10 @@
 "test:unit": "lerna run --ignore \"@sentry-internal/{browser-integration-tests,e2e-tests,integration-shims,node-integration-tests,overhead-metrics}\" test:unit",
 "test:update-snapshots": "lerna run test:update-snapshots",
 "test:pr": "nx affected -t test --exclude \"@sentry-internal/{browser-integration-tests,e2e-tests,integration-shims,node-integration-tests,overhead-metrics}\"",
 "test:pr:browser": "yarn test:pr --exclude \"@sentry/{core,utils,opentelemetry,bun,deno,node,profiling-node,aws-serverless,google-cloud-serverless,nextjs,nestjs,astro,cloudflare,solidstart,nuxt,remix,gatsby,sveltekit,vercel-edge}\"",
 "test:pr:node": "ts-node ./scripts/node-unit-tests.ts --affected",
 "test:ci:browser": "lerna run test --ignore \"@sentry/{core,utils,opentelemetry,bun,deno,node,profiling-node,aws-serverless,google-cloud-serverless,nextjs,nestjs,astro,cloudflare,solidstart,nuxt,remix,gatsby,sveltekit,vercel-edge}\" --ignore \"@sentry-internal/{browser-integration-tests,e2e-tests,integration-shims,node-integration-tests,overhead-metrics}\"",
 "test:ci:node": "ts-node ./scripts/node-unit-tests.ts",
 "test:pr:browser": "UNIT_TEST_ENV=browser ts-node ./scripts/ci-unit-tests.ts --affected",
 "test:pr:node": "UNIT_TEST_ENV=node ts-node ./scripts/ci-unit-tests.ts --affected",
 "test:ci:browser": "UNIT_TEST_ENV=browser ts-node ./scripts/ci-unit-tests.ts",
 "test:ci:node": "UNIT_TEST_ENV=node ts-node ./scripts/ci-unit-tests.ts",
 "test:ci:bun": "lerna run test --scope @sentry/bun",
 "yalc:publish": "lerna run yalc:publish"
 },
Expand Down

92 changes: 65 additions & 27 deletions
scripts/node-unit-tests.ts → scripts/ci-unit-tests.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,17 +1,24 @@
import * as childProcess from 'child_process';
import * as fs from 'fs';
import * as path from 'path';

type NodeVersion = '14' | '16' | '18' | '20' | '21';

interface VersionConfig {
 ignoredPackages: Array<`@${'sentry' | 'sentry-internal'}/${string}`>;
}

const UNIT_TEST_ENV = process.env.UNIT_TEST_ENV as 'node' | 'browser' | undefined;

const CURRENT_NODE_VERSION = process.version.replace('v', '').split('.')[0] as NodeVersion;

const RUN_AFFECTED = process.argv.includes('--affected');

const DEFAULT_SKIP_TESTS_PACKAGES = [
 '@sentry-internal/eslint-plugin-sdk',
// These packages are tested separately in CI, so no need to run them here
const DEFAULT_SKIP_PACKAGES = ['@sentry/profiling-node', '@sentry/bun', '@sentry/deno'];

// All other packages are run for multiple node versions
const BROWSER_TEST_PACKAGES = [
 '@sentry/ember',
 '@sentry/browser',
 '@sentry/vue',
Expand All@@ -26,10 +33,9 @@ const DEFAULT_SKIP_TESTS_PACKAGES = [
 '@sentry-internal/replay-worker',
 '@sentry-internal/feedback',
 '@sentry/wasm',
 '@sentry/bun',
 '@sentry/deno',
];

// These are Node-version specific tests that need to be skipped because of support
const SKIP_TEST_PACKAGES: Record<NodeVersion, VersionConfig> = {
 '14': {
 ignoredPackages: [
Expand All@@ -40,6 +46,7 @@ const SKIP_TEST_PACKAGES: Record<NodeVersion, VersionConfig> = {
 '@sentry/astro',
 '@sentry/nuxt',
 '@sentry/nestjs',
 '@sentry-internal/eslint-plugin-sdk',
@AbhiPrasadAbhiPrasadAug 12, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A micro optimization here is to change eslint-plugin-sdk to only run test for whatever the node version of the local env is.
We can effectively treat it as a browser test then.
@mydeamydeaAug 12, 2024

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

actually I guess we should technically run this in multiple node versions, as this is published? 🤔 and actually probably bump the min. node version of this to 16+ as it does not seem to work on 14... 😅 it's internal so I wouild not care about this too much 🤔 WDYT?
 ],
 },
 '16': {
Expand All@@ -56,6 +63,50 @@ const SKIP_TEST_PACKAGES: Record<NodeVersion, VersionConfig> = {
 },
};

function getAllPackages(): string[] {
 const { workspaces }: { workspaces: string[] } = JSON.parse(
 fs.readFileSync(path.join(process.cwd(), 'package.json'), 'utf-8'),
 );

 return workspaces.map(workspacePath => {
 const { name }: { name: string } = JSON.parse(
 fs.readFileSync(path.join(process.cwd(), workspacePath, 'package.json'), 'utf-8'),
 );
 return name;
 });
}

/**
 * Run the tests, accounting for compatibility problems in older versions of Node.
 */
function runTests(): void {
 const ignores = new Set<string>(DEFAULT_SKIP_PACKAGES);

 const packages = getAllPackages();

 if (UNIT_TEST_ENV === 'browser') {
 // Since we cannot "include" for affected mode, we instead exclude all other packages
 packages.forEach(pkg => {
 if (!BROWSER_TEST_PACKAGES.includes(pkg)) {
 ignores.add(pkg);
 }
 });
 } else if (UNIT_TEST_ENV === 'node') {
 BROWSER_TEST_PACKAGES.forEach(pkg => ignores.add(pkg));
 }

 const versionConfig = SKIP_TEST_PACKAGES[CURRENT_NODE_VERSION];
 if (versionConfig) {
 versionConfig.ignoredPackages.forEach(dep => ignores.add(dep));
 }

 if (RUN_AFFECTED) {
 runAffectedTests(ignores);
 } else {
 runAllTests(ignores);
 }
}

/**
 * Run the given shell command, piping the shell process's `stdin`, `stdout`, and `stderr` to that of the current
 * process. Returns contents of `stdout`.
Expand All@@ -67,41 +118,28 @@ function run(cmd: string, options?: childProcess.ExecSyncOptions): void {
/**
 * Run tests, ignoring the given packages
 */
function runWithIgnores(skipPackages: string[] = []): void {
 const ignoreFlags = skipPackages.map(dep => `--ignore="${dep}"`).join(' ');
function runAllTests(ignorePackages: Set<string>): void {
 const ignoreFlags = Array.from(ignorePackages)
 .map(dep => `--ignore="${dep}"`)
 .join(' ');

 run(`yarn test ${ignoreFlags}`);
}

/**
 * Run affected tests, ignoring the given packages
 */
function runAffectedWithIgnores(skipPackages: string[] = []): void {
function runAffectedTests(ignorePackages: Set<string>): void {
 const additionalArgs = process.argv
 .slice(2)
 .filter(arg => arg !== '--affected')
 .join(' ');
 const ignoreFlags = skipPackages.map(dep => `--exclude="${dep}"`).join(' ');
 run(`yarn test:pr ${ignoreFlags} ${additionalArgs}`);
}

/**
 * Run the tests, accounting for compatibility problems in older versions of Node.
 */
function runTests(): void {
 const ignores = new Set<string>();

 DEFAULT_SKIP_TESTS_PACKAGES.forEach(pkg => ignores.add(pkg));

 const versionConfig = SKIP_TEST_PACKAGES[CURRENT_NODE_VERSION];
 if (versionConfig) {
 versionConfig.ignoredPackages.forEach(dep => ignores.add(dep));
 }
 const excludeFlags = Array.from(ignorePackages)
 .map(dep => `--exclude="${dep}"`)
 .join(' ');

 if (RUN_AFFECTED) {
 runAffectedWithIgnores(Array.from(ignores));
 } else {
 runWithIgnores(Array.from(ignores));
 }
 run(`yarn test:pr ${excludeFlags} ${additionalArgs}`);
}

runTests();

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
ci: Streamline browser & node unit tests#13307

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

mydea
merged 3 commits into

from

Aug 14, 2024
 Merged


ci: Streamline browser & node unit tests
#13307
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
4af1d6a

ci: Streamline browser & node unit tests


mydea Aug 12, 2024
6b76889

add to checklist


mydea Aug 12, 2024
b1a6966

skip eslint test in node 14


mydea Aug 12, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
docs/new-sdk-release-checklist.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -45,8 +45,8 @@ differ slightly for other SDKs depending on how they are structured and how they

- [ ] Make sure `build.yml` CI script is correctly set up to cover tests for the new package

 - [ ] Ensure dependent packages are correctly set for “Determine changed packages”
 - [ ] Ensure unit tests run correctly
 - [ ] If it is a browser SDK, add it to `BROWSER_TEST_PACKAGES` in `scripts/ci-unit-tests.ts`

- [ ] Make sure the file paths in the
 ["Upload Artifacts" job](https://github.com/getsentry/sentry-javascript/blob/e5c1486eed236b878f2c49d6a04be86093816ac9/.github/workflows/build.yml#L314-L349)
Expand Down

8 changes: 4 additions & 4 deletions
package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,10 +35,10 @@
 "test:unit": "lerna run --ignore \"@sentry-internal/{browser-integration-tests,e2e-tests,integration-shims,node-integration-tests,overhead-metrics}\" test:unit",
 "test:update-snapshots": "lerna run test:update-snapshots",
 "test:pr": "nx affected -t test --exclude \"@sentry-internal/{browser-integration-tests,e2e-tests,integration-shims,node-integration-tests,overhead-metrics}\"",
 "test:pr:browser": "yarn test:pr --exclude \"@sentry/{core,utils,opentelemetry,bun,deno,node,profiling-node,aws-serverless,google-cloud-serverless,nextjs,nestjs,astro,cloudflare,solidstart,nuxt,remix,gatsby,sveltekit,vercel-edge}\"",
 "test:pr:node": "ts-node ./scripts/node-unit-tests.ts --affected",
 "test:ci:browser": "lerna run test --ignore \"@sentry/{core,utils,opentelemetry,bun,deno,node,profiling-node,aws-serverless,google-cloud-serverless,nextjs,nestjs,astro,cloudflare,solidstart,nuxt,remix,gatsby,sveltekit,vercel-edge}\" --ignore \"@sentry-internal/{browser-integration-tests,e2e-tests,integration-shims,node-integration-tests,overhead-metrics}\"",
 "test:ci:node": "ts-node ./scripts/node-unit-tests.ts",
 "test:pr:browser": "UNIT_TEST_ENV=browser ts-node ./scripts/ci-unit-tests.ts --affected",
 "test:pr:node": "UNIT_TEST_ENV=node ts-node ./scripts/ci-unit-tests.ts --affected",
 "test:ci:browser": "UNIT_TEST_ENV=browser ts-node ./scripts/ci-unit-tests.ts",
 "test:ci:node": "UNIT_TEST_ENV=node ts-node ./scripts/ci-unit-tests.ts",
 "test:ci:bun": "lerna run test --scope @sentry/bun",
 "yalc:publish": "lerna run yalc:publish"
 },
Expand Down

92 changes: 65 additions & 27 deletions
scripts/node-unit-tests.ts → scripts/ci-unit-tests.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,17 +1,24 @@
import * as childProcess from 'child_process';
import * as fs from 'fs';
import * as path from 'path';

type NodeVersion = '14' | '16' | '18' | '20' | '21';

interface VersionConfig {
 ignoredPackages: Array<`@${'sentry' | 'sentry-internal'}/${string}`>;
}

const UNIT_TEST_ENV = process.env.UNIT_TEST_ENV as 'node' | 'browser' | undefined;

const CURRENT_NODE_VERSION = process.version.replace('v', '').split('.')[0] as NodeVersion;

const RUN_AFFECTED = process.argv.includes('--affected');

const DEFAULT_SKIP_TESTS_PACKAGES = [
 '@sentry-internal/eslint-plugin-sdk',
// These packages are tested separately in CI, so no need to run them here
const DEFAULT_SKIP_PACKAGES = ['@sentry/profiling-node', '@sentry/bun', '@sentry/deno'];

// All other packages are run for multiple node versions
const BROWSER_TEST_PACKAGES = [
 '@sentry/ember',
 '@sentry/browser',
 '@sentry/vue',
Expand All@@ -26,10 +33,9 @@ const DEFAULT_SKIP_TESTS_PACKAGES = [
 '@sentry-internal/replay-worker',
 '@sentry-internal/feedback',
 '@sentry/wasm',
 '@sentry/bun',
 '@sentry/deno',
];

// These are Node-version specific tests that need to be skipped because of support
const SKIP_TEST_PACKAGES: Record<NodeVersion, VersionConfig> = {
 '14': {
 ignoredPackages: [
Expand All@@ -40,6 +46,7 @@ const SKIP_TEST_PACKAGES: Record<NodeVersion, VersionConfig> = {
 '@sentry/astro',
 '@sentry/nuxt',
 '@sentry/nestjs',
 '@sentry-internal/eslint-plugin-sdk',
@AbhiPrasadAbhiPrasadAug 12, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A micro optimization here is to change eslint-plugin-sdk to only run test for whatever the node version of the local env is.
We can effectively treat it as a browser test then.
@mydeamydeaAug 12, 2024

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

actually I guess we should technically run this in multiple node versions, as this is published? 🤔 and actually probably bump the min. node version of this to 16+ as it does not seem to work on 14... 😅 it's internal so I wouild not care about this too much 🤔 WDYT?
 ],
 },
 '16': {
Expand All@@ -56,6 +63,50 @@ const SKIP_TEST_PACKAGES: Record<NodeVersion, VersionConfig> = {
 },
};

function getAllPackages(): string[] {
 const { workspaces }: { workspaces: string[] } = JSON.parse(
 fs.readFileSync(path.join(process.cwd(), 'package.json'), 'utf-8'),
 );

 return workspaces.map(workspacePath => {
 const { name }: { name: string } = JSON.parse(
 fs.readFileSync(path.join(process.cwd(), workspacePath, 'package.json'), 'utf-8'),
 );
 return name;
 });
}

/**
 * Run the tests, accounting for compatibility problems in older versions of Node.
 */
function runTests(): void {
 const ignores = new Set<string>(DEFAULT_SKIP_PACKAGES);

 const packages = getAllPackages();

 if (UNIT_TEST_ENV === 'browser') {
 // Since we cannot "include" for affected mode, we instead exclude all other packages
 packages.forEach(pkg => {
 if (!BROWSER_TEST_PACKAGES.includes(pkg)) {
 ignores.add(pkg);
 }
 });
 } else if (UNIT_TEST_ENV === 'node') {
 BROWSER_TEST_PACKAGES.forEach(pkg => ignores.add(pkg));
 }

 const versionConfig = SKIP_TEST_PACKAGES[CURRENT_NODE_VERSION];
 if (versionConfig) {
 versionConfig.ignoredPackages.forEach(dep => ignores.add(dep));
 }

 if (RUN_AFFECTED) {
 runAffectedTests(ignores);
 } else {
 runAllTests(ignores);
 }
}

/**
 * Run the given shell command, piping the shell process's `stdin`, `stdout`, and `stderr` to that of the current
 * process. Returns contents of `stdout`.
Expand All@@ -67,41 +118,28 @@ function run(cmd: string, options?: childProcess.ExecSyncOptions): void {
/**
 * Run tests, ignoring the given packages
 */
function runWithIgnores(skipPackages: string[] = []): void {
 const ignoreFlags = skipPackages.map(dep => `--ignore="${dep}"`).join(' ');
function runAllTests(ignorePackages: Set<string>): void {
 const ignoreFlags = Array.from(ignorePackages)
 .map(dep => `--ignore="${dep}"`)
 .join(' ');

 run(`yarn test ${ignoreFlags}`);
}

/**
 * Run affected tests, ignoring the given packages
 */
function runAffectedWithIgnores(skipPackages: string[] = []): void {
function runAffectedTests(ignorePackages: Set<string>): void {
 const additionalArgs = process.argv
 .slice(2)
 .filter(arg => arg !== '--affected')
 .join(' ');
 const ignoreFlags = skipPackages.map(dep => `--exclude="${dep}"`).join(' ');
 run(`yarn test:pr ${ignoreFlags} ${additionalArgs}`);
}

/**
 * Run the tests, accounting for compatibility problems in older versions of Node.
 */
function runTests(): void {
 const ignores = new Set<string>();

 DEFAULT_SKIP_TESTS_PACKAGES.forEach(pkg => ignores.add(pkg));

 const versionConfig = SKIP_TEST_PACKAGES[CURRENT_NODE_VERSION];
 if (versionConfig) {
 versionConfig.ignoredPackages.forEach(dep => ignores.add(dep));
 }
 const excludeFlags = Array.from(ignorePackages)
 .map(dep => `--exclude="${dep}"`)
 .join(' ');

 if (RUN_AFFECTED) {
 runAffectedWithIgnores(Array.from(ignores));
 } else {
 runWithIgnores(Array.from(ignores));
 }
 run(`yarn test:pr ${excludeFlags} ${additionalArgs}`);
}

runTests();

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
ci: Streamline browser & node unit tests#13307

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

mydea
merged 3 commits into

from

Aug 14, 2024
 Merged


ci: Streamline browser & node unit tests
#13307
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
4af1d6a

ci: Streamline browser & node unit tests


mydea Aug 12, 2024
6b76889

add to checklist


mydea Aug 12, 2024
b1a6966

skip eslint test in node 14


mydea Aug 12, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
docs/new-sdk-release-checklist.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -45,8 +45,8 @@ differ slightly for other SDKs depending on how they are structured and how they

- [ ] Make sure `build.yml` CI script is correctly set up to cover tests for the new package

 - [ ] Ensure dependent packages are correctly set for “Determine changed packages”
 - [ ] Ensure unit tests run correctly
 - [ ] If it is a browser SDK, add it to `BROWSER_TEST_PACKAGES` in `scripts/ci-unit-tests.ts`

- [ ] Make sure the file paths in the
 ["Upload Artifacts" job](https://github.com/getsentry/sentry-javascript/blob/e5c1486eed236b878f2c49d6a04be86093816ac9/.github/workflows/build.yml#L314-L349)
Expand Down

8 changes: 4 additions & 4 deletions
package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,10 +35,10 @@
 "test:unit": "lerna run --ignore \"@sentry-internal/{browser-integration-tests,e2e-tests,integration-shims,node-integration-tests,overhead-metrics}\" test:unit",
 "test:update-snapshots": "lerna run test:update-snapshots",
 "test:pr": "nx affected -t test --exclude \"@sentry-internal/{browser-integration-tests,e2e-tests,integration-shims,node-integration-tests,overhead-metrics}\"",
 "test:pr:browser": "yarn test:pr --exclude \"@sentry/{core,utils,opentelemetry,bun,deno,node,profiling-node,aws-serverless,google-cloud-serverless,nextjs,nestjs,astro,cloudflare,solidstart,nuxt,remix,gatsby,sveltekit,vercel-edge}\"",
 "test:pr:node": "ts-node ./scripts/node-unit-tests.ts --affected",
 "test:ci:browser": "lerna run test --ignore \"@sentry/{core,utils,opentelemetry,bun,deno,node,profiling-node,aws-serverless,google-cloud-serverless,nextjs,nestjs,astro,cloudflare,solidstart,nuxt,remix,gatsby,sveltekit,vercel-edge}\" --ignore \"@sentry-internal/{browser-integration-tests,e2e-tests,integration-shims,node-integration-tests,overhead-metrics}\"",
 "test:ci:node": "ts-node ./scripts/node-unit-tests.ts",
 "test:pr:browser": "UNIT_TEST_ENV=browser ts-node ./scripts/ci-unit-tests.ts --affected",
 "test:pr:node": "UNIT_TEST_ENV=node ts-node ./scripts/ci-unit-tests.ts --affected",
 "test:ci:browser": "UNIT_TEST_ENV=browser ts-node ./scripts/ci-unit-tests.ts",
 "test:ci:node": "UNIT_TEST_ENV=node ts-node ./scripts/ci-unit-tests.ts",
 "test:ci:bun": "lerna run test --scope @sentry/bun",
 "yalc:publish": "lerna run yalc:publish"
 },
Expand Down

92 changes: 65 additions & 27 deletions
scripts/node-unit-tests.ts → scripts/ci-unit-tests.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,17 +1,24 @@
import * as childProcess from 'child_process';
import * as fs from 'fs';
import * as path from 'path';

type NodeVersion = '14' | '16' | '18' | '20' | '21';

interface VersionConfig {
 ignoredPackages: Array<`@${'sentry' | 'sentry-internal'}/${string}`>;
}

const UNIT_TEST_ENV = process.env.UNIT_TEST_ENV as 'node' | 'browser' | undefined;

const CURRENT_NODE_VERSION = process.version.replace('v', '').split('.')[0] as NodeVersion;

const RUN_AFFECTED = process.argv.includes('--affected');

const DEFAULT_SKIP_TESTS_PACKAGES = [
 '@sentry-internal/eslint-plugin-sdk',
// These packages are tested separately in CI, so no need to run them here
const DEFAULT_SKIP_PACKAGES = ['@sentry/profiling-node', '@sentry/bun', '@sentry/deno'];

// All other packages are run for multiple node versions
const BROWSER_TEST_PACKAGES = [
 '@sentry/ember',
 '@sentry/browser',
 '@sentry/vue',
Expand All@@ -26,10 +33,9 @@ const DEFAULT_SKIP_TESTS_PACKAGES = [
 '@sentry-internal/replay-worker',
 '@sentry-internal/feedback',
 '@sentry/wasm',
 '@sentry/bun',
 '@sentry/deno',
];

// These are Node-version specific tests that need to be skipped because of support
const SKIP_TEST_PACKAGES: Record<NodeVersion, VersionConfig> = {
 '14': {
 ignoredPackages: [
Expand All@@ -40,6 +46,7 @@ const SKIP_TEST_PACKAGES: Record<NodeVersion, VersionConfig> = {
 '@sentry/astro',
 '@sentry/nuxt',
 '@sentry/nestjs',
 '@sentry-internal/eslint-plugin-sdk',
@AbhiPrasadAbhiPrasadAug 12, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A micro optimization here is to change eslint-plugin-sdk to only run test for whatever the node version of the local env is.
We can effectively treat it as a browser test then.
@mydeamydeaAug 12, 2024

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

actually I guess we should technically run this in multiple node versions, as this is published? 🤔 and actually probably bump the min. node version of this to 16+ as it does not seem to work on 14... 😅 it's internal so I wouild not care about this too much 🤔 WDYT?
 ],
 },
 '16': {
Expand All@@ -56,6 +63,50 @@ const SKIP_TEST_PACKAGES: Record<NodeVersion, VersionConfig> = {
 },
};

function getAllPackages(): string[] {
 const { workspaces }: { workspaces: string[] } = JSON.parse(
 fs.readFileSync(path.join(process.cwd(), 'package.json'), 'utf-8'),
 );

 return workspaces.map(workspacePath => {
 const { name }: { name: string } = JSON.parse(
 fs.readFileSync(path.join(process.cwd(), workspacePath, 'package.json'), 'utf-8'),
 );
 return name;
 });
}

/**
 * Run the tests, accounting for compatibility problems in older versions of Node.
 */
function runTests(): void {
 const ignores = new Set<string>(DEFAULT_SKIP_PACKAGES);

 const packages = getAllPackages();

 if (UNIT_TEST_ENV === 'browser') {
 // Since we cannot "include" for affected mode, we instead exclude all other packages
 packages.forEach(pkg => {
 if (!BROWSER_TEST_PACKAGES.includes(pkg)) {
 ignores.add(pkg);
 }
 });
 } else if (UNIT_TEST_ENV === 'node') {
 BROWSER_TEST_PACKAGES.forEach(pkg => ignores.add(pkg));
 }

 const versionConfig = SKIP_TEST_PACKAGES[CURRENT_NODE_VERSION];
 if (versionConfig) {
 versionConfig.ignoredPackages.forEach(dep => ignores.add(dep));
 }

 if (RUN_AFFECTED) {
 runAffectedTests(ignores);
 } else {
 runAllTests(ignores);
 }
}

/**
 * Run the given shell command, piping the shell process's `stdin`, `stdout`, and `stderr` to that of the current
 * process. Returns contents of `stdout`.
Expand All@@ -67,41 +118,28 @@ function run(cmd: string, options?: childProcess.ExecSyncOptions): void {
/**
 * Run tests, ignoring the given packages
 */
function runWithIgnores(skipPackages: string[] = []): void {
 const ignoreFlags = skipPackages.map(dep => `--ignore="${dep}"`).join(' ');
function runAllTests(ignorePackages: Set<string>): void {
 const ignoreFlags = Array.from(ignorePackages)
 .map(dep => `--ignore="${dep}"`)
 .join(' ');

 run(`yarn test ${ignoreFlags}`);
}

/**
 * Run affected tests, ignoring the given packages
 */
function runAffectedWithIgnores(skipPackages: string[] = []): void {
function runAffectedTests(ignorePackages: Set<string>): void {
 const additionalArgs = process.argv
 .slice(2)
 .filter(arg => arg !== '--affected')
 .join(' ');
 const ignoreFlags = skipPackages.map(dep => `--exclude="${dep}"`).join(' ');
 run(`yarn test:pr ${ignoreFlags} ${additionalArgs}`);
}

/**
 * Run the tests, accounting for compatibility problems in older versions of Node.
 */
function runTests(): void {
 const ignores = new Set<string>();

 DEFAULT_SKIP_TESTS_PACKAGES.forEach(pkg => ignores.add(pkg));

 const versionConfig = SKIP_TEST_PACKAGES[CURRENT_NODE_VERSION];
 if (versionConfig) {
 versionConfig.ignoredPackages.forEach(dep => ignores.add(dep));
 }
 const excludeFlags = Array.from(ignorePackages)
 .map(dep => `--exclude="${dep}"`)
 .join(' ');

 if (RUN_AFFECTED) {
 runAffectedWithIgnores(Array.from(ignores));
 } else {
 runWithIgnores(Array.from(ignores));
 }
 run(`yarn test:pr ${excludeFlags} ${additionalArgs}`);
}

runTests();

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
ci: Streamline browser & node unit tests#13307

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

mydea
merged 3 commits into

from

Aug 14, 2024
 Merged


ci: Streamline browser & node unit tests
#13307
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
4af1d6a

ci: Streamline browser & node unit tests


mydea Aug 12, 2024
6b76889

add to checklist


mydea Aug 12, 2024
b1a6966

skip eslint test in node 14


mydea Aug 12, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
docs/new-sdk-release-checklist.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -45,8 +45,8 @@ differ slightly for other SDKs depending on how they are structured and how they

- [ ] Make sure `build.yml` CI script is correctly set up to cover tests for the new package

 - [ ] Ensure dependent packages are correctly set for “Determine changed packages”
 - [ ] Ensure unit tests run correctly
 - [ ] If it is a browser SDK, add it to `BROWSER_TEST_PACKAGES` in `scripts/ci-unit-tests.ts`

- [ ] Make sure the file paths in the
 ["Upload Artifacts" job](https://github.com/getsentry/sentry-javascript/blob/e5c1486eed236b878f2c49d6a04be86093816ac9/.github/workflows/build.yml#L314-L349)
Expand Down

8 changes: 4 additions & 4 deletions
package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,10 +35,10 @@
 "test:unit": "lerna run --ignore \"@sentry-internal/{browser-integration-tests,e2e-tests,integration-shims,node-integration-tests,overhead-metrics}\" test:unit",
 "test:update-snapshots": "lerna run test:update-snapshots",
 "test:pr": "nx affected -t test --exclude \"@sentry-internal/{browser-integration-tests,e2e-tests,integration-shims,node-integration-tests,overhead-metrics}\"",
 "test:pr:browser": "yarn test:pr --exclude \"@sentry/{core,utils,opentelemetry,bun,deno,node,profiling-node,aws-serverless,google-cloud-serverless,nextjs,nestjs,astro,cloudflare,solidstart,nuxt,remix,gatsby,sveltekit,vercel-edge}\"",
 "test:pr:node": "ts-node ./scripts/node-unit-tests.ts --affected",
 "test:ci:browser": "lerna run test --ignore \"@sentry/{core,utils,opentelemetry,bun,deno,node,profiling-node,aws-serverless,google-cloud-serverless,nextjs,nestjs,astro,cloudflare,solidstart,nuxt,remix,gatsby,sveltekit,vercel-edge}\" --ignore \"@sentry-internal/{browser-integration-tests,e2e-tests,integration-shims,node-integration-tests,overhead-metrics}\"",
 "test:ci:node": "ts-node ./scripts/node-unit-tests.ts",
 "test:pr:browser": "UNIT_TEST_ENV=browser ts-node ./scripts/ci-unit-tests.ts --affected",
 "test:pr:node": "UNIT_TEST_ENV=node ts-node ./scripts/ci-unit-tests.ts --affected",
 "test:ci:browser": "UNIT_TEST_ENV=browser ts-node ./scripts/ci-unit-tests.ts",
 "test:ci:node": "UNIT_TEST_ENV=node ts-node ./scripts/ci-unit-tests.ts",
 "test:ci:bun": "lerna run test --scope @sentry/bun",
 "yalc:publish": "lerna run yalc:publish"
 },
Expand Down

92 changes: 65 additions & 27 deletions
scripts/node-unit-tests.ts → scripts/ci-unit-tests.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,17 +1,24 @@
import * as childProcess from 'child_process';
import * as fs from 'fs';
import * as path from 'path';

type NodeVersion = '14' | '16' | '18' | '20' | '21';

interface VersionConfig {
 ignoredPackages: Array<`@${'sentry' | 'sentry-internal'}/${string}`>;
}

const UNIT_TEST_ENV = process.env.UNIT_TEST_ENV as 'node' | 'browser' | undefined;

const CURRENT_NODE_VERSION = process.version.replace('v', '').split('.')[0] as NodeVersion;

const RUN_AFFECTED = process.argv.includes('--affected');

const DEFAULT_SKIP_TESTS_PACKAGES = [
 '@sentry-internal/eslint-plugin-sdk',
// These packages are tested separately in CI, so no need to run them here
const DEFAULT_SKIP_PACKAGES = ['@sentry/profiling-node', '@sentry/bun', '@sentry/deno'];

// All other packages are run for multiple node versions
const BROWSER_TEST_PACKAGES = [
 '@sentry/ember',
 '@sentry/browser',
 '@sentry/vue',
Expand All@@ -26,10 +33,9 @@ const DEFAULT_SKIP_TESTS_PACKAGES = [
 '@sentry-internal/replay-worker',
 '@sentry-internal/feedback',
 '@sentry/wasm',
 '@sentry/bun',
 '@sentry/deno',
];

// These are Node-version specific tests that need to be skipped because of support
const SKIP_TEST_PACKAGES: Record<NodeVersion, VersionConfig> = {
 '14': {
 ignoredPackages: [
Expand All@@ -40,6 +46,7 @@ const SKIP_TEST_PACKAGES: Record<NodeVersion, VersionConfig> = {
 '@sentry/astro',
 '@sentry/nuxt',
 '@sentry/nestjs',
 '@sentry-internal/eslint-plugin-sdk',
@AbhiPrasadAbhiPrasadAug 12, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A micro optimization here is to change eslint-plugin-sdk to only run test for whatever the node version of the local env is.
We can effectively treat it as a browser test then.
@mydeamydeaAug 12, 2024

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

actually I guess we should technically run this in multiple node versions, as this is published? 🤔 and actually probably bump the min. node version of this to 16+ as it does not seem to work on 14... 😅 it's internal so I wouild not care about this too much 🤔 WDYT?
 ],
 },
 '16': {
Expand All@@ -56,6 +63,50 @@ const SKIP_TEST_PACKAGES: Record<NodeVersion, VersionConfig> = {
 },
};

function getAllPackages(): string[] {
 const { workspaces }: { workspaces: string[] } = JSON.parse(
 fs.readFileSync(path.join(process.cwd(), 'package.json'), 'utf-8'),
 );

 return workspaces.map(workspacePath => {
 const { name }: { name: string } = JSON.parse(
 fs.readFileSync(path.join(process.cwd(), workspacePath, 'package.json'), 'utf-8'),
 );
 return name;
 });
}

/**
 * Run the tests, accounting for compatibility problems in older versions of Node.
 */
function runTests(): void {
 const ignores = new Set<string>(DEFAULT_SKIP_PACKAGES);

 const packages = getAllPackages();

 if (UNIT_TEST_ENV === 'browser') {
 // Since we cannot "include" for affected mode, we instead exclude all other packages
 packages.forEach(pkg => {
 if (!BROWSER_TEST_PACKAGES.includes(pkg)) {
 ignores.add(pkg);
 }
 });
 } else if (UNIT_TEST_ENV === 'node') {
 BROWSER_TEST_PACKAGES.forEach(pkg => ignores.add(pkg));
 }

 const versionConfig = SKIP_TEST_PACKAGES[CURRENT_NODE_VERSION];
 if (versionConfig) {
 versionConfig.ignoredPackages.forEach(dep => ignores.add(dep));
 }

 if (RUN_AFFECTED) {
 runAffectedTests(ignores);
 } else {
 runAllTests(ignores);
 }
}

/**
 * Run the given shell command, piping the shell process's `stdin`, `stdout`, and `stderr` to that of the current
 * process. Returns contents of `stdout`.
Expand All@@ -67,41 +118,28 @@ function run(cmd: string, options?: childProcess.ExecSyncOptions): void {
/**
 * Run tests, ignoring the given packages
 */
function runWithIgnores(skipPackages: string[] = []): void {
 const ignoreFlags = skipPackages.map(dep => `--ignore="${dep}"`).join(' ');
function runAllTests(ignorePackages: Set<string>): void {
 const ignoreFlags = Array.from(ignorePackages)
 .map(dep => `--ignore="${dep}"`)
 .join(' ');

 run(`yarn test ${ignoreFlags}`);
}

/**
 * Run affected tests, ignoring the given packages
 */
function runAffectedWithIgnores(skipPackages: string[] = []): void {
function runAffectedTests(ignorePackages: Set<string>): void {
 const additionalArgs = process.argv
 .slice(2)
 .filter(arg => arg !== '--affected')
 .join(' ');
 const ignoreFlags = skipPackages.map(dep => `--exclude="${dep}"`).join(' ');
 run(`yarn test:pr ${ignoreFlags} ${additionalArgs}`);
}

/**
 * Run the tests, accounting for compatibility problems in older versions of Node.
 */
function runTests(): void {
 const ignores = new Set<string>();

 DEFAULT_SKIP_TESTS_PACKAGES.forEach(pkg => ignores.add(pkg));

 const versionConfig = SKIP_TEST_PACKAGES[CURRENT_NODE_VERSION];
 if (versionConfig) {
 versionConfig.ignoredPackages.forEach(dep => ignores.add(dep));
 }
 const excludeFlags = Array.from(ignorePackages)
 .map(dep => `--exclude="${dep}"`)
 .join(' ');

 if (RUN_AFFECTED) {
 runAffectedWithIgnores(Array.from(ignores));
 } else {
 runWithIgnores(Array.from(ignores));
 }
 run(`yarn test:pr ${excludeFlags} ${additionalArgs}`);
}

runTests();

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
ci: Streamline browser & node unit tests#13307

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

mydea
merged 3 commits into

from

Aug 14, 2024
 Merged


ci: Streamline browser & node unit tests
#13307
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
4af1d6a

ci: Streamline browser & node unit tests


mydea Aug 12, 2024
6b76889

add to checklist


mydea Aug 12, 2024
b1a6966

skip eslint test in node 14


mydea Aug 12, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
docs/new-sdk-release-checklist.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -45,8 +45,8 @@ differ slightly for other SDKs depending on how they are structured and how they

- [ ] Make sure `build.yml` CI script is correctly set up to cover tests for the new package

 - [ ] Ensure dependent packages are correctly set for “Determine changed packages”
 - [ ] Ensure unit tests run correctly
 - [ ] If it is a browser SDK, add it to `BROWSER_TEST_PACKAGES` in `scripts/ci-unit-tests.ts`

- [ ] Make sure the file paths in the
 ["Upload Artifacts" job](https://github.com/getsentry/sentry-javascript/blob/e5c1486eed236b878f2c49d6a04be86093816ac9/.github/workflows/build.yml#L314-L349)
Expand Down

8 changes: 4 additions & 4 deletions
package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,10 +35,10 @@
 "test:unit": "lerna run --ignore \"@sentry-internal/{browser-integration-tests,e2e-tests,integration-shims,node-integration-tests,overhead-metrics}\" test:unit",
 "test:update-snapshots": "lerna run test:update-snapshots",
 "test:pr": "nx affected -t test --exclude \"@sentry-internal/{browser-integration-tests,e2e-tests,integration-shims,node-integration-tests,overhead-metrics}\"",
 "test:pr:browser": "yarn test:pr --exclude \"@sentry/{core,utils,opentelemetry,bun,deno,node,profiling-node,aws-serverless,google-cloud-serverless,nextjs,nestjs,astro,cloudflare,solidstart,nuxt,remix,gatsby,sveltekit,vercel-edge}\"",
 "test:pr:node": "ts-node ./scripts/node-unit-tests.ts --affected",
 "test:ci:browser": "lerna run test --ignore \"@sentry/{core,utils,opentelemetry,bun,deno,node,profiling-node,aws-serverless,google-cloud-serverless,nextjs,nestjs,astro,cloudflare,solidstart,nuxt,remix,gatsby,sveltekit,vercel-edge}\" --ignore \"@sentry-internal/{browser-integration-tests,e2e-tests,integration-shims,node-integration-tests,overhead-metrics}\"",
 "test:ci:node": "ts-node ./scripts/node-unit-tests.ts",
 "test:pr:browser": "UNIT_TEST_ENV=browser ts-node ./scripts/ci-unit-tests.ts --affected",
 "test:pr:node": "UNIT_TEST_ENV=node ts-node ./scripts/ci-unit-tests.ts --affected",
 "test:ci:browser": "UNIT_TEST_ENV=browser ts-node ./scripts/ci-unit-tests.ts",
 "test:ci:node": "UNIT_TEST_ENV=node ts-node ./scripts/ci-unit-tests.ts",
 "test:ci:bun": "lerna run test --scope @sentry/bun",
 "yalc:publish": "lerna run yalc:publish"
 },
Expand Down

92 changes: 65 additions & 27 deletions
scripts/node-unit-tests.ts → scripts/ci-unit-tests.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,17 +1,24 @@
import * as childProcess from 'child_process';
import * as fs from 'fs';
import * as path from 'path';

type NodeVersion = '14' | '16' | '18' | '20' | '21';

interface VersionConfig {
 ignoredPackages: Array<`@${'sentry' | 'sentry-internal'}/${string}`>;
}

const UNIT_TEST_ENV = process.env.UNIT_TEST_ENV as 'node' | 'browser' | undefined;

const CURRENT_NODE_VERSION = process.version.replace('v', '').split('.')[0] as NodeVersion;

const RUN_AFFECTED = process.argv.includes('--affected');

const DEFAULT_SKIP_TESTS_PACKAGES = [
 '@sentry-internal/eslint-plugin-sdk',
// These packages are tested separately in CI, so no need to run them here
const DEFAULT_SKIP_PACKAGES = ['@sentry/profiling-node', '@sentry/bun', '@sentry/deno'];

// All other packages are run for multiple node versions
const BROWSER_TEST_PACKAGES = [
 '@sentry/ember',
 '@sentry/browser',
 '@sentry/vue',
Expand All@@ -26,10 +33,9 @@ const DEFAULT_SKIP_TESTS_PACKAGES = [
 '@sentry-internal/replay-worker',
 '@sentry-internal/feedback',
 '@sentry/wasm',
 '@sentry/bun',
 '@sentry/deno',
];

// These are Node-version specific tests that need to be skipped because of support
const SKIP_TEST_PACKAGES: Record<NodeVersion, VersionConfig> = {
 '14': {
 ignoredPackages: [
Expand All@@ -40,6 +46,7 @@ const SKIP_TEST_PACKAGES: Record<NodeVersion, VersionConfig> = {
 '@sentry/astro',
 '@sentry/nuxt',
 '@sentry/nestjs',
 '@sentry-internal/eslint-plugin-sdk',
@AbhiPrasadAbhiPrasadAug 12, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A micro optimization here is to change eslint-plugin-sdk to only run test for whatever the node version of the local env is.
We can effectively treat it as a browser test then.
@mydeamydeaAug 12, 2024

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

actually I guess we should technically run this in multiple node versions, as this is published? 🤔 and actually probably bump the min. node version of this to 16+ as it does not seem to work on 14... 😅 it's internal so I wouild not care about this too much 🤔 WDYT?
 ],
 },
 '16': {
Expand All@@ -56,6 +63,50 @@ const SKIP_TEST_PACKAGES: Record<NodeVersion, VersionConfig> = {
 },
};

function getAllPackages(): string[] {
 const { workspaces }: { workspaces: string[] } = JSON.parse(
 fs.readFileSync(path.join(process.cwd(), 'package.json'), 'utf-8'),
 );

 return workspaces.map(workspacePath => {
 const { name }: { name: string } = JSON.parse(
 fs.readFileSync(path.join(process.cwd(), workspacePath, 'package.json'), 'utf-8'),
 );
 return name;
 });
}

/**
 * Run the tests, accounting for compatibility problems in older versions of Node.
 */
function runTests(): void {
 const ignores = new Set<string>(DEFAULT_SKIP_PACKAGES);

 const packages = getAllPackages();

 if (UNIT_TEST_ENV === 'browser') {
 // Since we cannot "include" for affected mode, we instead exclude all other packages
 packages.forEach(pkg => {
 if (!BROWSER_TEST_PACKAGES.includes(pkg)) {
 ignores.add(pkg);
 }
 });
 } else if (UNIT_TEST_ENV === 'node') {
 BROWSER_TEST_PACKAGES.forEach(pkg => ignores.add(pkg));
 }

 const versionConfig = SKIP_TEST_PACKAGES[CURRENT_NODE_VERSION];
 if (versionConfig) {
 versionConfig.ignoredPackages.forEach(dep => ignores.add(dep));
 }

 if (RUN_AFFECTED) {
 runAffectedTests(ignores);
 } else {
 runAllTests(ignores);
 }
}

/**
 * Run the given shell command, piping the shell process's `stdin`, `stdout`, and `stderr` to that of the current
 * process. Returns contents of `stdout`.
Expand All@@ -67,41 +118,28 @@ function run(cmd: string, options?: childProcess.ExecSyncOptions): void {
/**
 * Run tests, ignoring the given packages
 */
function runWithIgnores(skipPackages: string[] = []): void {
 const ignoreFlags = skipPackages.map(dep => `--ignore="${dep}"`).join(' ');
function runAllTests(ignorePackages: Set<string>): void {
 const ignoreFlags = Array.from(ignorePackages)
 .map(dep => `--ignore="${dep}"`)
 .join(' ');

 run(`yarn test ${ignoreFlags}`);
}

/**
 * Run affected tests, ignoring the given packages
 */
function runAffectedWithIgnores(skipPackages: string[] = []): void {
function runAffectedTests(ignorePackages: Set<string>): void {
 const additionalArgs = process.argv
 .slice(2)
 .filter(arg => arg !== '--affected')
 .join(' ');
 const ignoreFlags = skipPackages.map(dep => `--exclude="${dep}"`).join(' ');
 run(`yarn test:pr ${ignoreFlags} ${additionalArgs}`);
}

/**
 * Run the tests, accounting for compatibility problems in older versions of Node.
 */
function runTests(): void {
 const ignores = new Set<string>();

 DEFAULT_SKIP_TESTS_PACKAGES.forEach(pkg => ignores.add(pkg));

 const versionConfig = SKIP_TEST_PACKAGES[CURRENT_NODE_VERSION];
 if (versionConfig) {
 versionConfig.ignoredPackages.forEach(dep => ignores.add(dep));
 }
 const excludeFlags = Array.from(ignorePackages)
 .map(dep => `--exclude="${dep}"`)
 .join(' ');

 if (RUN_AFFECTED) {
 runAffectedWithIgnores(Array.from(ignores));
 } else {
 runWithIgnores(Array.from(ignores));
 }
 run(`yarn test:pr ${excludeFlags} ${additionalArgs}`);
}

runTests();

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
ci: Streamline browser & node unit tests#13307

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

mydea
merged 3 commits into

from

Aug 14, 2024
 Merged


ci: Streamline browser & node unit tests
#13307
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
4af1d6a

ci: Streamline browser & node unit tests


mydea Aug 12, 2024
6b76889

add to checklist


mydea Aug 12, 2024
b1a6966

skip eslint test in node 14


mydea Aug 12, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
docs/new-sdk-release-checklist.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -45,8 +45,8 @@ differ slightly for other SDKs depending on how they are structured and how they

- [ ] Make sure `build.yml` CI script is correctly set up to cover tests for the new package

 - [ ] Ensure dependent packages are correctly set for “Determine changed packages”
 - [ ] Ensure unit tests run correctly
 - [ ] If it is a browser SDK, add it to `BROWSER_TEST_PACKAGES` in `scripts/ci-unit-tests.ts`

- [ ] Make sure the file paths in the
 ["Upload Artifacts" job](https://github.com/getsentry/sentry-javascript/blob/e5c1486eed236b878f2c49d6a04be86093816ac9/.github/workflows/build.yml#L314-L349)
Expand Down

8 changes: 4 additions & 4 deletions
package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,10 +35,10 @@
 "test:unit": "lerna run --ignore \"@sentry-internal/{browser-integration-tests,e2e-tests,integration-shims,node-integration-tests,overhead-metrics}\" test:unit",
 "test:update-snapshots": "lerna run test:update-snapshots",
 "test:pr": "nx affected -t test --exclude \"@sentry-internal/{browser-integration-tests,e2e-tests,integration-shims,node-integration-tests,overhead-metrics}\"",
 "test:pr:browser": "yarn test:pr --exclude \"@sentry/{core,utils,opentelemetry,bun,deno,node,profiling-node,aws-serverless,google-cloud-serverless,nextjs,nestjs,astro,cloudflare,solidstart,nuxt,remix,gatsby,sveltekit,vercel-edge}\"",
 "test:pr:node": "ts-node ./scripts/node-unit-tests.ts --affected",
 "test:ci:browser": "lerna run test --ignore \"@sentry/{core,utils,opentelemetry,bun,deno,node,profiling-node,aws-serverless,google-cloud-serverless,nextjs,nestjs,astro,cloudflare,solidstart,nuxt,remix,gatsby,sveltekit,vercel-edge}\" --ignore \"@sentry-internal/{browser-integration-tests,e2e-tests,integration-shims,node-integration-tests,overhead-metrics}\"",
 "test:ci:node": "ts-node ./scripts/node-unit-tests.ts",
 "test:pr:browser": "UNIT_TEST_ENV=browser ts-node ./scripts/ci-unit-tests.ts --affected",
 "test:pr:node": "UNIT_TEST_ENV=node ts-node ./scripts/ci-unit-tests.ts --affected",
 "test:ci:browser": "UNIT_TEST_ENV=browser ts-node ./scripts/ci-unit-tests.ts",
 "test:ci:node": "UNIT_TEST_ENV=node ts-node ./scripts/ci-unit-tests.ts",
 "test:ci:bun": "lerna run test --scope @sentry/bun",
 "yalc:publish": "lerna run yalc:publish"
 },
Expand Down

92 changes: 65 additions & 27 deletions
scripts/node-unit-tests.ts → scripts/ci-unit-tests.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,17 +1,24 @@
import * as childProcess from 'child_process';
import * as fs from 'fs';
import * as path from 'path';

type NodeVersion = '14' | '16' | '18' | '20' | '21';

interface VersionConfig {
 ignoredPackages: Array<`@${'sentry' | 'sentry-internal'}/${string}`>;
}

const UNIT_TEST_ENV = process.env.UNIT_TEST_ENV as 'node' | 'browser' | undefined;

const CURRENT_NODE_VERSION = process.version.replace('v', '').split('.')[0] as NodeVersion;

const RUN_AFFECTED = process.argv.includes('--affected');

const DEFAULT_SKIP_TESTS_PACKAGES = [
 '@sentry-internal/eslint-plugin-sdk',
// These packages are tested separately in CI, so no need to run them here
const DEFAULT_SKIP_PACKAGES = ['@sentry/profiling-node', '@sentry/bun', '@sentry/deno'];

// All other packages are run for multiple node versions
const BROWSER_TEST_PACKAGES = [
 '@sentry/ember',
 '@sentry/browser',
 '@sentry/vue',
Expand All@@ -26,10 +33,9 @@ const DEFAULT_SKIP_TESTS_PACKAGES = [
 '@sentry-internal/replay-worker',
 '@sentry-internal/feedback',
 '@sentry/wasm',
 '@sentry/bun',
 '@sentry/deno',
];

// These are Node-version specific tests that need to be skipped because of support
const SKIP_TEST_PACKAGES: Record<NodeVersion, VersionConfig> = {
 '14': {
 ignoredPackages: [
Expand All@@ -40,6 +46,7 @@ const SKIP_TEST_PACKAGES: Record<NodeVersion, VersionConfig> = {
 '@sentry/astro',
 '@sentry/nuxt',
 '@sentry/nestjs',
 '@sentry-internal/eslint-plugin-sdk',
@AbhiPrasadAbhiPrasadAug 12, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A micro optimization here is to change eslint-plugin-sdk to only run test for whatever the node version of the local env is.
We can effectively treat it as a browser test then.
@mydeamydeaAug 12, 2024

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

actually I guess we should technically run this in multiple node versions, as this is published? 🤔 and actually probably bump the min. node version of this to 16+ as it does not seem to work on 14... 😅 it's internal so I wouild not care about this too much 🤔 WDYT?
 ],
 },
 '16': {
Expand All@@ -56,6 +63,50 @@ const SKIP_TEST_PACKAGES: Record<NodeVersion, VersionConfig> = {
 },
};

function getAllPackages(): string[] {
 const { workspaces }: { workspaces: string[] } = JSON.parse(
 fs.readFileSync(path.join(process.cwd(), 'package.json'), 'utf-8'),
 );

 return workspaces.map(workspacePath => {
 const { name }: { name: string } = JSON.parse(
 fs.readFileSync(path.join(process.cwd(), workspacePath, 'package.json'), 'utf-8'),
 );
 return name;
 });
}

/**
 * Run the tests, accounting for compatibility problems in older versions of Node.
 */
function runTests(): void {
 const ignores = new Set<string>(DEFAULT_SKIP_PACKAGES);

 const packages = getAllPackages();

 if (UNIT_TEST_ENV === 'browser') {
 // Since we cannot "include" for affected mode, we instead exclude all other packages
 packages.forEach(pkg => {
 if (!BROWSER_TEST_PACKAGES.includes(pkg)) {
 ignores.add(pkg);
 }
 });
 } else if (UNIT_TEST_ENV === 'node') {
 BROWSER_TEST_PACKAGES.forEach(pkg => ignores.add(pkg));
 }

 const versionConfig = SKIP_TEST_PACKAGES[CURRENT_NODE_VERSION];
 if (versionConfig) {
 versionConfig.ignoredPackages.forEach(dep => ignores.add(dep));
 }

 if (RUN_AFFECTED) {
 runAffectedTests(ignores);
 } else {
 runAllTests(ignores);
 }
}

/**
 * Run the given shell command, piping the shell process's `stdin`, `stdout`, and `stderr` to that of the current
 * process. Returns contents of `stdout`.
Expand All@@ -67,41 +118,28 @@ function run(cmd: string, options?: childProcess.ExecSyncOptions): void {
/**
 * Run tests, ignoring the given packages
 */
function runWithIgnores(skipPackages: string[] = []): void {
 const ignoreFlags = skipPackages.map(dep => `--ignore="${dep}"`).join(' ');
function runAllTests(ignorePackages: Set<string>): void {
 const ignoreFlags = Array.from(ignorePackages)
 .map(dep => `--ignore="${dep}"`)
 .join(' ');

 run(`yarn test ${ignoreFlags}`);
}

/**
 * Run affected tests, ignoring the given packages
 */
function runAffectedWithIgnores(skipPackages: string[] = []): void {
function runAffectedTests(ignorePackages: Set<string>): void {
 const additionalArgs = process.argv
 .slice(2)
 .filter(arg => arg !== '--affected')
 .join(' ');
 const ignoreFlags = skipPackages.map(dep => `--exclude="${dep}"`).join(' ');
 run(`yarn test:pr ${ignoreFlags} ${additionalArgs}`);
}

/**
 * Run the tests, accounting for compatibility problems in older versions of Node.
 */
function runTests(): void {
 const ignores = new Set<string>();

 DEFAULT_SKIP_TESTS_PACKAGES.forEach(pkg => ignores.add(pkg));

 const versionConfig = SKIP_TEST_PACKAGES[CURRENT_NODE_VERSION];
 if (versionConfig) {
 versionConfig.ignoredPackages.forEach(dep => ignores.add(dep));
 }
 const excludeFlags = Array.from(ignorePackages)
 .map(dep => `--exclude="${dep}"`)
 .join(' ');

 if (RUN_AFFECTED) {
 runAffectedWithIgnores(Array.from(ignores));
 } else {
 runWithIgnores(Array.from(ignores));
 }
 run(`yarn test:pr ${excludeFlags} ${additionalArgs}`);
}

runTests();

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
ci: Streamline browser & node unit tests#13307

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

mydea
merged 3 commits into

from

Aug 14, 2024
 Merged


ci: Streamline browser & node unit tests
#13307
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
4af1d6a

ci: Streamline browser & node unit tests


mydea Aug 12, 2024
6b76889

add to checklist


mydea Aug 12, 2024
b1a6966

skip eslint test in node 14


mydea Aug 12, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
docs/new-sdk-release-checklist.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -45,8 +45,8 @@ differ slightly for other SDKs depending on how they are structured and how they

- [ ] Make sure `build.yml` CI script is correctly set up to cover tests for the new package

 - [ ] Ensure dependent packages are correctly set for “Determine changed packages”
 - [ ] Ensure unit tests run correctly
 - [ ] If it is a browser SDK, add it to `BROWSER_TEST_PACKAGES` in `scripts/ci-unit-tests.ts`

- [ ] Make sure the file paths in the
 ["Upload Artifacts" job](https://github.com/getsentry/sentry-javascript/blob/e5c1486eed236b878f2c49d6a04be86093816ac9/.github/workflows/build.yml#L314-L349)
Expand Down

8 changes: 4 additions & 4 deletions
package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,10 +35,10 @@
 "test:unit": "lerna run --ignore \"@sentry-internal/{browser-integration-tests,e2e-tests,integration-shims,node-integration-tests,overhead-metrics}\" test:unit",
 "test:update-snapshots": "lerna run test:update-snapshots",
 "test:pr": "nx affected -t test --exclude \"@sentry-internal/{browser-integration-tests,e2e-tests,integration-shims,node-integration-tests,overhead-metrics}\"",
 "test:pr:browser": "yarn test:pr --exclude \"@sentry/{core,utils,opentelemetry,bun,deno,node,profiling-node,aws-serverless,google-cloud-serverless,nextjs,nestjs,astro,cloudflare,solidstart,nuxt,remix,gatsby,sveltekit,vercel-edge}\"",
 "test:pr:node": "ts-node ./scripts/node-unit-tests.ts --affected",
 "test:ci:browser": "lerna run test --ignore \"@sentry/{core,utils,opentelemetry,bun,deno,node,profiling-node,aws-serverless,google-cloud-serverless,nextjs,nestjs,astro,cloudflare,solidstart,nuxt,remix,gatsby,sveltekit,vercel-edge}\" --ignore \"@sentry-internal/{browser-integration-tests,e2e-tests,integration-shims,node-integration-tests,overhead-metrics}\"",
 "test:ci:node": "ts-node ./scripts/node-unit-tests.ts",
 "test:pr:browser": "UNIT_TEST_ENV=browser ts-node ./scripts/ci-unit-tests.ts --affected",
 "test:pr:node": "UNIT_TEST_ENV=node ts-node ./scripts/ci-unit-tests.ts --affected",
 "test:ci:browser": "UNIT_TEST_ENV=browser ts-node ./scripts/ci-unit-tests.ts",
 "test:ci:node": "UNIT_TEST_ENV=node ts-node ./scripts/ci-unit-tests.ts",
 "test:ci:bun": "lerna run test --scope @sentry/bun",
 "yalc:publish": "lerna run yalc:publish"
 },
Expand Down

92 changes: 65 additions & 27 deletions
scripts/node-unit-tests.ts → scripts/ci-unit-tests.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,17 +1,24 @@
import * as childProcess from 'child_process';
import * as fs from 'fs';
import * as path from 'path';

type NodeVersion = '14' | '16' | '18' | '20' | '21';

interface VersionConfig {
 ignoredPackages: Array<`@${'sentry' | 'sentry-internal'}/${string}`>;
}

const UNIT_TEST_ENV = process.env.UNIT_TEST_ENV as 'node' | 'browser' | undefined;

const CURRENT_NODE_VERSION = process.version.replace('v', '').split('.')[0] as NodeVersion;

const RUN_AFFECTED = process.argv.includes('--affected');

const DEFAULT_SKIP_TESTS_PACKAGES = [
 '@sentry-internal/eslint-plugin-sdk',
// These packages are tested separately in CI, so no need to run them here
const DEFAULT_SKIP_PACKAGES = ['@sentry/profiling-node', '@sentry/bun', '@sentry/deno'];

// All other packages are run for multiple node versions
const BROWSER_TEST_PACKAGES = [
 '@sentry/ember',
 '@sentry/browser',
 '@sentry/vue',
Expand All@@ -26,10 +33,9 @@ const DEFAULT_SKIP_TESTS_PACKAGES = [
 '@sentry-internal/replay-worker',
 '@sentry-internal/feedback',
 '@sentry/wasm',
 '@sentry/bun',
 '@sentry/deno',
];

// These are Node-version specific tests that need to be skipped because of support
const SKIP_TEST_PACKAGES: Record<NodeVersion, VersionConfig> = {
 '14': {
 ignoredPackages: [
Expand All@@ -40,6 +46,7 @@ const SKIP_TEST_PACKAGES: Record<NodeVersion, VersionConfig> = {
 '@sentry/astro',
 '@sentry/nuxt',
 '@sentry/nestjs',
 '@sentry-internal/eslint-plugin-sdk',
@AbhiPrasadAbhiPrasadAug 12, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A micro optimization here is to change eslint-plugin-sdk to only run test for whatever the node version of the local env is.
We can effectively treat it as a browser test then.
@mydeamydeaAug 12, 2024

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

actually I guess we should technically run this in multiple node versions, as this is published? 🤔 and actually probably bump the min. node version of this to 16+ as it does not seem to work on 14... 😅 it's internal so I wouild not care about this too much 🤔 WDYT?
 ],
 },
 '16': {
Expand All@@ -56,6 +63,50 @@ const SKIP_TEST_PACKAGES: Record<NodeVersion, VersionConfig> = {
 },
};

function getAllPackages(): string[] {
 const { workspaces }: { workspaces: string[] } = JSON.parse(
 fs.readFileSync(path.join(process.cwd(), 'package.json'), 'utf-8'),
 );

 return workspaces.map(workspacePath => {
 const { name }: { name: string } = JSON.parse(
 fs.readFileSync(path.join(process.cwd(), workspacePath, 'package.json'), 'utf-8'),
 );
 return name;
 });
}

/**
 * Run the tests, accounting for compatibility problems in older versions of Node.
 */
function runTests(): void {
 const ignores = new Set<string>(DEFAULT_SKIP_PACKAGES);

 const packages = getAllPackages();

 if (UNIT_TEST_ENV === 'browser') {
 // Since we cannot "include" for affected mode, we instead exclude all other packages
 packages.forEach(pkg => {
 if (!BROWSER_TEST_PACKAGES.includes(pkg)) {
 ignores.add(pkg);
 }
 });
 } else if (UNIT_TEST_ENV === 'node') {
 BROWSER_TEST_PACKAGES.forEach(pkg => ignores.add(pkg));
 }

 const versionConfig = SKIP_TEST_PACKAGES[CURRENT_NODE_VERSION];
 if (versionConfig) {
 versionConfig.ignoredPackages.forEach(dep => ignores.add(dep));
 }

 if (RUN_AFFECTED) {
 runAffectedTests(ignores);
 } else {
 runAllTests(ignores);
 }
}

/**
 * Run the given shell command, piping the shell process's `stdin`, `stdout`, and `stderr` to that of the current
 * process. Returns contents of `stdout`.
Expand All@@ -67,41 +118,28 @@ function run(cmd: string, options?: childProcess.ExecSyncOptions): void {
/**
 * Run tests, ignoring the given packages
 */
function runWithIgnores(skipPackages: string[] = []): void {
 const ignoreFlags = skipPackages.map(dep => `--ignore="${dep}"`).join(' ');
function runAllTests(ignorePackages: Set<string>): void {
 const ignoreFlags = Array.from(ignorePackages)
 .map(dep => `--ignore="${dep}"`)
 .join(' ');

 run(`yarn test ${ignoreFlags}`);
}

/**
 * Run affected tests, ignoring the given packages
 */
function runAffectedWithIgnores(skipPackages: string[] = []): void {
function runAffectedTests(ignorePackages: Set<string>): void {
 const additionalArgs = process.argv
 .slice(2)
 .filter(arg => arg !== '--affected')
 .join(' ');
 const ignoreFlags = skipPackages.map(dep => `--exclude="${dep}"`).join(' ');
 run(`yarn test:pr ${ignoreFlags} ${additionalArgs}`);
}

/**
 * Run the tests, accounting for compatibility problems in older versions of Node.
 */
function runTests(): void {
 const ignores = new Set<string>();

 DEFAULT_SKIP_TESTS_PACKAGES.forEach(pkg => ignores.add(pkg));

 const versionConfig = SKIP_TEST_PACKAGES[CURRENT_NODE_VERSION];
 if (versionConfig) {
 versionConfig.ignoredPackages.forEach(dep => ignores.add(dep));
 }
 const excludeFlags = Array.from(ignorePackages)
 .map(dep => `--exclude="${dep}"`)
 .join(' ');

 if (RUN_AFFECTED) {
 runAffectedWithIgnores(Array.from(ignores));
 } else {
 runWithIgnores(Array.from(ignores));
 }
 run(`yarn test:pr ${excludeFlags} ${additionalArgs}`);
}

runTests();