Sitecore MVC Exception on Content Delivery servers

PublishedFebruary 1, 2017

•2 min read•View as Markdown

Sitecore MVC Exception on Content Delivery servers

Søren Kruse

Comments

Join the discussion

No comments yet. Be the first to comment.

More from this blog

Dynamic caching policy with Polly

Polly is great library for easily configuring different kinds of policies around code execution, be it retry, circuit breaker, caching or lots of other things. It's probably most often used around HTTP requests. If you haven't heard about it you defi...

Jan 15, 20213 min read

Unit Testing - Part 2: Naming, structure and readability

This is part 2 of my series on unit testing in .NET (C#) and will be about my conventions regarding naming unit tests, how to structure them and which parts to test. And lastly I will help you increase readability of assertions and potential error me...

Jan 9, 20217 min read

Unit Testing - Part 2: Naming, structure and readability

Unit Testing - Part 1: Getting started with unit tests in .NET

I feel like unit testing is very important and very beneficial in a lot of ways. It helps with not breaking existing functionality and thereby also making you more confident in changing code without fear of breaking important stuff. Often it also mak...

Dec 28, 20207 min read

Unit Testing - Part 1: Getting started with unit tests in .NET

Getting NSwag to work behind reverse proxy

I've been working with Swagger through NSwag a lot recently and also needed to get it to work when hidden behind a reverse proxy - i.e. another service forwarding a request to the service exposing the Swagger UI. Some of the issues I've had along the...

Dec 18, 20202 min read

Getting NSwag to work behind reverse proxy

NSubstitute - make async method (Task) throw an exception

The other day I was writing a unit test to verify what was supposed to happen when a Task would throw an exception when awaited. It wasn't as straight forward as I first assumed, but I quickly found this Stack Overflow post that helped me: https://st...

Dec 12, 20203 min read

NSubstitute - make async method (Task) throw an exception

Søren Kruse | .NET, C# and Azure

51 posts

The issue

This can happen when you have deleted/disabled the Sitecore.Speak.Mvc.config, which Sitecore recommends you do on Content Deliver servers, and use the default MVC helper methods @Html.Action and @Html.RenderAction in your renderings.

For some reason those methods requires a route containing the pattern {controller}/{action} to work. These are part of the default route in a standard MVC project, but usually not in a Sitecore project.

But then why does it work until we delete/disable Sitecore.Speak.Mvc.config?

Because that config files adds a processor to the initialize pipeline.

<initialize> <processor type="Sitecore.Mvc.Pipelines.Initialize.InitializeCommandRoute, Sitecore.Speak.Client" patch:before="processor[@type='Sitecore.Mvc.Pipelines.Loader.InitializeRoutes, Sitecore.Mvc']"/> </initialize>

This processor registers the following routes:

protected virtual void RegisterRoutes(RouteCollection routes, PipelineArgs args) { string commandRoutePrefix = SpeakSettings.Mvc.CommandRoutePrefix; routes.MapRoute("Sitecore.Speak.Commands", commandRoutePrefix + "{controller}/{action}"); routes.MapRoute("Sitecore.Speak", "sitecore/shell/api/sitecore/{controller}/{action}"); }

So when you delete/disable this config file, those routes do no longer get registered.

How to fix it

It's pretty simple to fix. You just have to add a route containing the {controller}/{action} pattern in your own processor in the initialize pipeline.

// Something like this RouteTable.Routes.MapRoute( "Bogus-Required-Route", "bogus-required-route/{controller}/{action}", );

I'm not sure if the route would overwrite Sitecore's route handling, so to be sure I would use a distinct path for the route that you are sure to never match a page URL for your site.

If you want to prevent the action method from being invoked as a result of a user request you can add the [ChildActionOnly] attribute to it.

Command Palette

Comments

More from this blog

The issue

How to fix it

The Config Enable-Disable spreadsheet