Skip to content

Commit 0893bef

Browse files
gr2mgr2m
committed
refactor: singleton octokit instance for shared throttling state
1 parent 5bb75f2 commit 0893bef

File tree

12 files changed

+369
-486
lines changed

12 files changed

+369
-486
lines changed

‎index.js

Lines changed: 21 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,10 @@ import addChannelGitHub from "./lib/add-channel.js";
77
import publishGitHub from "./lib/publish.js";
88
import successGitHub from "./lib/success.js";
99
import failGitHub from "./lib/fail.js";
10-
import { SemanticReleaseOctokit } from "./lib/octokit.js";
10+
import { SemanticReleaseOctokit, getOctokitInstance } from "./lib/octokit.js";
1111

1212
let verified;
13+
let octokit;
1314

1415
export async function verifyConditions(
1516
pluginConfig,
@@ -44,7 +45,9 @@ export async function verifyConditions(
4445
);
4546
}
4647

47-
await verifyGitHub(pluginConfig, context, { Octokit });
48+
octokit = octokit || getOctokitInstance(Octokit, pluginConfig, context);
49+
50+
await verifyGitHub(pluginConfig, context, { octokit });
4851
verified = true;
4952
}
5053

@@ -53,49 +56,57 @@ export async function publish(
5356
context,
5457
{ Octokit = SemanticReleaseOctokit } = {}
5558
) {
59+
octokit = octokit || getOctokitInstance(Octokit, pluginConfig, context);
60+
5661
if (!verified) {
57-
await verifyGitHub(pluginConfig, context, { Octokit });
62+
await verifyGitHub(pluginConfig, context, { octokit });
5863
verified = true;
5964
}
6065

61-
return publishGitHub(pluginConfig, context, { Octokit });
66+
return publishGitHub(pluginConfig, context, { octokit });
6267
}
6368

6469
export async function addChannel(
6570
pluginConfig,
6671
context,
6772
{ Octokit = SemanticReleaseOctokit } = {}
6873
) {
74+
octokit = octokit || getOctokitInstance(Octokit, pluginConfig, context);
75+
6976
if (!verified) {
70-
await verifyGitHub(pluginConfig, context, { Octokit });
77+
await verifyGitHub(pluginConfig, context, { octokit });
7178
verified = true;
7279
}
7380

74-
return addChannelGitHub(pluginConfig, context, { Octokit });
81+
return addChannelGitHub(pluginConfig, context, { octokit });
7582
}
7683

7784
export async function success(
7885
pluginConfig,
7986
context,
8087
{ Octokit = SemanticReleaseOctokit } = {}
8188
) {
89+
octokit = octokit || getOctokitInstance(Octokit, pluginConfig, context);
90+
8291
if (!verified) {
83-
await verifyGitHub(pluginConfig, context, { Octokit });
92+
await verifyGitHub(pluginConfig, context, { octokit });
8493
verified = true;
8594
}
8695

87-
await successGitHub(pluginConfig, context, { Octokit });
96+
await successGitHub(pluginConfig, context, { octokit });
8897
}
8998

9099
export async function fail(
91100
pluginConfig,
92101
context,
93102
{ Octokit = SemanticReleaseOctokit } = {}
94103
) {
104+
octokit = octokit || getOctokitInstance(Octokit, pluginConfig, context);
105+
95106
if (!verified) {
96-
await verifyGitHub(pluginConfig, context, { Octokit });
107+
await verifyGitHub(pluginConfig, context, { octokit });
97108
verified = true;
98109
}
99110

100-
await failGitHub(pluginConfig, context, { Octokit });
111+
await failGitHub(pluginConfig, context, { octokit });
101112
}

‎lib/add-channel.js

Lines changed: 1 addition & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,32 +2,18 @@ import debugFactory from "debug";
22

33
import { RELEASE_NAME } from "./definitions/constants.js";
44
import parseGithubUrl from "./parse-github-url.js";
5-
import resolveConfig from "./resolve-config.js";
65
import isPrerelease from "./is-prerelease.js";
7-
import { toOctokitOptions } from "./octokit.js";
86

97
const debug = debugFactory("semantic-release:github");
108

