Enable Integrated Mode #2786

New issue

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

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

Already on GitHub? Sign in to your account

Draft

mikeminutillo wants to merge 24 commits into master from embedded-mode-2

+330 −264

.github/workflows/ci.yml

-Original file line number
+Diff line change
@@ Expand Up / @@ -23,7 +23,7 @@ jobs: @@
           - name: Setup .NET SDK
             uses: actions/setup-dotnet@v5.1.0
             with:
-              dotnet-version: 8.0.x
+              global-json-file: global.json
           - name: Set up Node.js
             uses: actions/setup-node@v6.1.0
             with:
@@ Expand Down @@

.github/workflows/release.yml

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -29,7 +29,7 @@ jobs:
  
          - name: Setup .NET SDK

            uses: actions/setup-dotnet@v5.1.0

            with:

              dotnet-version: 7.0.x

              global-json-file: global.json

          - name: Set up Node.js

            uses: actions/setup-node@v6.1.0

            with:

    @@ -82,7 +82,7 @@ jobs:
  
              $nugetsCount =  (Get-ChildItem -Recurse -File nugets).Count

              $expectedAssetsCount = 1

              $expectedNugetsCount = 1

              $expectedNugetsCount = 2

              if ($assetsCount -ne $expectedAssetsCount)

              {

global.json

-Original file line number
+Diff line change
@@ -1,6 +1,7 @@
     {
       "sdk": {
-        "version": "8.0.400",
+        "version": "10.0.0",
+        "allowPrerelease": false,
         "rollForward": "latestFeature"
       }
     }

src/Frontend/env.d.ts

-Original file line number
+Diff line change
@@ Expand Up / @@ -10,6 +10,7 @@ declare global { @@
           service_control_url: string;
           monitoring_urls: string[];
           showPendingRetry: boolean;
+          isIntegrated?: boolean;
         };
       }
     }

src/Frontend/public/js/app.constants.js

-Original file line number
+Diff line change
@@ Expand Up / @@ -4,4 +4,5 @@ window.defaultConfig = { @@
       service_control_url: 'http://localhost:33333/api/',
       monitoring_urls: ['http://localhost:33633/'],
       showPendingRetry: false,
+      isIntegrated: false,
     };

src/Frontend/src/components/PageFooter.vue

-Original file line number
+Diff line change
@@ Expand Up / @@ -21,6 +21,7 @@ const environment = environmentAndVersionsStore.environment; @@
     const licenseStore = useLicenseStore();
     const { licenseStatus, license } = licenseStore;
     const isMonitoringEnabled = monitoringClient.isMonitoringEnabled;
