From c1cfe2ed5803b7a94829e9202b2b55791ded0dfe Mon Sep 17 00:00:00 2001 From: jacalvar Date: Mon, 17 Jun 2024 11:33:37 +0200 Subject: [PATCH 1/2] Rename ComponentPlatform to RendererInfo --- .../Components/src/ComponentBase.cs | 4 +-- .../Components/src/PublicAPI.Unshipped.txt | 14 ++++----- src/Components/Components/src/RenderHandle.cs | 4 +-- .../src/RenderTree/ComponentPlatform.cs | 31 ------------------- .../Components/src/RenderTree/Renderer.cs | 4 +-- .../Components/src/RenderTree/RendererInfo.cs | 23 ++++++++++++++ .../Server/src/Circuits/RemoteRenderer.cs | 4 +-- .../src/HtmlRendering/StaticHtmlRenderer.cs | 4 +-- .../Web/src/PublicAPI.Unshipped.txt | 2 +- .../src/Rendering/WebAssemblyRenderer.cs | 4 +-- .../WebView/src/Services/WebViewRenderer.cs | 4 +-- .../CascadingAuthenticationStateReader.razor | 4 +-- .../ComponentPlatformDetails.razor | 2 +- .../ResourceCollectionSample.razor | 4 +-- 14 files changed, 50 insertions(+), 58 deletions(-) delete mode 100644 src/Components/Components/src/RenderTree/ComponentPlatform.cs create mode 100644 src/Components/Components/src/RenderTree/RendererInfo.cs diff --git a/src/Components/Components/src/ComponentBase.cs b/src/Components/Components/src/ComponentBase.cs index d9c0f346b0ca..5de04ae8d70b 100644 --- a/src/Components/Components/src/ComponentBase.cs +++ b/src/Components/Components/src/ComponentBase.cs @@ -43,9 +43,9 @@ public ComponentBase() } /// - /// Gets the the component is running on. + /// Gets the the component is running on. /// - protected ComponentPlatform Platform => _renderHandle.Platform; + protected RendererInfo RendererInfo => _renderHandle.RendererInfo; /// /// Gets the for the application. diff --git a/src/Components/Components/src/PublicAPI.Unshipped.txt b/src/Components/Components/src/PublicAPI.Unshipped.txt index 77e24cf1f6e5..e8c43eb034cf 100644 --- a/src/Components/Components/src/PublicAPI.Unshipped.txt +++ b/src/Components/Components/src/PublicAPI.Unshipped.txt @@ -1,15 +1,15 @@ #nullable enable Microsoft.AspNetCore.Components.ComponentBase.Assets.get -> Microsoft.AspNetCore.Components.ResourceAssetCollection! Microsoft.AspNetCore.Components.ComponentBase.AssignedRenderMode.get -> Microsoft.AspNetCore.Components.IComponentRenderMode? -Microsoft.AspNetCore.Components.ComponentBase.Platform.get -> Microsoft.AspNetCore.Components.ComponentPlatform! -Microsoft.AspNetCore.Components.ComponentPlatform -Microsoft.AspNetCore.Components.ComponentPlatform.ComponentPlatform(string! platformName, bool isInteractive) -> void -Microsoft.AspNetCore.Components.ComponentPlatform.IsInteractive.get -> bool -Microsoft.AspNetCore.Components.ComponentPlatform.Name.get -> string! +Microsoft.AspNetCore.Components.ComponentBase.RendererInfo.get -> Microsoft.AspNetCore.Components.RendererInfo! Microsoft.AspNetCore.Components.ExcludeFromInteractiveRoutingAttribute Microsoft.AspNetCore.Components.ExcludeFromInteractiveRoutingAttribute.ExcludeFromInteractiveRoutingAttribute() -> void +Microsoft.AspNetCore.Components.RendererInfo +Microsoft.AspNetCore.Components.RendererInfo.IsInteractive.get -> bool +Microsoft.AspNetCore.Components.RendererInfo.Name.get -> string! +Microsoft.AspNetCore.Components.RendererInfo.RendererInfo(string! rendererName, bool isInteractive) -> void Microsoft.AspNetCore.Components.RenderHandle.Assets.get -> Microsoft.AspNetCore.Components.ResourceAssetCollection! -Microsoft.AspNetCore.Components.RenderHandle.Platform.get -> Microsoft.AspNetCore.Components.ComponentPlatform! +Microsoft.AspNetCore.Components.RenderHandle.RendererInfo.get -> Microsoft.AspNetCore.Components.RendererInfo! Microsoft.AspNetCore.Components.RenderHandle.RenderMode.get -> Microsoft.AspNetCore.Components.IComponentRenderMode? Microsoft.AspNetCore.Components.ResourceAsset Microsoft.AspNetCore.Components.ResourceAsset.Properties.get -> System.Collections.Generic.IReadOnlyList? @@ -25,4 +25,4 @@ Microsoft.AspNetCore.Components.ResourceAssetProperty.ResourceAssetProperty(stri Microsoft.AspNetCore.Components.ResourceAssetProperty.Value.get -> string! static readonly Microsoft.AspNetCore.Components.ResourceAssetCollection.Empty -> Microsoft.AspNetCore.Components.ResourceAssetCollection! virtual Microsoft.AspNetCore.Components.RenderTree.Renderer.Assets.get -> Microsoft.AspNetCore.Components.ResourceAssetCollection! -virtual Microsoft.AspNetCore.Components.RenderTree.Renderer.ComponentPlatform.get -> Microsoft.AspNetCore.Components.ComponentPlatform! +virtual Microsoft.AspNetCore.Components.RenderTree.Renderer.RendererInfo.get -> Microsoft.AspNetCore.Components.RendererInfo! diff --git a/src/Components/Components/src/RenderHandle.cs b/src/Components/Components/src/RenderHandle.cs index 4af99006811a..6ac2b7b3cdec 100644 --- a/src/Components/Components/src/RenderHandle.cs +++ b/src/Components/Components/src/RenderHandle.cs @@ -52,9 +52,9 @@ public Dispatcher Dispatcher ?? throw new InvalidOperationException("No renderer has been initialized."); /// - /// Gets the the component is running on. + /// Gets the the component is running on. /// - public ComponentPlatform Platform => _renderer?.ComponentPlatform ?? throw new InvalidOperationException("No renderer has been initialized."); + public RendererInfo RendererInfo => _renderer?.RendererInfo ?? throw new InvalidOperationException("No renderer has been initialized."); /// /// Retrieves the assigned to the component. diff --git a/src/Components/Components/src/RenderTree/ComponentPlatform.cs b/src/Components/Components/src/RenderTree/ComponentPlatform.cs deleted file mode 100644 index 40a15d4f6081..000000000000 --- a/src/Components/Components/src/RenderTree/ComponentPlatform.cs +++ /dev/null @@ -1,31 +0,0 @@ -// Licensed to the .NET Foundation under one or more agreements. -// The .NET Foundation licenses this file to you under the MIT license. - -namespace Microsoft.AspNetCore.Components; - -/// -/// Provides information about the platform that the component is running on. -/// -public sealed class ComponentPlatform -{ - /// - /// Constructs a new instance of . - /// - /// The name of the platform. - /// A flag to indicate if the platform is interactive. - public ComponentPlatform(string platformName, bool isInteractive) - { - Name = platformName; - IsInteractive = isInteractive; - } - - /// - /// Gets the name of the platform. - /// - public string Name { get; } - - /// - /// Gets a flag to indicate if the platform is interactive. - /// - public bool IsInteractive { get; } -} diff --git a/src/Components/Components/src/RenderTree/Renderer.cs b/src/Components/Components/src/RenderTree/Renderer.cs index 20be6ba7f07f..e0fcfd834340 100644 --- a/src/Components/Components/src/RenderTree/Renderer.cs +++ b/src/Components/Components/src/RenderTree/Renderer.cs @@ -154,9 +154,9 @@ protected internal ComponentState GetComponentState(IComponent component) => _componentStateByComponent.GetValueOrDefault(component); /// - /// Gets the associated with this . + /// Gets the associated with this . /// - protected internal virtual ComponentPlatform ComponentPlatform { get; } + protected internal virtual RendererInfo RendererInfo { get; } /// /// Gets the associated with this . diff --git a/src/Components/Components/src/RenderTree/RendererInfo.cs b/src/Components/Components/src/RenderTree/RendererInfo.cs new file mode 100644 index 000000000000..fbeba6a71c6f --- /dev/null +++ b/src/Components/Components/src/RenderTree/RendererInfo.cs @@ -0,0 +1,23 @@ +// Licensed to the .NET Foundation under one or more agreements. +// The .NET Foundation licenses this file to you under the MIT license. + +namespace Microsoft.AspNetCore.Components; + +/// +/// Provides information about the platform that the component is running on. +/// +/// The name of the platform. +/// A flag to indicate if the platform is interactive. +public sealed class RendererInfo(string rendererName, bool isInteractive) +{ + + /// + /// Gets the name of the platform. + /// + public string Name { get; } = rendererName; + + /// + /// Gets a flag to indicate if the platform is interactive. + /// + public bool IsInteractive { get; } = isInteractive; +} diff --git a/src/Components/Server/src/Circuits/RemoteRenderer.cs b/src/Components/Server/src/Circuits/RemoteRenderer.cs index c589d4eef88f..31b29206212b 100644 --- a/src/Components/Server/src/Circuits/RemoteRenderer.cs +++ b/src/Components/Server/src/Circuits/RemoteRenderer.cs @@ -18,7 +18,7 @@ internal partial class RemoteRenderer : WebRenderer #pragma warning restore CA1852 // Seal internal types { private static readonly Task CanceledTask = Task.FromCanceled(new CancellationToken(canceled: true)); - private static readonly ComponentPlatform _componentPlatform = new("Server", isInteractive: true); + private static readonly RendererInfo _componentPlatform = new("Server", isInteractive: true); private readonly CircuitClientProxy _client; private readonly CircuitOptions _options; @@ -62,7 +62,7 @@ public RemoteRenderer( protected override ResourceAssetCollection Assets => _resourceCollection ?? base.Assets; - protected override ComponentPlatform ComponentPlatform => _componentPlatform; + protected override RendererInfo RendererInfo => _componentPlatform; protected override IComponentRenderMode? GetComponentRenderMode(IComponent component) => RenderMode.InteractiveServer; diff --git a/src/Components/Web/src/HtmlRendering/StaticHtmlRenderer.cs b/src/Components/Web/src/HtmlRendering/StaticHtmlRenderer.cs index 1a1c3425c840..104dcb930d66 100644 --- a/src/Components/Web/src/HtmlRendering/StaticHtmlRenderer.cs +++ b/src/Components/Web/src/HtmlRendering/StaticHtmlRenderer.cs @@ -19,7 +19,7 @@ namespace Microsoft.AspNetCore.Components.HtmlRendering.Infrastructure; /// public partial class StaticHtmlRenderer : Renderer { - private static readonly ComponentPlatform _componentPlatform = new ComponentPlatform("Static", isInteractive: false); + private static readonly RendererInfo _componentPlatform = new RendererInfo("Static", isInteractive: false); private static readonly Task CanceledRenderTask = Task.FromCanceled(new CancellationToken(canceled: true)); private readonly NavigationManager? _navigationManager; @@ -41,7 +41,7 @@ public StaticHtmlRenderer(IServiceProvider serviceProvider, ILoggerFactory logge public override Dispatcher Dispatcher { get; } = Dispatcher.CreateDefault(); /// - protected internal override ComponentPlatform ComponentPlatform => _componentPlatform; + protected internal override RendererInfo RendererInfo => _componentPlatform; /// /// Adds a root component of the specified type and begins rendering it. diff --git a/src/Components/Web/src/PublicAPI.Unshipped.txt b/src/Components/Web/src/PublicAPI.Unshipped.txt index d3c627905559..42e7a30fad5c 100644 --- a/src/Components/Web/src/PublicAPI.Unshipped.txt +++ b/src/Components/Web/src/PublicAPI.Unshipped.txt @@ -3,4 +3,4 @@ Microsoft.AspNetCore.Components.Web.Internal.IInternalWebJSInProcessRuntime Microsoft.AspNetCore.Components.Web.Internal.IInternalWebJSInProcessRuntime.InvokeJS(string! identifier, string? argsJson, Microsoft.JSInterop.JSCallResultType resultType, long targetInstanceId) -> string! Microsoft.AspNetCore.Components.Web.KeyboardEventArgs.IsComposing.get -> bool Microsoft.AspNetCore.Components.Web.KeyboardEventArgs.IsComposing.set -> void -override Microsoft.AspNetCore.Components.HtmlRendering.Infrastructure.StaticHtmlRenderer.ComponentPlatform.get -> Microsoft.AspNetCore.Components.ComponentPlatform! +override Microsoft.AspNetCore.Components.HtmlRendering.Infrastructure.StaticHtmlRenderer.RendererInfo.get -> Microsoft.AspNetCore.Components.RendererInfo! diff --git a/src/Components/WebAssembly/WebAssembly/src/Rendering/WebAssemblyRenderer.cs b/src/Components/WebAssembly/WebAssembly/src/Rendering/WebAssemblyRenderer.cs index cc9426e2607c..d71cd1d63fcb 100644 --- a/src/Components/WebAssembly/WebAssembly/src/Rendering/WebAssemblyRenderer.cs +++ b/src/Components/WebAssembly/WebAssembly/src/Rendering/WebAssemblyRenderer.cs @@ -25,7 +25,7 @@ internal sealed partial class WebAssemblyRenderer : WebRenderer private readonly Dispatcher _dispatcher; private readonly ResourceAssetCollection _resourceCollection; private readonly IInternalJSImportMethods _jsMethods; - private static readonly ComponentPlatform _componentPlatform = new("WebAssembly", isInteractive: true); + private static readonly RendererInfo _componentPlatform = new("WebAssembly", isInteractive: true); public WebAssemblyRenderer(IServiceProvider serviceProvider, ResourceAssetCollection resourceCollection, ILoggerFactory loggerFactory, JSComponentInterop jsComponentInterop) : base(serviceProvider, loggerFactory, DefaultWebAssemblyJSRuntime.Instance.ReadJsonSerializerOptions(), jsComponentInterop) @@ -85,7 +85,7 @@ public void NotifyEndUpdateRootComponents(long batchId) protected override ResourceAssetCollection Assets => _resourceCollection; - protected override ComponentPlatform ComponentPlatform => _componentPlatform; + protected override RendererInfo RendererInfo => _componentPlatform; public override Dispatcher Dispatcher => _dispatcher; diff --git a/src/Components/WebView/WebView/src/Services/WebViewRenderer.cs b/src/Components/WebView/WebView/src/Services/WebViewRenderer.cs index 538750239477..8e4ef855964e 100644 --- a/src/Components/WebView/WebView/src/Services/WebViewRenderer.cs +++ b/src/Components/WebView/WebView/src/Services/WebViewRenderer.cs @@ -9,7 +9,7 @@ namespace Microsoft.AspNetCore.Components.WebView.Services; internal sealed class WebViewRenderer : WebRenderer { - private static readonly ComponentPlatform _componentPlatform = new("WebView", isInteractive: true); + private static readonly RendererInfo _componentPlatform = new("WebView", isInteractive: true); private readonly Queue _unacknowledgedRenderBatches = new(); private readonly Dispatcher _dispatcher; private readonly IpcSender _ipcSender; @@ -32,7 +32,7 @@ public WebViewRenderer( public override Dispatcher Dispatcher => _dispatcher; - protected override ComponentPlatform ComponentPlatform => _componentPlatform; + protected override RendererInfo RendererInfo => _componentPlatform; protected override int GetWebRendererId() => (int)WebRendererId.WebView; diff --git a/src/Components/test/testassets/TestContentPackage/CascadingAuthenticationStateReader.razor b/src/Components/test/testassets/TestContentPackage/CascadingAuthenticationStateReader.razor index 9f0e4830afea..77a7f86aa9e2 100644 --- a/src/Components/test/testassets/TestContentPackage/CascadingAuthenticationStateReader.razor +++ b/src/Components/test/testassets/TestContentPackage/CascadingAuthenticationStateReader.razor @@ -58,13 +58,13 @@ else

