Skip to content

Add AddHttpClientDefaults - #87953

Merged
CarnaViire merged 14 commits into
dotnet:mainfrom
JamesNK:jamesnk/httpclientfactory-servicecollectionhack
Jul 14, 2023
Merged

Add AddHttpClientDefaults#87953
CarnaViire merged 14 commits into
dotnet:mainfrom
JamesNK:jamesnk/httpclientfactory-servicecollectionhack

Conversation

@JamesNK

Copy link
Copy Markdown
Member

Fixes#87914

The AddHttpClientDefaults method supports adding configuration to all created HttpClients.

The method:

  • Creates a builder with a null name. Microsoft.Extensions.Configuration automatically applies configuration with a null name to all named configuration.
  • Ensures that default configuration is added before named configuration in the IServiceCollection. This is to make it so the order of AddHttpClientDefaults and AddHttpClient doesn't matter. Default config is always applied first, then named config is applied after. This is done by wrapping the IServiceCollection in an implementation that modifies the order that IConfigureOptions<HttpClientFactoryOptions> values are added.

@ghost

Copy link
Copy Markdown

Note regarding the new-api-needs-documentation label:

This serves as a reminder for when your PR is modifying a ref *.cs file and adding/modifying public APIs, please make sure the API implementation in the src *.cs file is documented with triple slash comments, so the PR reviewers can sign off that change.

@ghost

Copy link
Copy Markdown

Tagging subscribers to this area: @dotnet/ncl
See info in area-owners.md if you want to be subscribed.

Issue Details

Fixes #87914

The AddHttpClientDefaults method supports adding configuration to all created HttpClients.

The method:

  • Creates a builder with a null name. Microsoft.Extensions.Configuration automatically applies configuration with a null name to all named configuration.
  • Ensures that default configuration is added before named configuration in the IServiceCollection. This is to make it so the order of AddHttpClientDefaults and AddHttpClient doesn't matter. Default config is always applied first, then named config is applied after. This is done by wrapping the IServiceCollection in an implementation that modifies the order that IConfigureOptions<HttpClientFactoryOptions> values are added.
Author:JamesNK
Assignees:-
Labels:

area-Extensions-HttpClientFactory

Milestone:-

@davidfowl

Copy link
Copy Markdown
Member

Ensures that default configuration is added before named configuration in the IServiceCollection. This is to make it so the order of AddHttpClientDefaults and AddHttpClient doesn't matter. Default config is always applied first, then named config is applied after. This is done by wrapping the IServiceCollection in an implementation that modifies the order that IConfigureOptions values are added.

This feels pretty bad.

@JamesNK

JamesNK commented Jun 23, 2023

Copy link
Copy Markdown
MemberAuthor

@noahfalk@joperezr@geeknoid@davidfowl

The AddHttpClientDefaults is designed to make it easy to apply configuration to all clients configured with AddHttpClient using one extension method on IHttpClientBuilder.

The goal is to avoid having two methods:

  • Add config to one builder - extension method on IHttpClientBuilder.
  • Add config to all builders - extension method on IServiceCollection.

For example, methods in dotnet/extensions below will no longer be needed:

https://github.com/dotnet/extensions/blob/52ebc1b123613254f9dfe250515027c1332fba35/src/Libraries/Microsoft.Extensions.Http.Telemetry/Logging/HttpClientLoggingExtensions.cs#L31-L122

It will be possible to do:

// Add HttpClientLogging to all clients.services.AddHttpClientDefaults().AddHttpClientLogging();// Is configured with HttpClientLogging from the defaults.services.AddHttpClient();

@davidfowl

davidfowl commented Jun 23, 2023

Copy link
Copy Markdown
Member

I've also been thinking about an API like this and was hoping we could add an overload to AddHttpClient so it wasnt 2 different calls.

services.AddHttpClient(IHttpClientBuilder clientBuilder =>{clientBuilder.AddHttpMessageHandler<MyAuthHandler>();});

@JamesNK

Copy link
Copy Markdown
MemberAuthor

Ensures that default configuration is added before named configuration in the IServiceCollection. This is to make it so the order of AddHttpClientDefaults and AddHttpClient doesn't matter. Default config is always applied first, then named config is applied after. This is done by wrapping the IServiceCollection in an implementation that modifies the order that IConfigureOptions values are added.

This feels pretty bad.

It's not the best, but it works well. It hits these important requirements:

  • AddHttpClientDefaults config is overridden by named client configuration.
  • The order AddHttpClientDefaults and AddHttpClient are called doesn't matter. Named client configuration always wins.
  • It automatically works for people who have written their own IHttpClientBuilder extension methods that call services.Configure<HttpClientFactoryOptions>(...).

The extra logic is only applied to IOptionsConfiguration<HttpClientFactoryOptions> to ensure they have the right order. It won't interfere with or break other DI extension methods.

@geeknoid

Copy link
Copy Markdown
Member

@dpk83 FYI

@dpk83

Copy link
Copy Markdown

@xakep139

@stephentoub

Copy link
Copy Markdown
Member

Let's please agree on the API via discussion on the issue and API review before opening PRs. I spoke with @CarnaViire at length about this and other related APIs yesterday and I know she was going to be following up with you.

@JamesNK
JamesNK marked this pull request as draft June 23, 2023 11:49
@CarnaViire
CarnaViire marked this pull request as ready for review July 12, 2023 21:39

@CarnaViireCarnaViire left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM for @JamesNK 's changes

@CarnaViire

Copy link
Copy Markdown
Member

@dotnet/ncl can someone pls review as well? Since I've taken over the PR.

@CarnaViire
CarnaViire requested a review from a teamJuly 12, 2023 21:56
@CarnaViireCarnaViire self-assigned this Jul 12, 2023

@ManickaPManickaP left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@CarnaViire changes LGTM.

@lewing

Copy link
Copy Markdown
Member

This change appears to be breaking flow into aspnetcore in dotnet/aspnetcore#49433

@joperezr

Copy link
Copy Markdown
Member

@CarnaViire can you please take a look?

@CarnaViire

Copy link
Copy Markdown
Member

I've pushed the fix to the branch dotnet/aspnetcore#49433

@ghostghost locked as resolved and limited conversation to collaborators Aug 17, 2023
@davidfowl

Copy link
Copy Markdown
Member

So we have a problem here. I tried to use ConfigureHttpClientDefaults and noticed it isn't an extension method in the reference assembly.

@joperezr

Copy link
Copy Markdown
Member

Can you elaborate? This change seems to suggest that the reference assembly was edited and that the extension was properly added: https://github.com/dotnet/runtime/pull/87953/files#diff-06e422c9663ed696b723dc56832cbdb53b9f9c3e6d0a98e52a1cb081b7c9dc7aR50

@karelz

Copy link
Copy Markdown
Member

@joperezr the this is missing -- see #90911 which David filed and which was just fixed :)

@joperezr

Copy link
Copy Markdown
Member

Oh, completely missed it! Good catch @davidfowl and thanks for the quick fix 😃

Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[API Proposal] ConfigureHttpClientDefaults for HttpClientFactory

11 participants

@JamesNK@davidfowl@geeknoid@dpk83@stephentoub@CarnaViire@lewing@joperezr@karelz@xakep139@ManickaP
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Add AddHttpClientDefaults by JamesNK · Pull Request #87953 · dotnet/runtime · GitHub
Skip to content

Add AddHttpClientDefaults - #87953

Merged
CarnaViire merged 14 commits into
dotnet:mainfrom
JamesNK:jamesnk/httpclientfactory-servicecollectionhack
Jul 14, 2023
Merged

Add AddHttpClientDefaults#87953
CarnaViire merged 14 commits into
dotnet:mainfrom
JamesNK:jamesnk/httpclientfactory-servicecollectionhack

