Diff @actions/http-client changes #1064
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
fix failing http-client tests npm run lint-fix Simple manual fixes for lint rules Silence some linter errors Silence some linter warnings, but not "explicit any" Silence @typescript-eslint/no-explicit-any fix @typescript-eslint/no-non-null-assertion fix npm audit for http-client don't use I- prefix on interface names Get rid of `any` type in `Headers` Add http-client to the main README Update release notes
brcrista
force-pushed
the
brcrista/http-client
branch
from
ff7f186
to
f300e2c
Compare
brcrista
commented
Apr 28, 2022
| let response: HttpClientResponse | ||
| while (numTries < maxTries) { | ||
| let response: HttpClientResponse | undefined | ||
| do { |
There was a problem hiding this comment.
Switched to a do-while loop so the compiler knows we don't return undefined. In the previous logic, the loop should always execute at least once, but technically it could execute 0 times if someone passed a RequestOptions with maxRetries set to a negative number.
brcrista
commented
Apr 28, 2022
| export interface IHeaders { | ||
| [key: string]: any | ||
| export interface Headers { | ||
| [header: string]: string |
There was a problem hiding this comment.
I looked at existing usage in http-client and other toolkit packages and we always use string values for headers. Node's http module tends to use string | string[] | undefined for header values, but that would have required more code changes to handle where headers are consumed in http-client.
brcrista
commented
Apr 28, 2022
Comment on lines
-46
to
+49
| canHandleAuthentication(response: ifm.IHttpClientResponse): boolean { | ||
| canHandleAuthentication(): boolean { |
There was a problem hiding this comment.
The linter errors on unused parameters. TypeScript still considers this as implementing the interface method.
brcrista
commented
Apr 28, 2022
| import https = require('https') | ||
| import ifm = require('./interfaces') | ||
| import pm = require('./proxy') | ||
| /* eslint-disable @typescript-eslint/no-explicit-any */ |
There was a problem hiding this comment.
There were a lot of any's in this file and I didn't want to spend time eliminating all of them if it's already tested.
brcrista
commented
Apr 29, 2022
Comment on lines
-3
to
-5
| export interface IHeaders { | ||
| [key: string]: any | ||
| } |
There was a problem hiding this comment.
Deleting this in favor of the standard http.OutgoingHttpHeaders.
brcrista
commented
Apr 29, 2022
Comment on lines
-68
to
-70
| export interface IHttpClientResponse { | ||
| message: http.IncomingMessage | ||
| readBody(): Promise<string> |
There was a problem hiding this comment.
We already have the HttpClientResponse class. We were using this interface for creating mocks in testing. You don't need that in TypeScript because of duck typing.
brcrista
added a commit
that referenced
this pull request
May 3, 2022
💡 See #1064 for a better diff! https://github.com/actions/toolkit contains a variety of packages used for building actions. https://github.com/actions/http-client is one such package, but lives outside of the toolkit. Moving it inside of the toolkit will improve discoverability and reduce the number of repos we have to keep track of for maintenance tasks (such as github/c2c-actions-service#2937). I checked with @bryanmacfarlane on the historical decision here. Apparently it was just inertia from before we released the toolkit as multiple packages. The benefits here are: - Have one fewer repo to keep track of - Signal that this is an HTTP client meant for building actions, not for general use. ## Notes - `@actions/http-client` will continue to be released as its own package. - Bumping the package version to **2.0.0**. Since we're compiling in strict mode now, there are some breaking changes to the exported types. This is an improvement because the null-unsafe version of`http-client` is currently breaking the safety of null-safe consumers. - I'm not updating the other packages to use the new version in this PR. I plan to do that in a follow-up. We'll hold off on publishing `http-client` v2 to NPM until that's done just in case other changes shake out of it.
worldlight425
added a commit
to worldlight425/toolkit
that referenced
this pull request
Feb 22, 2023
💡 See actions/toolkit#1064 for a better diff! https://github.com/actions/toolkit contains a variety of packages used for building actions. https://github.com/actions/http-client is one such package, but lives outside of the toolkit. Moving it inside of the toolkit will improve discoverability and reduce the number of repos we have to keep track of for maintenance tasks (such as github/c2c-actions-service#2937). I checked with @bryanmacfarlane on the historical decision here. Apparently it was just inertia from before we released the toolkit as multiple packages. The benefits here are: - Have one fewer repo to keep track of - Signal that this is an HTTP client meant for building actions, not for general use. ## Notes - `@actions/http-client` will continue to be released as its own package. - Bumping the package version to **2.0.0**. Since we're compiling in strict mode now, there are some breaking changes to the exported types. This is an improvement because the null-unsafe version of`http-client` is currently breaking the safety of null-safe consumers. - I'm not updating the other packages to use the new version in this PR. I plan to do that in a follow-up. We'll hold off on publishing `http-client` v2 to NPM until that's done just in case other changes shake out of it.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Note: the base branch for this PR is
brcrista/http-client-diff, notmain. This is a branch I created just from copying over the files from https://github.com/actions/http-client without any changes.The purpose of this PR is to highlight the changes I had to make to get
@actions/http-clientbuilding along with toolkit. See #1062 for the actual PR to the mainline.The biggest change is having to update some exported types in
http-clientto get it to build withstrict. For example, null checking is now enforced. While there are more involved ways to clean this up (for example, to eliminate the possibility of returning nulls), I tried just to describe the current state of things without making any changes to behavior.There are also many minor changes to satisfy linting rules.