Implement GitHub webhooks #69
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This will allow webhooks to call this function to ensure that new dependencies have lifetime information if it is available.
The logic used to fetch and store information about repositories and dependencies will need to be reused to allow webhooks to make changes to the database. Using the logic in the application rather than in one-off seeding scripts makes it more important that it is tested to avoid unexpected changes to behaviour. This moves the actual seed scripts to wrapper scripts in the `seed` folder, which call the methods in the original files that have been refactored to be more testable.
To update dependency or repository information in an efficient way, Towtruck should listen to GitHub events rather than polling for updates. Towtruck needs to listen to the following events: - `pull_request.opened` and `pull_request.closed` to update the list of open pull requests - `issues.opened` and `issues.closed` to update the list of open issues - `push` and `issues.edited` to update the list of dependencies - `dependabot_alert` to update the list of vulnerabilities - `repository` to update basic information about repositories
Open
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR allows Towtruck to listen for several types of events on the
POST /api/github/webhooksendpoint. This can be used to incrementally update the database and spreading out the requests it makes to the GitHub API, rather than issuing a large number of requests in a short window of time as it does when seeding.The events it listens for are:
pull_request.openedandpull_request.closedto update the list of open pull requestsissues.openedandissues.closedto update the list of open issuespushandissues.editedto update the list of dependenciesdependabot_alertto update the list of vulnerabilitiesrepositoryto update basic information about repositoriesNB: this pull request depends on #63, which should be merged first.