Conversation

@JamesNK

Copy link
Copy Markdown
Member

Fixes#87914

The AddHttpClientDefaults method supports adding configuration to all created HttpClients.

The method:

  • Creates a builder with a null name. Microsoft.Extensions.Configuration automatically applies configuration with a null name to all named configuration.
  • Ensures that default configuration is added before named configuration in the IServiceCollection. This is to make it so the order of AddHttpClientDefaults and AddHttpClient doesn't matter. Default config is always applied first, then named config is applied after. This is done by wrapping the IServiceCollection in an implementation that modifies the order that IConfigureOptions<HttpClientFactoryOptions> values are added.

@ghost

Copy link
Copy Markdown

Note regarding the new-api-needs-documentation label:

This serves as a reminder for when your PR is modifying a ref *.cs file and adding/modifying public APIs, please make sure the API implementation in the src *.cs file is documented with triple slash comments, so the PR reviewers can sign off that change.

@ghost

Copy link
Copy Markdown

Tagging subscribers to this area: @dotnet/ncl
See info in area-owners.md if you want to be subscribed.

Issue Details

Fixes #87914

The AddHttpClientDefaults method supports adding configuration to all created HttpClients.

The method:

  • Creates a builder with a null name. Microsoft.Extensions.Configuration automatically applies configuration with a null name to all named configuration.
  • Ensures that default configuration is added before named configuration in the IServiceCollection. This is to make it so the order of AddHttpClientDefaults and AddHttpClient doesn't matter. Default config is always applied first, then named config is applied after. This is done by wrapping the IServiceCollection in an implementation that modifies the order that IConfigureOptions<HttpClientFactoryOptions> values are added.
Author:JamesNK
Assignees:-
Labels:

area-Extensions-HttpClientFactory

Milestone:-

@davidfowl

Copy link
Copy Markdown
Member

Ensures that default configuration is added before named configuration in the IServiceCollection. This is to make it so the order of AddHttpClientDefaults and AddHttpClient doesn't matter. Default config is always applied first, then named config is applied after. This is done by wrapping the IServiceCollection in an implementation that modifies the order that IConfigureOptions values are added.

This feels pretty bad.

@JamesNK

JamesNK commented Jun 23, 2023

Copy link
Copy Markdown
MemberAuthor

@noahfalk@joperezr@geeknoid@davidfowl

The AddHttpClientDefaults is designed to make it easy to apply configuration to all clients configured with AddHttpClient using one extension method on IHttpClientBuilder.

The goal is to avoid having two methods:

  • Add config to one builder - extension method on IHttpClientBuilder.
  • Add config to all builders - extension method on IServiceCollection.

For example, methods in dotnet/extensions below will no longer be needed:

https://github.com/dotnet/extensions/blob/52ebc1b123613254f9dfe250515027c1332fba35/src/Libraries/Microsoft.Extensions.Http.Telemetry/Logging/HttpClientLoggingExtensions.cs#L31-L122

It will be possible to do:

// Add HttpClientLogging to all clients.services.AddHttpClientDefaults().AddHttpClientLogging();// Is configured with HttpClientLogging from the defaults.services.AddHttpClient();

@davidfowl

davidfowl commented Jun 23, 2023

Copy link
Copy Markdown
Member

I've also been thinking about an API like this and was hoping we could add an overload to AddHttpClient so it wasnt 2 different calls.

services.AddHttpClient(IHttpClientBuilder clientBuilder =>{clientBuilder.AddHttpMessageHandler<MyAuthHandler>();});

@JamesNK

Copy link
Copy Markdown
MemberAuthor

Ensures that default configuration is added before named configuration in the IServiceCollection. This is to make it so the order of AddHttpClientDefaults and AddHttpClient doesn't matter. Default config is always applied first, then named config is applied after. This is done by wrapping the IServiceCollection in an implementation that modifies the order that IConfigureOptions values are added.

This feels pretty bad.

It's not the best, but it works well. It hits these important requirements:

  • AddHttpClientDefaults config is overridden by named client configuration.
  • The order AddHttpClientDefaults and AddHttpClient are called doesn't matter. Named client configuration always wins.
  • It automatically works for people who have written their own IHttpClientBuilder extension methods that call services.Configure<HttpClientFactoryOptions>(...).

The extra logic is only applied to IOptionsConfiguration<HttpClientFactoryOptions> to ensure they have the right order. It won't interfere with or break other DI extension methods.

@geeknoid

Copy link
Copy Markdown
Member

@dpk83 FYI

@dpk83

Copy link
Copy Markdown

@xakep139

@stephentoub

Copy link
Copy Markdown
Member

Let's please agree on the API via discussion on the issue and API review before opening PRs. I spoke with @CarnaViire at length about this and other related APIs yesterday and I know she was going to be following up with you.

@JamesNK
JamesNK marked this pull request as draft June 23, 2023 11:49
@CarnaViire
CarnaViire marked this pull request as ready for review July 12, 2023 21:39

@CarnaViireCarnaViire left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM for @JamesNK 's changes

@CarnaViire

Copy link
Copy Markdown
Member

@dotnet/ncl can someone pls review as well? Since I've taken over the PR.

@CarnaViire
CarnaViire requested a review from a teamJuly 12, 2023 21:56
@CarnaViireCarnaViire self-assigned this Jul 12, 2023

@ManickaPManickaP left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@CarnaViire changes LGTM.

@lewing

Copy link
Copy Markdown
Member

This change appears to be breaking flow into aspnetcore in dotnet/aspnetcore#49433

@joperezr

Copy link
Copy Markdown
Member

@CarnaViire can you please take a look?

@CarnaViire

Copy link
Copy Markdown
Member

I've pushed the fix to the branch dotnet/aspnetcore#49433

@ghostghost locked as resolved and limited conversation to collaborators Aug 17, 2023
@davidfowl

Copy link
Copy Markdown
Member

So we have a problem here. I tried to use ConfigureHttpClientDefaults and noticed it isn't an extension method in the reference assembly.

@joperezr

Copy link
Copy Markdown
Member

Can you elaborate? This change seems to suggest that the reference assembly was edited and that the extension was properly added: https://github.com/dotnet/runtime/pull/87953/files#diff-06e422c9663ed696b723dc56832cbdb53b9f9c3e6d0a98e52a1cb081b7c9dc7aR50

@karelz

Copy link
Copy Markdown
Member

@joperezr the this is missing -- see #90911 which David filed and which was just fixed :)

@joperezr

Copy link
Copy Markdown
Member

Oh, completely missed it! Good catch @davidfowl and thanks for the quick fix 😃

Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[API Proposal] ConfigureHttpClientDefaults for HttpClientFactory

11 participants

