From a3c649f9ce7da84b6e0a8064b14831508f3c4dfe Mon Sep 17 00:00:00 2001
From: Lukas Stracke <lukas.stracke@sentry.io>
Date: Mon, 31 Jul 2023 13:54:34 +0200
Subject: [PATCH 1/4] feat(js): Add documentation for new `ContextLines`
 integration

---
 .../configuration/integrations/plugin.mdx     | 17 +++++
 .../configuration/contextlines/javascript.mdx | 69 +++++++++++++++++++
 2 files changed, 86 insertions(+)
 create mode 100644 src/platform-includes/configuration/contextlines/javascript.mdx

diff --git a/src/includes/platforms/configuration/integrations/plugin.mdx b/src/includes/platforms/configuration/integrations/plugin.mdx
index 481c33c2adcd0..4cd38053859ab 100644
--- a/src/includes/platforms/configuration/integrations/plugin.mdx
+++ b/src/includes/platforms/configuration/integrations/plugin.mdx
@@ -107,3 +107,20 @@ Available options:
 <PlatformContent includePath="configuration/reporting-observer" />
 
 </PlatformSection>
+
+<PlatformSection supported={["javascript"]}>
+
+### ContextLines
+
+_Import name: `Sentry.Integrations.ReportingObserver`_
+
+This integration collects code lines at and around the stack frames of an error that point to code in the current page's html (for example in `<script>` tags).
+Note that this integration _cannot_ collect code lines from other files that are loaded by the browser.
+Generally, context line collection is already taken care of by the Sentry backend which will try to fetch the JavaScript file from your server when an error is reported to Sentry.
+However, in some cases, our backend might not be able to fetch the JavaScript file, for example if the file is only available for logged in users.
+
+Use this integration if you have inline JS code in HTML pages that can't be accessed by our backend, for example due to a login-protected page.
+
+<PlatformContent includePath="configuration/contextlines" />
+
+</PlatformSection>
diff --git a/src/platform-includes/configuration/contextlines/javascript.mdx b/src/platform-includes/configuration/contextlines/javascript.mdx
new file mode 100644
index 0000000000000..2ce019abf7906
--- /dev/null
+++ b/src/platform-includes/configuration/contextlines/javascript.mdx
@@ -0,0 +1,69 @@
+<SignInNote />
+
+```javascript {tabTitle: ESM}
+import * as Sentry from "@sentry/browser";
+import { ContextLines } from "@sentry/integrations";
+
+Sentry.init({
+  dsn: "___PUBLIC_DSN___",
+  integrations: [
+    new ContextLines({
+      // The number of lines to collect for each stack frame
+      // Defaults to 7
+      frameContextLines: 7,
+    }),
+  ],
+});
+```
+
+```html {tabTitle: Loader}
+<script
+  src="https://js.sentry-cdn.com/___PUBLIC_KEY___.min.js"
+  crossorigin="anonymous"
+></script>
+<script
+  src="https://browser.sentry-cdn.com/{{@inject packages.version('sentry.javascript.browser') }}/contextlines.min.js"
+  integrity="sha384-{{@inject packages.checksum('sentry.javascript.browser', 'contextlines.min.js', 'sha384-base64') }}"
+  crossorigin="anonymous"
+></script>
+
+<script>
+  Sentry.onLoad(function () {
+    Sentry.init({
+      integrations: [
+        new Sentry.Integrations.ContextLines({
+          // The number of lines to collect for each stack frame
+          // Defaults to 7
+          frameContextLines: 7,
+        }),
+      ],
+    });
+  });
+</script>
+```
+
+```html {tabTitle: CDN}
+<script
+  src="https://browser.sentry-cdn.com/{{@inject packages.version('sentry.javascript.browser') }}/bundle.tracing.min.js"
+  integrity="sha384-{{@inject packages.checksum('sentry.javascript.browser', 'bundle.tracing.min.js', 'sha384-base64') }}"
+  crossorigin="anonymous"
+></script>
+<script
+  src="https://browser.sentry-cdn.com/{{@inject packages.version('sentry.javascript.browser') }}/contextlines.min.js"
+  integrity="sha384-{{@inject packages.checksum('sentry.javascript.browser', 'contextlines.min.js', 'sha384-base64') }}"
+  crossorigin="anonymous"
+></script>
+
+<script>
+  Sentry.init({
+    dsn: "___PUBLIC_DSN___",
+    integrations: [
+      new Sentry.Integrations.ContextLines({
+        // The number of lines to collect for each stack frame
+        // Defaults to 7
+        frameContextLines: 7,
+      }),
+    ],
+  });
+</script>
+```

From 66882c9eba7ebd1ed5ee25754e71b56cf9848cfc Mon Sep 17 00:00:00 2001
From: Lukas Stracke <lukas.stracke@sentry.io>
Date: Wed, 2 Aug 2023 10:19:19 +0200
Subject: [PATCH 2/4] apply review suggestion && adjust wording around backend
 fetching

---
 .../platforms/configuration/integrations/plugin.mdx   | 11 ++++++-----
 1 file changed, 6 insertions(+), 5 deletions(-)

diff --git a/src/includes/platforms/configuration/integrations/plugin.mdx b/src/includes/platforms/configuration/integrations/plugin.mdx
index 4cd38053859ab..fb1652e1420bc 100644
--- a/src/includes/platforms/configuration/integrations/plugin.mdx
+++ b/src/includes/platforms/configuration/integrations/plugin.mdx
@@ -112,12 +112,13 @@ Available options:
 
 ### ContextLines
 
