fix(@octokit/request-error) Fixes depreciation error when accessing error.headers #2064

daltonscharff · 2021-08-27T21:08:47Z

What Changed

Updated @octokit/plugin-enterprise-compatibility to version 1.3.0 and modified the way error headers are accessed accordingly.

Why

A depreciation warning was being thrown by @octokit/request-error.

$ auto version
Deprecation: [@octokit/request-error] `error.headers` is deprecated, use `error.response.headers`.
    at RequestError.get (/Users/dalton.scharff/dev/auto-package-deployment-test/node_modules/@octokit/request-error/dist-node/index.js:64:24)
    at /Users/dalton.scharff/dev/auto-package-deployment-test/node_modules/@auto-it/core/dist/git.js:93:49
    at /Users/dalton.scharff/dev/auto-package-deployment-test/node_modules/before-after-hook/lib/add.js:37:18
    at runNextTicks (internal/process/task_queues.js:60:5)
    at listOnTimeout (internal/timers.js:526:9)
    at processTimers (internal/timers.js:500:7)
    at async Git.getCommit (/Users/dalton.scharff/dev/auto-package-deployment-test/node_modules/@auto-it/core/dist/git.js:204:26)
    at async Release.attachAuthor (/Users/dalton.scharff/dev/auto-package-deployment-test/node_modules/@auto-it/core/dist/release.js:382:34)

Issue 2049

Todo:

Add tests
Add docs

Change Type

Indicate the type of change your pull request is:

documentation
patch
minor
major

🐤 Download canary assets:

auto-linux--canary.2064.25372.gz
auto-macos--canary.2064.25372.gz
auto-win.exe--canary.2064.25372.gz

📦 Published PR as canary version: under canary scope @auto-canary@10.33.0--canary.2064.25372.0

✨ Test out this PR locally via:

