Modify Octokit retry options

[marcos-arranz]

I've a probot up running that listens for new pull requests. When it receives an event it gets the files in the PR to check if any of them match a particular name. 99% of the time it runs fine, but there are some other times that it returns a 404 error, saying that the pull request does not exist. My guess is that there is some kind of eventual consistency issue, where the event is received before the changes are visible everywhere.

In order to minimize this issue I was planning to retry on 404 errors.
I have attempted to do:

import {Server, Probot, ProbotOctokit} from "probot";
import {default as app} from "./app";
export = async () => {
    const server = new Server({
        Probot: Probot.defaults(
            {
                appId: process.env.APP_ID,
                privateKey: process.env.PRIVATE_KEY_PATH,
                Octokit: ProbotOctokit.defaults(
                    {
                        retry: {
                            doNotRetry: [400, 401, 403, 422]
                        }

                    }
                )
            }
        )
    });

    await server.load(app);

    return server
}

but I run the same issues as in #1608 and I lose some of the nice things provided by just running with probot run ./lib/index.js.

Is there any other way to modify Octokit retry options that doesn't imply using directly Server?

[gr2m]

when you start probot prorgamatically, you don't start it with probot run ./lib/index.js. Just do node ./lib/index.js.

And instead of exporting the async function, run the code directly

import { Server, Probot, ProbotOctokit } from "probot";
import { default as app } from "./app";

const server = new Server({
  Probot: Probot.defaults({
    appId: process.env.APP_ID,
    privateKey: process.env.PRIVATE_KEY_PATH,
    Octokit: ProbotOctokit.defaults({
      retry: {
        doNotRetry: [400, 401, 403, 422],
      },
    }),
  }),
});

server.load(app).then(() => server.start())

[marcos-arranz]

I see, thanks. Now it works, however, I had to recreate almost the whole file in https://github.com/probot/probot/blob/master/src/run.ts to make work things like smee. Isn't there any easier way to change the retry option?

[austinpray-mixpanel]

Just chiming in: I also had to "fork" run.ts for similar reasons. For me:

1. Instrumenting stuff like https://github.com/jochen-schweizer/express-prom-bundle has to be done before registering the webhook routes and such
2. I don't want to use probot's pino instance in production, I have pino transports that are specialized for reporting to gcp + rollbar

After running probot for a while I can see about coming back and adding plugin hooks or some way to get at this stuff without having to copy run.ts.

[gr2m]

if you feel like you are increasingly fighting Probot's defaults, I recommend to use the underlying Octokit libraries directly. Start here: https://github.com/octokit/octokit.js#app-client

The point of Probot is to cover 90% of the most common use case. But if it's not a fit, we provide a path to eject it layer by layer:
https://probot.github.io/docs/development/#run-probot-programmatically until you eventually arrive at the underlying Octokit libraries themselves.

"forking" run.ts is actually the right thing to do here. You take Probot's run.ts file as learning code and make it work for your own needs.