Merge branch 'main' into pr/4259

Author: jamescrosswell

.gitignore

@@ -27,6 +27,7 @@ test/**/*.apk
 /tools/
 *.log
 .sentry-native
+**/EnvironmentVariables.g.cs
 
 # Download cache for Cocoa SDK
 modules/sentry-cocoa

Directory.Build.props

@@ -67,6 +67,11 @@
     <DefineConstants>$(DefineConstants);CI_BUILD</DefineConstants>
   </PropertyGroup>
 
+  <!-- So we know at build time whether the DSN has been provided in an environment variable or not -->
+  <PropertyGroup Condition=" '$(SENTRY_DSN)' != '' ">
+    <DefineConstants>$(DefineConstants);SENTRY_DSN_DEFINED_IN_ENV</DefineConstants>
+  </PropertyGroup>
+
   <ItemGroup>
     <PackageReference Include="UnoptimizedAssemblyDetector" Version="0.1.1" PrivateAssets="All" />
     <PackageReference Include="Roslynator.Analyzers" Version="4.9.0" PrivateAssets="All" />

samples/Directory.Build.targets

@@ -7,4 +7,44 @@
   <Import Project="$(MSBuildThisFileDirectory)..\src\Sentry.Bindings.Cocoa\buildTransitive\Sentry.Bindings.Cocoa.targets"
     Condition="'$(OutputType)' == 'Exe' And ('$(TargetPlatformIdentifier)' == 'ios' Or '$(TargetPlatformIdentifier)' == 'maccatalyst')" />
   <Import Project="$(MSBuildThisFileDirectory)..\src\Sentry\Platforms\Native\buildTransitive\Sentry.Native.targets" />
+
+  <Target Name="GenerateSharedDsnConstant"
+          BeforeTargets="BeforeCompile"
+          Condition=" '$(SENTRY_DSN)' != '' and '$(PlatformIsMobile)' == 'true'">
+
+    <Message Text="Generating shared EnvironmentVariables.g.cs with embedded DSN..." Importance="High" />
+
+    <WriteLinesToFile
+      File="$(MSBuildThisFileDirectory)EnvironmentVariables.g.cs"
+      Lines="
+// This file is auto-generated by a custom build target used in the Sentry Samples... in your own projects you should
+// specify the DSN either directly in code (in the file where you initialize Sentry) or via SENTRY_DSN environment
+// variable (for non-mobile projects - that won't work on Android, iOS, or MacCatalyst).
+namespace Sentry.Samples%3B
+
+internal static class EnvironmentVariables
+{
+    /// &lt;summary&gt;
+    /// To make things easier for the SDK maintainers we have a custom build target that writes the
+    /// SENTRY_DSN environment variable into an EnvironmentVariables class that is available for mobile
+    /// targets. This allows us to share one DSN defined in the ENV across desktop and mobile samples.
+    /// Generally, you won't want to do this in your own mobile projects though - you should set the DSN
+    /// in code as above
+    /// &lt;/summary&gt;
+    internal const string Dsn = &quot;$(SENTRY_DSN)&quot;%3B
+}
+"
+      Overwrite="true" />
+  </Target>
+
+  <ItemGroup>
+    <!-- Make sure all sample projects include the generated file -->
+    <Compile Include="$(MSBuildThisFileDirectory)EnvironmentVariables.g.cs" Condition="Exists('$(MSBuildThisFileDirectory)EnvironmentVariables.g.cs')" />
+    <!-- Make sure all sample projects include any other shared files -->
+    <Compile Include="$(MSBuildThisFileDirectory)SamplesShared.cs" />
+
+    <!-- Add shared global usings   -->
+    <Using Include="Sentry.Samples" />
+  </ItemGroup>
+
 </Project>

samples/SamplesShared.cs

@@ -0,0 +1,23 @@
+namespace Sentry.Samples;
+
+public static class SamplesShared
+{
+#if !SENTRY_DSN_DEFINED_IN_ENV
+    /// <summary>
+    /// <para>
+    /// You must specify a DSN. See https://docs.sentry.io/product/sentry-basics/dsn-explainer/
+    /// </para>
+    /// <para>
+    /// On mobile platforms (iOS, Android or MacCatalyst), this should be done in code.
+    /// </para>
+    /// <para>
+    /// On other platforms you can set this in code and it is also possible to set this via an environment variable or
+    /// via configuration bindings (e.g. in an app.config or an appsettings.json file).
+    /// </para>
+    /// </summary>
+#if !CI_BUILD
+#error Sign up for a free Sentry Account and enter your DSN here
+#endif
+    public const string Dsn = "ENTER_YOUR_DSN_HERE";
+#endif
+}