Interactive: - @Platform.IsInteractive + @RendererInfo.IsInteractive

Platform: - @Platform.Name + @RendererInfo.Name


diff --git a/src/Components/test/testassets/TestContentPackage/ComponentPlatformDetails.razor b/src/Components/test/testassets/TestContentPackage/ComponentPlatformDetails.razor index 76763edadb6b..2debc69acaec 100644 --- a/src/Components/test/testassets/TestContentPackage/ComponentPlatformDetails.razor +++ b/src/Components/test/testassets/TestContentPackage/ComponentPlatformDetails.razor @@ -26,7 +26,7 @@ _renderMode = "static"; } - if (Platform.IsInteractive) + if (RendererInfo.IsInteractive) { _isInteractive = true; } diff --git a/src/Components/test/testassets/TestContentPackage/ResourceCollectionSample.razor b/src/Components/test/testassets/TestContentPackage/ResourceCollectionSample.razor index 703d78fc3f9a..d4ef2c3d829e 100644 --- a/src/Components/test/testassets/TestContentPackage/ResourceCollectionSample.razor +++ b/src/Components/test/testassets/TestContentPackage/ResourceCollectionSample.razor @@ -2,11 +2,11 @@ @using Microsoft.AspNetCore.Components.Web; @inject IJSRuntime JSRuntime -

@Platform.Name

+

@RendererInfo.Name

@Assets["BasicTestApp.styles.css"]

-@if (!Platform.IsInteractive) +@if (!RendererInfo.IsInteractive) { }else From 04a07f7be96c5efe696a86b1f9acb68720859f6e Mon Sep 17 00:00:00 2001 From: Javier Calvarro Nelson Date: Mon, 17 Jun 2024 12:19:45 +0200 Subject: [PATCH 2/2] Update src/Components/Components/src/RenderTree/RendererInfo.cs Co-authored-by: Steve Sanderson --- src/Components/Components/src/RenderTree/RendererInfo.cs | 1 - 1 file changed, 1 deletion(-) diff --git a/src/Components/Components/src/RenderTree/RendererInfo.cs b/src/Components/Components/src/RenderTree/RendererInfo.cs index fbeba6a71c6f..9c401b5ce006 100644 --- a/src/Components/Components/src/RenderTree/RendererInfo.cs +++ b/src/Components/Components/src/RenderTree/RendererInfo.cs @@ -10,7 +10,6 @@ namespace Microsoft.AspNetCore.Components; /// A flag to indicate if the platform is interactive. public sealed class RendererInfo(string rendererName, bool isInteractive) { - /// /// Gets the name of the platform. ///