Simplify/reorganize Micro Frontend Suport - #9215

Merged
maxkosty merged 14 commits into
masterfrom
simpler-micro-frontends
Mar 23, 2024
Merged

Simplify/reorganize Micro Frontend Suport#9215
maxkosty merged 14 commits into
masterfrom
simpler-micro-frontends

Conversation

@maxkosty

@maxkostymaxkosty commented Feb 23, 2024

Copy link
Copy Markdown
Contributor

Pre-merge checklist

If you work at Sentry, you're able to merge your own PR without review, but please don't unless there's a good reason.

  • Checked Vercel preview for correctness, including links
  • PR was reviewed and approved by any necessary SMEs
  • PR was reviewed and approved by a member of the Sentry docs team

Description of changes

  • current doc is structured around components of the solution, this restructures it around use-cases: Automatic and Manual
  • remove the other sample beforeSend code that didn't get the slice(-1) fix.
  • [Automatic] changes to the "Once metadata has been injected into modules..." paragraph
  • [Manual] Add a note about importance of using local scope

Legal Boilerplate

Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.

Extra resources

@vercel

vercelBot commented Feb 23, 2024

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for Git ↗︎

NameStatusPreviewCommentsUpdated (UTC)
sentry-docs✅ Ready (Inspect)Visit Preview💬 Add feedbackMar 21, 2024 7:09pm
1 Ignored Deployment
NameStatusPreviewCommentsUpdated (UTC)
sentry-docs-next⬜️ Ignored (Inspect)Visit PreviewMar 21, 2024 7:09pm

@codecov

codecovBot commented Feb 23, 2024

Copy link
Copy Markdown

Bundle Report

Changes will decrease total bundle size by 6 bytes ⬇️

Bundle nameSizeChange
sentry-docs-server5.88MB0 bytes
sentry-docs-edge-server3.47kB0 bytes
sentry-docs-client5.18MB6 bytes ⬇️

@vivianyentranvivianyentran left a comment

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.

Added some comments but overall LGTM!

Comment threaddocs/platforms/javascript/common/configuration/micro-frontend-support.mdx Outdated
Comment threaddocs/platforms/javascript/common/configuration/micro-frontend-support.mdx Outdated
Comment threaddocs/platforms/javascript/common/configuration/micro-frontend-support.mdx Outdated
Comment threaddocs/platforms/javascript/common/configuration/micro-frontend-support.mdx Outdated
Comment threaddocs/platforms/javascript/common/configuration/micro-frontend-support.mdx Outdated
Comment threaddocs/platforms/javascript/common/configuration/micro-frontend-support.mdx Outdated
Comment threaddocs/platforms/javascript/common/configuration/micro-frontend-support.mdx Outdated
maxkostyand others added 7 commits March 6, 2024 19:21
…support.mdx
Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com>
…support.mdx
Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com>
…support.mdx
Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com>
…support.mdx
Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com>
…support.mdx
Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com>
…support.mdx
Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com>
@maxkosty
maxkosty requested a review from lforstMarch 7, 2024 03:38

@lforstlforst left a comment

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.

Such a good change!

different release cycles, you may want to identify these or route events to specific projects. This is especially useful if you've set up [module federation](https://module-federation.github.io/) or a similar frontend architecture.

## Identifying the source of errors
Below we offer two approaches. Please note that `Sentry.init()` must be called only once, doing otherwise will result in undefined behavior.

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.

This is very good to mention. I wonder if we should highlight this even stronger.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

done

Comment on lines +37 to +39
First, to identify the source of an error, you must inject metadata that helps identify
which bundles were responsible for the error. You can do this with any of the
Sentry bundler plugins by enabling the `_experiments.moduleMetadata` option.

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.

I would love to mention here that this should also work for vite and esbuild. I know that we mention the packages above but I am not sure if people will connect the dots. Doesn't have to be in this PR though!

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

added, lmk what you think


