Upgrading from 11.4.1 to 12.2.5

[mimartin12]

Hey, I am having issues going from 11.4.1 to 12.2.5. When I upgrade, and I run npm install && npm run build I get the following.

src/comments.ts(81,33): error TS2339: Property 'repository' does not exist on type 'BranchProtectionRuleCreatedEvent | BranchProtectionRuleDeletedEvent | BranchProtectionRuleEditedEvent | ... 381 more ... | WorkflowDispatchEvent'.

Code:

const owner = context.payload.repository.owner.login;

Am I missing something that needs to be changed during an upgrade?

[welcome]

Thanks for opening this issue. A contributor should be by to give feedback soon. In the meantime, please check out the contributing guidelines and explore other ways you can get involved.

[gr2m]

try

const owner = context.payload.repository?.owner.login;

The .repository property is not guaranteed to exist on all events, but you should be fine if you have been thus far.

[mimartin12]

I tried that, unfortunately same error.

src/comments.ts(81,33): error TS2339: Property 'repository' does not exist on type 'BranchProtectionRuleCreatedEvent | BranchProtectionRuleDeletedEvent | BranchProtectionRuleEditedEvent | ... 381 more ... | WorkflowDispatchEvent'.
  Property 'repository' does not exist on type 'never'.

[wolfy1339]

This should work for you

if ('repository' in context.payload) {
    // do stuff here
}

[mimartin12]

This should work for you

if ('repository' in context.payload) {
    // do stuff here
}

That works, however, there would be a lot of if statements to check values for other expected values in context.payload. For example, I am getting errors for context.payload.number and context.payload.check_suite not existing. Has the structure of context.payload changed drastically in ProBot version 12?

[wolfy1339]

That works, however, there would be a lot of if statements to check values for other expected values in context.payload. For example, I am getting errors for context.payload.number and context.payload.check_suite not existing. Has the structure of context.payload changed drastically in ProBot version 12?

Yes, it has. We have upgraded to use @octokit/wehooks v9 in #1559

Instead of handling all the events in one handler, simply use one per event

app.on("pull_request", (context) => {
    // Do stuff here
    app.log.info(`Repo: ${context.repository}`);
});

[LeviDeng]

@mimartin12 you can use context.pullRequest() to get the owner

const params = context.pullRequest()
// Returns: {owner: 'username', repo: 'reponame', pull_number: 123}

https://probot.github.io/api/latest/classes/context.Context.html#pullRequest

Context | probot

Documentation for probot

[Uzlopak]

The solution is to write a typeguard.