Merge pull request #3 from lightness/feature/token-by-command-line-args

lightness · web-flow · commit 84c27c703de9 · 2019-06-29T17:09:10.000+02:00
Token can be passed by command line args
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "github-repo-tools",
-  "version": "2.1.2",
+  "version": "2.2.0",
   "description": "Useful tool to get versions from all repos of Github user/org",
   "main": "build/app.js",
   "bin": {
@@ -42,6 +42,7 @@
     "figlet": "^1.2.1",
     "inquirer": "^6.3.1",
     "lodash": "^4.17.11",
+    "lodash-decorators": "^6.0.1",
     "moment": "^2.24.0",
     "ora": "^3.4.0",
     "reflect-metadata": "^0.1.13",
diff --git a/src/app.service.ts b/src/app.service.ts
@@ -27,7 +27,7 @@ export class AppService {
     this.setupPresenter(options);
 
     this.presenterService.showFiglet();
-    this.presenterService.showGithubTokenInfo();
+    this.presenterService.showGithubTokenInfo(options);
 
     const { package: packageName, node, rateLimit } = options;
 
diff --git a/src/interfaces.ts b/src/interfaces.ts
@@ -30,6 +30,7 @@ export interface IPresenterOptions {
 
 export interface IProgramOptions extends IFilterOptions, IOwnerOptions, IPackageOptions, INodeOptions, IPresenterOptions {
   rateLimit?: boolean;
+  token?: string;
 }
 
 export interface IReportItem {
diff --git a/src/modules/cli/cli.service.ts b/src/modules/cli/cli.service.ts
@@ -1,9 +1,10 @@
 import { Injectable } from '@nestjs/common';
+import { Memoize } from 'lodash-decorators';
 import { IProgramOptions } from '../../interfaces';
 import { CommanderService } from './commander.service';
 import { InquirerService } from './inquirer.service';
 import { InputValidatorService } from './input.validator.service';
-import { InvalidResult, ValidResult } from './interfaces';
+import { InvalidResult } from './interfaces';
 
 @Injectable()
 export class CliService {
@@ -15,10 +16,11 @@ export class CliService {
   ) {
   }
 
-  public async getProgramOptions(): Promise<IProgramOptions> {
+  @Memoize()
+  public getProgramOptions(): Promise<IProgramOptions> {
     const options = this.commanderService.getProgramOptions();
 
-    return await this.patchOptions(options);
+    return this.patchOptions(options);
   }
 
   public async patchOptions(options): Promise<IProgramOptions> {
diff --git a/src/modules/cli/commander.service.ts b/src/modules/cli/commander.service.ts
@@ -10,7 +10,7 @@ export class CommanderService {
       .usage('Search npm packages in all org repos. You can set GITHUB_TOKEN env var, if public access restricted')
       .help('help')
       .alias('h', 'help')
-      .showHelpOnFail(false, "Specify --help for available options")
+      .showHelpOnFail(false, 'Specify --help for available options')
       .version()
       .alias('v', 'version')
       .describe('v', 'show version information')
@@ -92,6 +92,12 @@ export class CommanderService {
         default: false,
         type: 'boolean',
       })
+      .option('token', {
+        alias: 't',
+        describe: 'token to auth on github. Env var GITHUB_TOKEN strictly prefered',
+        default: process.env.GITHUB_TOKEN,
+        type: 'string'
+      })
       .group(['user', 'org'], 'Owner:')
       .group(['package', 'deps', 'dev-deps', 'peer-deps', 'yarn-lock', 'package-lock'], 'NPM package:')
       .group(['node', 'nvm', 'engines'], 'Node version:')
diff --git a/src/modules/cli/input.validator.service.ts b/src/modules/cli/input.validator.service.ts
@@ -1,6 +1,6 @@
-import { Injectable } from "@nestjs/common";
-import { IProgramOptions, IOwnerOptions } from "../../interfaces";
-import { Mode, ValidationResult } from "./interfaces";
+import { Injectable } from '@nestjs/common';
+import { IProgramOptions, IOwnerOptions } from '../../interfaces';
+import { Mode, ValidationResult } from './interfaces';
 
 @Injectable()
 export class InputValidatorService {
diff --git a/src/modules/node-version/node.version.module.ts b/src/modules/node-version/node.version.module.ts
@@ -1,7 +1,7 @@
-import { Module } from "@nestjs/common";
-import { OctokitModule } from "../octokit/octokit.module";
-import { NodeVersionService } from "./node.version.service";
-import { PresenterModule } from "../presenter/presenter.module";
+import { Module } from '@nestjs/common';
+import { OctokitModule } from '../octokit/octokit.module';
+import { NodeVersionService } from './node.version.service';
+import { PresenterModule } from '../presenter/presenter.module';
 
 @Module({
   imports: [
diff --git a/src/modules/node-version/node.version.service.ts b/src/modules/node-version/node.version.service.ts
@@ -1,8 +1,8 @@
-import { Injectable } from "@nestjs/common";
-import { IProgramOptions } from "../../interfaces";
-import { INodeVersion } from "./interfaces";
-import { OctokitService } from "../octokit/octokit.service";
-import { PresenterService } from "../presenter/presenter.service";
+import { Injectable } from '@nestjs/common';
+import { IProgramOptions } from '../../interfaces';
+import { INodeVersion } from './interfaces';
+import { OctokitService } from '../octokit/octokit.service';
+import { PresenterService } from '../presenter/presenter.service';
 
 @Injectable()
 export class NodeVersionService {
diff --git a/src/modules/npm-dependency-version/interfaces.ts b/src/modules/npm-dependency-version/interfaces.ts
@@ -1,4 +1,4 @@
-import { IReportItem } from "../../interfaces";
+import { IReportItem } from '../../interfaces';
 
 export interface IPacakgeVersion extends IReportItem {
   version?: string;
diff --git a/src/modules/npm-dependency-version/npm.dependency.version.module.ts b/src/modules/npm-dependency-version/npm.dependency.version.module.ts
@@ -1,9 +1,9 @@
-import { Module } from "@nestjs/common";
-import { OctokitModule } from "../octokit/octokit.module";
-import { NpmDependencyVersionService } from "./npm.dependency.version.service";
-import { PackageLockVersionService } from "./package.lock.version.service";
-import { YarnLockVersionService } from "./yarn.lock.version.service";
-import { PresenterModule } from "../presenter/presenter.module";
+import { Module } from '@nestjs/common';
+import { OctokitModule } from '../octokit/octokit.module';
+import { NpmDependencyVersionService } from './npm.dependency.version.service';
+import { PackageLockVersionService } from './package.lock.version.service';
+import { YarnLockVersionService } from './yarn.lock.version.service';
+import { PresenterModule } from '../presenter/presenter.module';
 
 
 @Module({
diff --git a/src/modules/npm-dependency-version/npm.dependency.version.service.ts b/src/modules/npm-dependency-version/npm.dependency.version.service.ts
@@ -1,11 +1,11 @@
-import { Injectable } from "@nestjs/common";
+import { Injectable } from '@nestjs/common';
 import chalk from 'chalk';
-import { IProgramOptions, IPackageOptions } from "../../interfaces";
-import { OctokitService } from "../octokit/octokit.service";
-import { PackageLockVersionService } from "./package.lock.version.service";
-import { YarnLockVersionService } from "./yarn.lock.version.service";
-import { PresenterService } from "../presenter/presenter.service";
-import { IPacakgeVersion as IPackageVersion } from "./interfaces";
+import { IProgramOptions, IPackageOptions } from '../../interfaces';
+import { OctokitService } from '../octokit/octokit.service';
+import { PackageLockVersionService } from './package.lock.version.service';
+import { YarnLockVersionService } from './yarn.lock.version.service';
+import { PresenterService } from '../presenter/presenter.service';
+import { IPacakgeVersion as IPackageVersion } from './interfaces';
 
 @Injectable()
 export class NpmDependencyVersionService {
diff --git a/src/modules/npm-dependency-version/package.lock.version.service.ts b/src/modules/npm-dependency-version/package.lock.version.service.ts
@@ -1,6 +1,6 @@
-import { Injectable } from "@nestjs/common";
+import { Injectable } from '@nestjs/common';
 import { get } from 'lodash';
-import { OctokitService } from "../octokit/octokit.service";
+import { OctokitService } from '../octokit/octokit.service';
 
 @Injectable()
 export class PackageLockVersionService {
diff --git a/src/modules/npm-dependency-version/yarn.lock.version.service.ts b/src/modules/npm-dependency-version/yarn.lock.version.service.ts
@@ -1,6 +1,6 @@
-import { Injectable } from "@nestjs/common";
+import { Injectable } from '@nestjs/common';
 import * as lockfile from '@yarnpkg/lockfile';
-import { OctokitService } from "../octokit/octokit.service";
+import { OctokitService } from '../octokit/octokit.service';
 
 @Injectable()
 export class YarnLockVersionService {
diff --git a/src/modules/octokit/octokit.module.ts b/src/modules/octokit/octokit.module.ts
@@ -1,10 +1,12 @@
-import { Module } from "@nestjs/common";
-import { OctokitService } from "./octokit.service";
-import { PresenterModule } from "../presenter/presenter.module";
+import { Module } from '@nestjs/common';
+import { OctokitService } from './octokit.service';
+import { PresenterModule } from '../presenter/presenter.module';
+import { CliModule } from '../cli/cli.module';
 
 @Module({
   imports: [
     PresenterModule,
+    CliModule,
   ],
   providers: [OctokitService],
   exports: [OctokitService]
diff --git a/src/modules/octokit/octokit.service.ts b/src/modules/octokit/octokit.service.ts
@@ -1,34 +1,37 @@
-import { Injectable } from "@nestjs/common";
+import { Injectable } from '@nestjs/common';
 import * as Octokit from '@octokit/rest';
 import * as RetryPlugin from '@octokit/plugin-retry';
-import { PresenterService } from "../presenter/presenter.service";
+import { PresenterService } from '../presenter/presenter.service';
+import { CliService } from '../cli/cli.service';
+import { Memoize } from 'lodash-decorators';
+import { ClientHttp2Stream } from 'http2';
 
 @Injectable()
 export class OctokitService {
 
   constructor(
     private presentationService: PresenterService,
+    private cliService: CliService,
   ) {
   }
 
-  private octokitInstance: Octokit;
+  @Memoize()
+  public async getOctokit() {
+    const { token } = await this.cliService.getProgramOptions();
 
-  public get octokit() {
-    if (!this.octokitInstance) {
-      this.octokitInstance = new (Octokit.plugin(RetryPlugin))({
-        auth: process.env.GITHUB_TOKEN,
-        retry: {
-          doNotRetry: [404],
-        }
-      });
-    }
-
-    return this.octokitInstance;
+    return new (Octokit.plugin(RetryPlugin))({
+      auth: token,
+      retry: {
+        doNotRetry: [404],
+      }
+    });
   }
 
   public async getFileContent(owner, repo, path) {
+    const octokit = await this.getOctokit();
+
     try {
-      const response = await this.octokit.repos.getContents({
+      const response = await octokit.repos.getContents({
         owner,
         repo,
         path,
@@ -48,13 +51,15 @@ export class OctokitService {
   }
 
   public async getRepos({ org, user }: { org: string, user: string }): Promise<string[] | null> {
+    const octokit = await this.getOctokit();
+
     const options = org
-      ? this.octokit.repos.listForOrg.endpoint.merge({ org })
-      : this.octokit.repos.listForUser.endpoint.merge({ username: user });
+      ? octokit.repos.listForOrg.endpoint.merge({ org })
+      : octokit.repos.listForUser.endpoint.merge({ username: user });
 
     this.presentationService.showSpinner('Searching for repos...');
     try {
-      const repos = await this.octokit.paginate(options);
+      const repos = await octokit.paginate(options);
       this.presentationService.hideSpinner({ success: true, message: `${repos.length} repos found` });
 
       return repos.map(repo => repo.name);
diff --git a/src/modules/presenter/default.presenter.service.ts b/src/modules/presenter/default.presenter.service.ts
@@ -3,11 +3,12 @@ import * as moment from 'moment';
 import * as Octokit from '@octokit/rest';
 import * as ora from 'ora';
 import chalk from 'chalk';
-import { TableService } from "../table/table.service";
-import { IPresenterService } from "./interfaces";
+import { Injectable } from '@nestjs/common';
+import { TableService } from '../table/table.service';
+import { IPresenterService } from './interfaces';
 import { IReportItem, IProgramOptions } from '../../interfaces';
 import { getFilter } from '../../util/result-filter';
-import { Injectable } from '@nestjs/common';
+import { CliService } from '../cli/cli.service';
 
 @Injectable()
 export class DefaultPresenterService implements IPresenterService {
@@ -25,13 +26,17 @@ export class DefaultPresenterService implements IPresenterService {
     console.log(figlet.textSync('Github Repo Tools'));
   }
 
-  public showGithubTokenInfo() {
-    const withGithubToken = !!process.env.GITHUB_TOKEN;
+  public showGithubTokenInfo(options: IProgramOptions) {
+    const withGithubToken = !!options.token;
 
     console.log(`Use GITHUB_TOKEN env: ${withGithubToken ? chalk.green('yes') : chalk.red('no')}`);
   }
 
   public showRateLimit(rateLimit: Octokit.RateLimitGetResponseRate) {
+    if (!rateLimit) {
+      return;
+    }
+
     const { limit, remaining, reset } = rateLimit;
     const resetMoment = moment(reset * 1000);
     const resetIn = resetMoment.fromNow();
@@ -45,6 +50,11 @@ export class DefaultPresenterService implements IPresenterService {
   }
 
   public showData(report: IReportItem[], options: IProgramOptions) {
+    if (!report) {
+      console.log('No data found');
+      return;
+    }
+
     const filteredReport: IReportItem[] = report.filter(getFilter(options));
     const output: string = this.tableService.format(filteredReport, options);
 
diff --git a/src/modules/presenter/interfaces.ts b/src/modules/presenter/interfaces.ts
@@ -9,7 +9,7 @@ export enum PresentationMode {
 
 export interface IPresenterService {
   showFiglet();
-  showGithubTokenInfo();
+  showGithubTokenInfo(options: IProgramOptions);
   showRateLimit(rateLimit: Octokit.RateLimitGetResponseRate, isMainInfo: boolean);
   showError(message: string);
   showData(report: IReportItem[], options: IProgramOptions);
diff --git a/src/modules/presenter/json.presenter.service.ts b/src/modules/presenter/json.presenter.service.ts
@@ -1,5 +1,5 @@
-import { Injectable } from "@nestjs/common";
-import { RawJsonPresenterService } from "./raw.json.presenter.service";
+import { Injectable } from '@nestjs/common';
+import { RawJsonPresenterService } from './raw.json.presenter.service';
 
 @Injectable()
 export class JsonPresenterService extends RawJsonPresenterService {
diff --git a/src/modules/presenter/presenter.module.ts b/src/modules/presenter/presenter.module.ts
@@ -1,9 +1,9 @@
-import { Module } from "@nestjs/common";
-import { PresenterService } from "./presenter.service";
-import { TableModule } from "../table/table.module";
-import { DefaultPresenterService } from "./default.presenter.service";
-import { JsonPresenterService } from "./json.presenter.service";
-import { RawJsonPresenterService } from "./raw.json.presenter.service";
+import { Module } from '@nestjs/common';
+import { PresenterService } from './presenter.service';
+import { TableModule } from '../table/table.module';
+import { DefaultPresenterService } from './default.presenter.service';
+import { JsonPresenterService } from './json.presenter.service';
+import { RawJsonPresenterService } from './raw.json.presenter.service';
 
 @Module({
   providers: [
diff --git a/src/modules/presenter/presenter.service.ts b/src/modules/presenter/presenter.service.ts
@@ -1,10 +1,10 @@
-import { Injectable } from "@nestjs/common";
+import { Injectable } from '@nestjs/common';
 import * as Octokit from '@octokit/rest';
-import { PresentationMode, IPresenterService } from "./interfaces";
-import { DefaultPresenterService } from "./default.presenter.service";
-import { JsonPresenterService } from "./json.presenter.service";
-import { IReportItem, IProgramOptions } from "../../interfaces";
-import { RawJsonPresenterService } from "./raw.json.presenter.service";
+import { PresentationMode, IPresenterService } from './interfaces';
+import { DefaultPresenterService } from './default.presenter.service';
+import { JsonPresenterService } from './json.presenter.service';
+import { IReportItem, IProgramOptions } from '../../interfaces';
+import { RawJsonPresenterService } from './raw.json.presenter.service';
 
 @Injectable()
 export class PresenterService implements IPresenterService {
@@ -37,8 +37,8 @@ export class PresenterService implements IPresenterService {
     this.presenter.showFiglet();
   }
 
-  public showGithubTokenInfo() {
-    this.presenter.showGithubTokenInfo();
+  public showGithubTokenInfo(options: IProgramOptions) {
+    this.presenter.showGithubTokenInfo(options);
   }
 
   public showRateLimit(rateLimit: Octokit.RateLimitGetResponseRate, isMainInfo: boolean) {
diff --git a/src/modules/presenter/raw.json.presenter.service.ts b/src/modules/presenter/raw.json.presenter.service.ts
@@ -1,8 +1,8 @@
 import * as Octokit from '@octokit/rest';
-import { Injectable } from "@nestjs/common";
-import { IPresenterService } from "./interfaces";
-import { IReportItem, IProgramOptions } from "../../interfaces";
-import { getFilter } from "../../util/result-filter";
+import { Injectable } from '@nestjs/common';
+import { IPresenterService } from './interfaces';
+import { IReportItem, IProgramOptions } from '../../interfaces';
+import { getFilter } from '../../util/result-filter';
 
 @Injectable()
 export class RawJsonPresenterService implements IPresenterService {
@@ -27,6 +27,11 @@ export class RawJsonPresenterService implements IPresenterService {
   }
 
   public showData(report: IReportItem[], options: IProgramOptions) {
+    if (!report) {
+      this.log({ error: 'No data found' });
+      return;
+    }
+
     const filteredReport: IReportItem[] = report.filter(getFilter(options));
 
     this.log(filteredReport);
diff --git a/src/modules/rate-limit/rate.limit.module.ts b/src/modules/rate-limit/rate.limit.module.ts
diff --git a/src/modules/rate-limit/rate.limit.service.ts b/src/modules/rate-limit/rate.limit.service.ts
diff --git a/src/modules/table/table.module.ts b/src/modules/table/table.module.ts
diff --git a/src/modules/table/table.service.ts b/src/modules/table/table.service.ts
diff --git a/src/util/result-filter.ts b/src/util/result-filter.ts
diff --git a/tslint.json b/tslint.json
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -30,6 +30,7 @@ export interface IPresenterOptions {`
`30`	`30`
`31`	`31`	`export interface IProgramOptions extends IFilterOptions, IOwnerOptions, IPackageOptions, INodeOptions, IPresenterOptions {`
`32`	`32`	`rateLimit?: boolean;`
	`33`	`+ token?: string;`
`33`	`34`	`}`
`34`	`35`
`35`	`36`	`export interface IReportItem {`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import { IReportItem } from "../../interfaces";`
	`1`	`+import { IReportItem } from '../../interfaces';`
`2`	`2`
`3`	`3`	`export interface IPacakgeVersion extends IReportItem {`
`4`	`4`	`version?: string;`