npm install @auto-canary/bot-list@10.33.0--canary.2064.25372.0
npm install @auto-canary/auto@10.33.0--canary.2064.25372.0
npm install @auto-canary/core@10.33.0--canary.2064.25372.0
npm install @auto-canary/package-json-utils@10.33.0--canary.2064.25372.0
npm install @auto-canary/all-contributors@10.33.0--canary.2064.25372.0
npm install @auto-canary/brew@10.33.0--canary.2064.25372.0
npm install @auto-canary/chrome@10.33.0--canary.2064.25372.0
npm install @auto-canary/cocoapods@10.33.0--canary.2064.25372.0
npm install @auto-canary/conventional-commits@10.33.0--canary.2064.25372.0
npm install @auto-canary/crates@10.33.0--canary.2064.25372.0
npm install @auto-canary/docker@10.33.0--canary.2064.25372.0
npm install @auto-canary/exec@10.33.0--canary.2064.25372.0
npm install @auto-canary/first-time-contributor@10.33.0--canary.2064.25372.0
npm install @auto-canary/gem@10.33.0--canary.2064.25372.0
npm install @auto-canary/gh-pages@10.33.0--canary.2064.25372.0
npm install @auto-canary/git-tag@10.33.0--canary.2064.25372.0
npm install @auto-canary/gradle@10.33.0--canary.2064.25372.0
npm install @auto-canary/jira@10.33.0--canary.2064.25372.0
npm install @auto-canary/magic-zero@10.33.0--canary.2064.25372.0
npm install @auto-canary/maven@10.33.0--canary.2064.25372.0
npm install @auto-canary/microsoft-teams@10.33.0--canary.2064.25372.0
npm install @auto-canary/npm@10.33.0--canary.2064.25372.0
npm install @auto-canary/omit-commits@10.33.0--canary.2064.25372.0
npm install @auto-canary/omit-release-notes@10.33.0--canary.2064.25372.0
npm install @auto-canary/pr-body-labels@10.33.0--canary.2064.25372.0
npm install @auto-canary/released@10.33.0--canary.2064.25372.0
npm install @auto-canary/s3@10.33.0--canary.2064.25372.0
npm install @auto-canary/sbt@10.33.0--canary.2064.25372.0
npm install @auto-canary/slack@10.33.0--canary.2064.25372.0
npm install @auto-canary/twitter@10.33.0--canary.2064.25372.0
npm install @auto-canary/upload-assets@10.33.0--canary.2064.25372.0
npm install @auto-canary/vscode@10.33.0--canary.2064.25372.0
# or 
yarn add @auto-canary/bot-list@10.33.0--canary.2064.25372.0
yarn add @auto-canary/auto@10.33.0--canary.2064.25372.0
yarn add @auto-canary/core@10.33.0--canary.2064.25372.0
yarn add @auto-canary/package-json-utils@10.33.0--canary.2064.25372.0
yarn add @auto-canary/all-contributors@10.33.0--canary.2064.25372.0
yarn add @auto-canary/brew@10.33.0--canary.2064.25372.0
yarn add @auto-canary/chrome@10.33.0--canary.2064.25372.0
yarn add @auto-canary/cocoapods@10.33.0--canary.2064.25372.0
yarn add @auto-canary/conventional-commits@10.33.0--canary.2064.25372.0
yarn add @auto-canary/crates@10.33.0--canary.2064.25372.0
yarn add @auto-canary/docker@10.33.0--canary.2064.25372.0
yarn add @auto-canary/exec@10.33.0--canary.2064.25372.0
yarn add @auto-canary/first-time-contributor@10.33.0--canary.2064.25372.0
yarn add @auto-canary/gem@10.33.0--canary.2064.25372.0
yarn add @auto-canary/gh-pages@10.33.0--canary.2064.25372.0
yarn add @auto-canary/git-tag@10.33.0--canary.2064.25372.0
yarn add @auto-canary/gradle@10.33.0--canary.2064.25372.0
yarn add @auto-canary/jira@10.33.0--canary.2064.25372.0
yarn add @auto-canary/magic-zero@10.33.0--canary.2064.25372.0
yarn add @auto-canary/maven@10.33.0--canary.2064.25372.0
yarn add @auto-canary/microsoft-teams@10.33.0--canary.2064.25372.0
yarn add @auto-canary/npm@10.33.0--canary.2064.25372.0
yarn add @auto-canary/omit-commits@10.33.0--canary.2064.25372.0
yarn add @auto-canary/omit-release-notes@10.33.0--canary.2064.25372.0
yarn add @auto-canary/pr-body-labels@10.33.0--canary.2064.25372.0
yarn add @auto-canary/released@10.33.0--canary.2064.25372.0
yarn add @auto-canary/s3@10.33.0--canary.2064.25372.0
yarn add @auto-canary/sbt@10.33.0--canary.2064.25372.0
yarn add @auto-canary/slack@10.33.0--canary.2064.25372.0
yarn add @auto-canary/twitter@10.33.0--canary.2064.25372.0
yarn add @auto-canary/upload-assets@10.33.0--canary.2064.25372.0
yarn add @auto-canary/vscode@10.33.0--canary.2064.25372.0

… modifies error headers accordingly

reintroducing · 2021-10-30T13:25:02Z

Any chance of getting the above PR merged in?

sam-frampton · 2021-12-29T16:55:42Z

+1 on getting this PR merged sometime soon

hipstersmoothie · 2022-01-11T16:59:07Z

Can you fix lint and update the PR?

codecov · 2022-01-11T17:50:45Z

Codecov Report

Merging #2064 (aad6559) into main (11021fa) will decrease coverage by 0.01%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main    #2064      +/-   ##
==========================================
- Coverage   80.19%   80.17%   -0.02%     
==========================================
  Files          66       66              
  Lines        5413     5413              
  Branches     1263     1263              
==========================================
- Hits         4341     4340       -1     
- Misses        709      710       +1     
  Partials      363      363

Impacted Files	Coverage Δ
packages/core/src/git.ts	`87.25% <0.00%> (-0.28%)`	⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 59b42d6...aad6559. Read the comment docs.

matheusslg · 2022-01-27T18:33:19Z

Any update?

daltonscharff · 2022-02-10T21:39:44Z

I'm not sure how to get past this Codecov check. There's no longer any change to the git.ts file, but I'm still getting blocked.

intuit-svc · 2022-03-04T21:09:04Z

🚀 PR was released in v10.33.0 🚀

npvisual · 2022-04-14T23:15:43Z

Note : I don't think that has been addressed as I am still seeing it in 10.36.5.

Is it possible to re-open the issue ?

The current warning is identical to the warning reported above.

