Use razor page to return error pages. #20687

maliming · 2024-09-01T02:23:37Z

You can use abp generate-razor-page to generate a page class and then use it in the ASPNET Core pipeline to return an HTML page.

Razor page:

abp/framework/src/Volo.Abp.AspNetCore.Mvc/Volo/Abp/AspNetCore/Mvc/Libs/AbpMvcLibsErrorPage.cshtml

Lines 1 to 22 in 739fa4c

    
           @using Volo.Abp.AspNetCore.RazorViews 
        
           @inherits AbpCompilationRazorPageBase 
        
           @{ 
        
               Response.ContentType = "text/html; charset=utf-8"; 
        
               Response.StatusCode = 500; 
        
           } 
        
           <html> 
        
               <head> 
        
                   <meta charset="utf-8" /> 
        
                   <title>Error - The Libs folder is missing!</title> 
        
               </head> 
        
               <body> 
        
                   <h1> &#9888;&#65039; The Libs folder under the <code style="background-color: #e7e7e7;">wwwroot/libs</code> directory is empty!</h1> 
        
                   <p>The Libs folder contains mandatory NPM Packages for running the project.</p> 
        
                   <p>Make sure you run the <code style="background-color: #e7e7e7;">abp install-libs</code> CLI tool command.</p> 
        
                   <p>For more information, check out the <a href="https://abp.io/docs/latest/CLI#install-libs">ABP CLI documentation</a></p> 
        
               </body> 
        
           </html>

Generate code by abp generate-razor-page:

abp/framework/src/Volo.Abp.AspNetCore.Mvc/Volo/Abp/AspNetCore/Mvc/Libs/AbpMvcLibsErrorPage.Designer.cs

Lines 15 to 49 in 739fa4c

    
               internal class AbpMvcLibsErrorPage : AbpCompilationRazorPageBase 
        
               { 
        
                   #pragma warning disable 1998 
        
                   public async override global::System.Threading.Tasks.Task ExecuteAsync() 
        
                   { 
        
           #nullable restore 
        
           #line 3 "AbpMvcLibsErrorPage.cshtml" 
        
               Response.ContentType = "text/html; charset=utf-8"; 
        
               Response.StatusCode = 500; 
        
           #line default 
        
           #line hidden 
        
           #nullable disable 
        
                       WriteLiteral(@" 
        
           <html> 
        
               <head> 
        
                   <meta charset=""utf-8"" /> 
        
                   <title>Error - The Libs folder is missing!</title> 
        
               </head> 
        
               <body> 
        
                   <h1> &#9888;&#65039; The Libs folder under the <code style=""background-color: #e7e7e7;"">wwwroot/libs</code> directory is empty!</h1> 
        
                   <p>The Libs folder contains mandatory NPM Packages for running the project.</p> 
        
                   <p>Make sure you run the <code style=""background-color: #e7e7e7;"">abp install-libs</code> CLI tool command.</p> 
        
                   <p>For more information, check out the <a href=""https://abp.io/docs/latest/CLI#install-libs"">ABP CLI documentation</a></p> 
        
               </body> 
        
           </html> 
        
           "); 
        
                   } 
        
                   #pragma warning restore 1998 
        
               } 
        
           }

Usage:

abp/framework/src/Volo.Abp.AspNetCore.Mvc/Volo/Abp/AspNetCore/Mvc/Libs/AbpMvcLibsService.cs

Lines 39 to 41 in 739fa4c

    
                               var errorPage = new AbpMvcLibsErrorPage(); 
        
                               await errorPage.ExecuteAsync(httpContext); 
        
                               return;

Use razor paeg to return error pages.

739fa4c

maliming added this to the 9.0-preview milestone Sep 1, 2024

maliming added the abp-cli label Sep 1, 2024

maliming changed the title ~~Use razor paeg to return error pages.~~ Use razor page to return error pages. Sep 1, 2024

maliming requested a review from hikalkan September 2, 2024 02:55

hikalkan approved these changes Oct 8, 2024

View reviewed changes

hikalkan merged commit f3fd4ce into dev Oct 8, 2024
3 checks passed

hikalkan deleted the AbpCompilationRazorPageBase branch October 8, 2024 07:07

maliming mentioned this pull request Oct 8, 2024

Introduce abp generate-razor-page command. #20998

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Use razor page to return error pages. #20687

Use razor page to return error pages. #20687

maliming commented Sep 1, 2024 •

edited

Loading

	@using Volo.Abp.AspNetCore.RazorViews
	@inherits AbpCompilationRazorPageBase
	@{
	Response.ContentType = "text/html; charset=utf-8";
	Response.StatusCode = 500;
	}

	<html>
	<head>
	<meta charset="utf-8" />
	<title>Error - The Libs folder is missing!</title>
	</head>
	<body>
	<h1> ⚠️ The Libs folder under the <code style="background-color: #e7e7e7;">wwwroot/libs</code> directory is empty!</h1>

	<p>The Libs folder contains mandatory NPM Packages for running the project.</p>

	<p>Make sure you run the <code style="background-color: #e7e7e7;">abp install-libs</code> CLI tool command.</p>

	<p>For more information, check out the <a href="https://abp.io/docs/latest/CLI#install-libs">ABP CLI documentation</a></p>
	</body>
	</html>

	internal class AbpMvcLibsErrorPage : AbpCompilationRazorPageBase
	{
	#pragma warning disable 1998
	public async override global::System.Threading.Tasks.Task ExecuteAsync()
	{
	#nullable restore
	#line 3 "AbpMvcLibsErrorPage.cshtml"

	Response.ContentType = "text/html; charset=utf-8";
	Response.StatusCode = 500;

	#line default
	#line hidden
	#nullable disable
	WriteLiteral(@"
	<html>
	<head>
	<meta charset=""utf-8"" />
	<title>Error - The Libs folder is missing!</title>
	</head>
	<body>
	<h1> ⚠️ The Libs folder under the <code style=""background-color: #e7e7e7;"">wwwroot/libs</code> directory is empty!</h1>

	<p>The Libs folder contains mandatory NPM Packages for running the project.</p>

	<p>Make sure you run the <code style=""background-color: #e7e7e7;"">abp install-libs</code> CLI tool command.</p>

	<p>For more information, check out the <a href=""https://abp.io/docs/latest/CLI#install-libs"">ABP CLI documentation</a></p>
	</body>
	</html>
	");
	}
	#pragma warning restore 1998
	}
	}

	var errorPage = new AbpMvcLibsErrorPage();
	await errorPage.ExecuteAsync(httpContext);
	return;

Use razor page to return error pages. #20687

Use razor page to return error pages. #20687

Conversation

maliming commented Sep 1, 2024 • edited Loading

maliming commented Sep 1, 2024 •

edited

Loading