Replies: 2 comments 11 replies
-
|
You start out with const { Octokit } = require("@octokit/rest");
const { createAppAuth } = require("@octokit/auth-app");
const appOctokit = new Octokit({
authStrategy: createAppAuth,
auth: {
appId: 123,
privateKey: process.env.PRIVATE_KEY,
// optional: this will make appOctokit authenticate as app (JWT)
// or installation (access token), depending on the request URL
installationId: 123,
},
});
You can use any other auth plugin the same way, instead of using Here are the docs for |
Beta Was this translation helpful? Give feedback.
-
|
I did look into Personal Access Tokens (PAT) and eventually want to go down that road but I seem to recall over a year ago they can use the same type? Would the combined one (the first one) be better for that? |
Beta Was this translation helpful? Give feedback.
-
|
I don't think you want Personal Access Tokens. Those are for individuals and not apps. |
Beta Was this translation helpful? Give feedback.
-
|
Maybe @gr2m can give more insight here |
Beta Was this translation helpful? Give feedback.
-
|
My thoughts were if our accounts that have GitHub as a strategy were to have their own rate/limiting maximums by using their own authorizations it would increase what they could do for scalability of the site. Right now we're pretty small so OAuth only (with our limits) could do for now and is what we currently use with the old github package. For some reason the original contributor starts our app out with the github authorization... I commented that out and then all the sudden I couldn't log into the site (the callback hung from GH)... also may have hit the "brown out" period earlier too but have to run tests on migrations for a few days so that should avoid those periods. There's another one scheduled later today so won't be twiddling at those times. 😸 |
Beta Was this translation helpful? Give feedback.
-
|
Hmmm... I tried using a test https://www.npmjs.com/package/@octokit/rest with https://github.com/octokit/auth-oauth-app.js and it throws a rejection saying that I need to use https://www.npmjs.com/package/@octokit/auth-oauth-user (node:12815) UnhandledPromiseRejectionWarning: Error: [@octokit/auth-oauth-app] "GET /users/{username}/repos" does not support clientId/clientSecret basic authentication. Use @octokit/auth-oauth-user instead.With our sites clientId and clientSecret is when this happens when I list my own repos with If I use https://www.npmjs.com/package/@octokit/auth-oauth-user then the initialization of the Octokit constructor says I need a |
Beta Was this translation helpful? Give feedback.
-
tl;dr - try thisconst { Octokit } = require("@octokit/core");
const { paginateRest } = require("@octokit/plugin-paginate-rest");
const MyOctokit = Octokit.plugin(paginateRest).defaults({ userAgent: "my-app-name" });
const oauthToken = Buffer.from([process.env.CLIENT_ID, process.env.CLIENT_SECRET].join(':')).toString('base64')
const octokit = new MyOctokit({ auth: `basic ${oauthToken}` });
octokit.paginate("GET /users/{username}/repos", { username: "Martii" }).then(repositories => {
console.log("%d repositories found", repositories.length)
})
😱Wow, that's been ... a while
The authentication strategies such as There were a ton of changes to REST API the methods since the What I would suggest is to migrate to The benefit is that the REST API endpoints barely change. You get full TypeScript support, too, the same as using the REST API methods:
It looks like you use endpoints that paginate, in that case I would recommend to use the paginate plugin:
I think this is actually a bug. When using with an OAuth App, it should set the apps clientId/clientSecret as basic authentication in order to bump the rate limit. I'll create a follow up issue to look into that. I've recently split up For the time being, can you try this const oauthToken = Buffer.from([process.env.CLIENT_ID, process.env.CLIENT_SECRET].join(':')).toString('base64')
const octokit = new Octokit({
auth: `basic ${oauthToken}`,
});That should work, I didn't test it though.
This is the code you get from the OAuth web flow, as you found out. This code expires quickly, there is no use in storing it, it's meant to be exchanged immediately for an OAuth user access token, which is what |
Beta Was this translation helpful? Give feedback.
-
That's because this dependency has been quite volatile and when I see the semver major going up like a slot machine on crack I usually avoid updating... but I'm here now, by force (May the 5th be with you too) 🙄
Yah but migration, with constant change, is the way of JavaScript... everyone is never happy with something that works well already. 😸
Well I'm kind of needing the request logger portion of @octokit/rest... just found it in the github package and it was nice to verify that requests to the API were indeed authenticated vs when they were not. Not entirely sure what the legacy REST endpoint ones are in @octokit/rest but I'm sure I'll find out. So I'm leaning towards @octokit/rest rather than learning about the plugin initialization. Plus it already has the pagination plugin built in. I'll just assume @octokit/rest is equivalent to a meta package until told differently.
Bugs happen. 😸 No problem... we'll wait.
const oauthToken = Buffer.from([process.env.CLIENT_ID, process.env.CLIENT_SECRET].join(':')).toString('base64')
const octokit = new Octokit({
auth: `basic ${oauthToken}`,
});Thanks and will do... but need slumber first so I don't pull all my remaining hair out in one shot... we have something similar but didn't find out until moments ago that the code that was modified was unreachable. but whilst I'm away if you get a moment please... I've been hunting for an alternate construction of Octokit... we don't use environment variables and we utilize a DB lookup for credentials. So every example I've seen, including here, uses environment variables. We won't be doing that... so we really need a way to create the Octokit instance, then authorize it after a DB lookup and then send it on it's module exports way. Since I haven't seen anything even remotely like this anywhere... how is this done please? ❓ Link that I haven't found in the last few years? ❓ I do see the .ts comments at https://github.com/octokit/core.js/blob/ 1.) Looks familiar with https://github.com/octokit/auth-oauth-app.js with the |
Beta Was this translation helpful? Give feedback.
-
Verbatim TestCODE: const { Octokit } = require("@octokit/core");
const { paginateRest } = require("@octokit/plugin-paginate-rest");
const MyOctokit = Octokit.plugin(paginateRest).defaults({ userAgent: "my-app-name" });
const oauthToken = Buffer.from([process.env.CLIENT_ID, process.env.CLIENT_SECRET].join(':')).toString('base64')
const octokit = new MyOctokit({ auth: `basic ${oauthToken}` });
octokit.paginate("GET /users/{username}/repos", { username: "Martii" }).then(repositories => {
console.log("%d repositories found", repositories.length)
})RESULT: (async function () {
^
TypeError: octokit.paginate(...).then(...) is not a functionCOMMENT(S): Modified testCODE: (We're partially limited to ES5.1 btw but syntactically the same... that's another issue atm) var Octokit = require("@octokit/rest").Octokit;
var clientId = 'Can not post this publicly but it is accurate';
var clientSecret = 'Can not post this publicly but it is accurate';
var oauthToken = Buffer.from([`${clientId}`, `${clientSecret}`].join(':')).toString('base64');
var test = new Octokit({
auth: `basic ${oauthToken}`
});
test.paginate("GET /users/{username}/repos", { username: "Martii" }).then(repositories => {
console.log("%d repositories found", repositories.length)
});RESULT: ...
(node:48411) UnhandledPromiseRejectionWarning: HttpError: Bad credentials
at ~/repo/git/OpenUserJS.org/martii/OpenUserJS.org/node_modules/@octokit/request/dist-node/index.js:68:23
at processTicksAndRejections (internal/process/task_queues.js:93:5)
at async Object.next (~/repo/git/OpenUserJS.org/martii/OpenUserJS.org/node_modules/@octokit/plugin-paginate-rest/dist-node/index.js:62:26)
...COMMENT(S): Ref(s): "@octokit/auth-oauth-app": "4.1.2",
"@octokit/auth-oauth-user": "1.2.4",
"@octokit/rest": "18.5.2",
"@octokit/core": "3.4.0",
"@octokit/plugin-paginate-rest": "2.13.3"$ node -v
v14.16.1Btw unrelated question... what are these here in Discussions? no tool tip and its very vague on what to do with the arrow click:
EDIT Saw a tooltip when I was logged out... it's a vote up for the solution button. Restested in package.json snippet with newly released: "@octokit/rest": "18.5.3",... same issue of "Bad credentials" as encountered in |
Beta Was this translation helpful? Give feedback.
-
|
Is octokit/auth-oauth-app.js#178 related to the failures experienced in your verbatim code and the modified test? |
Beta Was this translation helpful? Give feedback.
-
|
yeah, that bug should be resolved now. When using |
Beta Was this translation helpful? Give feedback.
-
So our project is currently using the old github dependency and we've been trying to migrate to the latest usage for the GitHub API v3... however...
There are a bazillion questions... here are some things done...
requirename which of course doesn't work. However the auth-oauth-app says use https://www.npmjs.com/package/@octokit/core ... which ones?access_tokenneeded to test if https://www.npmjs.com/package/@octokit/auth-oauth-app#usage-with-octokit ... so not sure what to do with this yet.My main question is where the heck do I start with what packages for migration? i.e. obviously we want the larger rate limit (we'll skip PAT for now and use our app OAuth) but there doesn't seem to be any clear, and current, documentation on migration.
Please help.
P.S. I've also searched the web and got a lot of outdated articles or way too general. I've also reached out to the original contributor and of course he's gone dark which isn't helpful.
Beta Was this translation helpful? Give feedback.
All reactions