Adds dependency injection support in non-model scenario #439

kakone · 2022-01-12T18:19:09Z

Adds a EnableDependencyInjection(Action<IServiceCollection> configureServices) method in ODataOptions to be able to add services (StringAsEnumResolver for example) in non-model scenario.

Fixes #422

Usage :

builder.Services
    .AddControllers()
    .AddOData(opt =>
    {
        opt.EnableQueryFeatures();
        opt.EnableDependencyInjection(services =>
        {
            services.AddSingleton<ODataUriResolver>(sp => new StringAsEnumResolver() { EnableCaseInsensitive = true });
        });
    });

ghost · 2022-01-12T18:19:20Z

All CLA requirements met.

xuzhg · 2022-01-13T07:24:00Z

@kakone

I don't like the method name
Where will you use 'StringAsEnumResolver'?

kakone · 2022-01-13T08:50:31Z

I don't like the method name

I agree, I don't like it too. I chose it because it was the method name I used with v7. A suggestion for another name ?

Where will you use 'StringAsEnumResolver'?

I have a simple webservice with [EnableQuery] attribute and a non-edm model. The registered StringAsEnumResolver will be retrieved automatically in the ODataQueryOptions object and transmitted to the ODataQueryOptionParser.
Then, I can use an OData filter like State eq '2' instead of State eq 'Completed'.

dquilong · 2022-01-26T14:19:10Z

Nice work! it's exactly what I needed. Please if you can merge it and create the release it as soon as possible. Thanks a lot!

src/Microsoft.AspNetCore.OData/ODataOptions.cs

corranrogue9

I really like this change, but I think it is very important to add a test case

Adds a test case

src/Microsoft.AspNetCore.OData/Extensions/HttpRequestExtensions.cs

test/Microsoft.AspNetCore.OData.E2E.Tests/NonEdm/ConfigureServiceCollectionTest.cs

corranrogue9 · 2022-04-24T20:06:10Z

I left a couple of small comments, but I really like this change, thanks for adding the test case.

@xuzhg, since you are more familiar with this repo can you take a look to make sure it fits?

vkarosas · 2022-06-28T17:40:55Z

@kakone @corranrogue9 @xuzhg Could we get some traction on this? We've encountered this issue as well. In our case, we're using the AddODataQueryFilter extension method to enable OData queries on non-OData controllers. We end up with basically the same problem, i.e., there's no way to inject a StringAsEnumResolver so that our OData query filters are case-insensitive.

xuzhg · 2022-06-28T21:38:42Z

test/Microsoft.AspNetCore.OData.E2E.Tests/NonEdm/NonEdmController.cs

+using Microsoft.AspNetCore.Mvc;
+using Microsoft.AspNetCore.OData.Query;
+using System.Collections.Generic;
+using System.Linq;


copy right head

xuzhg · 2022-06-28T21:38:59Z

test/Microsoft.AspNetCore.OData.E2E.Tests/NonEdm/NonEdmController.cs

+using Microsoft.AspNetCore.OData.Query;
+using System.Collections.Generic;
+using System.Linq;
+


move using System.* ahead
and sort

xuzhg · 2022-06-28T21:39:18Z

test/Microsoft.AspNetCore.OData.E2E.Tests/NonEdm/NonEdmController.cs

+                    Gender = e%2 == 0 ? Gender.Female : Gender.Male,
+                }).ToList();
+        }
+    }


put it into a new file

xuzhg · 2022-06-28T21:39:42Z

test/Microsoft.AspNetCore.OData.E2E.Tests/NonEdm/NonEdmController.cs

+        public IActionResult Get(ODataQueryOptions<Customer> options)
+        {
+            return Ok(options.ApplyTo(NonEdmDbContext.GetCustomers().AsQueryable()));
+        }


add a test using [EnableQuery] attribute

xuzhg · 2022-06-28T21:39:57Z

namespace Microsoft.AspNetCore.OData.E2E.Tests.NonEdm

add copyright

Refers to: test/Microsoft.AspNetCore.OData.E2E.Tests/NonEdm/NonEdmDataModel.cs:1 in e305e35. [](commit_id = e305e35, deletion_comment = False)

xuzhg · 2022-06-28T21:40:39Z

