-
Notifications
You must be signed in to change notification settings - Fork 128
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat: introduce new bot-framework library #5236
base: main
Are you sure you want to change the base?
Conversation
Warning: This pull request is touching the following templated files:
|
fc024c3
to
7a0ba0f
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This was for local testing and can be removed later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is for local testing and can be removed later.
@@ -0,0 +1,18 @@ | |||
# foo |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Imagine I want to write a new bot.* Please describe the list of services provided by this library and why I would want to use them.
- I know we said we never want to write a new bot, but I think imagining we might will result in a README that better helps maintainers.
Reimplements gcf-utils as bot-framework without probot as a dependency.
@octokit/webhooks
already handles webhook routing and signature verification.The design principles I tried to follow were:
TaskEnqueuer
- queue payload for a background taskPayloadCache
- save payload in a cache to save space in background taskSecretLoader
- load secrets (private key, webhook secret, etc) for a botInstallationHandler
- fetch bot installations (mostly used for test mocking)Rather than making this rewrite a completely breaking change for gcf-utils, I opted to make this a new library that should more or less be a drop in replacement for gcf-utils.
Other considerations:
gcf-logger
into its own standalone package