Delivery API - Getting media by path returns 500 error

[lauraneto]

Which Umbraco version are you using?

17.0.0-rc2

Bug summary

Found this while working on another feature. I haven't checked which versions are affected by this.
Attempting to call the /umbraco/delivery/api/v2/media/item/{path} with a valid path returns a 500 error with the following exception:

System.InvalidOperationException: Wasn't able to get an UmbracoContext
   at Umbraco.Extensions.UmbracoContextAccessorExtensions.GetRequiredUmbracoContext(IUmbracoContextAccessor umbracoContextAccessor)
   at Umbraco.Cms.Core.Routing.UrlProvider.GetMediaUrl(IPublishedContent content, UrlMode mode, String culture, String propertyAlias, Uri current)
   at Umbraco.Cms.Core.DeliveryApi.ApiMediaUrlProvider.GetUrl(IPublishedContent media)
   at Umbraco.Cms.Core.DeliveryApi.ApiMediaBuilder.Build(IPublishedContent media)
   at Umbraco.Cms.Infrastructure.DeliveryApi.ApiMediaWithCropsBuilderBase`1.Build(MediaWithCrops media)
   at Umbraco.Cms.Infrastructure.DeliveryApi.ApiMediaWithCropsBuilderBase`1.Build(IPublishedContent media)
...

Specifics

No response

Steps to reproduce

1. Create a new project.
2. Enable the Delivery API and Media, with public access enabled.

  "Umbraco": {
    "CMS": {
      ...
      "DeliveryApi": {
        "Enabled": true,
        "PublicAccess": true,
        "Media": {
          "Enabled": true,
          "PublicAccess": true
        }
      }

3. Upload an image to the media section.
4. Try to retrieve the image using the /umbraco/delivery/api/v2/media/item/{path} endpoint.

Expected result / actual result

No response

[AndyButland]

Seems that this only happens with media paths that have a file extension - so e.g. /umbraco/delivery/api/v2/media/item/pictures/test.jpg but https://localhost:44339/umbraco/delivery/api/v2/media/item/pictures/test is OK.

I think the fix would be that, if you need this type of request to work, you implement what's outlined here: #20774 (comment)

I.e. something like:

builder.Services.Configure<UmbracoRequestOptions>(options =>
{
    options.HandleAsServerSideRequest = httpRequest => 
        httpRequest.Path.StartsWithSegments("/umbraco/delivery/api/v2/media/item");
});

That seems to solve it. What do you think @lauraneto - does it seem a reasonable solution to you?

[lauraneto]

@AndyButland Not entirely sure on what you meant.
If you are suggesting that end users should apply that solution in their code, then I don't think that is reasonable, as this is an endpoint we own, and the affected file names are generated by default when using drag and drop to create an image.

If you are suggesting that we add that solution to the core, then I'm not sure that is the proper fix either, as the code shouldn't be considering this a client side request in the first place. Although, not sure how easy it would be to fix this without major changes.

[AndyButland]

I was initially thinking end users could apply this - we would document it of course, and it'll be a small % of installs that need the delivery API with media by path requests. I take your point that files with extensions is kind of the default for media though.

But also we could ship with this code in place too. As I understand, anything with a file extension is assumed to be a static file, as 99% of the time that's correct and we can be more performant by not sending these requests through the Umbraco pipeline. So we need to override this path to ensure the Delivery API endpoints are always handled as dynamic requests.

[iOvergaard]

You probably also need an exception for these paths in any web.config file for IIS to ignore the request, wouldn't you think so? Otherwise, I'd fear IIS would give you a 404 long before you reach the Delivery API.