test/Microsoft.AspNetCore.OData.E2E.Tests/NonEdm/ConfigureServiceCollectionTest.cs

+        }
+
+        [Fact]
+        public async Task EnableConfigureServiceCollectionTest()


EnableConfigureServiceCollectionTest

add new tests, for example, $select, $expand, $top to make sure it's working.

xuzhg · 2022-06-28T21:41:28Z

src/Microsoft.AspNetCore.OData/ODataOptions.cs

+        /// </summary>
+        /// <param name="configureServices">The configuring action to add the services to the container.</param>
+        /// <returns>The current <see cref="ODataOptions"/> instance to enable fluent configuration.</returns>
+        public ODataOptions ConfigureServiceCollection(Action<IServiceCollection> configureServices)


ConfigureServiceCollection

maybe just use AddRouteComponents as the method name

xuzhg · 2022-06-28T21:41:47Z

src/Microsoft.AspNetCore.OData/ODataOptions.cs

@@ -62,6 +62,19 @@ public class ODataOptions
        /// </summary>
        public ODataRouteOptions RouteOptions { get; } = new ODataRouteOptions();

+        private IServiceProvider ServiceProvider { get; set; }


private IServiceProvider ServiceProvider { get; set; }

move the private field ahead

make it a field, it seems we don't need a property

xuzhg · 2022-06-28T21:42:38Z

src/Microsoft.AspNetCore.OData/ODataOptions.cs

        /// <returns>The built service provider.</returns>
-        private IServiceProvider BuildRouteContainer(IEdmModel model, Action<IServiceCollection> setupAction)
+        private IServiceProvider BuildContainer(Action<IServiceCollection> setupAction, IEdmModel model = null)


BuildContainer

it seems we don't need to change the method name

xuzhg · 2022-06-28T21:43:01Z

src/Microsoft.AspNetCore.OData/ODataOptions.cs

