bolt-python icon indicating copy to clipboard operation
bolt-python copied to clipboard

Add custom function support

Open WilliamBergamin opened this issue 2 years ago • 1 comments

This PR includes all the changes from #986 aims to add support for custom functions in Bolt Python

Feedback

I'm looking for feedback on

  • Usability, is this what we envisioned the developer experience would be?
  • Does this aline with the Bolt-js experience?
  • Implementation, does this implementation align with bolt principles
  • Tests, is this missing tests that could be valuable for the feature

Testing

This gist was created to show how to test these new feature, use it with the following steps

  1. Create a new app a. Head to https://api.slack.com/apps/?new_app=1 b. Click "From an app manifest" c. Select YAML and paste the above manifest.yml content d. Click create button
  2. Install the app into org/workspace a. Install the app anyways (when the workspace is in an Org, org-wide installation is required to publish functions) b. Grab the xoxb- token (Settings > Install App > Bot User OAuth Token) c. export SLACK_BOT_TOKEN=xoxb-...
  3. Set up Socket Mode a. Head to Settings > Basic Information > App-Level Tokens on the https://api.slack.com/apps page b. Generate a new token with connections:write scope c. export SLACK_APP_TOKEN=xapp-...
  4. Spin up the app a. Add app.py and async_app.py with the above source code b. Pull the latest PR branch of bolt python to your local c. Run scripts/build_pypi_package.sh this will generate a .whl in the dist/ folder d. (Optional) In your project set up a venv with python -m venv .venv and source .venv/bin/activate e. pip install global/path/to/bolt-python/dist/something.whl f. pip install aiohttp g python app.py or python async_app.py
  5. Add the custom step to a workflow a. Open the workflow builder b. Create a new workflow with a link trigger d. Seach "Hello" in the Steps view on the right side e. Add the step to the workflow (you can set any user ID as the input) f. Publish the workflow

Category

  • [x] slack_bolt.App and/or its core components
  • [x] slack_bolt.async_app.AsyncApp and/or its core components
  • [ ] Adapters in slack_bolt.adapter
  • [ ] Document pages under /docs
  • [ ] Others

Requirements

Please read the Contributing guidelines and Code of Conduct before creating this issue or pull request. By submitting, you are agreeing to those rules.

  • [x] I've read and understood the Contributing Guidelines and have done my best effort to follow them.
  • [x] I've read and agree to the Code of Conduct.
  • [x] I've run ./scripts/install_all_and_run_tests.sh after making the changes.

WilliamBergamin avatar Jan 25 '24 16:01 WilliamBergamin

Codecov Report

Attention: Patch coverage is 98.49246% with 3 lines in your changes missing coverage. Please review.

Project coverage is 92.00%. Comparing base (fbd6462) to head (cd82e9a). Report is 1 commits behind head on main.

Files Patch % Lines
slack_bolt/request/internals.py 93.10% 2 Missing :warning:
slack_bolt/context/base_context.py 90.00% 1 Missing :warning:
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1021      +/-   ##
==========================================
+ Coverage   91.80%   92.00%   +0.19%     
==========================================
  Files         186      195       +9     
  Lines        6408     6605     +197     
==========================================
+ Hits         5883     6077     +194     
- Misses        525      528       +3     

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

codecov[bot] avatar Jan 25 '24 17:01 codecov[bot]

@seratch @WilliamBergamin When will this PR be merged?

sharvesh06 avatar Jul 03 '24 15:07 sharvesh06

@sharvesh06 yess this PR will be merged soon!

WilliamBergamin avatar Jul 26 '24 18:07 WilliamBergamin