@JamesNK@davidfowl@geeknoid@dpk83@stephentoub@CarnaViire@lewing@joperezr@karelz@xakep139@ManickaP
, 'i'); if (__m === '*' || __re.test(location.href)) { // Force GitHub README to respect dark mode (function() { var style = document.createElement('style'); style.textContent = ' .markdown-body { color-scheme: dark light; } .markdown-body pre { background: #161b22 !important; } .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; } .markdown-body table th, .markdown-body table td { border-color: #30363d !important; } .markdown-body img { background: #0d1117; } .markdown-body blockquote { border-left-color: #8b949e; } .markdown-body hr { border-color: #30363d; } '; document.head.appendChild(style); })(); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Add AddHttpClientDefaults by JamesNK · Pull Request #87953 · dotnet/runtime · GitHub
Skip to content

Add AddHttpClientDefaults - #87953

Merged
CarnaViire merged 14 commits into
dotnet:mainfrom
JamesNK:jamesnk/httpclientfactory-servicecollectionhack
Jul 14, 2023
Merged

Add AddHttpClientDefaults#87953
CarnaViire merged 14 commits into
dotnet:mainfrom
JamesNK:jamesnk/httpclientfactory-servicecollectionhack

Conversation

@JamesNK

Copy link
Copy Markdown
Member

Fixes#87914

The AddHttpClientDefaults method supports adding configuration to all created HttpClients.

The method:

  • Creates a builder with a null name. Microsoft.Extensions.Configuration automatically applies configuration with a null name to all named configuration.
  • Ensures that default configuration is added before named configuration in the IServiceCollection. This is to make it so the order of AddHttpClientDefaults and AddHttpClient doesn't matter. Default config is always applied first, then named config is applied after. This is done by wrapping the IServiceCollection in an implementation that modifies the order that IConfigureOptions<HttpClientFactoryOptions> values are added.

@ghost

Copy link
Copy Markdown

Note regarding the new-api-needs-documentation label:

This serves as a reminder for when your PR is modifying a ref *.cs file and adding/modifying public APIs, please make sure the API implementation in the src *.cs file is documented with triple slash comments, so the PR reviewers can sign off that change.

@ghost

Copy link
Copy Markdown

Tagging subscribers to this area: @dotnet/ncl
See info in area-owners.md if you want to be subscribed.

Issue Details

Fixes #87914

The AddHttpClientDefaults method supports adding configuration to all created HttpClients.

The method:

  • Creates a builder with a null name. Microsoft.Extensions.Configuration automatically applies configuration with a null name to all named configuration.
  • Ensures that default configuration is added before named configuration in the IServiceCollection. This is to make it so the order of AddHttpClientDefaults and AddHttpClient doesn't matter. Default config is always applied first, then named config is applied after. This is done by wrapping the IServiceCollection in an implementation that modifies the order that IConfigureOptions<HttpClientFactoryOptions> values are added.
Author:JamesNK
Assignees:-
Labels:

area-Extensions-HttpClientFactory

Milestone:-

@davidfowl

Copy link
Copy Markdown
Member

Ensures that default configuration is added before named configuration in the IServiceCollection. This is to make it so the order of AddHttpClientDefaults and AddHttpClient doesn't matter. Default config is always applied first, then named config is applied after. This is done by wrapping the IServiceCollection in an implementation that modifies the order that IConfigureOptions values are added.

This feels pretty bad.

@JamesNK

JamesNK commented Jun 23, 2023

Copy link
Copy Markdown
MemberAuthor

@noahfalk@joperezr@geeknoid@davidfowl

The AddHttpClientDefaults is designed to make it easy to apply configuration to all clients configured with AddHttpClient using one extension method on IHttpClientBuilder.

The goal is to avoid having two methods:

  • Add config to one builder - extension method on IHttpClientBuilder.
  • Add config to all builders - extension method on IServiceCollection.

For example, methods in dotnet/extensions below will no longer be needed:

https://github.com/dotnet/extensions/blob/52ebc1b123613254f9dfe250515027c1332fba35/src/Libraries/Microsoft.Extensions.Http.Telemetry/Logging/HttpClientLoggingExtensions.cs#L31-L122

It will be possible to do:

// Add HttpClientLogging to all clients.services.AddHttpClientDefaults().AddHttpClientLogging();// Is configured with HttpClientLogging from the defaults.services.AddHttpClient();

@davidfowl

davidfowl commented Jun 23, 2023

Copy link
Copy Markdown
Member

I've also been thinking about an API like this and was hoping we could add an overload to AddHttpClient so it wasnt 2 different calls.

services.AddHttpClient(IHttpClientBuilder clientBuilder =>{clientBuilder.AddHttpMessageHandler<MyAuthHandler>();});

@JamesNK

Copy link
Copy Markdown
MemberAuthor

Ensures that default configuration is added before named configuration in the IServiceCollection. This is to make it so the order of AddHttpClientDefaults and AddHttpClient doesn't matter. Default config is always applied first, then named config is applied after. This is done by wrapping the IServiceCollection in an implementation that modifies the order that IConfigureOptions values are added.

This feels pretty bad.

It's not the best, but it works well. It hits these important requirements:

  • AddHttpClientDefaults config is overridden by named client configuration.
  • The order AddHttpClientDefaults and AddHttpClient are called doesn't matter. Named client configuration always wins.
  • It automatically works for people who have written their own IHttpClientBuilder extension methods that call services.Configure<HttpClientFactoryOptions>(...).

The extra logic is only applied to IOptionsConfiguration<HttpClientFactoryOptions> to ensure they have the right order. It won't interfere with or break other DI extension methods.

@geeknoid

Copy link
Copy Markdown
Member

@dpk83 FYI

@dpk83

Copy link
Copy Markdown

@xakep139

@stephentoub

Copy link
Copy Markdown
Member

Let's please agree on the API via discussion on the issue and API review before opening PRs. I spoke with @CarnaViire at length about this and other related APIs yesterday and I know she was going to be following up with you.

@JamesNK
JamesNK marked this pull request as draft June 23, 2023 11:49
@CarnaViire
CarnaViire marked this pull request as ready for review July 12, 2023 21:39

@CarnaViireCarnaViire left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM for @JamesNK 's changes

@CarnaViire

Copy link
Copy Markdown
Member

@dotnet/ncl can someone pls review as well? Since I've taken over the PR.

@CarnaViire
CarnaViire requested a review from a teamJuly 12, 2023 21:56
@CarnaViireCarnaViire self-assigned this Jul 12, 2023

@ManickaPManickaP left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@CarnaViire changes LGTM.

@lewing

Copy link
Copy Markdown
Member

This change appears to be breaking flow into aspnetcore in dotnet/aspnetcore#49433

@joperezr

Copy link
Copy Markdown
Member

@CarnaViire can you please take a look?

@CarnaViire

Copy link
Copy Markdown
Member

I've pushed the fix to the branch dotnet/aspnetcore#49433

@ghostghost locked as resolved and limited conversation to collaborators Aug 17, 2023
@davidfowl

Copy link
Copy Markdown
Member

So we have a problem here. I tried to use ConfigureHttpClientDefaults and noticed it isn't an extension method in the reference assembly.

@joperezr

Copy link
Copy Markdown
Member

Can you elaborate? This change seems to suggest that the reference assembly was edited and that the extension was properly added: https://github.com/dotnet/runtime/pull/87953/files#diff-06e422c9663ed696b723dc56832cbdb53b9f9c3e6d0a98e52a1cb081b7c9dc7aR50

@karelz

Copy link
Copy Markdown
Member

@joperezr the this is missing -- see #90911 which David filed and which was just fixed :)

@joperezr

Copy link
Copy Markdown
Member

Oh, completely missed it! Good catch @davidfowl and thanks for the quick fix 😃

Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[API Proposal] ConfigureHttpClientDefaults for HttpClientFactory

11 participants

@JamesNK@davidfowl@geeknoid@dpk83@stephentoub@CarnaViire@lewing@joperezr@karelz@xakep139@ManickaP
, 'i'); if (__m === '*' || __re.test(location.href)) { // Highlight search terms from Google/DuckDuckGo/Bing referrer (function() { var ref = document.referrer; var terms = []; if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) { var url = new URL(ref); var q = url.searchParams.get('q') || url.searchParams.get('p'); if (q) { terms = q.split(/\s+/).filter(function(t) { return t.length > 2; }); } } if (terms.length === 0) return; var style = document.createElement('style'); style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }'; document.head.appendChild(style); function highlight(node) { if (node.nodeType === 3) { // text node var text = node.textContent; var found = false; terms.forEach(function(term) { var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Add AddHttpClientDefaults by JamesNK · Pull Request #87953 · dotnet/runtime · GitHub
Skip to content

Add AddHttpClientDefaults - #87953

Merged
CarnaViire merged 14 commits into
dotnet:mainfrom
JamesNK:jamesnk/httpclientfactory-servicecollectionhack
Jul 14, 2023
Merged

Add AddHttpClientDefaults#87953
CarnaViire merged 14 commits into
dotnet:mainfrom
JamesNK:jamesnk/httpclientfactory-servicecollectionhack

Conversation

@JamesNK

Copy link
Copy Markdown
Member

Fixes#87914

The AddHttpClientDefaults method supports adding configuration to all created HttpClients.

The method:

  • Creates a builder with a null name. Microsoft.Extensions.Configuration automatically applies configuration with a null name to all named configuration.
  • Ensures that default configuration is added before named configuration in the IServiceCollection. This is to make it so the order of AddHttpClientDefaults and AddHttpClient doesn't matter. Default config is always applied first, then named config is applied after. This is done by wrapping the IServiceCollection in an implementation that modifies the order that IConfigureOptions<HttpClientFactoryOptions> values are added.

@ghost

Copy link
Copy Markdown

Note regarding the new-api-needs-documentation label:

This serves as a reminder for when your PR is modifying a ref *.cs file and adding/modifying public APIs, please make sure the API implementation in the src *.cs file is documented with triple slash comments, so the PR reviewers can sign off that change.

@ghost

Copy link
Copy Markdown

Tagging subscribers to this area: @dotnet/ncl
See info in area-owners.md if you want to be subscribed.

Issue Details

Fixes #87914

The AddHttpClientDefaults method supports adding configuration to all created HttpClients.

The method:

  • Creates a builder with a null name. Microsoft.Extensions.Configuration automatically applies configuration with a null name to all named configuration.
  • Ensures that default configuration is added before named configuration in the IServiceCollection. This is to make it so the order of AddHttpClientDefaults and AddHttpClient doesn't matter. Default config is always applied first, then named config is applied after. This is done by wrapping the IServiceCollection in an implementation that modifies the order that IConfigureOptions<HttpClientFactoryOptions> values are added.
Author:JamesNK
Assignees:-
Labels:

area-Extensions-HttpClientFactory

Milestone:-

@davidfowl

Copy link
Copy Markdown
Member

Ensures that default configuration is added before named configuration in the IServiceCollection. This is to make it so the order of AddHttpClientDefaults and AddHttpClient doesn't matter. Default config is always applied first, then named config is applied after. This is done by wrapping the IServiceCollection in an implementation that modifies the order that IConfigureOptions values are added.

This feels pretty bad.

@JamesNK

JamesNK commented Jun 23, 2023

Copy link
Copy Markdown
MemberAuthor

@noahfalk@joperezr@geeknoid@davidfowl

The AddHttpClientDefaults is designed to make it easy to apply configuration to all clients configured with AddHttpClient using one extension method on IHttpClientBuilder.

The goal is to avoid having two methods:

  • Add config to one builder - extension method on IHttpClientBuilder.
  • Add config to all builders - extension method on IServiceCollection.

For example, methods in dotnet/extensions below will no longer be needed:

https://github.com/dotnet/extensions/blob/52ebc1b123613254f9dfe250515027c1332fba35/src/Libraries/Microsoft.Extensions.Http.Telemetry/Logging/HttpClientLoggingExtensions.cs#L31-L122

It will be possible to do:

// Add HttpClientLogging to all clients.services.AddHttpClientDefaults().AddHttpClientLogging();// Is configured with HttpClientLogging from the defaults.services.AddHttpClient();

@davidfowl

davidfowl commented Jun 23, 2023

Copy link
Copy Markdown
Member

I've also been thinking about an API like this and was hoping we could add an overload to AddHttpClient so it wasnt 2 different calls.

services.AddHttpClient(IHttpClientBuilder clientBuilder =>{clientBuilder.AddHttpMessageHandler<MyAuthHandler>();});

@JamesNK

Copy link
Copy Markdown
MemberAuthor

Ensures that default configuration is added before named configuration in the IServiceCollection. This is to make it so the order of AddHttpClientDefaults and AddHttpClient doesn't matter. Default config is always applied first, then named config is applied after. This is done by wrapping the IServiceCollection in an implementation that modifies the order that IConfigureOptions values are added.

This feels pretty bad.

It's not the best, but it works well. It hits these important requirements:

  • AddHttpClientDefaults config is overridden by named client configuration.
  • The order AddHttpClientDefaults and AddHttpClient are called doesn't matter. Named client configuration always wins.
  • It automatically works for people who have written their own IHttpClientBuilder extension methods that call services.Configure<HttpClientFactoryOptions>(...).

The extra logic is only applied to IOptionsConfiguration<HttpClientFactoryOptions> to ensure they have the right order. It won't interfere with or break other DI extension methods.

@geeknoid

Copy link
Copy Markdown
Member

@dpk83 FYI

@dpk83

Copy link
Copy Markdown

@xakep139

@stephentoub

Copy link
Copy Markdown
Member

Let's please agree on the API via discussion on the issue and API review before opening PRs. I spoke with @CarnaViire at length about this and other related APIs yesterday and I know she was going to be following up with you.

@JamesNK
JamesNK marked this pull request as draft June 23, 2023 11:49
@CarnaViire
CarnaViire marked this pull request as ready for review July 12, 2023 21:39

@CarnaViireCarnaViire left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM for @JamesNK 's changes

@CarnaViire

Copy link
Copy Markdown
Member

@dotnet/ncl can someone pls review as well? Since I've taken over the PR.

@CarnaViire
CarnaViire requested a review from a teamJuly 12, 2023 21:56
@CarnaViireCarnaViire self-assigned this Jul 12, 2023

@ManickaPManickaP left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@CarnaViire changes LGTM.

@lewing

Copy link
Copy Markdown
Member

This change appears to be breaking flow into aspnetcore in dotnet/aspnetcore#49433

@joperezr

Copy link
Copy Markdown
Member

@CarnaViire can you please take a look?

@CarnaViire

Copy link
Copy Markdown
Member

I've pushed the fix to the branch dotnet/aspnetcore#49433

@ghostghost locked as resolved and limited conversation to collaborators Aug 17, 2023
@davidfowl

Copy link
Copy Markdown
Member

So we have a problem here. I tried to use ConfigureHttpClientDefaults and noticed it isn't an extension method in the reference assembly.

@joperezr

Copy link
Copy Markdown
Member

Can you elaborate? This change seems to suggest that the reference assembly was edited and that the extension was properly added: https://github.com/dotnet/runtime/pull/87953/files#diff-06e422c9663ed696b723dc56832cbdb53b9f9c3e6d0a98e52a1cb081b7c9dc7aR50

@karelz

Copy link
Copy Markdown
Member

@joperezr the this is missing -- see #90911 which David filed and which was just fixed :)

@joperezr

Copy link
Copy Markdown
Member

Oh, completely missed it! Good catch @davidfowl and thanks for the quick fix 😃

Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[API Proposal] ConfigureHttpClientDefaults for HttpClientFactory

11 participants

@JamesNK@davidfowl@geeknoid@dpk83@stephentoub@CarnaViire@lewing@joperezr@karelz@xakep139@ManickaP
, 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + ' Add AddHttpClientDefaults by JamesNK · Pull Request #87953 · dotnet/runtime · GitHub
Skip to content

Add AddHttpClientDefaults - #87953

Merged
CarnaViire merged 14 commits into
dotnet:mainfrom
JamesNK:jamesnk/httpclientfactory-servicecollectionhack
Jul 14, 2023
Merged

Add AddHttpClientDefaults#87953
CarnaViire merged 14 commits into
dotnet:mainfrom
JamesNK:jamesnk/httpclientfactory-servicecollectionhack

Conversation

@JamesNK

Copy link
Copy Markdown
Member

Fixes#87914

The AddHttpClientDefaults method supports adding configuration to all created HttpClients.

The method:

  • Creates a builder with a null name. Microsoft.Extensions.Configuration automatically applies configuration with a null name to all named configuration.
  • Ensures that default configuration is added before named configuration in the IServiceCollection. This is to make it so the order of AddHttpClientDefaults and AddHttpClient doesn't matter. Default config is always applied first, then named config is applied after. This is done by wrapping the IServiceCollection in an implementation that modifies the order that IConfigureOptions<HttpClientFactoryOptions> values are added.

@ghost

Copy link
Copy Markdown

Note regarding the new-api-needs-documentation label:

This serves as a reminder for when your PR is modifying a ref *.cs file and adding/modifying public APIs, please make sure the API implementation in the src *.cs file is documented with triple slash comments, so the PR reviewers can sign off that change.

@ghost

Copy link
Copy Markdown

Tagging subscribers to this area: @dotnet/ncl
See info in area-owners.md if you want to be subscribed.

Issue Details

Fixes #87914

The AddHttpClientDefaults method supports adding configuration to all created HttpClients.

The method:

  • Creates a builder with a null name. Microsoft.Extensions.Configuration automatically applies configuration with a null name to all named configuration.
  • Ensures that default configuration is added before named configuration in the IServiceCollection. This is to make it so the order of AddHttpClientDefaults and AddHttpClient doesn't matter. Default config is always applied first, then named config is applied after. This is done by wrapping the IServiceCollection in an implementation that modifies the order that IConfigureOptions<HttpClientFactoryOptions> values are added.
Author:JamesNK
Assignees:-
Labels:

area-Extensions-HttpClientFactory

Milestone:-

@davidfowl

Copy link
Copy Markdown
Member

Ensures that default configuration is added before named configuration in the IServiceCollection. This is to make it so the order of AddHttpClientDefaults and AddHttpClient doesn't matter. Default config is always applied first, then named config is applied after. This is done by wrapping the IServiceCollection in an implementation that modifies the order that IConfigureOptions values are added.

This feels pretty bad.

@JamesNK

JamesNK commented Jun 23, 2023

Copy link
Copy Markdown
MemberAuthor

@noahfalk@joperezr@geeknoid@davidfowl

The AddHttpClientDefaults is designed to make it easy to apply configuration to all clients configured with AddHttpClient using one extension method on IHttpClientBuilder.

The goal is to avoid having two methods:

  • Add config to one builder - extension method on IHttpClientBuilder.
  • Add config to all builders - extension method on IServiceCollection.

For example, methods in dotnet/extensions below will no longer be needed:

https://github.com/dotnet/extensions/blob/52ebc1b123613254f9dfe250515027c1332fba35/src/Libraries/Microsoft.Extensions.Http.Telemetry/Logging/HttpClientLoggingExtensions.cs#L31-L122

It will be possible to do:

// Add HttpClientLogging to all clients.services.AddHttpClientDefaults().AddHttpClientLogging();// Is configured with HttpClientLogging from the defaults.services.AddHttpClient();

@davidfowl

davidfowl commented Jun 23, 2023

Copy link
Copy Markdown
Member

I've also been thinking about an API like this and was hoping we could add an overload to AddHttpClient so it wasnt 2 different calls.

services.AddHttpClient(IHttpClientBuilder clientBuilder =>{clientBuilder.AddHttpMessageHandler<MyAuthHandler>();});

@JamesNK

Copy link
Copy Markdown
MemberAuthor

Ensures that default configuration is added before named configuration in the IServiceCollection. This is to make it so the order of AddHttpClientDefaults and AddHttpClient doesn't matter. Default config is always applied first, then named config is applied after. This is done by wrapping the IServiceCollection in an implementation that modifies the order that IConfigureOptions values are added.

This feels pretty bad.

It's not the best, but it works well. It hits these important requirements:

  • AddHttpClientDefaults config is overridden by named client configuration.
  • The order AddHttpClientDefaults and AddHttpClient are called doesn't matter. Named client configuration always wins.
  • It automatically works for people who have written their own IHttpClientBuilder extension methods that call services.Configure<HttpClientFactoryOptions>(...).

The extra logic is only applied to IOptionsConfiguration<HttpClientFactoryOptions> to ensure they have the right order. It won't interfere with or break other DI extension methods.

@geeknoid

Copy link
Copy Markdown
Member

@dpk83 FYI

@dpk83

Copy link
Copy Markdown

@xakep139

@stephentoub

Copy link
Copy Markdown
Member

Let's please agree on the API via discussion on the issue and API review before opening PRs. I spoke with @CarnaViire at length about this and other related APIs yesterday and I know she was going to be following up with you.

@JamesNK
JamesNK marked this pull request as draft June 23, 2023 11:49
@CarnaViire
CarnaViire marked this pull request as ready for review July 12, 2023 21:39

@CarnaViireCarnaViire left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM for @JamesNK 's changes

@CarnaViire

Copy link
Copy Markdown
Member

@dotnet/ncl can someone pls review as well? Since I've taken over the PR.

@CarnaViire
CarnaViire requested a review from a teamJuly 12, 2023 21:56
@CarnaViireCarnaViire self-assigned this Jul 12, 2023

@ManickaPManickaP left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@CarnaViire changes LGTM.

@lewing

Copy link
Copy Markdown
Member

This change appears to be breaking flow into aspnetcore in dotnet/aspnetcore#49433

@joperezr

Copy link
Copy Markdown
Member

@CarnaViire can you please take a look?

@CarnaViire

Copy link
Copy Markdown
Member

I've pushed the fix to the branch dotnet/aspnetcore#49433

@ghostghost locked as resolved and limited conversation to collaborators Aug 17, 2023
@davidfowl

Copy link
Copy Markdown
Member

So we have a problem here. I tried to use ConfigureHttpClientDefaults and noticed it isn't an extension method in the reference assembly.

@joperezr

Copy link
Copy Markdown
Member

Can you elaborate? This change seems to suggest that the reference assembly was edited and that the extension was properly added: https://github.com/dotnet/runtime/pull/87953/files#diff-06e422c9663ed696b723dc56832cbdb53b9f9c3e6d0a98e52a1cb081b7c9dc7aR50

@karelz

Copy link
Copy Markdown
Member

@joperezr the this is missing -- see #90911 which David filed and which was just fixed :)

@joperezr

Copy link
Copy Markdown
Member

Oh, completely missed it! Good catch @davidfowl and thanks for the quick fix 😃

Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[API Proposal] ConfigureHttpClientDefaults for HttpClientFactory

11 participants

@JamesNK@davidfowl@geeknoid@dpk83@stephentoub@CarnaViire@lewing@joperezr@karelz@xakep139@ManickaP
, 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Add AddHttpClientDefaults by JamesNK · Pull Request #87953 · dotnet/runtime · GitHub
Skip to content

Add AddHttpClientDefaults - #87953

Merged
CarnaViire merged 14 commits into
dotnet:mainfrom
JamesNK:jamesnk/httpclientfactory-servicecollectionhack
Jul 14, 2023
Merged

Add AddHttpClientDefaults#87953
CarnaViire merged 14 commits into
dotnet:mainfrom
JamesNK:jamesnk/httpclientfactory-servicecollectionhack

Conversation

@JamesNK

Copy link
Copy Markdown
Member

Fixes#87914

The AddHttpClientDefaults method supports adding configuration to all created HttpClients.

The method:

  • Creates a builder with a null name. Microsoft.Extensions.Configuration automatically applies configuration with a null name to all named configuration.
  • Ensures that default configuration is added before named configuration in the IServiceCollection. This is to make it so the order of AddHttpClientDefaults and AddHttpClient doesn't matter. Default config is always applied first, then named config is applied after. This is done by wrapping the IServiceCollection in an implementation that modifies the order that IConfigureOptions<HttpClientFactoryOptions> values are added.

@ghost

Copy link
Copy Markdown

Note regarding the new-api-needs-documentation label:

This serves as a reminder for when your PR is modifying a ref *.cs file and adding/modifying public APIs, please make sure the API implementation in the src *.cs file is documented with triple slash comments, so the PR reviewers can sign off that change.

@ghost

Copy link
Copy Markdown

Tagging subscribers to this area: @dotnet/ncl
See info in area-owners.md if you want to be subscribed.

Issue Details

Fixes #87914

The AddHttpClientDefaults method supports adding configuration to all created HttpClients.

The method:

  • Creates a builder with a null name. Microsoft.Extensions.Configuration automatically applies configuration with a null name to all named configuration.
  • Ensures that default configuration is added before named configuration in the IServiceCollection. This is to make it so the order of AddHttpClientDefaults and AddHttpClient doesn't matter. Default config is always applied first, then named config is applied after. This is done by wrapping the IServiceCollection in an implementation that modifies the order that IConfigureOptions<HttpClientFactoryOptions> values are added.
Author:JamesNK
Assignees:-
Labels:

area-Extensions-HttpClientFactory

Milestone:-

@davidfowl

Copy link
Copy Markdown
Member

Ensures that default configuration is added before named configuration in the IServiceCollection. This is to make it so the order of AddHttpClientDefaults and AddHttpClient doesn't matter. Default config is always applied first, then named config is applied after. This is done by wrapping the IServiceCollection in an implementation that modifies the order that IConfigureOptions values are added.

This feels pretty bad.

@JamesNK

JamesNK commented Jun 23, 2023

Copy link
Copy Markdown
MemberAuthor

@noahfalk@joperezr@geeknoid@davidfowl

The AddHttpClientDefaults is designed to make it easy to apply configuration to all clients configured with AddHttpClient using one extension method on IHttpClientBuilder.

The goal is to avoid having two methods:

  • Add config to one builder - extension method on IHttpClientBuilder.
  • Add config to all builders - extension method on IServiceCollection.

For example, methods in dotnet/extensions below will no longer be needed:

https://github.com/dotnet/extensions/blob/52ebc1b123613254f9dfe250515027c1332fba35/src/Libraries/Microsoft.Extensions.Http.Telemetry/Logging/HttpClientLoggingExtensions.cs#L31-L122

It will be possible to do:

// Add HttpClientLogging to all clients.services.AddHttpClientDefaults().AddHttpClientLogging();// Is configured with HttpClientLogging from the defaults.services.AddHttpClient();

@davidfowl

davidfowl commented Jun 23, 2023

Copy link
Copy Markdown
Member

I've also been thinking about an API like this and was hoping we could add an overload to AddHttpClient so it wasnt 2 different calls.

services.AddHttpClient(IHttpClientBuilder clientBuilder =>{clientBuilder.AddHttpMessageHandler<MyAuthHandler>();});

@JamesNK

Copy link
Copy Markdown
MemberAuthor

Ensures that default configuration is added before named configuration in the IServiceCollection. This is to make it so the order of AddHttpClientDefaults and AddHttpClient doesn't matter. Default config is always applied first, then named config is applied after. This is done by wrapping the IServiceCollection in an implementation that modifies the order that IConfigureOptions values are added.

This feels pretty bad.

It's not the best, but it works well. It hits these important requirements:

  • AddHttpClientDefaults config is overridden by named client configuration.
  • The order AddHttpClientDefaults and AddHttpClient are called doesn't matter. Named client configuration always wins.
  • It automatically works for people who have written their own IHttpClientBuilder extension methods that call services.Configure<HttpClientFactoryOptions>(...).

The extra logic is only applied to IOptionsConfiguration<HttpClientFactoryOptions> to ensure they have the right order. It won't interfere with or break other DI extension methods.

@geeknoid

Copy link
Copy Markdown
Member

@dpk83 FYI

@dpk83

Copy link
Copy Markdown

@xakep139

@stephentoub

Copy link
Copy Markdown
Member

Let's please agree on the API via discussion on the issue and API review before opening PRs. I spoke with @CarnaViire at length about this and other related APIs yesterday and I know she was going to be following up with you.

@JamesNK
JamesNK marked this pull request as draft June 23, 2023 11:49
@CarnaViire
CarnaViire marked this pull request as ready for review July 12, 2023 21:39

@CarnaViireCarnaViire left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM for @JamesNK 's changes

@CarnaViire

Copy link
Copy Markdown
Member

@dotnet/ncl can someone pls review as well? Since I've taken over the PR.

@CarnaViire
CarnaViire requested a review from a teamJuly 12, 2023 21:56
@CarnaViireCarnaViire self-assigned this Jul 12, 2023

@ManickaPManickaP left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@CarnaViire changes LGTM.

@lewing

Copy link
Copy Markdown
Member

This change appears to be breaking flow into aspnetcore in dotnet/aspnetcore#49433

@joperezr

Copy link
Copy Markdown
Member

@CarnaViire can you please take a look?

@CarnaViire

Copy link
Copy Markdown
Member

I've pushed the fix to the branch dotnet/aspnetcore#49433

@ghostghost locked as resolved and limited conversation to collaborators Aug 17, 2023
@davidfowl

Copy link
Copy Markdown
Member

So we have a problem here. I tried to use ConfigureHttpClientDefaults and noticed it isn't an extension method in the reference assembly.

@joperezr

Copy link
Copy Markdown
Member

Can you elaborate? This change seems to suggest that the reference assembly was edited and that the extension was properly added: https://github.com/dotnet/runtime/pull/87953/files#diff-06e422c9663ed696b723dc56832cbdb53b9f9c3e6d0a98e52a1cb081b7c9dc7aR50

@karelz

Copy link
Copy Markdown
Member

@joperezr the this is missing -- see #90911 which David filed and which was just fixed :)

@joperezr

Copy link
Copy Markdown
Member

Oh, completely missed it! Good catch @davidfowl and thanks for the quick fix 😃

Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[API Proposal] ConfigureHttpClientDefaults for HttpClientFactory

11 participants

@JamesNK@davidfowl@geeknoid@dpk83@stephentoub@CarnaViire@lewing@joperezr@karelz@xakep139@ManickaP
, 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Add AddHttpClientDefaults by JamesNK · Pull Request #87953 · dotnet/runtime · GitHub
Skip to content

Add AddHttpClientDefaults - #87953

Merged
CarnaViire merged 14 commits into
dotnet:mainfrom
JamesNK:jamesnk/httpclientfactory-servicecollectionhack
Jul 14, 2023
Merged

Add AddHttpClientDefaults#87953
CarnaViire merged 14 commits into
dotnet:mainfrom
JamesNK:jamesnk/httpclientfactory-servicecollectionhack

Conversation

@JamesNK

Copy link
Copy Markdown
Member

Fixes#87914

The AddHttpClientDefaults method supports adding configuration to all created HttpClients.

The method:

  • Creates a builder with a null name. Microsoft.Extensions.Configuration automatically applies configuration with a null name to all named configuration.
  • Ensures that default configuration is added before named configuration in the IServiceCollection. This is to make it so the order of AddHttpClientDefaults and AddHttpClient doesn't matter. Default config is always applied first, then named config is applied after. This is done by wrapping the IServiceCollection in an implementation that modifies the order that IConfigureOptions<HttpClientFactoryOptions> values are added.

@ghost

Copy link
Copy Markdown

Note regarding the new-api-needs-documentation label:

This serves as a reminder for when your PR is modifying a ref *.cs file and adding/modifying public APIs, please make sure the API implementation in the src *.cs file is documented with triple slash comments, so the PR reviewers can sign off that change.

@ghost

Copy link
Copy Markdown

Tagging subscribers to this area: @dotnet/ncl
See info in area-owners.md if you want to be subscribed.

Issue Details

Fixes #87914

The AddHttpClientDefaults method supports adding configuration to all created HttpClients.

The method:

  • Creates a builder with a null name. Microsoft.Extensions.Configuration automatically applies configuration with a null name to all named configuration.
  • Ensures that default configuration is added before named configuration in the IServiceCollection. This is to make it so the order of AddHttpClientDefaults and AddHttpClient doesn't matter. Default config is always applied first, then named config is applied after. This is done by wrapping the IServiceCollection in an implementation that modifies the order that IConfigureOptions<HttpClientFactoryOptions> values are added.
Author:JamesNK
Assignees:-
Labels:

area-Extensions-HttpClientFactory

Milestone:-

@davidfowl

Copy link
Copy Markdown
Member

Ensures that default configuration is added before named configuration in the IServiceCollection. This is to make it so the order of AddHttpClientDefaults and AddHttpClient doesn't matter. Default config is always applied first, then named config is applied after. This is done by wrapping the IServiceCollection in an implementation that modifies the order that IConfigureOptions values are added.

This feels pretty bad.

@JamesNK

JamesNK commented Jun 23, 2023

Copy link
Copy Markdown
MemberAuthor

@noahfalk@joperezr@geeknoid@davidfowl

The AddHttpClientDefaults is designed to make it easy to apply configuration to all clients configured with AddHttpClient using one extension method on IHttpClientBuilder.

The goal is to avoid having two methods:

  • Add config to one builder - extension method on IHttpClientBuilder.
  • Add config to all builders - extension method on IServiceCollection.

For example, methods in dotnet/extensions below will no longer be needed:

https://github.com/dotnet/extensions/blob/52ebc1b123613254f9dfe250515027c1332fba35/src/Libraries/Microsoft.Extensions.Http.Telemetry/Logging/HttpClientLoggingExtensions.cs#L31-L122

It will be possible to do:

// Add HttpClientLogging to all clients.services.AddHttpClientDefaults().AddHttpClientLogging();// Is configured with HttpClientLogging from the defaults.services.AddHttpClient();

@davidfowl

davidfowl commented Jun 23, 2023

Copy link
Copy Markdown
Member

I've also been thinking about an API like this and was hoping we could add an overload to AddHttpClient so it wasnt 2 different calls.

services.AddHttpClient(IHttpClientBuilder clientBuilder =>{clientBuilder.AddHttpMessageHandler<MyAuthHandler>();});

@JamesNK

Copy link
Copy Markdown
MemberAuthor

Ensures that default configuration is added before named configuration in the IServiceCollection. This is to make it so the order of AddHttpClientDefaults and AddHttpClient doesn't matter. Default config is always applied first, then named config is applied after. This is done by wrapping the IServiceCollection in an implementation that modifies the order that IConfigureOptions values are added.

This feels pretty bad.

It's not the best, but it works well. It hits these important requirements:

  • AddHttpClientDefaults config is overridden by named client configuration.
  • The order AddHttpClientDefaults and AddHttpClient are called doesn't matter. Named client configuration always wins.
  • It automatically works for people who have written their own IHttpClientBuilder extension methods that call services.Configure<HttpClientFactoryOptions>(...).

The extra logic is only applied to IOptionsConfiguration<HttpClientFactoryOptions> to ensure they have the right order. It won't interfere with or break other DI extension methods.

@geeknoid

Copy link
Copy Markdown
Member

@dpk83 FYI

@dpk83

Copy link
Copy Markdown

@xakep139

@stephentoub

Copy link
Copy Markdown
Member

Let's please agree on the API via discussion on the issue and API review before opening PRs. I spoke with @CarnaViire at length about this and other related APIs yesterday and I know she was going to be following up with you.

@JamesNK
JamesNK marked this pull request as draft June 23, 2023 11:49
@CarnaViire
CarnaViire marked this pull request as ready for review July 12, 2023 21:39

@CarnaViireCarnaViire left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM for @JamesNK 's changes

@CarnaViire

Copy link
Copy Markdown
Member

@dotnet/ncl can someone pls review as well? Since I've taken over the PR.

@CarnaViire
CarnaViire requested a review from a teamJuly 12, 2023 21:56
@CarnaViireCarnaViire self-assigned this Jul 12, 2023

@ManickaPManickaP left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@CarnaViire changes LGTM.

@lewing

Copy link
Copy Markdown
Member

This change appears to be breaking flow into aspnetcore in dotnet/aspnetcore#49433

@joperezr

Copy link
Copy Markdown
Member

@CarnaViire can you please take a look?

@CarnaViire

Copy link
Copy Markdown
Member

I've pushed the fix to the branch dotnet/aspnetcore#49433

@ghostghost locked as resolved and limited conversation to collaborators Aug 17, 2023
@davidfowl

Copy link
Copy Markdown
Member

So we have a problem here. I tried to use ConfigureHttpClientDefaults and noticed it isn't an extension method in the reference assembly.

@joperezr

Copy link
Copy Markdown
Member

Can you elaborate? This change seems to suggest that the reference assembly was edited and that the extension was properly added: https://github.com/dotnet/runtime/pull/87953/files#diff-06e422c9663ed696b723dc56832cbdb53b9f9c3e6d0a98e52a1cb081b7c9dc7aR50

@karelz

Copy link
Copy Markdown
Member

@joperezr the this is missing -- see #90911 which David filed and which was just fixed :)

@joperezr

Copy link
Copy Markdown
Member

Oh, completely missed it! Good catch @davidfowl and thanks for the quick fix 😃

Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[API Proposal] ConfigureHttpClientDefaults for HttpClientFactory

11 participants

@JamesNK@davidfowl@geeknoid@dpk83@stephentoub@CarnaViire@lewing@joperezr@karelz@xakep139@ManickaP
, 'i'); if (__m === '*' || __re.test(location.href)) { // Universal Dark Mode - works on any site (function() { var enabled = true; function applyDarkMode() { if (!enabled) return; // Create style element if it doesn't exist var style = document.getElementById('universal-dark-mode-style'); if (!style) { style = document.createElement('style'); style.id = 'universal-dark-mode-style'; document.head.appendChild(style); } // Dark mode CSS - inverts colors but preserves images/video style.textContent = ' /* Invert everything except media */ html { filter: invert(1) hue-rotate(180deg) !important; background: #1a1a2e !important; } /* Restore images, videos, iframes, canvas */ img, video, iframe, canvas, svg, picture, [style*="background-image"] { filter: invert(1) hue-rotate(180deg) !important; } /* Preserve specific elements that should not be inverted */ .no-dark-mode, .no-dark-mode *, [data-theme="light"], [data-theme="light"], .ace_editor, .ace_editor *, .CodeMirror, .CodeMirror *, .monaco-editor, .monaco-editor *, .markdown-body pre, .markdown-body pre *, .highlight, .highlight *, pre code, pre code * { filter: none !important; } /* Fix common UI elements */ .modal, .popup, .dropdown-menu, .tooltip, .popover { filter: invert(1) hue-rotate(180deg) !important; background: #2d2d44 !important; border-color: #444 !important; } /* Scrollbars */ ::-webkit-scrollbar { background: #1a1a2e !important; } ::-webkit-scrollbar-thumb { background: #444 !important; } ::-webkit-scrollbar-thumb:hover { background: #555 !important; } /* Selection */ ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; } ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; } '; } function removeDarkMode() { var style = document.getElementById('universal-dark-mode-style'); if (style) style.remove(); } // Toggle with Alt+Shift+D document.addEventListener('keydown', function(e) { if (e.altKey && e.shiftKey && e.key === 'D') { e.preventDefault(); enabled = !enabled; if (enabled) { applyDarkMode(); console.log('[Universal Dark Mode] Enabled'); } else { removeDarkMode(); console.log('[Universal Dark Mode] Disabled'); } } }); // Apply on load applyDarkMode(); // Re-apply on dynamic content var observer = new MutationObserver(function(mutations) { if (enabled && !document.getElementById('universal-dark-mode-style')) { applyDarkMode(); } }); observer.observe(document.head, { childList: true }); console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle'); })(); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })(); Add AddHttpClientDefaults by JamesNK · Pull Request #87953 · dotnet/runtime · GitHub
Skip to content

Add AddHttpClientDefaults - #87953

Merged
CarnaViire merged 14 commits into
dotnet:mainfrom
JamesNK:jamesnk/httpclientfactory-servicecollectionhack
Jul 14, 2023
Merged

Add AddHttpClientDefaults#87953
CarnaViire merged 14 commits into
dotnet:mainfrom
JamesNK:jamesnk/httpclientfactory-servicecollectionhack

Conversation

@JamesNK

Copy link
Copy Markdown
Member

Fixes#87914

The AddHttpClientDefaults method supports adding configuration to all created HttpClients.

The method:

  • Creates a builder with a null name. Microsoft.Extensions.Configuration automatically applies configuration with a null name to all named configuration.
  • Ensures that default configuration is added before named configuration in the IServiceCollection. This is to make it so the order of AddHttpClientDefaults and AddHttpClient doesn't matter. Default config is always applied first, then named config is applied after. This is done by wrapping the IServiceCollection in an implementation that modifies the order that IConfigureOptions<HttpClientFactoryOptions> values are added.

@ghost

Copy link
Copy Markdown

Note regarding the new-api-needs-documentation label:

This serves as a reminder for when your PR is modifying a ref *.cs file and adding/modifying public APIs, please make sure the API implementation in the src *.cs file is documented with triple slash comments, so the PR reviewers can sign off that change.

@ghost

Copy link
Copy Markdown

Tagging subscribers to this area: @dotnet/ncl
See info in area-owners.md if you want to be subscribed.

Issue Details

Fixes #87914

The AddHttpClientDefaults method supports adding configuration to all created HttpClients.

The method:

  • Creates a builder with a null name. Microsoft.Extensions.Configuration automatically applies configuration with a null name to all named configuration.
  • Ensures that default configuration is added before named configuration in the IServiceCollection. This is to make it so the order of AddHttpClientDefaults and AddHttpClient doesn't matter. Default config is always applied first, then named config is applied after. This is done by wrapping the IServiceCollection in an implementation that modifies the order that IConfigureOptions<HttpClientFactoryOptions> values are added.
Author:JamesNK
Assignees:-
Labels:

area-Extensions-HttpClientFactory

Milestone:-

@davidfowl

Copy link
Copy Markdown
Member

Ensures that default configuration is added before named configuration in the IServiceCollection. This is to make it so the order of AddHttpClientDefaults and AddHttpClient doesn't matter. Default config is always applied first, then named config is applied after. This is done by wrapping the IServiceCollection in an implementation that modifies the order that IConfigureOptions values are added.

This feels pretty bad.

@JamesNK

JamesNK commented Jun 23, 2023

Copy link
Copy Markdown
MemberAuthor

@noahfalk@joperezr@geeknoid@davidfowl

The AddHttpClientDefaults is designed to make it easy to apply configuration to all clients configured with AddHttpClient using one extension method on IHttpClientBuilder.

The goal is to avoid having two methods:

  • Add config to one builder - extension method on IHttpClientBuilder.
  • Add config to all builders - extension method on IServiceCollection.

For example, methods in dotnet/extensions below will no longer be needed:

https://github.com/dotnet/extensions/blob/52ebc1b123613254f9dfe250515027c1332fba35/src/Libraries/Microsoft.Extensions.Http.Telemetry/Logging/HttpClientLoggingExtensions.cs#L31-L122

It will be possible to do:

// Add HttpClientLogging to all clients.services.AddHttpClientDefaults().AddHttpClientLogging();// Is configured with HttpClientLogging from the defaults.services.AddHttpClient();

@davidfowl

davidfowl commented Jun 23, 2023

Copy link
Copy Markdown
Member

I've also been thinking about an API like this and was hoping we could add an overload to AddHttpClient so it wasnt 2 different calls.

services.AddHttpClient(IHttpClientBuilder clientBuilder =>{clientBuilder.AddHttpMessageHandler<MyAuthHandler>();});

@JamesNK

Copy link
Copy Markdown
MemberAuthor

Ensures that default configuration is added before named configuration in the IServiceCollection. This is to make it so the order of AddHttpClientDefaults and AddHttpClient doesn't matter. Default config is always applied first, then named config is applied after. This is done by wrapping the IServiceCollection in an implementation that modifies the order that IConfigureOptions values are added.

This feels pretty bad.

It's not the best, but it works well. It hits these important requirements:

  • AddHttpClientDefaults config is overridden by named client configuration.
  • The order AddHttpClientDefaults and AddHttpClient are called doesn't matter. Named client configuration always wins.
  • It automatically works for people who have written their own IHttpClientBuilder extension methods that call services.Configure<HttpClientFactoryOptions>(...).

The extra logic is only applied to IOptionsConfiguration<HttpClientFactoryOptions> to ensure they have the right order. It won't interfere with or break other DI extension methods.

@geeknoid

Copy link
Copy Markdown
Member

@dpk83 FYI

@dpk83

Copy link
Copy Markdown

@xakep139

@stephentoub

Copy link
Copy Markdown
Member

Let's please agree on the API via discussion on the issue and API review before opening PRs. I spoke with @CarnaViire at length about this and other related APIs yesterday and I know she was going to be following up with you.

@JamesNK
JamesNK marked this pull request as draft June 23, 2023 11:49
@CarnaViire
CarnaViire marked this pull request as ready for review July 12, 2023 21:39

@CarnaViireCarnaViire left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM for @JamesNK 's changes

@CarnaViire

Copy link
Copy Markdown
Member

@dotnet/ncl can someone pls review as well? Since I've taken over the PR.

@CarnaViire
CarnaViire requested a review from a teamJuly 12, 2023 21:56
@CarnaViireCarnaViire self-assigned this Jul 12, 2023

@ManickaPManickaP left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@CarnaViire changes LGTM.

@lewing

Copy link
Copy Markdown
Member

This change appears to be breaking flow into aspnetcore in dotnet/aspnetcore#49433

@joperezr

Copy link
Copy Markdown
Member

@CarnaViire can you please take a look?

@CarnaViire

Copy link
Copy Markdown
Member

I've pushed the fix to the branch dotnet/aspnetcore#49433

@ghostghost locked as resolved and limited conversation to collaborators Aug 17, 2023
@davidfowl

Copy link
Copy Markdown
Member

So we have a problem here. I tried to use ConfigureHttpClientDefaults and noticed it isn't an extension method in the reference assembly.

@joperezr

Copy link
Copy Markdown
Member

Can you elaborate? This change seems to suggest that the reference assembly was edited and that the extension was properly added: https://github.com/dotnet/runtime/pull/87953/files#diff-06e422c9663ed696b723dc56832cbdb53b9f9c3e6d0a98e52a1cb081b7c9dc7aR50

@karelz

Copy link
Copy Markdown
Member

@joperezr the this is missing -- see #90911 which David filed and which was just fixed :)

@joperezr

Copy link
Copy Markdown
Member

Oh, completely missed it! Good catch @davidfowl and thanks for the quick fix 😃

Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[API Proposal] ConfigureHttpClientDefaults for HttpClientFactory

11 participants

@JamesNK@davidfowl@geeknoid@dpk83@stephentoub@CarnaViire@lewing@joperezr@karelz@xakep139@ManickaP