```javascript
import * as Sentry from "@sentry/browser";
import { init, makeFetchTransport, moduleMetadataIntegration, makeSimpleMultiplexedTransport, MULTIPLEXED_TRANSPORT_EXTRA_KEY } from "@sentry/browser";

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.

Suggested change
import { init, makeFetchTransport, moduleMetadataIntegration, makeSimpleMultiplexedTransport, MULTIPLEXED_TRANSPORT_EXTRA_KEY } from"@sentry/browser";
import { init, makeFetchTransport, moduleMetadataIntegration, MULTIPLEXED_TRANSPORT_EXTRA_KEY } from"@sentry/browser";

Once we added the makeSimpleMultiplexedTransport API we can revisit this but for now I'd leave it away.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

sounds good.
Reverting sample code to original including this change (as it hasn't been tested)

  • [Automatic] remove redundant if (routeTo.length) { check for empty array (done in matcher)

@lforst We should simplify the API sooner than later though. I feel like current sample code looks convoluted to the point of customers thinking "surely there must be an easier/more elegant way to do it, let me see what those other blog posts that showed up in search say"

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.

Ack, right now it is unfortunately not a priority for us and I'd like to avoid us losing focus but maybe I can sneak your PR in somehow.

Comment threaddocs/platforms/javascript/common/configuration/micro-frontend-support.mdx Outdated
@maxkosty

Copy link
Copy Markdown
ContributorAuthor

Hi @vivianyentran
there are a few wording changes in this increment 1144e30
would you mind checking my ESL please?

@vivianyentranvivianyentran left a comment

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.

Added one more tiny edit. Looks good! Thank you for this update!

Comment threaddocs/platforms/javascript/common/configuration/micro-frontend-support.mdx Outdated
…support.mdx
Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com>

@lforstlforst left a comment

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.

:shipit:

@maxkostymaxkosty changed the title Simplify/reorganize Micro Frontend Suport (DRAFT)Simplify/reorganize Micro Frontend SuportMar 23, 2024
@maxkosty
maxkosty merged commit 1d406de into masterMar 23, 2024
@maxkosty
maxkosty deleted the simpler-micro-frontends branch March 23, 2024 02:18
@github-actionsgithub-actionsBot locked and limited conversation to collaborators Apr 7, 2024
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@maxkosty@lforst@vivianyentran
, '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

Simplify/reorganize Micro Frontend Suport - #9215

Merged
maxkosty merged 14 commits into
masterfrom
simpler-micro-frontends
Mar 23, 2024
Merged

Simplify/reorganize Micro Frontend Suport#9215
maxkosty merged 14 commits into
masterfrom
simpler-micro-frontends

Conversation

@maxkosty

@maxkostymaxkosty commented Feb 23, 2024

Copy link
Copy Markdown
Contributor

Pre-merge checklist

If you work at Sentry, you're able to merge your own PR without review, but please don't unless there's a good reason.

  • Checked Vercel preview for correctness, including links
  • PR was reviewed and approved by any necessary SMEs
  • PR was reviewed and approved by a member of the Sentry docs team

Description of changes

  • current doc is structured around components of the solution, this restructures it around use-cases: Automatic and Manual
  • remove the other sample beforeSend code that didn't get the slice(-1) fix.
  • [Automatic] changes to the "Once metadata has been injected into modules..." paragraph
  • [Manual] Add a note about importance of using local scope

Legal Boilerplate

Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.

Extra resources

@vercel

vercelBot commented Feb 23, 2024

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for Git ↗︎

NameStatusPreviewCommentsUpdated (UTC)
sentry-docs✅ Ready (Inspect)Visit Preview💬 Add feedbackMar 21, 2024 7:09pm
1 Ignored Deployment
NameStatusPreviewCommentsUpdated (UTC)
sentry-docs-next⬜️ Ignored (Inspect)Visit PreviewMar 21, 2024 7:09pm

@codecov

codecovBot commented Feb 23, 2024

Copy link
Copy Markdown

Bundle Report

Changes will decrease total bundle size by 6 bytes ⬇️

Bundle nameSizeChange
sentry-docs-server5.88MB0 bytes
sentry-docs-edge-server3.47kB0 bytes
sentry-docs-client5.18MB6 bytes ⬇️

@vivianyentranvivianyentran left a comment

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.

Added some comments but overall LGTM!

Comment threaddocs/platforms/javascript/common/configuration/micro-frontend-support.mdx Outdated
Comment threaddocs/platforms/javascript/common/configuration/micro-frontend-support.mdx Outdated
Comment threaddocs/platforms/javascript/common/configuration/micro-frontend-support.mdx Outdated
Comment threaddocs/platforms/javascript/common/configuration/micro-frontend-support.mdx Outdated
Comment threaddocs/platforms/javascript/common/configuration/micro-frontend-support.mdx Outdated
Comment threaddocs/platforms/javascript/common/configuration/micro-frontend-support.mdx Outdated
Comment threaddocs/platforms/javascript/common/configuration/micro-frontend-support.mdx Outdated
maxkostyand others added 7 commits March 6, 2024 19:21
…support.mdx
Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com>
…support.mdx
Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com>
…support.mdx
Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com>
…support.mdx
Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com>
…support.mdx
Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com>
…support.mdx
Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com>
@maxkosty
maxkosty requested a review from lforstMarch 7, 2024 03:38

@lforstlforst left a comment

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.

Such a good change!

different release cycles, you may want to identify these or route events to specific projects. This is especially useful if you've set up [module federation](https://module-federation.github.io/) or a similar frontend architecture.

## Identifying the source of errors
Below we offer two approaches. Please note that `Sentry.init()` must be called only once, doing otherwise will result in undefined behavior.

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.

This is very good to mention. I wonder if we should highlight this even stronger.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

done

Comment on lines +37 to +39
First, to identify the source of an error, you must inject metadata that helps identify
which bundles were responsible for the error. You can do this with any of the
Sentry bundler plugins by enabling the `_experiments.moduleMetadata` option.

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.

I would love to mention here that this should also work for vite and esbuild. I know that we mention the packages above but I am not sure if people will connect the dots. Doesn't have to be in this PR though!

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

added, lmk what you think


```javascript
import * as Sentry from "@sentry/browser";
import { init, makeFetchTransport, moduleMetadataIntegration, makeSimpleMultiplexedTransport, MULTIPLEXED_TRANSPORT_EXTRA_KEY } from "@sentry/browser";

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.

Suggested change
import { init, makeFetchTransport, moduleMetadataIntegration, makeSimpleMultiplexedTransport, MULTIPLEXED_TRANSPORT_EXTRA_KEY } from"@sentry/browser";
import { init, makeFetchTransport, moduleMetadataIntegration, MULTIPLEXED_TRANSPORT_EXTRA_KEY } from"@sentry/browser";

Once we added the makeSimpleMultiplexedTransport API we can revisit this but for now I'd leave it away.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

