Skip to content

feat: v8 #599

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 15 commits into from
Jul 7, 2023
Merged

feat: v8 #599

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
2785a42
Breakinging change: stop passing objects to fetch in the fetch-wrapper
nickfloyd Jun 29, 2023
8a4f452
passes requestOptions through and making it optional
nickfloyd Jun 29, 2023
74d9b7c
updates types - actual octokit/types version will be v11.x
nickfloyd Jun 30, 2023
0592ad9
removes the default on the options parameter some of the options allo…
nickfloyd Jun 30, 2023
4ed1770
puts options.method docs back in
nickfloyd Jul 5, 2023
45f086b
Previews are only for GraphQL
kfcampbell Jul 6, 2023
035d865
Update README.md
kfcampbell Jul 6, 2023
35a84c6
Explicitly pass signal but no other request options
kfcampbell Jul 7, 2023
f174105
Add method, body, headers
kfcampbell Jul 7, 2023
f348708
Merge branch 'main' into beta. Use Object.assign to pass through data
kfcampbell Jul 7, 2023
1cfdf79
npm run lint:fix
kfcampbell Jul 7, 2023
b4f0bcd
Do not use Object.assign
kfcampbell Jul 7, 2023
4a80c29
npm run lint:fix
kfcampbell Jul 7, 2023
54c25e6
Remove skipped test
kfcampbell Jul 7, 2023
98259f7
Bump types version to v11
kfcampbell Jul 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 9 additions & 20 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -245,35 +245,35 @@ const { data: app } = await requestWithAuth(
</tr>
<tr>
<th align=left>
<code>options.mediaType.format</code>
<code>options.method</code>
</th>
<td>
String
</td>
<td>
Media type param, such as `raw`, `html`, or `full`. See <a href="https://developer.github.com/v3/media/">Media Types</a>.
Any supported <a href="https://developer.github.com/v3/#http-verbs">http verb</a>, case insensitive. <em>Defaults to <code>Get</code></em>.
</td>
</tr>
<tr>
<th align=left>
<code>options.mediaType.previews</code>
<code>options.mediaType.format</code>
</th>
<td>
Array of strings
String
</td>
<td>
Name of previews, such as `mercy`, `symmetra`, or `scarlet-witch`. See <a href="https://developer.github.com/v3/previews/">API Previews</a>.
Media type param, such as `raw`, `html`, or `full`. See <a href="https://developer.github.com/v3/media/">Media Types</a>.
</td>
</tr>
<tr>
<th align=left>
<code>options.method</code>
<code>options.mediaType.previews</code>
</th>
<td>
String
Array of strings
</td>
<td>
Any supported <a href="https://developer.github.com/v3/#http-verbs">http verb</a>, case insensitive. <em>Defaults to <code>Get</code></em>.
Name of previews, such as `mercy`, `symmetra`, or `scarlet-witch`. See <a href="https://developer.github.com/v3/previews/">API Previews</a>.
</td>
</tr>
<tr>
Expand All @@ -299,18 +299,7 @@ const { data: app } = await requestWithAuth(
Set request body directly instead of setting it to JSON based on additional parameters. See <a href="#data-parameter">"The `data` parameter"</a> below.
</td>
</tr>
<tr>
<th align=left>
<a name="options-request-agent"></a>
<code>options.request.agent</code>
</th>
<td>
<a href="https://nodejs.org/api/http.html#http_class_http_agent">http(s).Agent</a> instance
</td>
<td>
Node only. Useful for custom proxy, certificate, or dns lookup.
</td>
</tr>

<tr>
<th align=left>
<code>options.request.fetch</code>
Expand Down
24 changes: 20 additions & 4 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
"dependencies": {
"@octokit/endpoint": "^8.0.1",
"@octokit/request-error": "^4.0.1",
"@octokit/types": "^10.0.0",
"@octokit/types": "^10.1.0-beta.1",
"is-plain-object": "^5.0.0",
"universal-user-agent": "^6.0.0"
},
Expand Down
18 changes: 1 addition & 17 deletions src/fetch-wrapper.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,23 +36,7 @@ export default function fetchWrapper(
);
}

return fetch(
requestOptions.url,
Object.assign(
{
method: requestOptions.method,
body: requestOptions.body,
headers: requestOptions.headers as HeadersInit,
redirect: requestOptions.redirect,
// duplex must be set if request.body is ReadableStream or Async Iterables.
// See https://fetch.spec.whatwg.org/#dom-requestinit-duplex.
...(requestOptions.body && { duplex: "half" }),
},
// `requestOptions.request.agent` type is incompatible
// see https://github.com/octokit/types.ts/pull/264
requestOptions.request as any
)
)
return fetch(requestOptions.url, requestOptions as any)
.then(async (response) => {
url = response.url;
status = response.status;
Expand Down
3 changes: 2 additions & 1 deletion test/request.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -561,7 +561,8 @@ x//0u+zd/R/QRUzLOw4N72/Hu+UG6MNt5iDZFCtapRaKt6OvSBwy8w==
);
});

it("options.request.signal is passed as option to fetch", function () {
//TODO: figure out the expected behavior
it.skip("options.request.signal is passed as option to fetch", function () {
Copy link
Member

Choose a reason for hiding this comment

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

Linking docs for the signal option for clearer context: https://developer.mozilla.org/en-US/docs/Web/API/fetch#signal

This test seems like a sanity check to make sure the option is passed along by passing a value that isn't the expected type and checking if it throws an error

Example:

> fetch("https://example.com",{signal:"bar"})
Promise {
  <pending>,
  [Symbol(async_id_symbol)]: 294,
  [Symbol(trigger_async_id_symbol)]: 5
}
> Uncaught:
TypeError: Failed to construct 'Request': member signal is not of type AbortSignal.
    at Object.fetch (node:internal/deps/undici/undici:11457:11)
    at process.processTicksAndRejections (node:internal/process/task_queues:95:5)

Copy link
Member

Choose a reason for hiding this comment

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

In that case, with these breaking changes, should this test be removed? If we're expecting the caller to bring their own fetch, perhaps we shouldn't test on the internals of those options.

Copy link
Member

Choose a reason for hiding this comment

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

It seems that this is the only test that checks if the options were properly passed along.

I think it should be fine to remove it

return request("/", {
request: {
// We pass a value that is not an `AbortSignal`, and expect `fetch` to
Expand Down