build(polyfills): Remove output format specific logic#9467

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
lforst merged 2 commits into from
Nov 7, 2023
Merged

build(polyfills): Remove output format specific logic #9467

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
58141b5
build(polyfills): Remove output format specific logic
Nov 7, 2023
1460a70
I want 2 hours of my life back
Nov 7, 2023
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 nx.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,7 @@
},
"build:transpile": {
"inputs": ["production", "^production"],
"dependsOn": ["^build:transpile:uncached", "^build:transpile", "build:transpile:uncached"],
"dependsOn": ["^build:transpile"],
"outputs": ["{projectRoot}/build/npm", "{projectRoot}/build/esm", "{projectRoot}/build/cjs"]
},
"build:types": {
Expand Down
1 change: 0 additions & 1 deletion packages/angular-ivy/package.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -67,7 +67,6 @@
"build:transpile": {
"dependsOn": [
"^build:transpile",
"^build:transpile:uncached",
"^build:types"
]
}
Expand Down
1 change: 0 additions & 1 deletion packages/angular/package.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -71,7 +71,6 @@
"build:transpile": {
"dependsOn": [
"^build:transpile",
"^build:transpile:uncached",
"^build:types"
]
}
Expand Down
1 change: 0 additions & 1 deletion packages/utils/package.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -34,7 +34,6 @@
"build": "run-p build:transpile build:types",
"build:dev": "yarn build",
"build:transpile": "yarn ts-node scripts/buildRollup.ts",
"build:transpile:uncached": "yarn ts-node scripts/buildRollup.ts",
"build:types": "run-s build:types:core build:types:downlevel",
"build:types:core": "tsc -p tsconfig.types.json",
"build:types:downlevel": "yarn downlevel-dts build/types build/types-ts3.8 --to ts3.8",
Expand Down
8 changes: 1 addition & 7 deletions packages/utils/rollup.npm.config.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,3 @@
import { makeBaseNPMConfig, makeNPMConfigVariants } from '../../rollup/index.js';

export default makeNPMConfigVariants(
makeBaseNPMConfig({
// We build the polyfills separately because they're not included in the top-level exports of the package, in order
// to keep them out of the public API.
entrypoints: ['src/index.ts', 'src/buildPolyfills/index.ts'],
}),
);
export default makeNPMConfigVariants(makeBaseNPMConfig());
14 changes: 0 additions & 14 deletions packages/utils/scripts/buildRollup.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,17 +14,3 @@ run('yarn rollup -c rollup.npm.config.js');
// We want to distribute the README because it contains the MIT license blurb from Sucrase and Rollup
fs.copyFileSync('src/buildPolyfills/README.md', 'build/cjs/buildPolyfills/README.md');
fs.copyFileSync('src/buildPolyfills/README.md', 'build/esm/buildPolyfills/README.md');

Comment thread
lforst marked this conversation as resolved.
// Because we import our polyfills from `@sentry/utils/cjs/buildPolyfills` and `@sentry/utils/esm/buildPolyfills` rather
// than straight from `@sentry/utils` (so as to avoid having them in the package's public API), when tests run, they'll
// expect to find `cjs` and `esm` at the root level of the repo.
try {
fs.symlinkSync('build/cjs', 'cjs');
} catch (oO) {
// if we get here, it's because the symlink already exists, so we're good
}
try {
fs.symlinkSync('build/esm', 'esm');
} catch (oO) {
// same as above
}
2 changes: 1 addition & 1 deletion packages/utils/src/buildPolyfills/README.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
## Build Polyfills

This is a collection of syntax and import/export polyfills either copied directly from or heavily inspired by those used by [Rollup](https://github.com/rollup/rollup) and [Sucrase](https://github.com/alangpierce/sucrase). When either tool uses one of these polyfills during a build, it injects the function source code into each file needing the function, which can lead to a great deal of duplication. For our builds, we have therefore implemented something similar to [`tsc`'s `importHelpers` behavior](https://www.typescriptlang.org/tsconfig#importHelpers): Instead of leaving the polyfills injected in multiple places, we instead replace each injected function with an `import` or `require` statement, pulling from the CJS or ESM builds as appropriate. (In other words, the injected `import` statements import from `@sentry/utils/esm/buildPolyfills` and the injected `require` statements pull from `@sentry/utils/cjs/buildPolyfills/`. Because these functions should never be part of the public API, they're not exported from the package directly.)
This is a collection of syntax and import/export polyfills either copied directly from or heavily inspired by those used by [Rollup](https://github.com/rollup/rollup) and [Sucrase](https://github.com/alangpierce/sucrase). When either tool uses one of these polyfills during a build, it injects the function source code into each file needing the function, which can lead to a great deal of duplication. For our builds, we have therefore implemented something similar to [`tsc`'s `importHelpers` behavior](https://www.typescriptlang.org/tsconfig#importHelpers): Instead of leaving the polyfills injected in multiple places, we instead replace each injected function with an `import` or `require` statement.

Note that not all polyfills are currently used by the SDK, but all are included here for future compatitibility, should they ever be needed. Also, since we're never going to be calling these directly from within another TS file, their types are fairly generic. In some cases testing required more specific types, which can be found in the test files.

Expand Down
1 change: 1 addition & 0 deletions packages/utils/src/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -34,3 +34,4 @@ export * from './cache';
export * from './eventbuilder';
export * from './anr';
export * from './lru';
export * from './buildPolyfills';
11 changes: 8 additions & 3 deletions rollup/plugins/extractPolyfillsPlugin.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -40,6 +40,13 @@ export function makeExtractPolyfillsPlugin() {
return null;
}

// The index.js file of the tuils package will include identifiers named after polyfills so we would inject the
// polyfills, however that would override the exports so we should just skip that file.
const isUtilsPackage = process.cwd().endsWith('packages/utils');
if (isUtilsPackage && sourceFile === 'index.js') {
return null;
}

const parserOptions = {
sourceFileName: sourceFile,
// We supply a custom parser which wraps the provided `acorn` parser in order to override the `ecmaVersion` value.
Expand DownExpand Up@@ -187,9 +194,7 @@ function createImportOrRequireNode(polyfillNodes, currentSourceFile, moduleForma
// relative
const isUtilsPackage = process.cwd().endsWith('packages/utils');
const importSource = literal(
isUtilsPackage
? `./${path.relative(path.dirname(currentSourceFile), 'buildPolyfills')}`
: `@sentry/utils/${moduleFormat}/buildPolyfills`,
isUtilsPackage ? `./${path.relative(path.dirname(currentSourceFile), 'buildPolyfills')}` : '@sentry/utils',
);

// This is the `x, y, z` of inside of `import { x, y, z }` or `var { x, y, z }`
Expand Down
, '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
build(polyfills): Remove output format specific logic#9467

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

lforst
merged 2 commits into

from

Nov 7, 2023
 Merged


build(polyfills): Remove output format specific logic
#9467
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
58141b5

build(polyfills): Remove output format specific logic

Nov 7, 2023
1460a70

I want 2 hours of my life back

Nov 7, 2023

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
nx.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,7 @@
 },
 "build:transpile": {
 "inputs": ["production", "^production"],
 "dependsOn": ["^build:transpile:uncached", "^build:transpile", "build:transpile:uncached"],
 "dependsOn": ["^build:transpile"],
 "outputs": ["{projectRoot}/build/npm", "{projectRoot}/build/esm", "{projectRoot}/build/cjs"]
 },
 "build:types": {
Expand Down

1 change: 0 additions & 1 deletion
packages/angular-ivy/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -67,7 +67,6 @@
 "build:transpile": {
 "dependsOn": [
 "^build:transpile",
 "^build:transpile:uncached",
 "^build:types"
 ]
 }
Expand Down

1 change: 0 additions & 1 deletion
packages/angular/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -71,7 +71,6 @@
 "build:transpile": {
 "dependsOn": [
 "^build:transpile",
 "^build:transpile:uncached",
 "^build:types"
 ]
 }
Expand Down

1 change: 0 additions & 1 deletion
packages/utils/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,7 +34,6 @@
 "build": "run-p build:transpile build:types",
 "build:dev": "yarn build",
 "build:transpile": "yarn ts-node scripts/buildRollup.ts",
 "build:transpile:uncached": "yarn ts-node scripts/buildRollup.ts",
 "build:types": "run-s build:types:core build:types:downlevel",
 "build:types:core": "tsc -p tsconfig.types.json",
 "build:types:downlevel": "yarn downlevel-dts build/types build/types-ts3.8 --to ts3.8",
Expand Down

8 changes: 1 addition & 7 deletions
packages/utils/rollup.npm.config.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,9 +1,3 @@
import { makeBaseNPMConfig, makeNPMConfigVariants } from '../../rollup/index.js';

export default makeNPMConfigVariants(
 makeBaseNPMConfig({
 // We build the polyfills separately because they're not included in the top-level exports of the package, in order
 // to keep them out of the public API.
 entrypoints: ['src/index.ts', 'src/buildPolyfills/index.ts'],
 }),
);
export default makeNPMConfigVariants(makeBaseNPMConfig());

14 changes: 0 additions & 14 deletions
packages/utils/scripts/buildRollup.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,17 +14,3 @@ run('yarn rollup -c rollup.npm.config.js');
// We want to distribute the README because it contains the MIT license blurb from Sucrase and Rollup
fs.copyFileSync('src/buildPolyfills/README.md', 'build/cjs/buildPolyfills/README.md');
fs.copyFileSync('src/buildPolyfills/README.md', 'build/esm/buildPolyfills/README.md');

Comment thread
lforst marked this conversation as resolved.

// Because we import our polyfills from `@sentry/utils/cjs/buildPolyfills` and `@sentry/utils/esm/buildPolyfills` rather
// than straight from `@sentry/utils` (so as to avoid having them in the package's public API), when tests run, they'll
// expect to find `cjs` and `esm` at the root level of the repo.
try {
 fs.symlinkSync('build/cjs', 'cjs');
} catch (oO) {
 // if we get here, it's because the symlink already exists, so we're good
}
try {
 fs.symlinkSync('build/esm', 'esm');
} catch (oO) {
 // same as above
}

2 changes: 1 addition & 1 deletion
packages/utils/src/buildPolyfills/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
## Build Polyfills

This is a collection of syntax and import/export polyfills either copied directly from or heavily inspired by those used by [Rollup](https://github.com/rollup/rollup) and [Sucrase](https://github.com/alangpierce/sucrase). When either tool uses one of these polyfills during a build, it injects the function source code into each file needing the function, which can lead to a great deal of duplication. For our builds, we have therefore implemented something similar to [`tsc`'s `importHelpers` behavior](https://www.typescriptlang.org/tsconfig#importHelpers): Instead of leaving the polyfills injected in multiple places, we instead replace each injected function with an `import` or `require` statement, pulling from the CJS or ESM builds as appropriate. (In other words, the injected `import` statements import from `@sentry/utils/esm/buildPolyfills` and the injected `require` statements pull from `@sentry/utils/cjs/buildPolyfills/`. Because these functions should never be part of the public API, they're not exported from the package directly.)
This is a collection of syntax and import/export polyfills either copied directly from or heavily inspired by those used by [Rollup](https://github.com/rollup/rollup) and [Sucrase](https://github.com/alangpierce/sucrase). When either tool uses one of these polyfills during a build, it injects the function source code into each file needing the function, which can lead to a great deal of duplication. For our builds, we have therefore implemented something similar to [`tsc`'s `importHelpers` behavior](https://www.typescriptlang.org/tsconfig#importHelpers): Instead of leaving the polyfills injected in multiple places, we instead replace each injected function with an `import` or `require` statement.

Note that not all polyfills are currently used by the SDK, but all are included here for future compatitibility, should they ever be needed. Also, since we're never going to be calling these directly from within another TS file, their types are fairly generic. In some cases testing required more specific types, which can be found in the test files.

Expand Down

1 change: 1 addition & 0 deletions
packages/utils/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,3 +34,4 @@ export * from './cache';
export * from './eventbuilder';
export * from './anr';
export * from './lru';
export * from './buildPolyfills';

11 changes: 8 additions & 3 deletions
rollup/plugins/extractPolyfillsPlugin.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -40,6 +40,13 @@ export function makeExtractPolyfillsPlugin() {
 return null;
 }

 // The index.js file of the tuils package will include identifiers named after polyfills so we would inject the
 // polyfills, however that would override the exports so we should just skip that file.
 const isUtilsPackage = process.cwd().endsWith('packages/utils');
 if (isUtilsPackage && sourceFile === 'index.js') {
 return null;
 }

 const parserOptions = {
 sourceFileName: sourceFile,
 // We supply a custom parser which wraps the provided `acorn` parser in order to override the `ecmaVersion` value.
Expand DownExpand Up@@ -187,9 +194,7 @@ function createImportOrRequireNode(polyfillNodes, currentSourceFile, moduleForma
 // relative
 const isUtilsPackage = process.cwd().endsWith('packages/utils');
 const importSource = literal(
 isUtilsPackage
 ? `./${path.relative(path.dirname(currentSourceFile), 'buildPolyfills')}`
 : `@sentry/utils/${moduleFormat}/buildPolyfills`,
 isUtilsPackage ? `./${path.relative(path.dirname(currentSourceFile), 'buildPolyfills')}` : '@sentry/utils',
 );

 // This is the `x, y, z` of inside of `import { x, y, z }` or `var { x, y, z }`
Expand Down

, '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
build(polyfills): Remove output format specific logic#9467

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

lforst
merged 2 commits into

from

Nov 7, 2023
 Merged


build(polyfills): Remove output format specific logic
#9467
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
58141b5

build(polyfills): Remove output format specific logic

Nov 7, 2023
1460a70

I want 2 hours of my life back

Nov 7, 2023

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
nx.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,7 @@
 },
 "build:transpile": {
 "inputs": ["production", "^production"],
 "dependsOn": ["^build:transpile:uncached", "^build:transpile", "build:transpile:uncached"],
 "dependsOn": ["^build:transpile"],
 "outputs": ["{projectRoot}/build/npm", "{projectRoot}/build/esm", "{projectRoot}/build/cjs"]
 },
 "build:types": {
Expand Down

1 change: 0 additions & 1 deletion
packages/angular-ivy/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -67,7 +67,6 @@
 "build:transpile": {
 "dependsOn": [
 "^build:transpile",
 "^build:transpile:uncached",
 "^build:types"
 ]
 }
Expand Down

1 change: 0 additions & 1 deletion
packages/angular/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -71,7 +71,6 @@
 "build:transpile": {
 "dependsOn": [
 "^build:transpile",
 "^build:transpile:uncached",
 "^build:types"
 ]
 }
Expand Down

1 change: 0 additions & 1 deletion
packages/utils/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,7 +34,6 @@
 "build": "run-p build:transpile build:types",
 "build:dev": "yarn build",
 "build:transpile": "yarn ts-node scripts/buildRollup.ts",
 "build:transpile:uncached": "yarn ts-node scripts/buildRollup.ts",
 "build:types": "run-s build:types:core build:types:downlevel",
 "build:types:core": "tsc -p tsconfig.types.json",
 "build:types:downlevel": "yarn downlevel-dts build/types build/types-ts3.8 --to ts3.8",
Expand Down

8 changes: 1 addition & 7 deletions
packages/utils/rollup.npm.config.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,9 +1,3 @@
import { makeBaseNPMConfig, makeNPMConfigVariants } from '../../rollup/index.js';

export default makeNPMConfigVariants(
 makeBaseNPMConfig({
 // We build the polyfills separately because they're not included in the top-level exports of the package, in order
 // to keep them out of the public API.
 entrypoints: ['src/index.ts', 'src/buildPolyfills/index.ts'],
 }),
);
export default makeNPMConfigVariants(makeBaseNPMConfig());

14 changes: 0 additions & 14 deletions
packages/utils/scripts/buildRollup.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,17 +14,3 @@ run('yarn rollup -c rollup.npm.config.js');
// We want to distribute the README because it contains the MIT license blurb from Sucrase and Rollup
fs.copyFileSync('src/buildPolyfills/README.md', 'build/cjs/buildPolyfills/README.md');
fs.copyFileSync('src/buildPolyfills/README.md', 'build/esm/buildPolyfills/README.md');

Comment thread
lforst marked this conversation as resolved.

// Because we import our polyfills from `@sentry/utils/cjs/buildPolyfills` and `@sentry/utils/esm/buildPolyfills` rather
// than straight from `@sentry/utils` (so as to avoid having them in the package's public API), when tests run, they'll
// expect to find `cjs` and `esm` at the root level of the repo.
try {
 fs.symlinkSync('build/cjs', 'cjs');
} catch (oO) {
 // if we get here, it's because the symlink already exists, so we're good
}
try {
 fs.symlinkSync('build/esm', 'esm');
} catch (oO) {
 // same as above
}

2 changes: 1 addition & 1 deletion
packages/utils/src/buildPolyfills/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
## Build Polyfills

This is a collection of syntax and import/export polyfills either copied directly from or heavily inspired by those used by [Rollup](https://github.com/rollup/rollup) and [Sucrase](https://github.com/alangpierce/sucrase). When either tool uses one of these polyfills during a build, it injects the function source code into each file needing the function, which can lead to a great deal of duplication. For our builds, we have therefore implemented something similar to [`tsc`'s `importHelpers` behavior](https://www.typescriptlang.org/tsconfig#importHelpers): Instead of leaving the polyfills injected in multiple places, we instead replace each injected function with an `import` or `require` statement, pulling from the CJS or ESM builds as appropriate. (In other words, the injected `import` statements import from `@sentry/utils/esm/buildPolyfills` and the injected `require` statements pull from `@sentry/utils/cjs/buildPolyfills/`. Because these functions should never be part of the public API, they're not exported from the package directly.)
This is a collection of syntax and import/export polyfills either copied directly from or heavily inspired by those used by [Rollup](https://github.com/rollup/rollup) and [Sucrase](https://github.com/alangpierce/sucrase). When either tool uses one of these polyfills during a build, it injects the function source code into each file needing the function, which can lead to a great deal of duplication. For our builds, we have therefore implemented something similar to [`tsc`'s `importHelpers` behavior](https://www.typescriptlang.org/tsconfig#importHelpers): Instead of leaving the polyfills injected in multiple places, we instead replace each injected function with an `import` or `require` statement.

Note that not all polyfills are currently used by the SDK, but all are included here for future compatitibility, should they ever be needed. Also, since we're never going to be calling these directly from within another TS file, their types are fairly generic. In some cases testing required more specific types, which can be found in the test files.

Expand Down

1 change: 1 addition & 0 deletions
packages/utils/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,3 +34,4 @@ export * from './cache';
export * from './eventbuilder';
export * from './anr';
export * from './lru';
export * from './buildPolyfills';

11 changes: 8 additions & 3 deletions
rollup/plugins/extractPolyfillsPlugin.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -40,6 +40,13 @@ export function makeExtractPolyfillsPlugin() {
 return null;
 }

 // The index.js file of the tuils package will include identifiers named after polyfills so we would inject the
 // polyfills, however that would override the exports so we should just skip that file.
 const isUtilsPackage = process.cwd().endsWith('packages/utils');
 if (isUtilsPackage && sourceFile === 'index.js') {
 return null;
 }

 const parserOptions = {
 sourceFileName: sourceFile,
 // We supply a custom parser which wraps the provided `acorn` parser in order to override the `ecmaVersion` value.
Expand DownExpand Up@@ -187,9 +194,7 @@ function createImportOrRequireNode(polyfillNodes, currentSourceFile, moduleForma
 // relative
 const isUtilsPackage = process.cwd().endsWith('packages/utils');
 const importSource = literal(
 isUtilsPackage
 ? `./${path.relative(path.dirname(currentSourceFile), 'buildPolyfills')}`
 : `@sentry/utils/${moduleFormat}/buildPolyfills`,
 isUtilsPackage ? `./${path.relative(path.dirname(currentSourceFile), 'buildPolyfills')}` : '@sentry/utils',
 );

 // This is the `x, y, z` of inside of `import { x, y, z }` or `var { x, y, z }`
Expand Down

, '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
build(polyfills): Remove output format specific logic#9467

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

lforst
merged 2 commits into

from

Nov 7, 2023
 Merged


build(polyfills): Remove output format specific logic
#9467
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
58141b5

build(polyfills): Remove output format specific logic

Nov 7, 2023
1460a70

I want 2 hours of my life back

Nov 7, 2023

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
nx.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,7 @@
 },
 "build:transpile": {
 "inputs": ["production", "^production"],
 "dependsOn": ["^build:transpile:uncached", "^build:transpile", "build:transpile:uncached"],
 "dependsOn": ["^build:transpile"],
 "outputs": ["{projectRoot}/build/npm", "{projectRoot}/build/esm", "{projectRoot}/build/cjs"]
 },
 "build:types": {
Expand Down

1 change: 0 additions & 1 deletion
packages/angular-ivy/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -67,7 +67,6 @@
 "build:transpile": {
 "dependsOn": [
 "^build:transpile",
 "^build:transpile:uncached",
 "^build:types"
 ]
 }
Expand Down

1 change: 0 additions & 1 deletion
packages/angular/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -71,7 +71,6 @@
 "build:transpile": {
 "dependsOn": [
 "^build:transpile",
 "^build:transpile:uncached",
 "^build:types"
 ]
 }
Expand Down

1 change: 0 additions & 1 deletion
packages/utils/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,7 +34,6 @@
 "build": "run-p build:transpile build:types",
 "build:dev": "yarn build",
 "build:transpile": "yarn ts-node scripts/buildRollup.ts",
 "build:transpile:uncached": "yarn ts-node scripts/buildRollup.ts",
 "build:types": "run-s build:types:core build:types:downlevel",
 "build:types:core": "tsc -p tsconfig.types.json",
 "build:types:downlevel": "yarn downlevel-dts build/types build/types-ts3.8 --to ts3.8",
Expand Down

8 changes: 1 addition & 7 deletions
packages/utils/rollup.npm.config.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,9 +1,3 @@
import { makeBaseNPMConfig, makeNPMConfigVariants } from '../../rollup/index.js';

export default makeNPMConfigVariants(
 makeBaseNPMConfig({
 // We build the polyfills separately because they're not included in the top-level exports of the package, in order
 // to keep them out of the public API.
 entrypoints: ['src/index.ts', 'src/buildPolyfills/index.ts'],
 }),
);
export default makeNPMConfigVariants(makeBaseNPMConfig());

14 changes: 0 additions & 14 deletions
packages/utils/scripts/buildRollup.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,17 +14,3 @@ run('yarn rollup -c rollup.npm.config.js');
// We want to distribute the README because it contains the MIT license blurb from Sucrase and Rollup
fs.copyFileSync('src/buildPolyfills/README.md', 'build/cjs/buildPolyfills/README.md');
fs.copyFileSync('src/buildPolyfills/README.md', 'build/esm/buildPolyfills/README.md');

Comment thread
lforst marked this conversation as resolved.

// Because we import our polyfills from `@sentry/utils/cjs/buildPolyfills` and `@sentry/utils/esm/buildPolyfills` rather
// than straight from `@sentry/utils` (so as to avoid having them in the package's public API), when tests run, they'll
// expect to find `cjs` and `esm` at the root level of the repo.
try {
 fs.symlinkSync('build/cjs', 'cjs');
} catch (oO) {
 // if we get here, it's because the symlink already exists, so we're good
}
try {
 fs.symlinkSync('build/esm', 'esm');
} catch (oO) {
 // same as above
}

2 changes: 1 addition & 1 deletion
packages/utils/src/buildPolyfills/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
## Build Polyfills

This is a collection of syntax and import/export polyfills either copied directly from or heavily inspired by those used by [Rollup](https://github.com/rollup/rollup) and [Sucrase](https://github.com/alangpierce/sucrase). When either tool uses one of these polyfills during a build, it injects the function source code into each file needing the function, which can lead to a great deal of duplication. For our builds, we have therefore implemented something similar to [`tsc`'s `importHelpers` behavior](https://www.typescriptlang.org/tsconfig#importHelpers): Instead of leaving the polyfills injected in multiple places, we instead replace each injected function with an `import` or `require` statement, pulling from the CJS or ESM builds as appropriate. (In other words, the injected `import` statements import from `@sentry/utils/esm/buildPolyfills` and the injected `require` statements pull from `@sentry/utils/cjs/buildPolyfills/`. Because these functions should never be part of the public API, they're not exported from the package directly.)
This is a collection of syntax and import/export polyfills either copied directly from or heavily inspired by those used by [Rollup](https://github.com/rollup/rollup) and [Sucrase](https://github.com/alangpierce/sucrase). When either tool uses one of these polyfills during a build, it injects the function source code into each file needing the function, which can lead to a great deal of duplication. For our builds, we have therefore implemented something similar to [`tsc`'s `importHelpers` behavior](https://www.typescriptlang.org/tsconfig#importHelpers): Instead of leaving the polyfills injected in multiple places, we instead replace each injected function with an `import` or `require` statement.

Note that not all polyfills are currently used by the SDK, but all are included here for future compatitibility, should they ever be needed. Also, since we're never going to be calling these directly from within another TS file, their types are fairly generic. In some cases testing required more specific types, which can be found in the test files.

Expand Down

1 change: 1 addition & 0 deletions
packages/utils/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,3 +34,4 @@ export * from './cache';
export * from './eventbuilder';
export * from './anr';
export * from './lru';
export * from './buildPolyfills';

11 changes: 8 additions & 3 deletions
rollup/plugins/extractPolyfillsPlugin.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -40,6 +40,13 @@ export function makeExtractPolyfillsPlugin() {
 return null;
 }

 // The index.js file of the tuils package will include identifiers named after polyfills so we would inject the
 // polyfills, however that would override the exports so we should just skip that file.
 const isUtilsPackage = process.cwd().endsWith('packages/utils');
 if (isUtilsPackage && sourceFile === 'index.js') {
 return null;
 }

 const parserOptions = {
 sourceFileName: sourceFile,
 // We supply a custom parser which wraps the provided `acorn` parser in order to override the `ecmaVersion` value.
Expand DownExpand Up@@ -187,9 +194,7 @@ function createImportOrRequireNode(polyfillNodes, currentSourceFile, moduleForma
 // relative
 const isUtilsPackage = process.cwd().endsWith('packages/utils');
 const importSource = literal(
 isUtilsPackage
 ? `./${path.relative(path.dirname(currentSourceFile), 'buildPolyfills')}`
 : `@sentry/utils/${moduleFormat}/buildPolyfills`,
 isUtilsPackage ? `./${path.relative(path.dirname(currentSourceFile), 'buildPolyfills')}` : '@sentry/utils',
 );

 // This is the `x, y, z` of inside of `import { x, y, z }` or `var { x, y, z }`
Expand Down

, '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
build(polyfills): Remove output format specific logic#9467

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

lforst
merged 2 commits into

from

Nov 7, 2023
 Merged


build(polyfills): Remove output format specific logic
#9467
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
58141b5

build(polyfills): Remove output format specific logic

Nov 7, 2023
1460a70

I want 2 hours of my life back

Nov 7, 2023

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
nx.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,7 @@
 },
 "build:transpile": {
 "inputs": ["production", "^production"],
 "dependsOn": ["^build:transpile:uncached", "^build:transpile", "build:transpile:uncached"],
 "dependsOn": ["^build:transpile"],
 "outputs": ["{projectRoot}/build/npm", "{projectRoot}/build/esm", "{projectRoot}/build/cjs"]
 },
 "build:types": {
Expand Down

1 change: 0 additions & 1 deletion
packages/angular-ivy/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -67,7 +67,6 @@
 "build:transpile": {
 "dependsOn": [
 "^build:transpile",
 "^build:transpile:uncached",
 "^build:types"
 ]
 }
Expand Down

1 change: 0 additions & 1 deletion
packages/angular/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -71,7 +71,6 @@
 "build:transpile": {
 "dependsOn": [
 "^build:transpile",
 "^build:transpile:uncached",
 "^build:types"
 ]
 }
Expand Down

1 change: 0 additions & 1 deletion
packages/utils/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,7 +34,6 @@
 "build": "run-p build:transpile build:types",
 "build:dev": "yarn build",
 "build:transpile": "yarn ts-node scripts/buildRollup.ts",
 "build:transpile:uncached": "yarn ts-node scripts/buildRollup.ts",
 "build:types": "run-s build:types:core build:types:downlevel",
 "build:types:core": "tsc -p tsconfig.types.json",
 "build:types:downlevel": "yarn downlevel-dts build/types build/types-ts3.8 --to ts3.8",
Expand Down

8 changes: 1 addition & 7 deletions
packages/utils/rollup.npm.config.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,9 +1,3 @@
import { makeBaseNPMConfig, makeNPMConfigVariants } from '../../rollup/index.js';

export default makeNPMConfigVariants(
 makeBaseNPMConfig({
 // We build the polyfills separately because they're not included in the top-level exports of the package, in order
 // to keep them out of the public API.
 entrypoints: ['src/index.ts', 'src/buildPolyfills/index.ts'],
 }),
);
export default makeNPMConfigVariants(makeBaseNPMConfig());

14 changes: 0 additions & 14 deletions
packages/utils/scripts/buildRollup.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,17 +14,3 @@ run('yarn rollup -c rollup.npm.config.js');
// We want to distribute the README because it contains the MIT license blurb from Sucrase and Rollup
fs.copyFileSync('src/buildPolyfills/README.md', 'build/cjs/buildPolyfills/README.md');
fs.copyFileSync('src/buildPolyfills/README.md', 'build/esm/buildPolyfills/README.md');

Comment thread
lforst marked this conversation as resolved.

// Because we import our polyfills from `@sentry/utils/cjs/buildPolyfills` and `@sentry/utils/esm/buildPolyfills` rather
// than straight from `@sentry/utils` (so as to avoid having them in the package's public API), when tests run, they'll
// expect to find `cjs` and `esm` at the root level of the repo.
try {
 fs.symlinkSync('build/cjs', 'cjs');
} catch (oO) {
 // if we get here, it's because the symlink already exists, so we're good
}
try {
 fs.symlinkSync('build/esm', 'esm');
} catch (oO) {
 // same as above
}

2 changes: 1 addition & 1 deletion
packages/utils/src/buildPolyfills/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
## Build Polyfills

This is a collection of syntax and import/export polyfills either copied directly from or heavily inspired by those used by [Rollup](https://github.com/rollup/rollup) and [Sucrase](https://github.com/alangpierce/sucrase). When either tool uses one of these polyfills during a build, it injects the function source code into each file needing the function, which can lead to a great deal of duplication. For our builds, we have therefore implemented something similar to [`tsc`'s `importHelpers` behavior](https://www.typescriptlang.org/tsconfig#importHelpers): Instead of leaving the polyfills injected in multiple places, we instead replace each injected function with an `import` or `require` statement, pulling from the CJS or ESM builds as appropriate. (In other words, the injected `import` statements import from `@sentry/utils/esm/buildPolyfills` and the injected `require` statements pull from `@sentry/utils/cjs/buildPolyfills/`. Because these functions should never be part of the public API, they're not exported from the package directly.)
This is a collection of syntax and import/export polyfills either copied directly from or heavily inspired by those used by [Rollup](https://github.com/rollup/rollup) and [Sucrase](https://github.com/alangpierce/sucrase). When either tool uses one of these polyfills during a build, it injects the function source code into each file needing the function, which can lead to a great deal of duplication. For our builds, we have therefore implemented something similar to [`tsc`'s `importHelpers` behavior](https://www.typescriptlang.org/tsconfig#importHelpers): Instead of leaving the polyfills injected in multiple places, we instead replace each injected function with an `import` or `require` statement.

Note that not all polyfills are currently used by the SDK, but all are included here for future compatitibility, should they ever be needed. Also, since we're never going to be calling these directly from within another TS file, their types are fairly generic. In some cases testing required more specific types, which can be found in the test files.

Expand Down

1 change: 1 addition & 0 deletions
packages/utils/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,3 +34,4 @@ export * from './cache';
export * from './eventbuilder';
export * from './anr';
export * from './lru';
export * from './buildPolyfills';

11 changes: 8 additions & 3 deletions
rollup/plugins/extractPolyfillsPlugin.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -40,6 +40,13 @@ export function makeExtractPolyfillsPlugin() {
 return null;
 }

 // The index.js file of the tuils package will include identifiers named after polyfills so we would inject the
 // polyfills, however that would override the exports so we should just skip that file.
 const isUtilsPackage = process.cwd().endsWith('packages/utils');
 if (isUtilsPackage && sourceFile === 'index.js') {
 return null;
 }

 const parserOptions = {
 sourceFileName: sourceFile,
 // We supply a custom parser which wraps the provided `acorn` parser in order to override the `ecmaVersion` value.
Expand DownExpand Up@@ -187,9 +194,7 @@ function createImportOrRequireNode(polyfillNodes, currentSourceFile, moduleForma
 // relative
 const isUtilsPackage = process.cwd().endsWith('packages/utils');
 const importSource = literal(
 isUtilsPackage
 ? `./${path.relative(path.dirname(currentSourceFile), 'buildPolyfills')}`
 : `@sentry/utils/${moduleFormat}/buildPolyfills`,
 isUtilsPackage ? `./${path.relative(path.dirname(currentSourceFile), 'buildPolyfills')}` : '@sentry/utils',
 );

 // This is the `x, y, z` of inside of `import { x, y, z }` or `var { x, y, z }`
Expand Down

, '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
build(polyfills): Remove output format specific logic#9467

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

lforst
merged 2 commits into

from

Nov 7, 2023
 Merged


build(polyfills): Remove output format specific logic
#9467
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
58141b5

build(polyfills): Remove output format specific logic

Nov 7, 2023
1460a70

I want 2 hours of my life back

Nov 7, 2023

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
nx.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,7 @@
 },
 "build:transpile": {
 "inputs": ["production", "^production"],
 "dependsOn": ["^build:transpile:uncached", "^build:transpile", "build:transpile:uncached"],
 "dependsOn": ["^build:transpile"],
 "outputs": ["{projectRoot}/build/npm", "{projectRoot}/build/esm", "{projectRoot}/build/cjs"]
 },
 "build:types": {
Expand Down

1 change: 0 additions & 1 deletion
packages/angular-ivy/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -67,7 +67,6 @@
 "build:transpile": {
 "dependsOn": [
 "^build:transpile",
 "^build:transpile:uncached",
 "^build:types"
 ]
 }
Expand Down

1 change: 0 additions & 1 deletion
packages/angular/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -71,7 +71,6 @@
 "build:transpile": {
 "dependsOn": [
 "^build:transpile",
 "^build:transpile:uncached",
 "^build:types"
 ]
 }
Expand Down

1 change: 0 additions & 1 deletion
packages/utils/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,7 +34,6 @@
 "build": "run-p build:transpile build:types",
 "build:dev": "yarn build",
 "build:transpile": "yarn ts-node scripts/buildRollup.ts",
 "build:transpile:uncached": "yarn ts-node scripts/buildRollup.ts",
 "build:types": "run-s build:types:core build:types:downlevel",
 "build:types:core": "tsc -p tsconfig.types.json",
 "build:types:downlevel": "yarn downlevel-dts build/types build/types-ts3.8 --to ts3.8",
Expand Down

8 changes: 1 addition & 7 deletions
packages/utils/rollup.npm.config.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,9 +1,3 @@
import { makeBaseNPMConfig, makeNPMConfigVariants } from '../../rollup/index.js';

export default makeNPMConfigVariants(
 makeBaseNPMConfig({
 // We build the polyfills separately because they're not included in the top-level exports of the package, in order
 // to keep them out of the public API.
 entrypoints: ['src/index.ts', 'src/buildPolyfills/index.ts'],
 }),
);
export default makeNPMConfigVariants(makeBaseNPMConfig());

14 changes: 0 additions & 14 deletions
packages/utils/scripts/buildRollup.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,17 +14,3 @@ run('yarn rollup -c rollup.npm.config.js');
// We want to distribute the README because it contains the MIT license blurb from Sucrase and Rollup
fs.copyFileSync('src/buildPolyfills/README.md', 'build/cjs/buildPolyfills/README.md');
fs.copyFileSync('src/buildPolyfills/README.md', 'build/esm/buildPolyfills/README.md');

Comment thread
lforst marked this conversation as resolved.

// Because we import our polyfills from `@sentry/utils/cjs/buildPolyfills` and `@sentry/utils/esm/buildPolyfills` rather
// than straight from `@sentry/utils` (so as to avoid having them in the package's public API), when tests run, they'll
// expect to find `cjs` and `esm` at the root level of the repo.
try {
 fs.symlinkSync('build/cjs', 'cjs');
} catch (oO) {
 // if we get here, it's because the symlink already exists, so we're good
}
try {
 fs.symlinkSync('build/esm', 'esm');
} catch (oO) {
 // same as above
}

2 changes: 1 addition & 1 deletion
packages/utils/src/buildPolyfills/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
## Build Polyfills

This is a collection of syntax and import/export polyfills either copied directly from or heavily inspired by those used by [Rollup](https://github.com/rollup/rollup) and [Sucrase](https://github.com/alangpierce/sucrase). When either tool uses one of these polyfills during a build, it injects the function source code into each file needing the function, which can lead to a great deal of duplication. For our builds, we have therefore implemented something similar to [`tsc`'s `importHelpers` behavior](https://www.typescriptlang.org/tsconfig#importHelpers): Instead of leaving the polyfills injected in multiple places, we instead replace each injected function with an `import` or `require` statement, pulling from the CJS or ESM builds as appropriate. (In other words, the injected `import` statements import from `@sentry/utils/esm/buildPolyfills` and the injected `require` statements pull from `@sentry/utils/cjs/buildPolyfills/`. Because these functions should never be part of the public API, they're not exported from the package directly.)
This is a collection of syntax and import/export polyfills either copied directly from or heavily inspired by those used by [Rollup](https://github.com/rollup/rollup) and [Sucrase](https://github.com/alangpierce/sucrase). When either tool uses one of these polyfills during a build, it injects the function source code into each file needing the function, which can lead to a great deal of duplication. For our builds, we have therefore implemented something similar to [`tsc`'s `importHelpers` behavior](https://www.typescriptlang.org/tsconfig#importHelpers): Instead of leaving the polyfills injected in multiple places, we instead replace each injected function with an `import` or `require` statement.

Note that not all polyfills are currently used by the SDK, but all are included here for future compatitibility, should they ever be needed. Also, since we're never going to be calling these directly from within another TS file, their types are fairly generic. In some cases testing required more specific types, which can be found in the test files.

Expand Down

1 change: 1 addition & 0 deletions
packages/utils/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,3 +34,4 @@ export * from './cache';
export * from './eventbuilder';
export * from './anr';
export * from './lru';
export * from './buildPolyfills';

11 changes: 8 additions & 3 deletions
rollup/plugins/extractPolyfillsPlugin.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -40,6 +40,13 @@ export function makeExtractPolyfillsPlugin() {
 return null;
 }

 // The index.js file of the tuils package will include identifiers named after polyfills so we would inject the
 // polyfills, however that would override the exports so we should just skip that file.
 const isUtilsPackage = process.cwd().endsWith('packages/utils');
 if (isUtilsPackage && sourceFile === 'index.js') {
 return null;
 }

 const parserOptions = {
 sourceFileName: sourceFile,
 // We supply a custom parser which wraps the provided `acorn` parser in order to override the `ecmaVersion` value.
Expand DownExpand Up@@ -187,9 +194,7 @@ function createImportOrRequireNode(polyfillNodes, currentSourceFile, moduleForma
 // relative
 const isUtilsPackage = process.cwd().endsWith('packages/utils');
 const importSource = literal(
 isUtilsPackage
 ? `./${path.relative(path.dirname(currentSourceFile), 'buildPolyfills')}`
 : `@sentry/utils/${moduleFormat}/buildPolyfills`,
 isUtilsPackage ? `./${path.relative(path.dirname(currentSourceFile), 'buildPolyfills')}` : '@sentry/utils',
 );

 // This is the `x, y, z` of inside of `import { x, y, z }` or `var { x, y, z }`
Expand Down

, '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
build(polyfills): Remove output format specific logic#9467

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

lforst
merged 2 commits into

from

Nov 7, 2023
 Merged


build(polyfills): Remove output format specific logic
#9467
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
58141b5

build(polyfills): Remove output format specific logic

Nov 7, 2023
1460a70

I want 2 hours of my life back

Nov 7, 2023

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
nx.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,7 @@
 },
 "build:transpile": {
 "inputs": ["production", "^production"],
 "dependsOn": ["^build:transpile:uncached", "^build:transpile", "build:transpile:uncached"],
 "dependsOn": ["^build:transpile"],
 "outputs": ["{projectRoot}/build/npm", "{projectRoot}/build/esm", "{projectRoot}/build/cjs"]
 },
 "build:types": {
Expand Down

1 change: 0 additions & 1 deletion
packages/angular-ivy/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -67,7 +67,6 @@
 "build:transpile": {
 "dependsOn": [
 "^build:transpile",
 "^build:transpile:uncached",
 "^build:types"
 ]
 }
Expand Down

1 change: 0 additions & 1 deletion
packages/angular/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -71,7 +71,6 @@
 "build:transpile": {
 "dependsOn": [
 "^build:transpile",
 "^build:transpile:uncached",
 "^build:types"
 ]
 }
Expand Down

1 change: 0 additions & 1 deletion
packages/utils/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,7 +34,6 @@
 "build": "run-p build:transpile build:types",
 "build:dev": "yarn build",
 "build:transpile": "yarn ts-node scripts/buildRollup.ts",
 "build:transpile:uncached": "yarn ts-node scripts/buildRollup.ts",
 "build:types": "run-s build:types:core build:types:downlevel",
 "build:types:core": "tsc -p tsconfig.types.json",
 "build:types:downlevel": "yarn downlevel-dts build/types build/types-ts3.8 --to ts3.8",
Expand Down

8 changes: 1 addition & 7 deletions
packages/utils/rollup.npm.config.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,9 +1,3 @@
import { makeBaseNPMConfig, makeNPMConfigVariants } from '../../rollup/index.js';

export default makeNPMConfigVariants(
 makeBaseNPMConfig({
 // We build the polyfills separately because they're not included in the top-level exports of the package, in order
 // to keep them out of the public API.
 entrypoints: ['src/index.ts', 'src/buildPolyfills/index.ts'],
 }),
);
export default makeNPMConfigVariants(makeBaseNPMConfig());

14 changes: 0 additions & 14 deletions
packages/utils/scripts/buildRollup.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,17 +14,3 @@ run('yarn rollup -c rollup.npm.config.js');
// We want to distribute the README because it contains the MIT license blurb from Sucrase and Rollup
fs.copyFileSync('src/buildPolyfills/README.md', 'build/cjs/buildPolyfills/README.md');
fs.copyFileSync('src/buildPolyfills/README.md', 'build/esm/buildPolyfills/README.md');

Comment thread
lforst marked this conversation as resolved.

// Because we import our polyfills from `@sentry/utils/cjs/buildPolyfills` and `@sentry/utils/esm/buildPolyfills` rather
// than straight from `@sentry/utils` (so as to avoid having them in the package's public API), when tests run, they'll
// expect to find `cjs` and `esm` at the root level of the repo.
try {
 fs.symlinkSync('build/cjs', 'cjs');
} catch (oO) {
 // if we get here, it's because the symlink already exists, so we're good
}
try {
 fs.symlinkSync('build/esm', 'esm');
} catch (oO) {
 // same as above
}

2 changes: 1 addition & 1 deletion
packages/utils/src/buildPolyfills/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
## Build Polyfills

This is a collection of syntax and import/export polyfills either copied directly from or heavily inspired by those used by [Rollup](https://github.com/rollup/rollup) and [Sucrase](https://github.com/alangpierce/sucrase). When either tool uses one of these polyfills during a build, it injects the function source code into each file needing the function, which can lead to a great deal of duplication. For our builds, we have therefore implemented something similar to [`tsc`'s `importHelpers` behavior](https://www.typescriptlang.org/tsconfig#importHelpers): Instead of leaving the polyfills injected in multiple places, we instead replace each injected function with an `import` or `require` statement, pulling from the CJS or ESM builds as appropriate. (In other words, the injected `import` statements import from `@sentry/utils/esm/buildPolyfills` and the injected `require` statements pull from `@sentry/utils/cjs/buildPolyfills/`. Because these functions should never be part of the public API, they're not exported from the package directly.)
This is a collection of syntax and import/export polyfills either copied directly from or heavily inspired by those used by [Rollup](https://github.com/rollup/rollup) and [Sucrase](https://github.com/alangpierce/sucrase). When either tool uses one of these polyfills during a build, it injects the function source code into each file needing the function, which can lead to a great deal of duplication. For our builds, we have therefore implemented something similar to [`tsc`'s `importHelpers` behavior](https://www.typescriptlang.org/tsconfig#importHelpers): Instead of leaving the polyfills injected in multiple places, we instead replace each injected function with an `import` or `require` statement.

Note that not all polyfills are currently used by the SDK, but all are included here for future compatitibility, should they ever be needed. Also, since we're never going to be calling these directly from within another TS file, their types are fairly generic. In some cases testing required more specific types, which can be found in the test files.

Expand Down

1 change: 1 addition & 0 deletions
packages/utils/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,3 +34,4 @@ export * from './cache';
export * from './eventbuilder';
export * from './anr';
export * from './lru';
export * from './buildPolyfills';

11 changes: 8 additions & 3 deletions
rollup/plugins/extractPolyfillsPlugin.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -40,6 +40,13 @@ export function makeExtractPolyfillsPlugin() {
 return null;
 }

 // The index.js file of the tuils package will include identifiers named after polyfills so we would inject the
 // polyfills, however that would override the exports so we should just skip that file.
 const isUtilsPackage = process.cwd().endsWith('packages/utils');
 if (isUtilsPackage && sourceFile === 'index.js') {
 return null;
 }

 const parserOptions = {
 sourceFileName: sourceFile,
 // We supply a custom parser which wraps the provided `acorn` parser in order to override the `ecmaVersion` value.
Expand DownExpand Up@@ -187,9 +194,7 @@ function createImportOrRequireNode(polyfillNodes, currentSourceFile, moduleForma
 // relative
 const isUtilsPackage = process.cwd().endsWith('packages/utils');
 const importSource = literal(
 isUtilsPackage
 ? `./${path.relative(path.dirname(currentSourceFile), 'buildPolyfills')}`
 : `@sentry/utils/${moduleFormat}/buildPolyfills`,
 isUtilsPackage ? `./${path.relative(path.dirname(currentSourceFile), 'buildPolyfills')}` : '@sentry/utils',
 );

 // This is the `x, y, z` of inside of `import { x, y, z }` or `var { x, y, z }`
Expand Down

, '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
build(polyfills): Remove output format specific logic#9467

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

lforst
merged 2 commits into

from

Nov 7, 2023
 Merged


build(polyfills): Remove output format specific logic
#9467
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
58141b5

build(polyfills): Remove output format specific logic

Nov 7, 2023
1460a70

I want 2 hours of my life back

Nov 7, 2023

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
nx.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,7 @@
 },
 "build:transpile": {
 "inputs": ["production", "^production"],
 "dependsOn": ["^build:transpile:uncached", "^build:transpile", "build:transpile:uncached"],
 "dependsOn": ["^build:transpile"],
 "outputs": ["{projectRoot}/build/npm", "{projectRoot}/build/esm", "{projectRoot}/build/cjs"]
 },
 "build:types": {
Expand Down

1 change: 0 additions & 1 deletion
packages/angular-ivy/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -67,7 +67,6 @@
 "build:transpile": {
 "dependsOn": [
 "^build:transpile",
 "^build:transpile:uncached",
 "^build:types"
 ]
 }
Expand Down

1 change: 0 additions & 1 deletion
packages/angular/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -71,7 +71,6 @@
 "build:transpile": {
 "dependsOn": [
 "^build:transpile",
 "^build:transpile:uncached",
 "^build:types"
 ]
 }
Expand Down

1 change: 0 additions & 1 deletion
packages/utils/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,7 +34,6 @@
 "build": "run-p build:transpile build:types",
 "build:dev": "yarn build",
 "build:transpile": "yarn ts-node scripts/buildRollup.ts",
 "build:transpile:uncached": "yarn ts-node scripts/buildRollup.ts",
 "build:types": "run-s build:types:core build:types:downlevel",
 "build:types:core": "tsc -p tsconfig.types.json",
 "build:types:downlevel": "yarn downlevel-dts build/types build/types-ts3.8 --to ts3.8",
Expand Down

8 changes: 1 addition & 7 deletions
packages/utils/rollup.npm.config.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,9 +1,3 @@
import { makeBaseNPMConfig, makeNPMConfigVariants } from '../../rollup/index.js';

export default makeNPMConfigVariants(
 makeBaseNPMConfig({
 // We build the polyfills separately because they're not included in the top-level exports of the package, in order
 // to keep them out of the public API.
 entrypoints: ['src/index.ts', 'src/buildPolyfills/index.ts'],
 }),
);
export default makeNPMConfigVariants(makeBaseNPMConfig());

14 changes: 0 additions & 14 deletions
packages/utils/scripts/buildRollup.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,17 +14,3 @@ run('yarn rollup -c rollup.npm.config.js');
// We want to distribute the README because it contains the MIT license blurb from Sucrase and Rollup
fs.copyFileSync('src/buildPolyfills/README.md', 'build/cjs/buildPolyfills/README.md');
fs.copyFileSync('src/buildPolyfills/README.md', 'build/esm/buildPolyfills/README.md');

Comment thread
lforst marked this conversation as resolved.

// Because we import our polyfills from `@sentry/utils/cjs/buildPolyfills` and `@sentry/utils/esm/buildPolyfills` rather
// than straight from `@sentry/utils` (so as to avoid having them in the package's public API), when tests run, they'll
// expect to find `cjs` and `esm` at the root level of the repo.
try {
 fs.symlinkSync('build/cjs', 'cjs');
} catch (oO) {
 // if we get here, it's because the symlink already exists, so we're good
}
try {
 fs.symlinkSync('build/esm', 'esm');
} catch (oO) {
 // same as above
}

2 changes: 1 addition & 1 deletion
packages/utils/src/buildPolyfills/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
## Build Polyfills

This is a collection of syntax and import/export polyfills either copied directly from or heavily inspired by those used by [Rollup](https://github.com/rollup/rollup) and [Sucrase](https://github.com/alangpierce/sucrase). When either tool uses one of these polyfills during a build, it injects the function source code into each file needing the function, which can lead to a great deal of duplication. For our builds, we have therefore implemented something similar to [`tsc`'s `importHelpers` behavior](https://www.typescriptlang.org/tsconfig#importHelpers): Instead of leaving the polyfills injected in multiple places, we instead replace each injected function with an `import` or `require` statement, pulling from the CJS or ESM builds as appropriate. (In other words, the injected `import` statements import from `@sentry/utils/esm/buildPolyfills` and the injected `require` statements pull from `@sentry/utils/cjs/buildPolyfills/`. Because these functions should never be part of the public API, they're not exported from the package directly.)
This is a collection of syntax and import/export polyfills either copied directly from or heavily inspired by those used by [Rollup](https://github.com/rollup/rollup) and [Sucrase](https://github.com/alangpierce/sucrase). When either tool uses one of these polyfills during a build, it injects the function source code into each file needing the function, which can lead to a great deal of duplication. For our builds, we have therefore implemented something similar to [`tsc`'s `importHelpers` behavior](https://www.typescriptlang.org/tsconfig#importHelpers): Instead of leaving the polyfills injected in multiple places, we instead replace each injected function with an `import` or `require` statement.

Note that not all polyfills are currently used by the SDK, but all are included here for future compatitibility, should they ever be needed. Also, since we're never going to be calling these directly from within another TS file, their types are fairly generic. In some cases testing required more specific types, which can be found in the test files.

Expand Down

1 change: 1 addition & 0 deletions
packages/utils/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,3 +34,4 @@ export * from './cache';
export * from './eventbuilder';
export * from './anr';
export * from './lru';
export * from './buildPolyfills';

11 changes: 8 additions & 3 deletions
rollup/plugins/extractPolyfillsPlugin.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -40,6 +40,13 @@ export function makeExtractPolyfillsPlugin() {
 return null;
 }

 // The index.js file of the tuils package will include identifiers named after polyfills so we would inject the
 // polyfills, however that would override the exports so we should just skip that file.
 const isUtilsPackage = process.cwd().endsWith('packages/utils');
 if (isUtilsPackage && sourceFile === 'index.js') {
 return null;
 }

 const parserOptions = {
 sourceFileName: sourceFile,
 // We supply a custom parser which wraps the provided `acorn` parser in order to override the `ecmaVersion` value.
Expand DownExpand Up@@ -187,9 +194,7 @@ function createImportOrRequireNode(polyfillNodes, currentSourceFile, moduleForma
 // relative
 const isUtilsPackage = process.cwd().endsWith('packages/utils');
 const importSource = literal(
 isUtilsPackage
 ? `./${path.relative(path.dirname(currentSourceFile), 'buildPolyfills')}`
 : `@sentry/utils/${moduleFormat}/buildPolyfills`,
 isUtilsPackage ? `./${path.relative(path.dirname(currentSourceFile), 'buildPolyfills')}` : '@sentry/utils',
 );

 // This is the `x, y, z` of inside of `import { x, y, z }` or `var { x, y, z }`
Expand Down