Fix search engines issue with StreamRendering enabled (#9510) #9511
Conversation
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the WalkthroughThe pull request focuses on enhancing the stream rendering functionality in the Boilerplate project template, specifically addressing crawler compatibility. Changes span multiple files including Changes
Assessment against linked issues
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (3)
src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Web/Components/App.razor.cs (1)
29-44: Reduce code duplication in container componentsThe
StreamRenderingEnabledContainerandStreamRenderingDisabledContainershare identical implementation with only theStreamRenderingattribute being different.Consider consolidating into a single component:
/// <summary> /// Streaming pre-rendering enhances user experience (UX) and overall application performance. /// However, it prevents search engines from accessing your pre-rendered dynamic content. /// To address this, the conditional logic in App.razor, leveraging <see cref="HttpRequestExtensions.IsCrawlerClient(HttpRequest)"/>, /// disables streaming specifically for search engine crawlers, while maintaining the improved UX and performance for regular users. /// </summary> -[StreamRendering(enabled: true)] -public class StreamRenderingEnabledContainer : ComponentBase +public class StreamRenderingContainer : ComponentBase { + [Parameter] public bool Enabled { get; set; } [Parameter] public RenderFragment? ChildContent { get; set; } + protected override void OnInitialized() + { + base.OnInitialized(); + StreamRenderingAttribute.SetEnabled(Enabled); + } + protected override void BuildRenderTree(RenderTreeBuilder builder) { builder.AddContent(0, ChildContent); } } - -/// <summary> -/// <inheritdoc cref="StreamRenderingEnabledContainer"/> -/// </summary> -[StreamRendering(enabled: false)] -public class StreamRenderingDisabledContainer : ComponentBase -{ - [Parameter] public RenderFragment? ChildContent { get; set; } - - protected override void BuildRenderTree(RenderTreeBuilder builder) - { - builder.AddContent(0, ChildContent); - } -}Then update the usage in App.razor:
-<StreamRenderingDisabledContainer> +<StreamRenderingContainer Enabled="false"> <Routes @rendermode=renderMode /> -</StreamRenderingDisabledContainer> +</StreamRenderingContainer>Also applies to: 46-58
src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Web/Components/App.razor (2)
68-80: Consider extracting the crawler-based rendering logicThe conditional rendering logic could be encapsulated in a separate component for better maintainability.
Consider creating a
CrawlerAwareRenderercomponent:+@* CrawlerAwareRenderer.razor *@ +@code { + [Parameter] public RenderFragment? ChildContent { get; set; } + [Parameter] public RenderMode? RenderMode { get; set; } + + [CascadingParameter] HttpContext HttpContext { get; set; } = default!; +} + +@if (HttpContext.Request.IsCrawlerClient()) +{ + <StreamRenderingContainer Enabled="false"> + @ChildContent + </StreamRenderingContainer> +} +else +{ + <StreamRenderingContainer Enabled="true"> + @ChildContent + </StreamRenderingContainer> +}Then simplify the usage in App.razor:
-@if (HttpContext.Request.IsCrawlerClient()) -{ - <StreamRenderingDisabledContainer> - <Routes @rendermode=renderMode /> - </StreamRenderingDisabledContainer> -} -else -{ - <StreamRenderingEnabledContainer> - <Routes @rendermode=renderMode /> - </StreamRenderingEnabledContainer> -} +<CrawlerAwareRenderer> + <Routes @rendermode=renderMode /> +</CrawlerAwareRenderer>
82-84: Elevate version matching comment visibilityThe comment about version matching between
blazor.web.jsandservice-worker.published.jsis crucial for PWA functionality.Consider moving this important note to a more visible location, such as:
- Add it to the XML documentation of the App component
- Create a dedicated README section about PWA setup
- Add a warning log during app startup if versions mismatch
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Web/wwwroot/service-worker.published.js(0 hunks)src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Web/Components/App.razor(1 hunks)src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Web/Components/App.razor.cs(2 hunks)src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Web/Extensions/HttpRequestExtensions.cs(2 hunks)
💤 Files with no reviewable changes (1)
- src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Web/wwwroot/service-worker.published.js
🔇 Additional comments (1)
src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Web/Extensions/HttpRequestExtensions.cs (1)
32-39:
Add null check for Headers collection
The current implementation might throw NullReferenceException if Headers collection is null.
Add null check:
private static string GetLoweredUserAgent(HttpRequest request)
{
+ if (request.Headers == null) return string.Empty;
var userAgent = request.Headers[HeaderNames.UserAgent].ToString();
if (string.IsNullOrEmpty(userAgent)) return string.Empty;
return userAgent.ToLowerInvariant();
}Likely invalid or redundant comment.
...rplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Web/Extensions/HttpRequestExtensions.cs
Outdated
Show resolved
Hide resolved
msynk
changed the title
ysmoradi
deleted the
9510-boilerplate-project-templates-stream-rendering-doesnt-work-with-crawlers-like-google-etc
branch
closes #9510
Summary by CodeRabbit
New Features
Bug Fixes
Chores