samples/Sentry.Samples.Android/MainActivity.cs

@@ -9,7 +9,17 @@ protected override void OnCreate(Bundle? savedInstanceState)
     {
         SentrySdk.Init(options =>
         {
-            options.Dsn = "https://[email protected]/5428537";
+#if !SENTRY_DSN_DEFINED_IN_ENV
+            // You must specify a DSN. On mobile platforms, this should be done in code here.
+            // See https://docs.sentry.io/product/sentry-basics/dsn-explainer/
+            options.Dsn = SamplesShared.Dsn;
+#else
+            // To make things easier for the SDK maintainers our samples check for a SENTRY_DSN environment variable
+            // and write this (as a constant) into an EnvironmentVariables class. Generally, you won't want to do
+            // this in your own mobile projects though - you should set the DSN in code as above
+            options.Dsn = EnvironmentVariables.Dsn;
+#endif
+
             options.SendDefaultPii = true; // adds the user's IP address automatically
 
             // Android specific .NET features are under the Android properties:

samples/Sentry.Samples.AspNetCore.Basic/Program.cs

@@ -2,8 +2,11 @@
 
 builder.WebHost.UseSentry(options =>
 {
-    // A DSN is required.  You can set it here, or in configuration, or in an environment variable.
-    options.Dsn = "https://[email protected]/5428537";
+#if !SENTRY_DSN_DEFINED_IN_ENV
+    // A DSN is required. You can set here in code, or you can set it in the SENTRY_DSN environment variable.
+    // See https://docs.sentry.io/product/sentry-basics/dsn-explainer/
+    options.Dsn = SamplesShared.Dsn;
+#endif
 
     // Enable Sentry performance monitoring
     options.TracesSampleRate = 1.0;

samples/Sentry.Samples.AspNetCore.Blazor.Server/Program.cs

@@ -6,7 +6,11 @@
 builder.Services.AddServerSideBlazor();
 builder.WebHost.UseSentry(options =>
 {
-    options.Dsn = "https://[email protected]/5428537";
+#if !SENTRY_DSN_DEFINED_IN_ENV
+    // A DSN is required. You can set here in code, in the SENTRY_DSN environment variable or in your appsettings.json
+    // See https://docs.sentry.io/product/sentry-basics/dsn-explainer/
+    options.Dsn = SamplesShared.Dsn;
+#endif
     options.TracesSampleRate = 1.0;
     options.Debug = true;
 });

samples/Sentry.Samples.AspNetCore.Blazor.Wasm/Program.cs

@@ -6,7 +6,11 @@
     var builder = WebAssemblyHostBuilder.CreateDefault(args);
     builder.UseSentry(options =>
     {
-        options.Dsn = "https://[email protected]/5428537";
+#if !SENTRY_DSN_DEFINED_IN_ENV
+        // A DSN is required. You can set here in code, or you can set it in the SENTRY_DSN environment variable.
+        // See https://docs.sentry.io/product/sentry-basics/dsn-explainer/
+        options.Dsn = SamplesShared.Dsn;
+#endif
         options.Debug = true;
     });
 

samples/Sentry.Samples.AspNetCore.Grpc/Program.cs

@@ -31,6 +31,13 @@ public static IWebHost BuildWebHost(string[] args) =>
                 builder.AddGrpc();
                 builder.AddSentryOptions(options =>
                 {
+#if !SENTRY_DSN_DEFINED_IN_ENV
+                    // A DSN is required. You can set here in code, via the SENTRY_DSN environment variable or in your
+                    // appsettings.json file.
+                    // See https://docs.sentry.io/platforms/dotnet/guides/aspnetcore/#configure
+                    options.Dsn = SamplesShared.Dsn;
+#endif
+
                     // The parameter 'options' here has values populated through the configuration system.
                     // That includes 'appsettings.json', environment variables and anything else
                     // defined on the ConfigurationBuilder.

samples/Sentry.Samples.AspNetCore.Grpc/appsettings.json

@@ -3,7 +3,7 @@
   // All Sentry settings can also be configured via code or environment variables:
   "Sentry": {
     // The DSN can also be set via environment variable
-    "Dsn": "https://[email protected]/5428537",
+    //"Dsn": "TODO: Configure your DSN here and uncomment this line",
     // Opt-in for payload submission
     "MaxRequestBodySize": "Always",
     // Sends Cookies, User Id when one is logged on and user IP address to sentry. It's turned off by default.