Repository navigation
feat(standardized-auth): add an acme sample for standardized app auth - #305
Draft
WilliamBergamin wants to merge 19 commits into
Draft
WilliamBergamin wants to merge 19 commits into
WilliamBergamin wants to merge 19 commits into
Conversation
Connects user accounts with the Slack-owned Connect and Manage connection controls. Bolt's installation store holds each connection: the OAuth success hook reports it with apps.user.connection.requestAuth, the disconnect action forgets and revokes the user token, tokens_revoked forgets users who remove the app, and the user_connection_status_requested event is answered with apps.user.connection.update. App Home renders the auth_provider block. The user_connection request listener is written and tested but not yet registered, since no Bolt routes that payload to action listeners yet.
Resolves the conflict with #306, which replaced test.yml with ci.yml. Adds standardized-auth to the lint, typecheck, and test matrices. Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
OAuth state no longer needs files on disk. The state is now an HMAC-signed token checked with the signing secret, and it expires after 5 minutes because a stateless token can be replayed until then. Installations stay in the file store so connections survive a restart. Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
… helpers
Split the listeners into src/listeners/{events,actions,oauth}/, one file per
handler, following the bolt-python-starter-template layout. Replace the
AcmeAccounts and AcmeListeners classes, the Connection dataclass, and the
action ID constants with plain functions in src/acme.py, and use a single
App Home greeting. Tests mirror the new layout.
Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
Each listener file now registers itself with @app.action or @app.event, so its id sits next to its callback. app.py imports every file under src/listeners at startup, replacing the hand-written register functions, and the user_connection listener is registered too. Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
… bolt_app.py Renaming src/app.py to src/bolt_app.py leaves one module named app, the entry point. The OAuth success and failure callbacks are arguments to OAuthSettings rather than listeners, so they now live next to the App they configure, and src/listeners holds only self-registering listeners. Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
Loading the listener directory where the app is built means any import of the app comes with every listener registered, and app.py is left as a plain entry point. Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
…package The loader builds each module name from the listeners directory and the package bolt_app.py lives in, so no project root path is needed. Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
Walking the listeners package by module name reads more plainly than building names from file paths. Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
…tion on forget Deleting only the per-user installer files left the revoked user token in the workspace's latest installation. Bolt's authorize then ran auth.test on that token for the disconnected user and dropped their next request. Saving the installation without the user token updates both files. Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
The default success page sends org-wide installs to the admin page for adding workspaces. A user who clicked Connect should land back in the app's Home tab, so the success callback now redirects there. Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
…in page The installation store pulled in OAuth, request URLs, a signing secret, token revocation, and tokens_revoked, none of which the sample is about. Acme now runs over Socket Mode, keeps connections in SQLite, and serves a small sign-in page as the Connect auth_url. A signed state ties that page to the Slack user who clicked Connect. Only the sign-in page needs ngrok, since auth_url must be HTTPS. Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
…ample Sign-in state now comes from StatelessOAuthStateStore, signed with a per-user secret so the user_id tag can't be swapped, and expires after 5 minutes as the SDK docs recommend. Connections persist with shelve instead of a hand-written SQLite table, the sign-in GET only renders the form (the POST checks the state), and the Bolt dispatch tests that duplicated the listener tests are gone. Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
Clicking Connect now connects the Slack user who clicked it, with their user ID as the connected identity. Slack signs that click, so the sample no longer needs a browser sign-in page, a state, or a public URL; everything runs over Socket Mode. The manifest keeps example.com in auth_hosts because Slack requires at least one host when user connections are enabled. The README explains how to bring back auth_url with a signed state for a real login, and notes that the Slack CLI must be newer than v4.10.0 to send user_connections. Tests use setup_method/teardown_method in place of fixtures. Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
The app and its five listeners now live in src/listeners.py, which drops the walk_packages loader in src/bolt_app.py and the listeners package tree. Listener tests move into tests/test_listeners.py. Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
The App, its five listeners, and the Socket Mode entry point now share app.py, so src/listeners.py goes away. Listener tests follow as tests/test_app.py. Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
This pull request adds a
standardized-authsample: Acme, an app that connects user accounts with the Slack-owned Connect and Manage connection controls. Rocket skates, anvils, and giant magnets not included.apps.user.connection.requestAuth, which also redraws an open auth modal, and refreshes App Home.tokens_revokedforgets users who remove the app.user_connection_status_requestedis answered withapps.user.connection.update.auth_providerblock.@app.actionor@app.event, andapp.pyimports every file undersrc/listenersat startup, so a new listener only needs a new file.user_connectionlistener, for the Connect on the app profile, is registered, but it won't fire until Bolt routes theuser_connectionpayload to.actionlisteners.slack_sdkto python-slack-sdk main by commit until the next release.Testing
In a workspace where standardized app authentication is available:
ngrok http 3000and replace1234-56-78-90-0.ngrok-free.appinmanifest.json.slack install --environment local, thenslack env initwith the client ID, client secret, signing secret, and your ngrok URL asBASE_URL.slack runand openhttps://<ngrok host>/slack/installto install the app.@you.🤖 Generated with Claude Code