% yarn --silent auto version
Deprecation: [@octokit/request-error] `error.headers` is deprecated, use `error.response.headers`.
    at RequestError.get (/Users/nicolasphilippe/Mperativ/GitHub/auto/node_modules/@octokit/core/node_modules/@octokit/request/node_modules/@octokit/request-error/dist-src/index.js:50:32)
    at /Users/nicolasphilippe/Mperativ/GitHub/auto/packages/core/src/git.ts:171:24
    at /Users/nicolasphilippe/Mperativ/GitHub/auto/node_modules/before-after-hook/lib/add.js:37:18
    at Git.getUserByUsername (/Users/nicolasphilippe/Mperativ/GitHub/auto/packages/core/src/git.ts:480:20)
minor

% yarn list --pattern auto
yarn list v1.22.18
warning package.json: No license field
warning No license field
├─ @auto-it/all-contributors@10.36.5
├─ @auto-it/bot-list@10.36.5
├─ @auto-it/core@10.36.5
├─ @auto-it/first-time-contributor@10.36.5
├─ @auto-it/git-tag@10.36.5
├─ @auto-it/magic-zero@10.36.5
├─ @auto-it/npm@10.36.5
├─ @auto-it/package-json-utils@10.36.5
├─ @auto-it/released@10.36.5
├─ @auto-it/slack@10.36.5
├─ @auto-it/upload-assets@10.36.5
└─ auto@10.36.5
✨  Done in 0.25s.

The problem seems to come from this statement in git.ts, since commenting that out will remove the warning :

    this.github.hook.error("request", (error) => {
      if (error) {
        // narrow down the type
        if ("headers" in error && error.request.headers.authorization) {
          delete error.request.headers.authorization;
          delete error.headers.authorization;                <-------- error.headers deprecated
        }
      }

The PR doesn't seem to modify this file at all.

I am not totally sure what the best course of action is here so please @hipstersmoothie advise.

updates @octokit/plugin-enterprise-compatibility to version 1.3.0 and…

0e026dc

… modifies error headers accordingly

adierkens added the minor Increment the minor version when merged label Aug 27, 2021

hipstersmoothie added patch Increment the patch version when merged and removed minor Increment the minor version when merged labels Jan 11, 2022

Dalton Scharff and others added 3 commits January 11, 2022 11:36

uses optional chain expression to fix lintng error

bc427bc

Merge branch 'main' into daltonscharff/change-git-error-header

6c9ab85

Merge branch 'main' into daltonscharff/change-git-error-header

0cd7854

adierkens added the minor Increment the minor version when merged label Jan 11, 2022

removes linting changes

aad6559

hipstersmoothie removed the minor Increment the minor version when merged label Mar 4, 2022

hipstersmoothie merged commit 837aa6a into intuit:main Mar 4, 2022

intuit-svc added the released This issue/pull request has been released. label Mar 4, 2022

daltonscharff deleted the daltonscharff/change-git-error-header branch April 5, 2022 00:33

npvisual mentioned this pull request Apr 15, 2022

Deprecation: [@octokit/request-error] error.headers is deprecated, use error.response.headers. #2049

Closed

poloagustin mentioned this pull request May 11, 2022

fix(git): #2049 removes the use of deprecated error.headers #2202

Merged

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(@octokit/request-error) Fixes depreciation error when accessing error.headers #2064

fix(@octokit/request-error) Fixes depreciation error when accessing error.headers #2064

daltonscharff commented Aug 27, 2021 •

edited by hipstersmoothie

reintroducing commented Oct 30, 2021

sam-frampton commented Dec 29, 2021

hipstersmoothie commented Jan 11, 2022

codecov bot commented Jan 11, 2022 •

edited

matheusslg commented Jan 27, 2022

daltonscharff commented Feb 10, 2022

intuit-svc commented Mar 4, 2022

npvisual commented Apr 14, 2022

fix(@octokit/request-error) Fixes depreciation error when accessing error.headers #2064

fix(@octokit/request-error) Fixes depreciation error when accessing error.headers #2064

Conversation

daltonscharff commented Aug 27, 2021 • edited by hipstersmoothie

What Changed

Why

Change Type

reintroducing commented Oct 30, 2021

sam-frampton commented Dec 29, 2021

hipstersmoothie commented Jan 11, 2022

codecov bot commented Jan 11, 2022 • edited

Codecov Report

matheusslg commented Jan 27, 2022

daltonscharff commented Feb 10, 2022

intuit-svc commented Mar 4, 2022

npvisual commented Apr 14, 2022

daltonscharff commented Aug 27, 2021 •

edited by hipstersmoothie

codecov bot commented Jan 11, 2022 •

edited