+        /// <returns>The current <see cref="ODataOptions"/> instance to enable fluent configuration.</returns>
+        public ODataOptions ConfigureServiceCollection(Action<IServiceCollection> configureServices)
+        {
+            ServiceProvider = BuildContainer(configureServices);


BuildContainer

call the method using model=null as parameter?

xuzhg

🕐

xuzhg · 2022-06-28T21:43:33Z

src/Microsoft.AspNetCore.OData/Extensions/HttpRequestExtensions.cs

            {
-                scope.ServiceProvider.GetRequiredService<HttpRequestScope>().HttpRequest = request;
+                return null;
            }


insert whiteline after {} block

xuzhg · 2022-06-28T21:43:56Z

src/Microsoft.AspNetCore.OData/Extensions/HttpRequestExtensions.cs

+            {
+                // non-model scenario with dependency injection non enabled
+                return null;
+            }


insert whiteline

xuzhg · 2022-06-28T21:46:21Z

@kakone It looks ok to me but would you please take a look for my comments.
Besides, do you think we should make this available directly calling AddOData();

For example:

services.AddOData(); // this can inject the odata serivces into the global level service provider??

In reply to: 1169031180

KenitoInc · 2023-02-23T11:27:29Z

@kakone Did you get a chance to look at the comments?

microsoft-github-policy-service · 2023-02-23T14:34:11Z

@kakone please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

(default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@microsoft-github-policy-service agree
(when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@microsoft-github-policy-service agree company="Microsoft"

Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement ( “Agreement” ) is agreed to by the party signing below ( “You” ),
and conveys certain license rights to the .NET Foundation ( “.NET Foundation” ) for Your contributions to
.NET Foundation open source projects. This Agreement is effective as of the latest signature date below.

1. Definitions.

“Code” means the computer software code, whether in human-readable or machine-executable form,
that is delivered by You to .NET Foundation under this Agreement.

“Project” means any of the projects owned or managed by .NET Foundation and offered under a license
approved by the Open Source Initiative (www.opensource.org).

“Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any
Project, including but not limited to communication on electronic mailing lists, source code control
systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of
discussing and improving that Project, but excluding communication that is conspicuously marked or
otherwise designated in writing by You as “Not a Submission.”

“Submission” means the Code and any other copyrightable material Submitted by You, including any
associated comments and documentation.

2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any
Project. This Agreement covers any and all Submissions that You, now or in the future (except as
described in Section 4 below), Submit to any Project.

3. Originality of Work. You represent that each of Your Submissions is entirely Your original work.

Should You wish to Submit materials that are not Your original work, You may Submit them separately
to the Project if You (a) retain all copyright and license information that was in the materials as You
received them, (b) in the description accompanying Your Submission, include the phrase “Submission
containing materials of a third party:” followed by the names of the third party and any licenses or other
restrictions of which You are aware, and (c) follow any other instructions in the Project’s written

4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else
for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your
Submission is made in the course of Your work for an employer or Your employer has intellectual
property rights in Your Submission by contract or applicable law, You must secure permission from Your
employer to make the Submission before signing this Agreement. In that case, the term “You” in this
Agreement will refer to You and the employer collectively. If You change employers in the future and
desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement
and secure permission from the new employer before Submitting those Submissions.

5. Licenses.

a. Copyright License. You grant .NET Foundation, and those who receive the Submission directly
or indirectly from .NET Foundation, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable

license in the Submission to reproduce, prepare derivative works of, publicly display, publicly perform,
and distribute the Submission and such derivative works, and to sublicense any or all of the foregoing
rights to third parties.

b. Patent License. You grant .NET Foundation, and those who receive the Submission directly or
indirectly from .NET Foundation, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license
under Your patent claims that are necessarily infringed by the Submission or the combination of the
Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and
import or otherwise dispose of the Submission alone or with the Project.

c. Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement.
No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are
granted by implication, exhaustion, estoppel or otherwise.

6. Representations and Warranties. You represent that You are legally entitled to grant the above
licenses. You represent that each of Your Submissions is entirely Your original work (except as You may
have disclosed under Section 3 ). You represent that You have secured permission from Your employer to
make the Submission in cases where Your Submission is made in the course of Your work for Your
employer or Your employer has intellectual property rights in Your Submission by contract or applicable
law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You
have the necessary authority to bind the listed employer to the obligations contained in this Agreement.
You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS
REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES
EXPRESSLY STATED IN SECTIONS 3, 4, AND 6 , THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS
PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF
NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.

7. Notice to .NET Foundation. You agree to notify .NET Foundation in writing of any facts or
circumstances of which You later become aware that would make Your representations in this
Agreement inaccurate in any respect.

8. Information about Submissions. You agree that contributions to Projects and information about
contributions may be maintained indefinitely and disclosed publicly, including Your name and other
information that You submit with Your Submission.

9. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and
the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County,
Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to
exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all
defenses of lack of personal jurisdiction and forum non-conveniens.

10. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and
supersedes any and all prior agreements, understandings or communications, written or oral, between
the parties relating to the subject matter hereof. This Agreement may be assigned by .NET Foundation.

.NET Foundation dedicates this Contribution License Agreement to the public domain according to the Creative Commons CC0 1.

kakone · 2023-02-23T14:36:14Z

@microsoft-github-policy-service agree company="Berger-Levrault"

kakone · 2023-02-23T14:39:38Z

@kakone Did you get a chance to look at the comments?

Yes, changes done.

soargon · 2023-05-29T08:06:11Z

please merge this pr quickly

PhilippeAntom · 2023-07-24T13:44:07Z

Great! It would be nice to have this PR merged and released! Thanks for your hard work!

Adds dependency injection support in non-model scenario

f7a6048

Fixes failed tests

c8013bd

KenitoInc requested review from habbes, KenitoInc, ElizabethOkerio and gathogojr February 3, 2022 07:29

KenitoInc requested review from mikepizzo and xuzhg March 3, 2022 11:19

corranrogue9 reviewed Mar 4, 2022

View reviewed changes

src/Microsoft.AspNetCore.OData/ODataOptions.cs Outdated Show resolved Hide resolved

corranrogue9 requested changes Mar 4, 2022

View reviewed changes

dweeden mentioned this pull request Mar 23, 2022

Array of Enums not working for Filtering #536

Closed

kakone force-pushed the NonModelDependencyInjection branch from d436efa to c8013bd Compare April 3, 2022 17:47

kakone and others added 2 commits April 3, 2022 19:49

Merge branch 'OData:main' into NonModelDependencyInjection

4a09031

Renames EnableDependencyInjection method to ConfigureServiceCollection

f92320a

Adds a test case

kakone requested a review from corranrogue9 April 4, 2022 09:31

Stéphane Mitermite added 2 commits April 4, 2022 11:37

Reorder using statements

b6ea3c6

Updates PublicApi bsl files

7ede7fa

corranrogue9 reviewed Apr 24, 2022

View reviewed changes

src/Microsoft.AspNetCore.OData/Extensions/HttpRequestExtensions.cs Show resolved Hide resolved

corranrogue9 reviewed Apr 24, 2022

View reviewed changes

test/Microsoft.AspNetCore.OData.E2E.Tests/NonEdm/ConfigureServiceCollectionTest.cs Outdated Show resolved Hide resolved

Adds a using in EnableConfigureServiceCollectionTest method

e305e35

kakone requested a review from corranrogue9 April 25, 2022 16:04

xuzhg reviewed Jun 28, 2022

View reviewed changes

xuzhg requested changes Jun 28, 2022

View reviewed changes

xuzhg reviewed Jun 28, 2022

View reviewed changes

KillTrot mentioned this pull request Oct 19, 2022

Enum types bervProject/ODataTutorial#33

Open

Stéphane Mitermite added 2 commits February 23, 2023 13:16

Merge from upstream

d8a675a

Applies PR remarks

9c121bc

kakone requested review from xuzhg and removed request for KenitoInc, habbes, mikepizzo, corranrogue9, ElizabethOkerio and gathogojr February 23, 2023 14:36

kakone requested a review from corranrogue9 July 24, 2023 14:22

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adds dependency injection support in non-model scenario #439

Adds dependency injection support in non-model scenario #439

kakone commented Jan 12, 2022 •

edited

Loading

ghost commented Jan 12, 2022 •

edited by ghost

Loading

xuzhg commented Jan 13, 2022

kakone commented Jan 13, 2022

dquilong commented Jan 26, 2022 •

edited

Loading

corranrogue9 left a comment

corranrogue9 commented Apr 24, 2022

vkarosas commented Jun 28, 2022 •

edited

Loading

xuzhg Jun 28, 2022

xuzhg Jun 28, 2022

xuzhg Jun 28, 2022

xuzhg Jun 28, 2022

xuzhg commented Jun 28, 2022

xuzhg Jun 28, 2022

xuzhg Jun 28, 2022

xuzhg Jun 28, 2022

xuzhg Jun 28, 2022

xuzhg Jun 28, 2022

xuzhg Jun 28, 2022

xuzhg left a comment

xuzhg Jun 28, 2022

xuzhg Jun 28, 2022

xuzhg commented Jun 28, 2022

KenitoInc commented Feb 23, 2023

microsoft-github-policy-service bot commented Feb 23, 2023

Contribution License Agreement

kakone commented Feb 23, 2023

kakone commented Feb 23, 2023

soargon commented May 29, 2023

PhilippeAntom commented Jul 24, 2023

Adds dependency injection support in non-model scenario #439

Are you sure you want to change the base?

Adds dependency injection support in non-model scenario #439

Conversation

kakone commented Jan 12, 2022 • edited Loading

Usage :

ghost commented Jan 12, 2022 • edited by ghost Loading

xuzhg commented Jan 13, 2022

kakone commented Jan 13, 2022

dquilong commented Jan 26, 2022 • edited Loading

corranrogue9 left a comment

Choose a reason for hiding this comment

corranrogue9 commented Apr 24, 2022

vkarosas commented Jun 28, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

xuzhg commented Jun 28, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

xuzhg left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

xuzhg commented Jun 28, 2022

KenitoInc commented Feb 23, 2023

microsoft-github-policy-service bot commented Feb 23, 2023

Contribution License Agreement

kakone commented Feb 23, 2023

kakone commented Feb 23, 2023

soargon commented May 29, 2023

PhilippeAntom commented Jul 24, 2023

kakone commented Jan 12, 2022 •

edited

Loading

ghost commented Jan 12, 2022 •

edited by ghost

Loading

dquilong commented Jan 26, 2022 •

edited

Loading

vkarosas commented Jun 28, 2022 •

edited

Loading