ssube
/
cautious-journey
1
0
Fork 0
Code

fix(remote/github): selectively disable requests for dry run

This commit is contained in:
ssube 2020-08-13 21:59:53 -05:00 committed by BZ Libby
parent b1adb116c6
commit b562f803cd
4 changed files with 67 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/api/cautious-journey.githubremote.md generated
View File

@ -25,6 +25,8 @@ export declare class GithubRemote implements Remote
| --- | --- | --- | --- |
| [options](./cautious-journey.githubremote.options.md) | | [RemoteOptions](./cautious-journey.remoteoptions.md) | |
| [request](./cautious-journey.githubremote.request.md) | | Octokit | Github API client. Will not be set for a dry run. |
| [writeCapable](./cautious-journey.githubremote.writecapable.md) | | boolean | |
| [writeRequest](./cautious-journey.githubremote.writerequest.md) | | Octokit | |
## Methods

11
docs/api/cautious-journey.githubremote.writecapable.md generated Normal file
View File

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [cautious-journey](./cautious-journey.md) &gt; [GithubRemote](./cautious-journey.githubremote.md) &gt; [writeCapable](./cautious-journey.githubremote.writecapable.md)
## GithubRemote.writeCapable property
<b>Signature:</b>
```typescript
protected get writeCapable(): boolean;
```

11
docs/api/cautious-journey.githubremote.writerequest.md generated Normal file
View File

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [cautious-journey](./cautious-journey.md) &gt; [GithubRemote](./cautious-journey.githubremote.md) &gt; [writeRequest](./cautious-journey.githubremote.writerequest.md)
## GithubRemote.writeRequest property
<b>Signature:</b>
```typescript
protected get writeRequest(): Octokit;
```

80
src/remote/github.ts
View File

@ -1,4 +1,4 @@
import { mustExist, NotImplementedError } from '@apextoaster/js-utils';
import { doesExist, InvalidArgumentError, mustExist, NotImplementedError } from '@apextoaster/js-utils';
import { createAppAuth } from '@octokit/auth-app';
import { Octokit } from '@octokit/rest';
@ -23,16 +23,14 @@ export class GithubRemote implements Remote {
}
public async connect() {
if (this.options.dryrun === false) {
this.request = new Octokit({
auth: {
id: parseInt(mustExist(this.options.data.id), 10),
installationId: parseInt(mustExist(this.options.data.installationId), 10),
privateKey: mustExist(this.options.data.privateKey),
},
authStrategy: createAppAuth,
});
}
this.request = new Octokit({
auth: {
id: parseInt(mustExist(this.options.data.id), 10),
installationId: parseInt(mustExist(this.options.data.installationId), 10),
privateKey: mustExist(this.options.data.privateKey),
},
authStrategy: createAppAuth,
});
}
public async splitProject(project: string): Promise<{
@ -54,8 +52,8 @@ export class GithubRemote implements Remote {
const path = await this.splitProject(options.project);
// TODO: check if the label already exists
if (this.request) {
await this.request.issues.createLabel({
if (this.writeCapable) {
await this.writeRequest.issues.createLabel({
color: options.color,
description: options.desc,
name: options.name,
@ -71,8 +69,8 @@ export class GithubRemote implements Remote {
const path = await this.splitProject(options.project);
// TODO: check if the label is in use
if (this.request) {
await this.request.issues.deleteLabel({
if (this.writeCapable) {
await this.writeRequest.issues.deleteLabel({
name: options.name,
owner: path.owner,
repo: path.repo,
@ -95,16 +93,14 @@ export class GithubRemote implements Remote {
const issues: Array<IssueUpdate> = [];
if (this.request) {
const repo = await this.request.issues.listForRepo(path);
for (const issue of repo.data) {
issues.push({
issue: issue.id.toString(10),
labels: issue.labels.map((l) => l.name),
name: issue.title,
project: options.project,
});
}
const repo = await mustExist(this.request).issues.listForRepo(path);
for (const issue of repo.data) {
issues.push({
issue: issue.id.toString(10),
labels: issue.labels.map((l) => l.name),
name: issue.title,
project: options.project,
});
}
return issues;
@ -115,16 +111,14 @@ export class GithubRemote implements Remote {
const labels: Array<LabelUpdate> = [];
if (this.request) {
const repo = await this.request.issues.listLabelsForRepo(path);
for (const label of repo.data) {
labels.push({
color: label.color,
desc: label.description,
name: label.name,
project: options.project,
});
}
const repo = await mustExist(this.request).issues.listLabelsForRepo(path);
for (const label of repo.data) {
labels.push({
color: label.color,
desc: label.description,
name: label.name,
project: options.project,
});
}
return labels;
@ -137,8 +131,8 @@ export class GithubRemote implements Remote {
public async updateLabel(options: LabelUpdate): Promise<LabelUpdate> {
const path = await this.splitProject(options.project);
if (this.request) {
const data = await this.request.issues.updateLabel({
if (this.writeCapable) {
const data = await this.writeRequest.issues.updateLabel({
color: options.color,
description: options.desc,
name: options.name,
@ -156,4 +150,16 @@ export class GithubRemote implements Remote {
return options;
}
}
protected get writeCapable(): boolean {
return this.options.dryrun === false;
}
protected get writeRequest(): Octokit {
if (doesExist(this.request)) {
return this.request;
} else {
throw new InvalidArgumentError();
}
}
}