fix(deps): update octokit monorepo (major) #513

renovate · 2023-07-07T18:31:34Z

This PR contains the following updates:

Package	Change	Age	Adoption	Passing	Confidence
@octokit/auth-action	`^3.0.0` -> `^4.0.0`
@octokit/core	`^4.0.0` -> `^5.0.0`
@octokit/plugin-paginate-rest	`^7.0.0` -> `^8.0.0`
@octokit/plugin-rest-endpoint-methods	`^8.0.0` -> `^9.0.0`
@octokit/types	`^10.0.0` -> `^11.0.0`

Release Notes

octokit/auth-action.js (@octokit/auth-action)

`v4.0.0`

Compare Source

chore

deps: update octokit monorepo (major) (#331) (b7432b0)

BREAKING CHANGES

deps: bump version of @octokit/types to v11

octokit/core.js (@octokit/core)

`v5.0.0`

Compare Source

Features

v5 (#563) (0b4ad1e)

BREAKING CHANGES

Drop support for NodeJS v14, v16
Remove previews support for the REST API
remove agent option from octokit.request()

octokit/plugin-paginate-rest.js (@octokit/plugin-paginate-rest)

`v8.0.0`

Compare Source

chore

deps: update octokit monorepo (major) (#541) (25c86b9)

BREAKING CHANGES

deps: Bump peerDependency of @octokit/core to v5
deps: Bump @octokit/types to v11

octokit/plugin-rest-endpoint-methods.js (@octokit/plugin-rest-endpoint-methods)

`v9.0.0`

Compare Source

Bug Fixes

deps: update octokit monorepo (major) (#658) (b1b6ad3)

BREAKING CHANGES

deps: require @octokit/core > 5
deps: bump @octokit/types to v11

octokit/types.ts (@octokit/types)

`v11.1.0`

Compare Source

Features

new parseSuccessResonseBody option for requests (#563) (f70144e)

`v11.0.0`

Compare Source

Features

v11 (#561) (2fc7576)

BREAKING CHANGES

Replace support for Node.js http(s) Agents with documentation on using fetch dispatchers instead

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

👻 Immortal: This PR will be recreated if closed unmerged. Get config help if that's undesired.

If you want to rebase/retry this PR, check this box

This PR has been generated by Mend Renovate. View repository job log here.

wolfy1339

Requires updates to dependencies first

nickfloyd · 2023-07-11T17:15:09Z

I'm working on the failing tests for this to unblock these dep updates.

nickfloyd

Skipped tests need to be fixed

nickfloyd · 2023-07-11T22:05:20Z

I ran into issues with how we mock fetch in the smoke tests, HttpProxyAgent and using something like undici. I need to read up on the APIs for that library to get a better idea of how to get this done properly. My code sandbox works fine but our fetch mocks do some heavy lifting so implementing this in tests always results in auth failure or something like it (see my scratch example below).

const { HttpProxyAgent } = require('https-proxy-agent');
const { Client } = require('undici');

async function main() {
  const proxyUrl = 'https://127.0.0.1';
  const targetUrl = '/repos/octocat/hello-world/issues';
  const agent = new HttpProxyAgent(proxyUrl);
  // Should be swapped with octokit.request w/ agent/dispatcher as an option
  const client = new Client(targetUrl, { agent });
  
  await client.request("POST /repos/{owner}/{repo}/issues", {
      owner: "octocat",
      repo: "hello-world",
      title: "My test issue",
  });
}

I am sure I am missing something obvious so If anyone else has a moment to take a look (@gr2m or @wolfy1339 or @oscard0m) I'd be glad for the additional 👀.

This is a blocker to getting https://github.com/octokit/request-action updated and out the door.

renovate · 2023-07-11T22:20:33Z

Edited/Blocked Notification

Renovate will not automatically rebase this PR, because it does not recognize the last commit author and assumes somebody else may have edited the PR.

You can manually request rebase by checking the rebase/retry box above.

⚠ Warning: custom changes will be lost.

wolfy1339 · 2023-07-11T22:30:56Z

The library used doesn't seem to be compatible with the Fetch API because it uses http.Agent from NodeJS

The fetch mock uses global.fetch which shouldn't be a problem as Node uses undici under the hood, the on;ly issue is the types aren't yet included in @types/node which is why we need to import undici's fetch method

The code will need to be updated, not just the tests

wolfy1339 · 2023-07-11T22:42:04Z

Also of interest, nodejs/undici#1650

…octokit/action.js into renovate/major-octokit-monorepo

package.json

test/smoke.test.ts

kfcampbell · 2023-07-13T22:25:13Z

The test coverage failures here don't seem to me to be helping us in this instance. My instinct would be to suggest modifying the coverage threshold to unblock wrapping the Node/fetch breaking changes. I'm receptive to other suggestions for testing and challenges to my perception that the uncovered code is related to undici and not worth our time to test.

wolfy1339 · 2023-07-13T22:27:28Z

It seems that the HTTP proxy isn't getting used at all in the tests 😓 hence the coverage issues

nickfloyd · 2023-07-14T14:45:27Z

It seems that the HTTP proxy isn't getting used at all in the tests 😓 hence the coverage issues

I'm digging in this morning to determine why... given the changes you proposed and the proxy tests all set the env, this should be working.

wolfy1339 · 2023-07-14T14:58:01Z

I did look into this some bit, and we override the custom fetch in the tests that is used in the production code. Since the custom fetch gets overridden the dispatcher option isn't set anymore

kfcampbell

@oscard0m @wolfy1339 @gr2m @nickfloyd I've made some changes here to fix the failing tests and increase our test coverage. Please take another look and let me know what should be changed!

src/index.ts

test/smoke.test.ts

kfcampbell · 2023-07-17T23:11:51Z

test/smoke.test.ts

+        },
+      );
+      await customFetch("http://api.github.com", {});
+      expect(JSON.stringify(dispatcher)).toEqual(JSON.stringify(expectedAgent));


I believe these JSON.stringify hacks are similar to the others present we've been seeing and can be cleaned up when octokit/core.js#588 is addressed.

This reverts commit 6458785 in order to increase code coverage.

nickfloyd

💥

kfcampbell · 2023-07-18T18:44:44Z

@wolfy1339 it looks like your review is required here due to the earlier request for changes. Do you mind taking another peek at this PR?

kfcampbell · 2023-07-18T19:07:09Z

I have two final points before merging I'd like to address:

Are we okay merging with @gr2m's PR'd version of fetch-mock as a dependency? Is there a plan to get back to the main tree in the future?
This PR is currently set up to be a minor version bump, which is maybe a bit suspect as we're passing in different options to the Octokit client now. Should this be a major version bump?

kfcampbell · 2023-07-18T20:05:19Z

I've talked with @nickfloyd a bit and we've decided to merge with the forked dependency and with a minor version bump as the interface hasn't had a breaking change.

github-actions · 2023-07-18T20:43:55Z

🎉 This PR is included in version 6.0.5 🎉

The release is available on:

Your semantic-release bot 📦🚀

gr2m · 2023-07-18T23:38:33Z

Are we okay merging with @gr2m's PR'd version of fetch-mock as a dependency? Is there a plan to get back to the main tree in the future?

Absolutely, unfortunately the pull request is still open 🤷🏼

I think it would also be worth to look into undici's request mocking solutions and see if we can use that as a better replacement to fetch-mock. I feel fetch-mock is not actively maintained any more for a while now

wolfy1339 · 2023-07-18T23:41:11Z

Undici's does offer a mocking solution built-in, however it require the use of dispatchers, which means we can't test things like HTTP(s) proxies as they require dispatchers as well

https://undici.nodejs.org/#/docs/best-practices/mocking-request

gr2m · 2023-07-18T23:48:49Z

we can't test things like HTTP(s) proxies

we already test proxies with a local server today without mocking requests. But yeah there could be other reasons that we cannot use it, but it's worth to explore it

gr2m · 2024-04-19T17:38:27Z

fyi nodejs/undici#1650, new release is still outstanding at this time.

renovate bot added the Type: Maintenance Any dependency, housekeeping, and clean up Issue or PR label Jul 7, 2023

wolfy1339 requested changes Jul 7, 2023

View reviewed changes

renovate bot changed the title ~~fix(deps): update dependency @octokit/types to v11~~ fix(deps): update octokit monorepo (major) Jul 7, 2023

renovate bot force-pushed the renovate/major-octokit-monorepo branch 2 times, most recently from 59bf9a8 to 2042b52 Compare July 10, 2023 20:35

fix(deps): update octokit monorepo

ce49779

renovate bot force-pushed the renovate/major-octokit-monorepo branch from 2042b52 to ce49779 Compare July 10, 2023 23:08

nickfloyd mentioned this pull request Jul 11, 2023

[MAINT]: Tracking issue for dropping support for Node v14/v16 and Fetch dispatch breaking changes octokit/octokit.js#2486

Closed

63 tasks

wolfy1339 added the Type: Breaking change Used to note any change that requires a major version bump label Jul 11, 2023

todo fix proxy test by replacing http agent/fetch mock with custom fetch

9a984f4

nickfloyd requested changes Jul 11, 2023

View reviewed changes

build: switch to @gr2m/fetch-mock

8d6afaa

nickfloyd mentioned this pull request Jul 12, 2023

Pass node-fetch as options.request.fetch to the Octokit constructor octokit/graphql-action#225

Closed

nickfloyd added 2 commits July 13, 2023 15:29

updates the plugin to use a custom fetch as suggested

b89fa45

Merge branch 'renovate/major-octokit-monorepo' of https://github.com/…

7f1f87a

…octokit/action.js into renovate/major-octokit-monorepo

wolfy1339 reviewed Jul 13, 2023

View reviewed changes

package.json Outdated Show resolved Hide resolved

nickfloyd added 2 commits July 13, 2023 15:52

moves undici to deps and removes https-proxy-agent

45937ec

Serialization issue as seen in core

a68deda

nickfloyd reviewed Jul 13, 2023

View reviewed changes

test/smoke.test.ts Show resolved Hide resolved

kfcampbell added 8 commits July 17, 2023 15:14

Use localhost for consistency

5f82b61

Remove extraneous console.log statements

f3821ab

Strongly type Server

b970c0d

Some test cleanup

b4dddca

WIP comment out spy

dd21769

Refactor customFetch tests to own describe block

dcd0341

Comment fix

3670f90

Remove redundant tests

ad90bcd

kfcampbell reviewed Jul 17, 2023

View reviewed changes

kfcampbell requested review from nickfloyd, wolfy1339 and oscard0m July 17, 2023 23:13

gr2m mentioned this pull request Jul 18, 2023

fix(deps): update dependency @octokit/action to v6 octokit/graphql-action#221

Merged

1 task

kfcampbell added 2 commits July 18, 2023 09:24

Remove unnecessary tests

6458785

Revert "Remove unnecessary tests"

2f41cd5

This reverts commit 6458785 in order to increase code coverage.

nickfloyd approved these changes Jul 18, 2023

View reviewed changes

nickfloyd requested review from kfcampbell and gr2m July 18, 2023 17:05

wolfy1339 approved these changes Jul 18, 2023

View reviewed changes

kfcampbell merged commit 3fd4ef6 into main Jul 18, 2023
7 checks passed

kfcampbell deleted the renovate/major-octokit-monorepo branch July 18, 2023 20:42

github-actions bot added the released label Jul 18, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(deps): update octokit monorepo (major) #513

fix(deps): update octokit monorepo (major) #513

renovate bot commented Jul 7, 2023 •

edited

Loading

wolfy1339 left a comment

nickfloyd commented Jul 11, 2023

nickfloyd left a comment

nickfloyd commented Jul 11, 2023

renovate bot commented Jul 11, 2023

wolfy1339 commented Jul 11, 2023

wolfy1339 commented Jul 11, 2023

kfcampbell commented Jul 13, 2023

wolfy1339 commented Jul 13, 2023

nickfloyd commented Jul 14, 2023

wolfy1339 commented Jul 14, 2023

kfcampbell left a comment

kfcampbell Jul 17, 2023

nickfloyd left a comment

kfcampbell commented Jul 18, 2023

kfcampbell commented Jul 18, 2023

kfcampbell commented Jul 18, 2023 •

edited

Loading

github-actions bot commented Jul 18, 2023

gr2m commented Jul 18, 2023

wolfy1339 commented Jul 18, 2023

gr2m commented Jul 18, 2023

gr2m commented Apr 19, 2024

fix(deps): update octokit monorepo (major) #513

fix(deps): update octokit monorepo (major) #513

Conversation

renovate bot commented Jul 7, 2023 • edited Loading

Release Notes

v4.0.0

chore

BREAKING CHANGES

v5.0.0

Features

BREAKING CHANGES

v8.0.0

chore

BREAKING CHANGES

v9.0.0

Bug Fixes

BREAKING CHANGES

v11.1.0

Features

v11.0.0

Features

BREAKING CHANGES

Configuration

wolfy1339 left a comment

Choose a reason for hiding this comment

nickfloyd commented Jul 11, 2023

nickfloyd left a comment

Choose a reason for hiding this comment

nickfloyd commented Jul 11, 2023

renovate bot commented Jul 11, 2023

Edited/Blocked Notification

wolfy1339 commented Jul 11, 2023

wolfy1339 commented Jul 11, 2023

kfcampbell commented Jul 13, 2023

wolfy1339 commented Jul 13, 2023

nickfloyd commented Jul 14, 2023

wolfy1339 commented Jul 14, 2023

kfcampbell left a comment

Choose a reason for hiding this comment

kfcampbell Jul 17, 2023

Choose a reason for hiding this comment

nickfloyd left a comment

Choose a reason for hiding this comment

kfcampbell commented Jul 18, 2023

kfcampbell commented Jul 18, 2023

kfcampbell commented Jul 18, 2023 • edited Loading

github-actions bot commented Jul 18, 2023

gr2m commented Jul 18, 2023

wolfy1339 commented Jul 18, 2023

gr2m commented Jul 18, 2023

gr2m commented Apr 19, 2024

renovate bot commented Jul 7, 2023 •

edited

Loading

`v4.0.0`

`v5.0.0`

`v8.0.0`

`v9.0.0`

`v11.1.0`

`v11.0.0`

kfcampbell commented Jul 18, 2023 •

edited

Loading