sounds good.
Reverting sample code to original including this change (as it hasn't been tested)

  • [Automatic] remove redundant if (routeTo.length) { check for empty array (done in matcher)

@lforst We should simplify the API sooner than later though. I feel like current sample code looks convoluted to the point of customers thinking "surely there must be an easier/more elegant way to do it, let me see what those other blog posts that showed up in search say"

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.

Ack, right now it is unfortunately not a priority for us and I'd like to avoid us losing focus but maybe I can sneak your PR in somehow.

Comment threaddocs/platforms/javascript/common/configuration/micro-frontend-support.mdx Outdated
@maxkosty

Copy link
Copy Markdown
ContributorAuthor

Hi @vivianyentran
there are a few wording changes in this increment 1144e30
would you mind checking my ESL please?

@vivianyentranvivianyentran left a comment

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.

Added one more tiny edit. Looks good! Thank you for this update!

Comment threaddocs/platforms/javascript/common/configuration/micro-frontend-support.mdx Outdated
…support.mdx
Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com>

@lforstlforst left a comment

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.

:shipit:

@maxkostymaxkosty changed the title Simplify/reorganize Micro Frontend Suport (DRAFT)Simplify/reorganize Micro Frontend SuportMar 23, 2024
@maxkosty
maxkosty merged commit 1d406de into masterMar 23, 2024
@maxkosty
maxkosty deleted the simpler-micro-frontends branch March 23, 2024 02:18
@github-actionsgithub-actionsBot locked and limited conversation to collaborators Apr 7, 2024
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@maxkosty@lforst@vivianyentran
, '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

Simplify/reorganize Micro Frontend Suport - #9215

Merged
maxkosty merged 14 commits into
masterfrom
simpler-micro-frontends
Mar 23, 2024
Merged

Simplify/reorganize Micro Frontend Suport#9215
maxkosty merged 14 commits into
masterfrom
simpler-micro-frontends

Conversation

@maxkosty

@maxkostymaxkosty commented Feb 23, 2024

Copy link
Copy Markdown
Contributor

Pre-merge checklist

If you work at Sentry, you're able to merge your own PR without review, but please don't unless there's a good reason.

  • Checked Vercel preview for correctness, including links
  • PR was reviewed and approved by any necessary SMEs
  • PR was reviewed and approved by a member of the Sentry docs team

Description of changes

  • current doc is structured around components of the solution, this restructures it around use-cases: Automatic and Manual
  • remove the other sample beforeSend code that didn't get the slice(-1) fix.
  • [Automatic] changes to the "Once metadata has been injected into modules..." paragraph
  • [Manual] Add a note about importance of using local scope

Legal Boilerplate

Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.

Extra resources

@vercel

vercelBot commented Feb 23, 2024

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for Git ↗︎

NameStatusPreviewCommentsUpdated (UTC)
sentry-docs✅ Ready (Inspect)Visit Preview💬 Add feedbackMar 21, 2024 7:09pm
1 Ignored Deployment
NameStatusPreviewCommentsUpdated (UTC)
sentry-docs-next⬜️ Ignored (Inspect)Visit PreviewMar 21, 2024 7:09pm

@codecov

codecovBot commented Feb 23, 2024

Copy link
Copy Markdown

Bundle Report

Changes will decrease total bundle size by 6 bytes ⬇️

Bundle nameSizeChange
sentry-docs-server5.88MB0 bytes
sentry-docs-edge-server3.47kB0 bytes
sentry-docs-client5.18MB6 bytes ⬇️

@vivianyentranvivianyentran left a comment

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.

Added some comments but overall LGTM!

Comment threaddocs/platforms/javascript/common/configuration/micro-frontend-support.mdx Outdated
Comment threaddocs/platforms/javascript/common/configuration/micro-frontend-support.mdx Outdated
Comment threaddocs/platforms/javascript/common/configuration/micro-frontend-support.mdx Outdated
Comment threaddocs/platforms/javascript/common/configuration/micro-frontend-support.mdx Outdated
Comment threaddocs/platforms/javascript/common/configuration/micro-frontend-support.mdx Outdated
Comment threaddocs/platforms/javascript/common/configuration/micro-frontend-support.mdx Outdated
Comment threaddocs/platforms/javascript/common/configuration/micro-frontend-support.mdx Outdated
maxkostyand others added 7 commits March 6, 2024 19:21
…support.mdx
Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com>
…support.mdx
Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com>
…support.mdx
Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com>
…support.mdx
Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com>
…support.mdx
Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com>
…support.mdx
Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com>
@maxkosty
maxkosty requested a review from lforstMarch 7, 2024 03:38

@lforstlforst left a comment

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.

Such a good change!

different release cycles, you may want to identify these or route events to specific projects. This is especially useful if you've set up [module federation](https://module-federation.github.io/) or a similar frontend architecture.

## Identifying the source of errors
Below we offer two approaches. Please note that `Sentry.init()` must be called only once, doing otherwise will result in undefined behavior.

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.

This is very good to mention. I wonder if we should highlight this even stronger.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

done

Comment on lines +37 to +39
First, to identify the source of an error, you must inject metadata that helps identify
which bundles were responsible for the error. You can do this with any of the
Sentry bundler plugins by enabling the `_experiments.moduleMetadata` option.

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.

I would love to mention here that this should also work for vite and esbuild. I know that we mention the packages above but I am not sure if people will connect the dots. Doesn't have to be in this PR though!

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

added, lmk what you think


```javascript
import * as Sentry from "@sentry/browser";
import { init, makeFetchTransport, moduleMetadataIntegration, makeSimpleMultiplexedTransport, MULTIPLEXED_TRANSPORT_EXTRA_KEY } from "@sentry/browser";

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.

Suggested change
import { init, makeFetchTransport, moduleMetadataIntegration, makeSimpleMultiplexedTransport, MULTIPLEXED_TRANSPORT_EXTRA_KEY } from"@sentry/browser";
import { init, makeFetchTransport, moduleMetadataIntegration, MULTIPLEXED_TRANSPORT_EXTRA_KEY } from"@sentry/browser";

Once we added the makeSimpleMultiplexedTransport API we can revisit this but for now I'd leave it away.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

sounds good.
Reverting sample code to original including this change (as it hasn't been tested)

  • [Automatic] remove redundant if (routeTo.length) { check for empty array (done in matcher)

@lforst We should simplify the API sooner than later though. I feel like current sample code looks convoluted to the point of customers thinking "surely there must be an easier/more elegant way to do it, let me see what those other blog posts that showed up in search say"

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.

Ack, right now it is unfortunately not a priority for us and I'd like to avoid us losing focus but maybe I can sneak your PR in somehow.

Comment threaddocs/platforms/javascript/common/configuration/micro-frontend-support.mdx Outdated
@maxkosty

Copy link
Copy Markdown
ContributorAuthor

Hi @vivianyentran
there are a few wording changes in this increment 1144e30
would you mind checking my ESL please?

@vivianyentranvivianyentran left a comment

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.

Added one more tiny edit. Looks good! Thank you for this update!

Comment threaddocs/platforms/javascript/common/configuration/micro-frontend-support.mdx Outdated
…support.mdx
Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com>

@lforstlforst left a comment

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.

:shipit:

@maxkostymaxkosty changed the title Simplify/reorganize Micro Frontend Suport (DRAFT)Simplify/reorganize Micro Frontend SuportMar 23, 2024
@maxkosty
maxkosty merged commit 1d406de into masterMar 23, 2024
@maxkosty
maxkosty deleted the simpler-micro-frontends branch March 23, 2024 02:18
@github-actionsgithub-actionsBot locked and limited conversation to collaborators Apr 7, 2024
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@maxkosty@lforst@vivianyentran
, '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

Simplify/reorganize Micro Frontend Suport - #9215

Merged
maxkosty merged 14 commits into
masterfrom
simpler-micro-frontends
Mar 23, 2024
Merged

Simplify/reorganize Micro Frontend Suport#9215
maxkosty merged 14 commits into
masterfrom
simpler-micro-frontends

Conversation

@maxkosty

@maxkostymaxkosty commented Feb 23, 2024

Copy link
Copy Markdown
Contributor

Pre-merge checklist

If you work at Sentry, you're able to merge your own PR without review, but please don't unless there's a good reason.

  • Checked Vercel preview for correctness, including links
  • PR was reviewed and approved by any necessary SMEs
  • PR was reviewed and approved by a member of the Sentry docs team

Description of changes

  • current doc is structured around components of the solution, this restructures it around use-cases: Automatic and Manual
  • remove the other sample beforeSend code that didn't get the slice(-1) fix.
  • [Automatic] changes to the "Once metadata has been injected into modules..." paragraph
  • [Manual] Add a note about importance of using local scope

Legal Boilerplate

Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.

Extra resources

@vercel

vercelBot commented Feb 23, 2024

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for Git ↗︎

NameStatusPreviewCommentsUpdated (UTC)
sentry-docs✅ Ready (Inspect)Visit Preview💬 Add feedbackMar 21, 2024 7:09pm
1 Ignored Deployment
NameStatusPreviewCommentsUpdated (UTC)
sentry-docs-next⬜️ Ignored (Inspect)Visit PreviewMar 21, 2024 7:09pm

@codecov

codecovBot commented Feb 23, 2024

Copy link
Copy Markdown

Bundle Report

Changes will decrease total bundle size by 6 bytes ⬇️

Bundle nameSizeChange
sentry-docs-server5.88MB0 bytes
sentry-docs-edge-server3.47kB0 bytes
sentry-docs-client5.18MB6 bytes ⬇️

@vivianyentranvivianyentran left a comment

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.

Added some comments but overall LGTM!

Comment threaddocs/platforms/javascript/common/configuration/micro-frontend-support.mdx Outdated
Comment threaddocs/platforms/javascript/common/configuration/micro-frontend-support.mdx Outdated
Comment threaddocs/platforms/javascript/common/configuration/micro-frontend-support.mdx Outdated
Comment threaddocs/platforms/javascript/common/configuration/micro-frontend-support.mdx Outdated
Comment threaddocs/platforms/javascript/common/configuration/micro-frontend-support.mdx Outdated
Comment threaddocs/platforms/javascript/common/configuration/micro-frontend-support.mdx Outdated
Comment threaddocs/platforms/javascript/common/configuration/micro-frontend-support.mdx Outdated
maxkostyand others added 7 commits March 6, 2024 19:21
…support.mdx
Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com>
…support.mdx
Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com>
…support.mdx
Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com>
…support.mdx
Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com>
…support.mdx
Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com>
…support.mdx
Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com>
@maxkosty
maxkosty requested a review from lforstMarch 7, 2024 03:38

@lforstlforst left a comment

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.

Such a good change!

different release cycles, you may want to identify these or route events to specific projects. This is especially useful if you've set up [module federation](https://module-federation.github.io/) or a similar frontend architecture.

## Identifying the source of errors
Below we offer two approaches. Please note that `Sentry.init()` must be called only once, doing otherwise will result in undefined behavior.

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.

This is very good to mention. I wonder if we should highlight this even stronger.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

done

Comment on lines +37 to +39
First, to identify the source of an error, you must inject metadata that helps identify
which bundles were responsible for the error. You can do this with any of the
Sentry bundler plugins by enabling the `_experiments.moduleMetadata` option.

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.

I would love to mention here that this should also work for vite and esbuild. I know that we mention the packages above but I am not sure if people will connect the dots. Doesn't have to be in this PR though!

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

added, lmk what you think


```javascript
import * as Sentry from "@sentry/browser";
import { init, makeFetchTransport, moduleMetadataIntegration, makeSimpleMultiplexedTransport, MULTIPLEXED_TRANSPORT_EXTRA_KEY } from "@sentry/browser";

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.

Suggested change
import { init, makeFetchTransport, moduleMetadataIntegration, makeSimpleMultiplexedTransport, MULTIPLEXED_TRANSPORT_EXTRA_KEY } from"@sentry/browser";
import { init, makeFetchTransport, moduleMetadataIntegration, MULTIPLEXED_TRANSPORT_EXTRA_KEY } from"@sentry/browser";

Once we added the makeSimpleMultiplexedTransport API we can revisit this but for now I'd leave it away.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

sounds good.
Reverting sample code to original including this change (as it hasn't been tested)

  • [Automatic] remove redundant if (routeTo.length) { check for empty array (done in matcher)

@lforst We should simplify the API sooner than later though. I feel like current sample code looks convoluted to the point of customers thinking "surely there must be an easier/more elegant way to do it, let me see what those other blog posts that showed up in search say"

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.

Ack, right now it is unfortunately not a priority for us and I'd like to avoid us losing focus but maybe I can sneak your PR in somehow.

Comment threaddocs/platforms/javascript/common/configuration/micro-frontend-support.mdx Outdated
@maxkosty

Copy link
Copy Markdown
ContributorAuthor

Hi @vivianyentran
there are a few wording changes in this increment 1144e30
would you mind checking my ESL please?

@vivianyentranvivianyentran left a comment

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.

Added one more tiny edit. Looks good! Thank you for this update!

Comment threaddocs/platforms/javascript/common/configuration/micro-frontend-support.mdx Outdated
…support.mdx
Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com>

@lforstlforst left a comment

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.

:shipit:

@maxkostymaxkosty changed the title Simplify/reorganize Micro Frontend Suport (DRAFT)Simplify/reorganize Micro Frontend SuportMar 23, 2024
@maxkosty
maxkosty merged commit 1d406de into masterMar 23, 2024
@maxkosty
maxkosty deleted the simpler-micro-frontends branch March 23, 2024 02:18
@github-actionsgithub-actionsBot locked and limited conversation to collaborators Apr 7, 2024
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@maxkosty@lforst@vivianyentran
, '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

Simplify/reorganize Micro Frontend Suport - #9215

Merged
maxkosty merged 14 commits into
masterfrom
simpler-micro-frontends
Mar 23, 2024
Merged

Simplify/reorganize Micro Frontend Suport#9215
maxkosty merged 14 commits into
masterfrom
simpler-micro-frontends

Conversation

@maxkosty

@maxkostymaxkosty commented Feb 23, 2024

Copy link
Copy Markdown
Contributor

Pre-merge checklist

If you work at Sentry, you're able to merge your own PR without review, but please don't unless there's a good reason.

  • Checked Vercel preview for correctness, including links
  • PR was reviewed and approved by any necessary SMEs
  • PR was reviewed and approved by a member of the Sentry docs team

Description of changes

  • current doc is structured around components of the solution, this restructures it around use-cases: Automatic and Manual
  • remove the other sample beforeSend code that didn't get the slice(-1) fix.
  • [Automatic] changes to the "Once metadata has been injected into modules..." paragraph
  • [Manual] Add a note about importance of using local scope

Legal Boilerplate

Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.

Extra resources

@vercel

vercelBot commented Feb 23, 2024

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for Git ↗︎

NameStatusPreviewCommentsUpdated (UTC)
sentry-docs✅ Ready (Inspect)Visit Preview💬 Add feedbackMar 21, 2024 7:09pm
1 Ignored Deployment
NameStatusPreviewCommentsUpdated (UTC)
sentry-docs-next⬜️ Ignored (Inspect)Visit PreviewMar 21, 2024 7:09pm

@codecov

codecovBot commented Feb 23, 2024

Copy link
Copy Markdown

Bundle Report

Changes will decrease total bundle size by 6 bytes ⬇️

Bundle nameSizeChange
sentry-docs-server5.88MB0 bytes
sentry-docs-edge-server3.47kB0 bytes
sentry-docs-client5.18MB6 bytes ⬇️

@vivianyentranvivianyentran left a comment

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.

Added some comments but overall LGTM!

Comment threaddocs/platforms/javascript/common/configuration/micro-frontend-support.mdx Outdated
Comment threaddocs/platforms/javascript/common/configuration/micro-frontend-support.mdx Outdated
Comment threaddocs/platforms/javascript/common/configuration/micro-frontend-support.mdx Outdated
Comment threaddocs/platforms/javascript/common/configuration/micro-frontend-support.mdx Outdated
Comment threaddocs/platforms/javascript/common/configuration/micro-frontend-support.mdx Outdated
Comment threaddocs/platforms/javascript/common/configuration/micro-frontend-support.mdx Outdated
Comment threaddocs/platforms/javascript/common/configuration/micro-frontend-support.mdx Outdated
maxkostyand others added 7 commits March 6, 2024 19:21
…support.mdx
Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com>
…support.mdx
Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com>
…support.mdx
Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com>
…support.mdx
Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com>
…support.mdx
Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com>
…support.mdx
Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com>
@maxkosty
maxkosty requested a review from lforstMarch 7, 2024 03:38

@lforstlforst left a comment

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.

Such a good change!

different release cycles, you may want to identify these or route events to specific projects. This is especially useful if you've set up [module federation](https://module-federation.github.io/) or a similar frontend architecture.

## Identifying the source of errors
Below we offer two approaches. Please note that `Sentry.init()` must be called only once, doing otherwise will result in undefined behavior.

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.

This is very good to mention. I wonder if we should highlight this even stronger.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

done

Comment on lines +37 to +39
First, to identify the source of an error, you must inject metadata that helps identify
which bundles were responsible for the error. You can do this with any of the
Sentry bundler plugins by enabling the `_experiments.moduleMetadata` option.

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.

I would love to mention here that this should also work for vite and esbuild. I know that we mention the packages above but I am not sure if people will connect the dots. Doesn't have to be in this PR though!

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

added, lmk what you think


```javascript
import * as Sentry from "@sentry/browser";
import { init, makeFetchTransport, moduleMetadataIntegration, makeSimpleMultiplexedTransport, MULTIPLEXED_TRANSPORT_EXTRA_KEY } from "@sentry/browser";

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.

Suggested change
import { init, makeFetchTransport, moduleMetadataIntegration, makeSimpleMultiplexedTransport, MULTIPLEXED_TRANSPORT_EXTRA_KEY } from"@sentry/browser";
import { init, makeFetchTransport, moduleMetadataIntegration, MULTIPLEXED_TRANSPORT_EXTRA_KEY } from"@sentry/browser";

Once we added the makeSimpleMultiplexedTransport API we can revisit this but for now I'd leave it away.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

sounds good.
Reverting sample code to original including this change (as it hasn't been tested)

  • [Automatic] remove redundant if (routeTo.length) { check for empty array (done in matcher)

@lforst We should simplify the API sooner than later though. I feel like current sample code looks convoluted to the point of customers thinking "surely there must be an easier/more elegant way to do it, let me see what those other blog posts that showed up in search say"

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.

Ack, right now it is unfortunately not a priority for us and I'd like to avoid us losing focus but maybe I can sneak your PR in somehow.

Comment threaddocs/platforms/javascript/common/configuration/micro-frontend-support.mdx Outdated
@maxkosty

Copy link
Copy Markdown
ContributorAuthor

Hi @vivianyentran
there are a few wording changes in this increment 1144e30
would you mind checking my ESL please?

@vivianyentranvivianyentran left a comment

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.

Added one more tiny edit. Looks good! Thank you for this update!

Comment threaddocs/platforms/javascript/common/configuration/micro-frontend-support.mdx Outdated
…support.mdx
Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com>

@lforstlforst left a comment

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.

:shipit:

@maxkostymaxkosty changed the title Simplify/reorganize Micro Frontend Suport (DRAFT)Simplify/reorganize Micro Frontend SuportMar 23, 2024
@maxkosty
maxkosty merged commit 1d406de into masterMar 23, 2024
@maxkosty
maxkosty deleted the simpler-micro-frontends branch March 23, 2024 02:18
@github-actionsgithub-actionsBot locked and limited conversation to collaborators Apr 7, 2024
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@maxkosty@lforst@vivianyentran
, '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

Simplify/reorganize Micro Frontend Suport - #9215

Merged
maxkosty merged 14 commits into
masterfrom
simpler-micro-frontends
Mar 23, 2024
Merged

Simplify/reorganize Micro Frontend Suport#9215
maxkosty merged 14 commits into
masterfrom
simpler-micro-frontends

Conversation

@maxkosty

@maxkostymaxkosty commented Feb 23, 2024

Copy link
Copy Markdown
Contributor

Pre-merge checklist

If you work at Sentry, you're able to merge your own PR without review, but please don't unless there's a good reason.

  • Checked Vercel preview for correctness, including links
  • PR was reviewed and approved by any necessary SMEs
  • PR was reviewed and approved by a member of the Sentry docs team

Description of changes

  • current doc is structured around components of the solution, this restructures it around use-cases: Automatic and Manual
  • remove the other sample beforeSend code that didn't get the slice(-1) fix.
  • [Automatic] changes to the "Once metadata has been injected into modules..." paragraph
  • [Manual] Add a note about importance of using local scope

Legal Boilerplate

Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.

Extra resources

@vercel

vercelBot commented Feb 23, 2024

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for Git ↗︎

NameStatusPreviewCommentsUpdated (UTC)
sentry-docs✅ Ready (Inspect)Visit Preview💬 Add feedbackMar 21, 2024 7:09pm
1 Ignored Deployment
NameStatusPreviewCommentsUpdated (UTC)
sentry-docs-next⬜️ Ignored (Inspect)Visit PreviewMar 21, 2024 7:09pm

@codecov

codecovBot commented Feb 23, 2024

Copy link
Copy Markdown

Bundle Report

Changes will decrease total bundle size by 6 bytes ⬇️

Bundle nameSizeChange
sentry-docs-server5.88MB0 bytes
sentry-docs-edge-server3.47kB0 bytes
sentry-docs-client5.18MB6 bytes ⬇️

@vivianyentranvivianyentran left a comment

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.

Added some comments but overall LGTM!

Comment threaddocs/platforms/javascript/common/configuration/micro-frontend-support.mdx Outdated
Comment threaddocs/platforms/javascript/common/configuration/micro-frontend-support.mdx Outdated
Comment threaddocs/platforms/javascript/common/configuration/micro-frontend-support.mdx Outdated
Comment threaddocs/platforms/javascript/common/configuration/micro-frontend-support.mdx Outdated
Comment threaddocs/platforms/javascript/common/configuration/micro-frontend-support.mdx Outdated
Comment threaddocs/platforms/javascript/common/configuration/micro-frontend-support.mdx Outdated
Comment threaddocs/platforms/javascript/common/configuration/micro-frontend-support.mdx Outdated
maxkostyand others added 7 commits March 6, 2024 19:21
…support.mdx
Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com>
…support.mdx
Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com>
…support.mdx
Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com>
…support.mdx
Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com>
…support.mdx
Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com>
…support.mdx
Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com>
@maxkosty
maxkosty requested a review from lforstMarch 7, 2024 03:38

@lforstlforst left a comment

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.

Such a good change!

different release cycles, you may want to identify these or route events to specific projects. This is especially useful if you've set up [module federation](https://module-federation.github.io/) or a similar frontend architecture.

## Identifying the source of errors
Below we offer two approaches. Please note that `Sentry.init()` must be called only once, doing otherwise will result in undefined behavior.

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.

This is very good to mention. I wonder if we should highlight this even stronger.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

done

Comment on lines +37 to +39
First, to identify the source of an error, you must inject metadata that helps identify
which bundles were responsible for the error. You can do this with any of the
Sentry bundler plugins by enabling the `_experiments.moduleMetadata` option.

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.

I would love to mention here that this should also work for vite and esbuild. I know that we mention the packages above but I am not sure if people will connect the dots. Doesn't have to be in this PR though!

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

added, lmk what you think


```javascript
import * as Sentry from "@sentry/browser";
import { init, makeFetchTransport, moduleMetadataIntegration, makeSimpleMultiplexedTransport, MULTIPLEXED_TRANSPORT_EXTRA_KEY } from "@sentry/browser";

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.

Suggested change
import { init, makeFetchTransport, moduleMetadataIntegration, makeSimpleMultiplexedTransport, MULTIPLEXED_TRANSPORT_EXTRA_KEY } from"@sentry/browser";
import { init, makeFetchTransport, moduleMetadataIntegration, MULTIPLEXED_TRANSPORT_EXTRA_KEY } from"@sentry/browser";

Once we added the makeSimpleMultiplexedTransport API we can revisit this but for now I'd leave it away.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

sounds good.
Reverting sample code to original including this change (as it hasn't been tested)

  • [Automatic] remove redundant if (routeTo.length) { check for empty array (done in matcher)

@lforst We should simplify the API sooner than later though. I feel like current sample code looks convoluted to the point of customers thinking "surely there must be an easier/more elegant way to do it, let me see what those other blog posts that showed up in search say"

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.

Ack, right now it is unfortunately not a priority for us and I'd like to avoid us losing focus but maybe I can sneak your PR in somehow.

Comment threaddocs/platforms/javascript/common/configuration/micro-frontend-support.mdx Outdated
@maxkosty

Copy link
Copy Markdown
ContributorAuthor

Hi @vivianyentran
there are a few wording changes in this increment 1144e30
would you mind checking my ESL please?

@vivianyentranvivianyentran left a comment

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.

Added one more tiny edit. Looks good! Thank you for this update!

Comment threaddocs/platforms/javascript/common/configuration/micro-frontend-support.mdx Outdated
…support.mdx
Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com>

@lforstlforst left a comment

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.

:shipit:

@maxkostymaxkosty changed the title Simplify/reorganize Micro Frontend Suport (DRAFT)Simplify/reorganize Micro Frontend SuportMar 23, 2024
@maxkosty
maxkosty merged commit 1d406de into masterMar 23, 2024
@maxkosty
maxkosty deleted the simpler-micro-frontends branch March 23, 2024 02:18
@github-actionsgithub-actionsBot locked and limited conversation to collaborators Apr 7, 2024
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@maxkosty@lforst@vivianyentran
, '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

Simplify/reorganize Micro Frontend Suport - #9215

Merged
maxkosty merged 14 commits into
masterfrom
simpler-micro-frontends
Mar 23, 2024
Merged

Simplify/reorganize Micro Frontend Suport#9215
maxkosty merged 14 commits into
masterfrom
simpler-micro-frontends

Conversation

@maxkosty

@maxkostymaxkosty commented Feb 23, 2024

Copy link
Copy Markdown
Contributor

Pre-merge checklist

If you work at Sentry, you're able to merge your own PR without review, but please don't unless there's a good reason.

  • Checked Vercel preview for correctness, including links
  • PR was reviewed and approved by any necessary SMEs
  • PR was reviewed and approved by a member of the Sentry docs team

Description of changes

  • current doc is structured around components of the solution, this restructures it around use-cases: Automatic and Manual
  • remove the other sample beforeSend code that didn't get the slice(-1) fix.
  • [Automatic] changes to the "Once metadata has been injected into modules..." paragraph
  • [Manual] Add a note about importance of using local scope

Legal Boilerplate

Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.

Extra resources

@vercel

vercelBot commented Feb 23, 2024

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for Git ↗︎

NameStatusPreviewCommentsUpdated (UTC)
sentry-docs✅ Ready (Inspect)Visit Preview💬 Add feedbackMar 21, 2024 7:09pm
1 Ignored Deployment
NameStatusPreviewCommentsUpdated (UTC)
sentry-docs-next⬜️ Ignored (Inspect)Visit PreviewMar 21, 2024 7:09pm

@codecov

codecovBot commented Feb 23, 2024

Copy link
Copy Markdown

Bundle Report

Changes will decrease total bundle size by 6 bytes ⬇️

Bundle nameSizeChange
sentry-docs-server5.88MB0 bytes
sentry-docs-edge-server3.47kB0 bytes
sentry-docs-client5.18MB6 bytes ⬇️

@vivianyentranvivianyentran left a comment

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.

Added some comments but overall LGTM!

Comment threaddocs/platforms/javascript/common/configuration/micro-frontend-support.mdx Outdated
Comment threaddocs/platforms/javascript/common/configuration/micro-frontend-support.mdx Outdated
Comment threaddocs/platforms/javascript/common/configuration/micro-frontend-support.mdx Outdated
Comment threaddocs/platforms/javascript/common/configuration/micro-frontend-support.mdx Outdated
Comment threaddocs/platforms/javascript/common/configuration/micro-frontend-support.mdx Outdated
Comment threaddocs/platforms/javascript/common/configuration/micro-frontend-support.mdx Outdated
Comment threaddocs/platforms/javascript/common/configuration/micro-frontend-support.mdx Outdated
maxkostyand others added 7 commits March 6, 2024 19:21
…support.mdx
Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com>
…support.mdx
Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com>
…support.mdx
Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com>
…support.mdx
Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com>
…support.mdx
Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com>
…support.mdx
Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com>
@maxkosty
maxkosty requested a review from lforstMarch 7, 2024 03:38

@lforstlforst left a comment

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.

Such a good change!

different release cycles, you may want to identify these or route events to specific projects. This is especially useful if you've set up [module federation](https://module-federation.github.io/) or a similar frontend architecture.

## Identifying the source of errors
Below we offer two approaches. Please note that `Sentry.init()` must be called only once, doing otherwise will result in undefined behavior.

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.

This is very good to mention. I wonder if we should highlight this even stronger.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

done

Comment on lines +37 to +39
First, to identify the source of an error, you must inject metadata that helps identify
which bundles were responsible for the error. You can do this with any of the
Sentry bundler plugins by enabling the `_experiments.moduleMetadata` option.

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.

I would love to mention here that this should also work for vite and esbuild. I know that we mention the packages above but I am not sure if people will connect the dots. Doesn't have to be in this PR though!

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

added, lmk what you think


```javascript
import * as Sentry from "@sentry/browser";
import { init, makeFetchTransport, moduleMetadataIntegration, makeSimpleMultiplexedTransport, MULTIPLEXED_TRANSPORT_EXTRA_KEY } from "@sentry/browser";

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.

Suggested change
import { init, makeFetchTransport, moduleMetadataIntegration, makeSimpleMultiplexedTransport, MULTIPLEXED_TRANSPORT_EXTRA_KEY } from"@sentry/browser";
import { init, makeFetchTransport, moduleMetadataIntegration, MULTIPLEXED_TRANSPORT_EXTRA_KEY } from"@sentry/browser";

Once we added the makeSimpleMultiplexedTransport API we can revisit this but for now I'd leave it away.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

sounds good.
Reverting sample code to original including this change (as it hasn't been tested)

  • [Automatic] remove redundant if (routeTo.length) { check for empty array (done in matcher)

@lforst We should simplify the API sooner than later though. I feel like current sample code looks convoluted to the point of customers thinking "surely there must be an easier/more elegant way to do it, let me see what those other blog posts that showed up in search say"

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.

Ack, right now it is unfortunately not a priority for us and I'd like to avoid us losing focus but maybe I can sneak your PR in somehow.

Comment threaddocs/platforms/javascript/common/configuration/micro-frontend-support.mdx Outdated
@maxkosty

Copy link
Copy Markdown
ContributorAuthor

Hi @vivianyentran
there are a few wording changes in this increment 1144e30
would you mind checking my ESL please?

@vivianyentranvivianyentran left a comment

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.

Added one more tiny edit. Looks good! Thank you for this update!

Comment threaddocs/platforms/javascript/common/configuration/micro-frontend-support.mdx Outdated
…support.mdx
Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com>

@lforstlforst left a comment

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.

:shipit:

@maxkostymaxkosty changed the title Simplify/reorganize Micro Frontend Suport (DRAFT)Simplify/reorganize Micro Frontend SuportMar 23, 2024
@maxkosty
maxkosty merged commit 1d406de into masterMar 23, 2024
@maxkosty
maxkosty deleted the simpler-micro-frontends branch March 23, 2024 02:18
@github-actionsgithub-actionsBot locked and limited conversation to collaborators Apr 7, 2024
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@maxkosty@lforst@vivianyentran
, '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

Simplify/reorganize Micro Frontend Suport - #9215

Merged
maxkosty merged 14 commits into
masterfrom
simpler-micro-frontends
Mar 23, 2024
Merged

Simplify/reorganize Micro Frontend Suport#9215
maxkosty merged 14 commits into
masterfrom
simpler-micro-frontends

Conversation

@maxkosty

@maxkostymaxkosty commented Feb 23, 2024

Copy link
Copy Markdown
Contributor

Pre-merge checklist

If you work at Sentry, you're able to merge your own PR without review, but please don't unless there's a good reason.

  • Checked Vercel preview for correctness, including links
  • PR was reviewed and approved by any necessary SMEs
  • PR was reviewed and approved by a member of the Sentry docs team

Description of changes

  • current doc is structured around components of the solution, this restructures it around use-cases: Automatic and Manual
  • remove the other sample beforeSend code that didn't get the slice(-1) fix.
  • [Automatic] changes to the "Once metadata has been injected into modules..." paragraph
  • [Manual] Add a note about importance of using local scope

Legal Boilerplate

Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.

Extra resources

@vercel

vercelBot commented Feb 23, 2024

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for Git ↗︎

NameStatusPreviewCommentsUpdated (UTC)
sentry-docs✅ Ready (Inspect)Visit Preview💬 Add feedbackMar 21, 2024 7:09pm
1 Ignored Deployment
NameStatusPreviewCommentsUpdated (UTC)
sentry-docs-next⬜️ Ignored (Inspect)Visit PreviewMar 21, 2024 7:09pm

@codecov

codecovBot commented Feb 23, 2024

Copy link
Copy Markdown

Bundle Report

Changes will decrease total bundle size by 6 bytes ⬇️

Bundle nameSizeChange
sentry-docs-server5.88MB0 bytes
sentry-docs-edge-server3.47kB0 bytes
sentry-docs-client5.18MB6 bytes ⬇️

@vivianyentranvivianyentran left a comment

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.

Added some comments but overall LGTM!

Comment threaddocs/platforms/javascript/common/configuration/micro-frontend-support.mdx Outdated
Comment threaddocs/platforms/javascript/common/configuration/micro-frontend-support.mdx Outdated
Comment threaddocs/platforms/javascript/common/configuration/micro-frontend-support.mdx Outdated
Comment threaddocs/platforms/javascript/common/configuration/micro-frontend-support.mdx Outdated
Comment threaddocs/platforms/javascript/common/configuration/micro-frontend-support.mdx Outdated
Comment threaddocs/platforms/javascript/common/configuration/micro-frontend-support.mdx Outdated
Comment threaddocs/platforms/javascript/common/configuration/micro-frontend-support.mdx Outdated
maxkostyand others added 7 commits March 6, 2024 19:21
…support.mdx
Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com>
…support.mdx
Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com>
…support.mdx
Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com>
…support.mdx
Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com>
…support.mdx
Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com>
…support.mdx
Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com>
@maxkosty
maxkosty requested a review from lforstMarch 7, 2024 03:38

@lforstlforst left a comment

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.

Such a good change!

different release cycles, you may want to identify these or route events to specific projects. This is especially useful if you've set up [module federation](https://module-federation.github.io/) or a similar frontend architecture.

## Identifying the source of errors
Below we offer two approaches. Please note that `Sentry.init()` must be called only once, doing otherwise will result in undefined behavior.

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.

This is very good to mention. I wonder if we should highlight this even stronger.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

done

Comment on lines +37 to +39
First, to identify the source of an error, you must inject metadata that helps identify
which bundles were responsible for the error. You can do this with any of the
Sentry bundler plugins by enabling the `_experiments.moduleMetadata` option.

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.

I would love to mention here that this should also work for vite and esbuild. I know that we mention the packages above but I am not sure if people will connect the dots. Doesn't have to be in this PR though!

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

added, lmk what you think


```javascript
import * as Sentry from "@sentry/browser";
import { init, makeFetchTransport, moduleMetadataIntegration, makeSimpleMultiplexedTransport, MULTIPLEXED_TRANSPORT_EXTRA_KEY } from "@sentry/browser";

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.

Suggested change
import { init, makeFetchTransport, moduleMetadataIntegration, makeSimpleMultiplexedTransport, MULTIPLEXED_TRANSPORT_EXTRA_KEY } from"@sentry/browser";
import { init, makeFetchTransport, moduleMetadataIntegration, MULTIPLEXED_TRANSPORT_EXTRA_KEY } from"@sentry/browser";

Once we added the makeSimpleMultiplexedTransport API we can revisit this but for now I'd leave it away.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

sounds good.
Reverting sample code to original including this change (as it hasn't been tested)

  • [Automatic] remove redundant if (routeTo.length) { check for empty array (done in matcher)

@lforst We should simplify the API sooner than later though. I feel like current sample code looks convoluted to the point of customers thinking "surely there must be an easier/more elegant way to do it, let me see what those other blog posts that showed up in search say"

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.

Ack, right now it is unfortunately not a priority for us and I'd like to avoid us losing focus but maybe I can sneak your PR in somehow.

Comment threaddocs/platforms/javascript/common/configuration/micro-frontend-support.mdx Outdated
@maxkosty

Copy link
Copy Markdown
ContributorAuthor

Hi @vivianyentran
there are a few wording changes in this increment 1144e30
would you mind checking my ESL please?

@vivianyentranvivianyentran left a comment

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.

Added one more tiny edit. Looks good! Thank you for this update!

Comment threaddocs/platforms/javascript/common/configuration/micro-frontend-support.mdx Outdated
…support.mdx
Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com>

@lforstlforst left a comment

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.

:shipit:

@maxkostymaxkosty changed the title Simplify/reorganize Micro Frontend Suport (DRAFT)Simplify/reorganize Micro Frontend SuportMar 23, 2024
@maxkosty
maxkosty merged commit 1d406de into masterMar 23, 2024
@maxkosty
maxkosty deleted the simpler-micro-frontends branch March 23, 2024 02:18
@github-actionsgithub-actionsBot locked and limited conversation to collaborators Apr 7, 2024
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@maxkosty@lforst@vivianyentran