Skip applying filter

[KnapSac]

Is there a way to tell the library to skip applying the filter on the returned results?

I need to apply the filter manually to be able to integrate it with my database queries (as I'm not using EF, the library can only apply it in memory). But if I apply it myself, the library will still apply the filter in memory, effectively applying the filter twice. Which is unfortunate, because the results I return already satisfy the filter, so this is a waste of CPU cycles.

I tried a couple of things like overriding the EnableQuery attribute and ODataQueryOptions behavior, but I couldn't get that to work without also losing functionality like the default server-side paging ect. Ideally I'd want to only mark certain query options as already applied, so the library won't apply them a second time, without then having to go and implement a lot of the standard functionality myself.

[julealgon]

If you want to manually apply the odata query options, pass the ODataQueryOptions<T> instace to your controller, manually call .Apply on your IQueryable, and make sure you remove the `[EnableQuery] attribute from your action.

If you keep the [EnableQuery] attribute, it will attempt to perform the same odata operations again to the result of your manually applied query, which obviously is not what you want.

[EnableQuery] and ODataQueryOptions<T> were not meant to be used together. Use one or the other: the attribute on simpler flows, and the model on advanced scenarios where you need more control of application.

[KnapSac]

The fact that IQueryable can't be generic makes sense. However, I can't get the select to work. When I apply it manually and return the resulting IQueryable, I get an error than the EDM instance is missing a property, despite that property not being selected in the query. When selecting that property, everything works fine. So it seems that somewhere there is still a trigger for the library to apply the select itself or something like that.

public class Dto
{
    [Key]
    public string Id { get; set; }
    public DateTime Date { get; set;
}

public class DtoController : ODataController
{
    public ActionResult< IQueryable > Get(ODataQueryOptions< Dto > options)
    {
        IQueryable< Dto > values = GetValues();
        return options.SelectExpand.ApplyTo(values, new ODataQuerySettings());
    }
}

When doing a query which only selects Id, this gives the following error. Any ideas what I'm doing wrong?

 System.InvalidOperationException: The EDM instance of type '[Dto Nullable=True]' is missing the property 'Date'.
         at Microsoft.AspNetCore.OData.Formatter.ResourceContext.GetPropertyValue(String propertyName)
         at Microsoft.AspNetCore.OData.Formatter.Serialization.ODataResourceSerializer.CreateStructuralProperty(IEdmStructuralProperty structuralProperty, ResourceContext resourceContext)
         at Microsoft.AspNetCore.OData.Formatter.Serialization.ODataResourceSerializer.CreateStructuralPropertyBag(SelectExpandNode selectExpandNode, ResourceContext resourceContext)
         at Microsoft.AspNetCore.OData.Formatter.Serialization.ODataResourceSerializer.CreateResource(SelectExpandNode selectExpandNode, ResourceContext resourceContext)
         at Microsoft.AspNetCore.OData.Formatter.Serialization.ODataResourceSerializer.WriteResourceAsync(Object graph, ODataWriter writer, ODataSerializerContext writeContext, IEdmTypeReference expectedType)
         at Microsoft.AspNetCore.OData.Formatter.Serialization.ODataResourceSerializer.WriteObjectInlineAsync(Object graph, IEdmTypeReference expectedType, ODataWriter writer, ODataSerializerContext writeContext)
         at Microsoft.AspNetCore.OData.Formatter.Serialization.ODataResourceSetSerializer.WriteResourceSetItemAsync(Object item, IEdmStructuredTypeReference elementType, Boolean isUntypedCollection, IEdmTypeReference resourceSetType, ODataWriter writer, IODataEdmTypeSerializer resourceSerializer, ODataSerializerContext writeContext)
         at Microsoft.AspNetCore.OData.Formatter.Serialization.ODataResourceSetSerializer.WriteResourceSetAsync(IEnumerable enumerable, IEdmTypeReference resourceSetType, ODataWriter writer, ODataSerializerContext writeContext)
         at Microsoft.AspNetCore.OData.Formatter.Serialization.ODataResourceSetSerializer.WriteObjectInlineAsync(Object graph, IEdmTypeReference expectedType, ODataWriter writer, ODataSerializerContext writeContext)
         at Microsoft.AspNetCore.OData.Formatter.Serialization.ODataResourceSetSerializer.WriteObjectAsync(Object graph, Type type, ODataMessageWriter messageWriter, ODataSerializerContext writeContext)
         at Microsoft.AspNetCore.OData.Formatter.ODataOutputFormatterHelper.WriteToStreamAsync(Type type, Object value, IEdmModel model, ODataVersion version, Uri baseAddress, MediaTypeHeaderValue contentType, HttpRequest request, IHeaderDictionary requestHeaders, IODataSerializerProvider serializerProvider)
         at Microsoft.AspNetCore.Mvc.Infrastructure.ResourceInvoker.<InvokeResultFilters>g__Awaited|28_0(ResourceInvoker invoker, Task lastTask, State next, Scope scope, Object state, Boolean isCompleted)
         at Microsoft.AspNetCore.Mvc.Infrastructure.ResourceInvoker.<InvokeFilterPipelineAsync>g__Awaited|20_0(ResourceInvoker invoker, Task lastTask, State next, Scope scope, Object state, Boolean isCompleted)
         at Microsoft.AspNetCore.Mvc.Infrastructure.ResourceInvoker.<InvokeAsync>g__Logged|17_1(ResourceInvoker invoker)
         at Microsoft.AspNetCore.Mvc.Infrastructure.ResourceInvoker.<InvokeAsync>g__Logged|17_1(ResourceInvoker invoker)
         at Microsoft.AspNetCore.Routing.EndpointMiddleware.<Invoke>g__AwaitRequestTask|7_0(Endpoint endpoint, Task requestTask, ILogger logger)
         at Microsoft.AspNetCore.Authorization.AuthorizationMiddleware.Invoke(HttpContext context)
         at Microsoft.AspNetCore.Authentication.AuthenticationMiddleware.Invoke(HttpContext context)
         at Microsoft.AspNetCore.HttpLogging.HttpLoggingMiddleware.InvokeInternal(HttpContext context, HttpLoggingOptions options, HttpLoggingAttribute loggingAttribute, HttpLoggingFields loggingFields)
         at Microsoft.AspNetCore.HttpLogging.HttpLoggingMiddleware.InvokeInternal(HttpContext context, HttpLoggingOptions options, HttpLoggingAttribute loggingAttribute, HttpLoggingFields loggingFields)
         at Microsoft.AspNetCore.Diagnostics.DeveloperExceptionPageMiddlewareImpl.Invoke(HttpContext context)

[julealgon]

So it seems that somewhere there is still a trigger for the library to apply the select itself or something like that.

In OData AspNet (the non-Core OData), there was a way to enable the [EnableQuery] behavior globally, using EnableQuerySupport in the configuration.

I assume you are not using that version and are using OData AspNetCore, so it doesn't apply. Please confirm. EDIT: scratch that, I see the namespaces in your stacktrace...

Otherwise, I don't know what is happening there in your case. You might want to share a fully working project sample that highlights the problem and maybe open an issue.

[julealgon]

@KnapSac can you share your metadata xml and your EDM model building logic? Are you using the ODataConventionalModelBuilder to build your EDM?

[KnapSac]

<?xml version="1.0" encoding="utf-8"?>

<edmx:Edmx Version="4.0" xmlns:edmx="http://docs.oasis-open.org/odata/ns/edmx">
	<edmx:DataServices>
		<Schema Namespace="Test" xmlns="http://docs.oasis-open.org/odata/ns/edm">
			<EntityType Name="Dto">
				<Key>
					<PropertyRef Name="Id" />
				</Key>
				<Property Name="Id" Type="Edm.String" Nullable="false" />
				<Property Name="Date" Type="Edm.DateTimeOffset" Nullable="false" />
			</EntityType>
		</Schema>
		<Schema Namespace="Default" xmlns="http://docs.oasis-open.org/odata/ns/edm">
			<EntityContainer Name="Container">
				<EntitySet Name="Dtos" EntityType="Dto" />
			</EntityContainer>
		</Schema>
	</edmx:DataServices>
</edmx:Edmx>

private static IEdmModel GetEdmModel( )
{
    ODataConventionModelBuilder builder = new( );
    builder.EntitySet< Dto >( "Dtos" );

    IEdmModel model = builder.GetEdmModel( );
    model.MarkAsImmutable( );

    return model;
}

[KnapSac]

I opened #1231 with a minimal reproduction of this issue.