11-
export default async function addChannel(pluginConfig, context, { Octokit }) {
9+
export default async function addChannel(pluginConfig, context, { octokit }) {
1210
const {
1311
options: { repositoryUrl },
1412
branch,
1513
nextRelease: { name, gitTag, notes },
1614
logger,
1715
} = context;
18-
const { githubToken, githubUrl, githubApiPathPrefix, proxy } = resolveConfig(
19-
pluginConfig,
20-
context
21-
);
2216
const { owner, repo } = parseGithubUrl(repositoryUrl);
23-
const octokit = new Octokit(
24-
toOctokitOptions({
25-
githubToken,
26-
githubUrl,
27-
githubApiPathPrefix,
28-
proxy,
29-
})
30-
);
3117
let releaseId;
3218

3319
const release = {

‎lib/fail.js

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import getFailComment from "./get-fail-comment.js";
1010

1111
const debug = debugFactory("semantic-release:github");
1212

13-
export default async function fail(pluginConfig, context, { Octokit }) {
13+
export default async function fail(pluginConfig, context, { octokit }) {
1414
const {
1515
options: { repositoryUrl },
1616
branch,
@@ -31,9 +31,6 @@ export default async function fail(pluginConfig, context, { Octokit }) {
3131
if (failComment === false || failTitle === false) {
3232
logger.log("Skip issue creation.");
3333
} else {
34-
const octokit = new Octokit(
35-
toOctokitOptions({ githubToken, githubUrl, githubApiPathPrefix, proxy })
36-
);
3734
// In case the repo changed name, get the new `repo`/`owner` as the search API will not follow redirects
3835
const { data: repoData } = await octokit.request(
3936
"GET /repos/{owner}/{repo}",

‎lib/octokit.js

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ import { HttpsProxyAgent } from "https-proxy-agent";
1717

1818
import { RETRY_CONF } from "./definitions/retry.js";
1919
import { THROTTLE_CONF } from "./definitions/throttle.js";
20+
import resolveConfig from "./resolve-config.js";
2021

2122
// NOTE: replace with import ... assert { type: 'json' } once supported
2223
const require = createRequire(import.meta.url);
@@ -74,3 +75,14 @@ export function toOctokitOptions(options) {
7475
},
7576
};
7677
}
78+
79+
export function getOctokitInstance(Octokit, pluginConfig, context) {
80+
const { githubToken, githubUrl, githubApiPathPrefix, proxy } = resolveConfig(
81+
pluginConfig,
82+
context
83+
);
84+
85+
return new Octokit(
86+
toOctokitOptions({ githubToken, githubUrl, githubApiPathPrefix, proxy })
87+
);
88+
}

‎lib/publish.js

Lines changed: 2 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -9,36 +9,20 @@ import { RELEASE_NAME } from "./definitions/constants.js";
99
import parseGithubUrl from "./parse-github-url.js";
1010
import globAssets from "./glob-assets.js";
1111
import resolveConfig from "./resolve-config.js";
12-
import { toOctokitOptions } from "./octokit.js";
1312
import isPrerelease from "./is-prerelease.js";
1413

1514
const debug = debugFactory("semantic-release:github");
1615

17-
export default async function publish(pluginConfig, context, { Octokit }) {
16+
export default async function publish(pluginConfig, context, { octokit }) {
1817
const {
1918
cwd,
2019
options: { repositoryUrl },
2120
branch,
2221
nextRelease: { name, gitTag, notes },
2322
logger,
2423
} = context;
25-
const {
26-
githubToken,
27-
githubUrl,
28-
githubApiPathPrefix,
29-
proxy,
30-
assets,
31-
draftRelease,
32-
} = resolveConfig(pluginConfig, context);
24+
const { assets, draftRelease } = resolveConfig(pluginConfig, context);
3325
const { owner, repo } = parseGithubUrl(repositoryUrl);
34-
const octokit = new Octokit(
35-
toOctokitOptions({
36-
githubToken,
37-
githubUrl,
38-
githubApiPathPrefix,
39-
proxy,
40-
})
41-
);
4226
const release = {
4327
owner,
4428
repo,

‎lib/success.js

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ import getReleaseLinks from "./get-release-links.js";
1515

1616
const debug = debugFactory("semantic-release:github");
1717

18-
export default async function success(pluginConfig, context, { Octokit }) {
18+
export default async function success(pluginConfig, context, { octokit }) {
1919
const {
2020
options: { repositoryUrl },
2121
commits,
@@ -24,21 +24,14 @@ export default async function success(pluginConfig, context, { Octokit }) {
2424
logger,
2525
} = context;
2626
const {
27-
githubToken,
2827
githubUrl,
29-
githubApiPathPrefix,
30-
proxy,
3128
successComment,
3229
failComment,
3330
failTitle,
3431
releasedLabels,
3532
addReleases,
3633
} = resolveConfig(pluginConfig, context);
3734

38-
const octokit = new Octokit(
39-
toOctokitOptions({ githubToken, githubUrl, githubApiPathPrefix, proxy })
40-
);
41-
4235
// In case the repo changed name, get the new `repo`/`owner` as the search API will not follow redirects
4336
const { data: repoData } = await octokit.request(
4437
"GET /repos/{owner}/{repo}",

‎lib/verify.js

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@ import AggregateError from "aggregate-error";
1111

1212
import parseGithubUrl from "./parse-github-url.js";
1313
import resolveConfig from "./resolve-config.js";
14-
import { toOctokitOptions } from "./octokit.js";
1514
import getError from "./get-error.js";
1615

1716
const isNonEmptyString = (value) => isString(value) && value.trim();
@@ -47,7 +46,7 @@ const VALIDATORS = {
4746
draftRelease: isBoolean,
4847
};
4948

50-
export default async function verify(pluginConfig, context, { Octokit }) {
49+
export default async function verify(pluginConfig, context, { octokit }) {
5150
const {
5251
env,
5352
options: { repositoryUrl },
@@ -83,10 +82,6 @@ export default async function verify(pluginConfig, context, { Octokit }) {
8382
githubToken &&
8483
!errors.find(({ code }) => code === "EINVALIDPROXY")
8584
) {
86-
const octokit = new Octokit(
87-
toOctokitOptions({ githubToken, githubUrl, githubApiPathPrefix, proxy })
88-
);
89-
9085
// https://github.com/semantic-release/github/issues/182
9186
// Do not check for permissions in GitHub actions, as the provided token is an installation access token.
9287
// octokit.request("GET /repos/{owner}/{repo}", {repo, owner}) does not return the "permissions" key in that case.

‎test/add-channel.test.js

Lines changed: 26 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -61,10 +61,9 @@ test("Update a release", async (t) => {
6161
logger: t.context.logger,
6262
},
6363
{
64-
Octokit: TestOctokit.defaults((options) => ({
65-
...options,
66-
request: { ...options.request, fetch },
67-
})),
64+
octokit: new TestOctokit({
65+
request: { fetch },
66+
}),
6867
}
6968
);
7069

@@ -123,10 +122,9 @@ test("Update a maintenance release", async (t) => {
123122
logger: t.context.logger,
124123
},
125124
{
126-
Octokit: TestOctokit.defaults((options) => ({
127-
...options,
128-
request: { ...options.request, fetch },
129-
})),
125+
octokit: new TestOctokit({
126+
request: { fetch },
127+
}),
130128
}
131129
);
132130

@@ -184,10 +182,9 @@ test("Update a prerelease", async (t) => {
184182
logger: t.context.logger,
185183
},
186184
{
187-
Octokit: TestOctokit.defaults((options) => ({
188-
...options,
189-
request: { ...options.request, fetch },
190-
})),
185+
octokit: new TestOctokit({
186+
request: { fetch },
187+
}),
191188
}
192189
);
193190

@@ -199,7 +196,8 @@ test("Update a prerelease", async (t) => {
199196
t.true(fetch.done());
200197
});
201198

202-
test("Update a release with a custom github url", async (t) => {
199+
// TODO: move to integration tests
200+
test.skip("Update a release with a custom github url", async (t) => {
203201
const owner = "test_user";
204202
const repo = "test_repo";
205203
const env = {
@@ -249,10 +247,9 @@ test("Update a release with a custom github url", async (t) => {
249247
logger: t.context.logger,
250248
},
251249
{
252-
Octokit: TestOctokit.defaults((options) => ({
253-
...options,
254-
request: { ...options.request, fetch },
255-
})),
250+
octokit: new TestOctokit({
251+
request: { fetch },
252+
}),
256253
}
257254
);
258255

@@ -308,10 +305,9 @@ test("Create the new release if current one is missing", async (t) => {
308305
logger: t.context.logger,
309306
},
310307
{
311-
Octokit: TestOctokit.defaults((options) => ({
312-
...options,
313-
request: { ...options.request, fetch },
314-
})),
308+
octokit: new TestOctokit({
309+
request: { fetch },
310+
}),
315311
}
316312
);
317313

@@ -357,10 +353,9 @@ test("Throw error if cannot read current release", async (t) => {
357353
logger: t.context.logger,
358354
},
359355
{
360-
Octokit: TestOctokit.defaults((options) => ({
361-
...options,
362-
request: { ...options.request, fetch },
363-
})),
356+
octokit: new TestOctokit({
357+
request: { fetch },
358+
}),
364359
}
365360
)
366361
);
@@ -409,10 +404,9 @@ test("Throw error if cannot create missing current release", async (t) => {
409404
logger: t.context.logger,
410405
},
411406
{
412-
Octokit: TestOctokit.defaults((options) => ({
413-
...options,
414-
request: { ...options.request, fetch },
415-
})),
407+
octokit: new TestOctokit({
408+
request: { fetch },
409+
}),
416410
}
417411
)
418412
);
@@ -463,10 +457,9 @@ test("Throw error if cannot update release", async (t) => {
463457
logger: t.context.logger,
464458
},
465459
{
466-
Octokit: TestOctokit.defaults((options) => ({
467-
...options,
468-
request: { ...options.request, fetch },
469-
})),
460+
octokit: new TestOctokit({
461+
request: { fetch },
462+
}),
470463
}
471464
)
472465
);

0 commit comments

Comments
 (0)