update to probot 7

Author: ocombe

functions/package.json

@@ -5,7 +5,7 @@
     "firebase-admin": "5.12.0",
     "firebase-functions": "1.0.0",
     "minimatch": "3.0.4",
-    "probot-ts": "6.1.0-ts"
+    "probot": "7.0.0-typescript.2"
   },
   "private": true
 }

functions/src/dev.ts

@@ -1,7 +1,6 @@
-import {createProbot} from "probot-ts";
+import {createProbot} from "probot";
 import {credential, firestore, initializeApp} from "firebase-admin";
 import {consoleStream, registerTasks} from "./util";
-import {Probot} from './typings';
 
 console.warn(`Starting dev mode`);
 
@@ -14,7 +13,7 @@ initializeApp({
 const store: FirebaseFirestore.Firestore = firestore();
 
 // Probot setup
-const bot: Probot = createProbot(config);
+const bot = createProbot(config);
 
 // disable probot logging
 bot.logger.streams.splice(0, 1);

functions/src/index.ts

@@ -1,9 +1,8 @@
 import {firestore as database, https} from 'firebase-functions';
 import {Request, Response} from "express";
-import {createProbot, Options} from "probot-ts";
+import {createProbot, Options} from "probot";
 import {consoleStream, registerTasks, Tasks} from "./util";
 import {credential, firestore, initializeApp} from "firebase-admin";
-import {Probot} from "./typings";
 import {DocumentSnapshot} from "firebase-functions/lib/providers/firestore";
 import {EventContext} from "firebase-functions/lib/cloud-functions";
 
@@ -25,7 +24,7 @@ if(probotConfig) {
 
 const store: FirebaseFirestore.Firestore = firestore();
 // Create the bot using Firebase's probot config (see Readme.md)
-const bot: Probot = createProbot(probotConfig);
+const bot = createProbot(probotConfig);
 // disable probot logging
 bot.logger.streams.splice(0, 1);
 // Use node console as the output stream

functions/src/plugins/common.ts

@@ -1,9 +1,9 @@
-import {Context, Robot} from "probot-ts";
+import {Context, Robot} from "probot";
 import * as Github from '@octokit/rest';
 import * as minimatch from "minimatch";
 import {AdminConfig} from "../default";
 import {Task} from "./task";
-import {OctokitWithPagination} from "probot-ts/lib/github";
+import {OctokitWithPagination} from "probot/lib/github";
 import * as firebase from "firebase";
 
 export class CommonTask extends Task {
@@ -51,7 +51,7 @@ export class CommonTask extends Task {
    */
   async triggeredInit(data: firebase.firestore.DocumentData): Promise<void> {
     const repository = data as Repository & { installationId: number };
-    const authGithub = await this.robot.auth(repository.installationId);
+    const authGithub = await this.robot.auth(repository.installationId.toString());
     return this.init(authGithub, [repository]);
   }
 

functions/src/plugins/merge.ts

@@ -1,6 +1,6 @@
 import * as Github from '@octokit/rest';
-import {Context, Robot} from "probot-ts";
-import {appConfig, MergeConfig} from "../default";
+import {Context, Robot} from "probot";
+import {AppConfig, appConfig, MergeConfig} from "../default";
 import {addComment, getGhLabels, getLabelsNames, matchAny, matchAnyFile} from "./common";
 import {Task} from "./task";
 import {REVIEW_STATE, STATUS_STATE} from "../typings";
@@ -46,7 +46,7 @@ export class MergeTask extends Task {
    */
   async onLabeled(context: Context): Promise<void> {
     const newLabel = context.payload.label.name;
-    const pr: Github.PullRequest = context.payload.pull_request;
+    const pr = context.payload.pull_request;
     const config = await this.getConfig(context);
     const {owner, repo} = context.repo();
     // we need the list of labels from Github because we might be adding multiple labels at once
@@ -534,11 +534,8 @@ export class MergeTask extends Task {
    * Gets the config for the merge plugin from Github or uses default if necessary
    */
   async getConfig(context: Context): Promise<MergeConfig> {
-    let repositoryConfig = await context.config(CONFIG_FILE);
-    if(!repositoryConfig || !repositoryConfig.merge) {
-      repositoryConfig = {merge: {}};
-    }
-    return {...appConfig.merge, ...repositoryConfig.merge};
+    const repositoryConfig = await context.config<AppConfig>(CONFIG_FILE, appConfig);
+    return repositoryConfig.merge;
   }
 }
 

functions/src/plugins/task.ts

@@ -1,5 +1,5 @@
-import {Context, Robot} from "probot-ts";
-import {OctokitWithPagination} from "probot-ts/lib/github";
+import {Context, Robot} from "probot";
+import {OctokitWithPagination} from "probot/lib/github";
 
 export class Task {
   repositories: FirebaseFirestore.CollectionReference;
@@ -28,7 +28,7 @@ export class Task {
 
   // wrapper for this.robot.on
   dispatch(events: string | string[], callback: (context: Context) => any) {
-    this.robot.on(events, (context: Context) => {
+    this.robot.on(events, (context: any) => {
       this.log({context}, "Event received");
       return callback(context);
     });

functions/src/plugins/triage.ts

@@ -1,10 +1,10 @@
-import {Context, Robot} from "probot-ts";
-import {OctokitWithPagination} from "probot-ts/lib/github";
+import {Context, Robot} from "probot";
 import {Task} from "./task";
 import {CONFIG_FILE} from "./merge";
-import {AdminConfig, appConfig, TriageConfig} from "../default";
+import {AdminConfig, AppConfig, appConfig, TriageConfig} from "../default";
 import {getGhLabels, getLabelsNames, matchAllOfAny} from "./common";
 import * as Github from '@octokit/rest';
+import {GitHubApi} from "../typings";
 
 export class TriageTask extends Task {
   constructor(robot: Robot, db: FirebaseFirestore.Firestore) {
@@ -25,10 +25,10 @@ export class TriageTask extends Task {
       const github = await this.robot.auth();
       const installations = await github.paginate(github.apps.getInstallations({}), pages => pages.data);
       await Promise.all(installations.map(async installation => {
-        const authGithub: OctokitWithPagination = await this.robot.auth(installation.id);
+        const authGithub = await this.robot.auth(installation.id) as GitHubApi;
         const repositories = await authGithub.apps.getInstallationRepositories({});
         await Promise.all(repositories.data.repositories.map(async (repository: Github.Repository) => {
-          const context: Context = new Context({payload: {repository}}, authGithub);
+          const context = new Context({payload: {repository}}, authGithub, this.robot.log);
           const config = await this.getConfig(context);
           const {owner, repo} = context.repo();
           const issues = await authGithub.paginate(authGithub.issues.getForRepo({
@@ -69,7 +69,7 @@ export class TriageTask extends Task {
   }
 
   async checkTriage(context: Context): Promise<any> {
-    const issue = context.payload.issue;
+    const issue: any = context.payload.issue;
     const config = await this.getConfig(context);
     const {owner, repo} = context.repo();
     // getting labels from Github because we might be adding multiple labels at once
@@ -94,7 +94,7 @@ export class TriageTask extends Task {
     }
   }
 
-  setMilestone(milestoneNumber: number | null, github: OctokitWithPagination, owner: string, repo: string, issue: Github.Issue): Promise<any> {
+  setMilestone(milestoneNumber: number | null, github: Github, owner: string, repo: string, issue: Github.Issue): Promise<any> {
     if(milestoneNumber) {
       this.log(`Adding milestone ${milestoneNumber} to issue ${issue.html_url}`);
     } else {
@@ -113,13 +113,10 @@ export class TriageTask extends Task {
    * Gets the config for the merge plugin from Github or uses default if necessary
    */
   async getConfig(context: Context): Promise<TriageConfig> {
-    let repositoryConfig = await context.config(CONFIG_FILE);
-    if(!repositoryConfig || !repositoryConfig.triage) {
-      repositoryConfig = {triage: {}};
-    }
-    const config = {...appConfig.triage, ...repositoryConfig.triage};
-    config.defaultMilestone = parseInt(config.defaultMilestone, 10);
-    config.needsTriageMilestone = parseInt(config.needsTriageMilestone, 10);
+    const repositoryConfig = await context.config<AppConfig>(CONFIG_FILE, appConfig);
+    const config = repositoryConfig.triage;
+    config.defaultMilestone = parseInt(<any>config.defaultMilestone, 10);
+    config.needsTriageMilestone = parseInt(<any>config.needsTriageMilestone, 10);
     return config;
   }
 }

functions/src/typings.ts

@@ -1,13 +1,131 @@
-// Type definitions for probot v3.0.0 (WIP)
-// Project: github.com/probot/probot
-// Definitions by: sirMerr <github.com/sirMerr>
-// Definitions: DefinitelyTyped/DefinitelyTyped
-/// <reference types="express" />
+import {Logger} from "probot";
+import {LoggerWithTarget} from "probot/lib/wrap-logger";
+import {OctokitWithPagination, Variables} from "probot/lib/github";
+import {Issue, PullRequest, Repository} from "@octokit/rest";
 
-import {Application} from "express";
-import {WebhookEvent} from "probot-ts/lib/robot";
-import {Logger, Robot} from "probot-ts";
-import {Plugin} from "probot-ts/lib";
+// override this for now until the types are fixed
+declare module "probot/lib/wrap-logger" {
+
+  interface LoggerWithTarget extends Logger {
+    (str: string): void;
+
+    target: Logger;
+    child: (attrs: ChildArgs) => LoggerWithTarget;
+    trace: Logger;
+    debug: Logger;
+    info: Logger;
+    warn: Logger;
+    error: Logger;
+    fatal: Logger;
+  }
+}
+
+export interface GitHubApi extends OctokitWithPagination {
+  query: (string, variables: Variables, headers?: any) => any;
+}
+
+export interface Payload {
+  [x: string]: any;
+  repository: Repository;
+  issue: Issue;
+  pull_request: PullRequest;
+  sender: {
+    type: string;
+  };
+  action: string;
+  installation: {
+    id: string;
+  };
+}
+
+declare module "probot" {
+  export class Context {
+    id: string;
+    github: GitHubApi;
+    log: LoggerWithTarget;
+    payload: Payload;
+    event: string;
+
+    constructor(event: any, github: GitHubApi, log: LoggerWithTarget);
+
+    /**
+     * Return the `owner` and `repo` params for making API requests against a
+     * repository.
+     *
+     * @param {object} [object] - Params to be merged with the repo params.
+     *
+     * @example
+     *
+     * const params = context.repo({path: '.github/config.yml'})
+     * // Returns: {owner: 'username', repo: 'reponame', path: '.github/config.yml'}
+     *
+     */
+    repo<T>(object?: T): {
+      owner: string;
+      repo: string;
+    } & T;
+
+    /**
+     * Return the `owner`, `repo`, and `number` params for making API requests
+     * against an issue or pull request. The object passed in will be merged with
+     * the repo params.
+     *
+     * @example
+     *
+     * const params = context.issue({body: 'Hello World!'})
+     * // Returns: {owner: 'username', repo: 'reponame', number: 123, body: 'Hello World!'}
+     *
+     * @param {object} [object] - Params to be merged with the issue params.
+     */
+    issue<T>(object?: T): {
+      number: number;
+    } & {
+      owner: string;
+      repo: string;
+    } & T;
+
+    /**
+     * Returns a boolean if the actor on the event was a bot.
+     * @type {boolean}
+     */
+    readonly isBot: boolean;
+
+    /**
+     * Reads the app configuration from the given YAML file in the `.github`
+     * directory of the repository.
+     *
+     * @example <caption>Contents of <code>.github/config.yml</code>.</caption>
+     *
+     * close: true
+     * comment: Check the specs on the rotary girder.
+     *
+     * @example <caption>App that reads from <code>.github/config.yml</code>.</caption>
+     *
+     * // Load config from .github/config.yml in the repository
+     * const config = await context.config('config.yml')
+     *
+     * if (config.close) {
+     *   context.github.issues.comment(context.issue({body: config.comment}))
+     *   context.github.issues.edit(context.issue({state: 'closed'}))
+     * }
+     *
+     * @example <caption>Using a <code>defaultConfig</code> object.</caption>
+     *
+     * // Load config from .github/config.yml in the repository and combine with default config
+     * const config = await context.config('config.yml', {comment: 'Make sure to check all the specs.'})
+     *
+     * if (config.close) {
+     *   context.github.issues.comment(context.issue({body: config.comment}));
+     *   context.github.issues.edit(context.issue({state: 'closed'}))
+     * }
+     *
+     * @param {string} fileName - Name of the YAML file in the `.github` directory
+     * @param {object} [defaultConfig] - An object of default config options
+     * @return {Promise<Object>} - Configuration object read from the file
+     */
+    config<T>(fileName: string, defaultConfig: T): Promise<T | null>;
+  }
+}
 
 declare module "@octokit/rest" {
   export interface Label {
@@ -107,7 +225,7 @@ declare module "@octokit/rest" {
     };
     requested_reviewers: User[];
     requested_teams: any[]; // need to check how the "team" json structure is
-    mergeable: boolean|null;
+    mergeable: boolean | null;
   }
 
   export interface File {
@@ -160,13 +278,3 @@ export const enum REVIEW_STATE {
   Commented = 'COMMENTED',
   Dismissed = 'DISMISSED'
 }
-
-export interface Probot {
-  server: Application;
-  webhook: any;
-  receive: (event: WebhookEvent) => Promise<any[]>;
-  logger: Logger;
-  load: (plugin: string | Plugin) => Robot;
-  setup: (apps: Array<string | Plugin>) => void;
-  start: () => void;
-}

functions/src/util.ts

@@ -1,8 +1,8 @@
-import {Context, Robot} from "probot-ts";
+import {Robot} from "probot";
 import {CommonTask} from "./plugins/common";
 import {MergeTask} from "./plugins/merge";
 import {TriageTask} from "./plugins/triage";
-import {OctokitWithPagination} from "probot-ts/lib/github";
+import {OctokitWithPagination} from "probot/lib/github";
 
 /**
  * Get all results in case of paginated Github request
@@ -47,7 +47,7 @@ class Stream {
 
     let event = '';
     let extraData = '';
-    const context: Context = data.context;
+    const context = data.context;
     if(context) {
       event = context.event;
       const payload = data.context.payload;