-_Import name: `Sentry.Integrations.ReportingObserver`_
+_Import name: `Sentry.Integrations.ContextLines`_
+
+This integration attaches source code of inline JavaScript inside the page's HTML (e.g. JS in `<script>` tags) to errors captured by the SDK.
+Note that this integration _cannot_ collect source code from assets referenced by your HTML (e.g. `<script src="..." />`).
 
-This integration collects code lines at and around the stack frames of an error that point to code in the current page's html (for example in `<script>` tags).
-Note that this integration _cannot_ collect code lines from other files that are loaded by the browser.
-Generally, context line collection is already taken care of by the Sentry backend which will try to fetch the JavaScript file from your server when an error is reported to Sentry.
-However, in some cases, our backend might not be able to fetch the JavaScript file, for example if the file is only available for logged in users.
+Generally, the Sentry backend tries to attach source code to these errors by fetching the page and extracting the respective lines.
+However, in some cases, our backend might not be able to fetch the JavaScript file, for example if the file is only available for authenticated users.
 
 Use this integration if you have inline JS code in HTML pages that can't be accessed by our backend, for example due to a login-protected page.
 

From 43cfb482ea193d56342831b68fec5ea90c830b92 Mon Sep 17 00:00:00 2001
From: Lukas Stracke <lukas.stracke@sentry.io>
Date: Thu, 3 Aug 2023 11:01:56 +0200
Subject: [PATCH 3/4] apply review suggestions and streamline some sentences

---
 .../platforms/configuration/integrations/plugin.mdx      | 9 +++------
 .../configuration/contextlines/javascript.mdx            | 6 +++---
 2 files changed, 6 insertions(+), 9 deletions(-)

diff --git a/src/includes/platforms/configuration/integrations/plugin.mdx b/src/includes/platforms/configuration/integrations/plugin.mdx
index fb1652e1420bc..822e753f338c8 100644
--- a/src/includes/platforms/configuration/integrations/plugin.mdx
+++ b/src/includes/platforms/configuration/integrations/plugin.mdx
@@ -114,13 +114,10 @@ Available options:
 
 _Import name: `Sentry.Integrations.ContextLines`_
 
-This integration attaches source code of inline JavaScript inside the page's HTML (e.g. JS in `<script>` tags) to errors captured by the SDK.
-Note that this integration _cannot_ collect source code from assets referenced by your HTML (e.g. `<script src="..." />`).
+This integration adds source code from inline JavaScript of the current page's HTML (e.g. JS in `<script>` tags) to stack traces of captured errors.
+It _can't_ collect source code from assets referenced by your HTML (e.g. `<script src="..." />`).
 
-Generally, the Sentry backend tries to attach source code to these errors by fetching the page and extracting the respective lines.
-However, in some cases, our backend might not be able to fetch the JavaScript file, for example if the file is only available for authenticated users.
-
-Use this integration if you have inline JS code in HTML pages that can't be accessed by our backend, for example due to a login-protected page.
+The `ContextLines` integration is useful when you have inline JS code in HTML pages that can't be accessed by Sentry's backend, for example, due to a login-protected page.
 
 <PlatformContent includePath="configuration/contextlines" />
 
diff --git a/src/platform-includes/configuration/contextlines/javascript.mdx b/src/platform-includes/configuration/contextlines/javascript.mdx
index 2ce019abf7906..b9d070ab6af9a 100644
--- a/src/platform-includes/configuration/contextlines/javascript.mdx
+++ b/src/platform-includes/configuration/contextlines/javascript.mdx
@@ -8,7 +8,7 @@ Sentry.init({
   dsn: "___PUBLIC_DSN___",
   integrations: [
     new ContextLines({
-      // The number of lines to collect for each stack frame
+      // The number of lines to collect around each stack frame's line number
       // Defaults to 7
       frameContextLines: 7,
     }),
@@ -32,7 +32,7 @@ Sentry.init({
     Sentry.init({
       integrations: [
         new Sentry.Integrations.ContextLines({
-          // The number of lines to collect for each stack frame
+          // The number of lines to collect around each stack frame's line number
           // Defaults to 7
           frameContextLines: 7,
         }),
@@ -59,7 +59,7 @@ Sentry.init({
     dsn: "___PUBLIC_DSN___",
     integrations: [
       new Sentry.Integrations.ContextLines({
-        // The number of lines to collect for each stack frame
+        // The number of lines to collect around each stack frame's line number
         // Defaults to 7
         frameContextLines: 7,
       }),

From 7583a89f64241659352175166d92159ea23303db Mon Sep 17 00:00:00 2001
From: Lukas Stracke <lukas.stracke@sentry.io>
Date: Tue, 8 Aug 2023 16:15:11 +0200
Subject: [PATCH 4/4] Update
 src/platform-includes/configuration/contextlines/javascript.mdx

---
 src/platform-includes/configuration/contextlines/javascript.mdx | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/platform-includes/configuration/contextlines/javascript.mdx b/src/platform-includes/configuration/contextlines/javascript.mdx
index b9d070ab6af9a..0a949d0b8a062 100644
--- a/src/platform-includes/configuration/contextlines/javascript.mdx
+++ b/src/platform-includes/configuration/contextlines/javascript.mdx
@@ -32,7 +32,7 @@ Sentry.init({
     Sentry.init({
       integrations: [
         new Sentry.Integrations.ContextLines({
-          // The number of lines to collect around each stack frame's line number
+          // The number of lines to collect before and after each stack frame's line number
           // Defaults to 7
           frameContextLines: 7,
         }),