+    const isIntegrated = window.defaultConfig.isIntegrated;
     const scAddressTooltip = computed(() => {
       return `ServiceControl URL ${serviceControlClient.url}`;
@@ Expand All / @@ -44,11 +45,14 @@ const { configuration } = storeToRefs(configurationStore); @@
                 <RouterLink :to="routeLinks.configuration.endpointConnection.link">Connect new endpoint</RouterLink>
               </span>
-              <span v-if="!newVersions.newSPVersion.newspversion && environment.sp_version"> ServicePulse v{{ environment.sp_version }} </span>
-              <span v-if="newVersions.newSPVersion.newspversion && environment.sp_version">
-                ServicePulse v{{ environment.sp_version }} (<FAIcon v-if="newVersions.newSPVersion.newspversionnumber" class="footer-icon fake-link" :icon="faArrowTurnUp" />
-                <a :href="newVersions.newSPVersion.newspversionlink" target="_blank">v{{ newVersions.newSPVersion.newspversionnumber }} available</a>)
-              </span>
+              <span v-if="isIntegrated"> ServicePulse: Integrated </span>
+              <template v-else-if="environment.sp_version">
+                <span v-if="!newVersions.newSPVersion.newspversion"> ServicePulse v{{ environment.sp_version }} </span>
+                <span v-else>
+                  ServicePulse v{{ environment.sp_version }} (<FAIcon v-if="newVersions.newSPVersion.newspversionnumber" class="footer-icon fake-link" :icon="faArrowTurnUp" />
+                  <a :href="newVersions.newSPVersion.newspversionlink" target="_blank">v{{ newVersions.newSPVersion.newspversionnumber }} available</a>)
+                </span>
+              </template>
               <span :title="scAddressTooltip">
                 Service Control:
                 <span class="connected-status" v-if="connectionState.connected && !connectionState.connecting">
@@ Expand Down @@

src/Frontend/src/components/configuration/PlatformConnections.vue

-Original file line number
+Diff line change
@@ Expand Up / @@ -20,6 +20,7 @@ const serviceControlValid = ref<boolean | null>(null); @@
     const testingMonitoring = ref(false);
     const monitoringValid = ref<boolean | null>(null);
     const connectionSaved = ref<boolean | null>(null);
+    const isIntegrated = window.defaultConfig.isIntegrated;
     async function testServiceControlUrl() {
       if (localServiceControlUrl.value) {
@@ Expand Down Expand Up / @@ -64,10 +65,15 @@ function saveConnections() { @@
     }
     function updateServiceControlUrls() {
-      if (!localServiceControlUrl.value) {
-        throw new Error("ServiceControl URL is mandatory");
-      } else if (!localServiceControlUrl.value.endsWith("/")) {
-        localServiceControlUrl.value += "/";
+      const params = new URLSearchParams();
+      if (!isIntegrated) {
+        if (!localServiceControlUrl.value) {
+          throw new Error("ServiceControl URL is mandatory");
+        } else if (!localServiceControlUrl.value.endsWith("/")) {
+          localServiceControlUrl.value += "/";
+        }
+        params.set("scu", localServiceControlUrl.value);
       }
       if (!localMonitoringUrl.value) {
@@ Expand All / @@ -76,8 +82,6 @@ function updateServiceControlUrls() { @@
         localMonitoringUrl.value += "/";
       }
-      const params = new URLSearchParams();
-      params.set("scu", localServiceControlUrl.value);
       params.set("mu", localMonitoringUrl.value);
       window.location.search = `?${params.toString()}`;
     }
@@ Expand All / @@ -94,11 +98,14 @@ function updateServiceControlUrls() { @@
                   <div class="col-7 form-group">
                     <label for="serviceControlUrl">
                       CONNECTION URL
+                      <template v-if="isIntegrated">
+                        <span>(INTEGRATED)</span>
+                      </template>
                       <template v-if="connectionState.unableToConnect">
                         <span class="failed-validation"><FAIcon :icon="faExclamationTriangle" /> Unable to connect </span>
                       </template>
                     </label>
-                    <input type="text" id="serviceControlUrl" name="serviceControlUrl" v-model="localServiceControlUrl" class="form-control" style="color: #000" required />
+                    <input type="text" id="serviceControlUrl" name="serviceControlUrl" v-model="localServiceControlUrl" class="form-control" style="color: #000" required :disabled="isIntegrated" />
                   </div>
                   <div class="col-5 no-side-padding">
@@ Expand Down @@

src/Frontend/src/components/serviceControlClient.ts

-Original file line number
+Diff line change
@@ Expand Up / @@ -96,6 +96,10 @@ class ServiceControlClient { @@
       }
       private getUrl() {
+        if (window.defaultConfig?.isIntegrated && window.defaultConfig.service_control_url?.length) {
+          return window.defaultConfig.service_control_url;
+        }
         const searchParams = new URLSearchParams(window.location.search);
         const scu = searchParams.get("scu");
         const existingScu = window.localStorage.getItem("scu");
@@ Expand Down @@

src/Particular.PlatformSample.ServicePulse/Particular.PlatformSample.ServicePulse.csproj

-Original file line number
+Diff line change
@@ -1,7 +1,7 @@
     <Project Sdk="Microsoft.NET.Sdk">
       <PropertyGroup>
-        <TargetFramework>net8.0</TargetFramework>
+        <TargetFramework>net10.0</TargetFramework>
         <IncludeBuildOutput>false</IncludeBuildOutput>
         <SuppressDependenciesWhenPacking>true</SuppressDependenciesWhenPacking>
         <Description>Particular ServicePulse binaries for use by Particular.PlatformSample. Not intended for use outside of Particular.PlatformSample.</Description>
@@ Expand Down @@

src/ServicePulse.Core/ConstantsFile.cs

-Original file line number
+Diff line change
@@ -0,0 +1,41 @@
+    namespace ServicePulse;
+    using System.Reflection;
+    class ConstantsFile
+    {
+        public static string GetContent(ServicePulseSettings settings)
+        {
+            var version = GetVersionInformation();
+            var constantsFile = $$"""
+    window.defaultConfig = {
+      default_route: '{{settings.DefaultRoute}}',
+      version: '{{version}}',
+      service_control_url: '{{settings.ServiceControlUrl}}',
+      monitoring_urls: ['{{settings.MonitoringUrl ?? "!"}}'],
+      showPendingRetry: {{settings.ShowPendingRetry.ToString().ToLower()}},
+      isIntegrated: {{settings.IsIntegrated.ToString().ToLower()}}
+    }
+    """;
+            return constantsFile;
+        }
+        static string GetVersionInformation()
+        {
+            var majorMinorPatch = "0.0.0";
+            var attributes = typeof(ConstantsFile).Assembly.GetCustomAttributes<AssemblyMetadataAttribute>();
+            foreach (var attribute in attributes)
+            {
+                if (attribute.Key == "MajorMinorPatch")
+                {
+                    majorMinorPatch = attribute.Value ?? "0.0.0";
+                }
+            }
+            return majorMinorPatch;
+        }
+    }

src/ServicePulse.Core/ServicePulse.Core.csproj

-Original file line number
+Diff line change
@@ -0,0 +1,23 @@
+    <Project Sdk="Microsoft.NET.Sdk">
+      <PropertyGroup>
+        <TargetFramework>net10.0</TargetFramework>
+        <ImplicitUsings>enable</ImplicitUsings>
+        <Nullable>enable</Nullable>
+        <GenerateEmbeddedFilesManifest>true</GenerateEmbeddedFilesManifest>
+      </PropertyGroup>
+      <ItemGroup>
+        <PackageReference Include="Microsoft.Extensions.FileProviders.Embedded" Version="10.0.2" AutomaticVersionRange="false" />
+        <PackageReference Include="Particular.Packaging" Version="4.5.0" PrivateAssets="All" />
+      </ItemGroup>
+      <ItemGroup>
+        <FrameworkReference Include="Microsoft.AspNetCore.App" />
+      </ItemGroup>
+      <ItemGroup>
+        <EmbeddedResource Include="..\Frontend\dist\**\*" Exclude="..\Frontend\dist\js\**\*" LinkBase="wwwroot" />
+      </ItemGroup>
+    </Project>

src/ServicePulse.Core/ServicePulseHostingExtensions.cs

-Original file line number
+Diff line change
@@ -0,0 +1,37 @@
+    namespace ServicePulse;
+    using System.Net.Mime;
+    using Microsoft.AspNetCore.Builder;
+    using Microsoft.AspNetCore.Http;
+    using Microsoft.Extensions.FileProviders;
+    /// <summary>
+    /// Extensions for hosting ServicePulse within a WebApplication.
+    /// </summary>
+    public static class ServicePulseHostingExtensions
+    {
+        /// <summary>
+        /// Adds ServicePulse static file serving and configuration endpoint to the WebApplication.
+        /// </summary>
+        public static void UseServicePulse(this WebApplication app, ServicePulseSettings settings, IFileProvider? overrideFileProvider = null)
+        {
+            var manifestEmbeddedFileProvider = new ManifestEmbeddedFileProvider(typeof(ServicePulseHostingExtensions).Assembly, "wwwroot");
+            IFileProvider fileProvider = overrideFileProvider is null
+                ? manifestEmbeddedFileProvider
+                : new CompositeFileProvider(overrideFileProvider, manifestEmbeddedFileProvider);
+            var defaultFilesOptions = new DefaultFilesOptions { FileProvider = fileProvider };
+            app.UseDefaultFiles(defaultFilesOptions);
+            var staticFileOptions = new StaticFileOptions { FileProvider = fileProvider };
+            app.UseStaticFiles(staticFileOptions);
+            var constantsFile = ConstantsFile.GetContent(settings);
+            app.MapGet("/js/app.constants.js", (HttpContext context) =>
+            {
+                context.Response.ContentType = MediaTypeNames.Text.JavaScript;
+                return constantsFile;
+            }).AllowAnonymous();
+        }
+    }

src/ServicePulse.Core/ServicePulseSettings.cs

-Original file line number
+Diff line change
@@ -0,0 +1,112 @@
+    namespace ServicePulse;
+    using System.Text.Json;
+    /// <summary>
+    /// Application Settings for ServicePulse.
+    /// </summary>
+    public record ServicePulseSettings
+    {
+        /// <summary>
+        /// The location of the ServiceControl API.
+        /// </summary>
+        public required string ServiceControlUrl { get; init; }
+        /// <summary>
+        /// The location of the ServiceControl Monitoring API.
+        /// </summary>
+        public required string? MonitoringUrl { get; init; }
+        /// <summary>
+        /// The default route to navigate to from the root.
+        /// </summary>
+        public required string DefaultRoute { get; init; }
+        /// <summary>
+        /// Flag to enable the pending retry feature.
+        /// </summary>
+        public required bool ShowPendingRetry { get; init; }
+        /// <summary>
+        /// Flag to indicate if ServicePulse is running in integrated mode.
+        /// </summary>
+        public required bool IsIntegrated { get; init; }
+        /// <summary>
+        /// Loads the settings from environment variables.
+        /// </summary>
+        public static ServicePulseSettings GetFromEnvironmentVariables()
+        {
+            var serviceControlUrl = Environment.GetEnvironmentVariable("SERVICECONTROL_URL") ?? "http://localhost:33333/api/";
+            if (!serviceControlUrl.EndsWith("/", StringComparison.Ordinal))
+            {
+                serviceControlUrl += "/";
+            }
+            if (!serviceControlUrl.EndsWith("api/", StringComparison.Ordinal))
+            {
+                serviceControlUrl += "api/";
+            }
+            var serviceControlUri = new Uri(serviceControlUrl);
+            var monitoringUrls = ParseLegacyMonitoringValue(Environment.GetEnvironmentVariable("MONITORING_URLS"));
+            var monitoringUrl = Environment.GetEnvironmentVariable("MONITORING_URL");
+            monitoringUrl ??= monitoringUrls;
+            monitoringUrl ??= "http://localhost:33633/";
+            var monitoringUri = monitoringUrl == "!" ? null : new Uri(monitoringUrl);
+            var defaultRoute = Environment.GetEnvironmentVariable("DEFAULT_ROUTE") ?? "/dashboard";
+            var showPendingRetryValue = Environment.GetEnvironmentVariable("SHOW_PENDING_RETRY");
+            bool.TryParse(showPendingRetryValue, out var showPendingRetry);
+            return new ServicePulseSettings
+            {
+                ServiceControlUrl = serviceControlUri.ToString(),
+                MonitoringUrl = monitoringUri?.ToString(),
+                DefaultRoute = defaultRoute,
+                ShowPendingRetry = showPendingRetry,
+                IsIntegrated = false
+            };
+        }
+        static string? ParseLegacyMonitoringValue(string? value)
+        {
+            if (value is null)
+            {
+                return null;
+            }
+            var cleanedValue = value.Replace('\'', '"');
+            var json = $$"""{"Addresses":{{cleanedValue}}}""";
+            MonitoringUrls? result;
+            try
+            {
+                result = JsonSerializer.Deserialize<MonitoringUrls>(json);
+            }
+            catch (JsonException)
+            {
+                return null;
+            }
+            var addresses = result?.Addresses;
+            if (addresses is not null && addresses.Length > 0)
+            {
+                return addresses[0];
+            }
+            return null;
+        }
+        class MonitoringUrls
+        {
+            public string[] Addresses { get; set; } = [];
+        }
+    }

src/ServicePulse.Host.Tests/Owin/StaticMiddlewareTests.cs

-Original file line number
+Diff line change
@@ Expand Up @@
                     }
                 };
                 await middleware.Invoke(context);
-                const long sizeOfFileOnDisk = 215; // this is the /app/js/app.constants.js file
+                const long sizeOfFileOnDisk = 239; // this is the /app/js/app.constants.js file
                 Assert.That(context.Response.ContentLength, Is.EqualTo(sizeOfFileOnDisk));
                 Assert.That(context.Response.ContentType, Is.EqualTo("application/javascript"));
             }
@@ Expand Down @@

src/ServicePulse.Host/Hosting/HostArguments.cs

-Original file line number
+Diff line change
@@ Expand Up / @@ -2,9 +2,6 @@ namespace ServicePulse.Host.Hosting @@
     {
         using System;
         using System.Collections.Generic;
-    #if DEBUG
-        using System.Diagnostics;
-    #endif
         using System.IO;
         using System.Linq;
         using System.Reflection;
@@ Expand Down Expand Up / @@ -355,8 +352,7 @@ void ValidateArgs() @@
                         goto case ExecutionMode.Run;
                     case ExecutionMode.Run:
-                        Uri spUri;
-                        if (!Uri.TryCreate(Url, UriKind.Absolute, out spUri) || (!validProtocols.Contains(spUri.Scheme, StringComparer.OrdinalIgnoreCase)))
+                        if (!Uri.TryCreate(Url, UriKind.Absolute, out Uri spUri) || (!validProtocols.Contains(spUri.Scheme, StringComparer.OrdinalIgnoreCase)))
                         {
                             throw new Exception("The value specified for 'url' is not a valid URL");
                         }
@@ Expand Down @@

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Enable Integrated Mode #2786

Diff view

Diff view

There are no files selected for viewing

Uh oh!

Uh oh!

Enable Integrated Mode #2786

Are you sure you want to change the base?

Enable Integrated Mode #2786

Uh oh!

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!

Uh oh!