Add remote function support #986

WilliamBergamin · 2023-11-16T21:34:55Z

This PR aims to add minimalist support for remote functions in 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

I created this gist to show how to test this new feature, use it for the following steps

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
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-...
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-...
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
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

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.

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

seratch

Thanks for sharing this! This is already amazing but I left a few comments

slack_bolt/app/app.py

slack_bolt/app/async_app.py

slack_bolt/app/app.py

slack_bolt/app/async_app.py

slack_bolt/request/async_internals.py

slack_bolt/request/internals.py

tests/scenario_tests/test_function.py

tests/slack_bolt/request/test_internals.py

Co-authored-by: Kazuhiro Sera <seratch@gmail.com>

misscoded

Nice work! Looking good so far. 🎉

Usability, is this what we envisioned the developer experience would be?
Usability in the gist looks good, though I want to confirm that we're going to also support the same utilities currently available in the BoltJS implementation, correct? i.e., inputs, definition, complete, fail.

Does this aline with the Bolt-js experience?
So long as the same utilities are pulled over (see above) and we replace the low-level API calls (with formal methods (e.g., functions_completeSuccess), the experience looks generally aligned.

Implementation, does this implementation align with bolt principles
Enough, IMO, though Kaz to ultimately decide.

There are some differences to be expected between the two, but that’s OK. For example, the matchers aspect is nested within the WorkflowFunction class in Bolt, but what you have here appears to be the standard approach in Bolt for Python.

One thing: we have gone with a class-based design for tidiness/organization purposes (similar to WorkflowStep seen here). I ultimately leave it to Kaz to decide if he wants to carry this approach over.

Tests, is this missing tests that could be valuable for the feature
We currently have tests as a non-blocking requirement. That said, given how quickly we’re progressing thus far, I don’t see an issue with us ensuring tests are also introduced by EOQ.

filmaj

Hell yeah I love it!
The API looks great from my point of view - feels extremely familiar.
Worked like a charm too 🥇
This is really exciting!!!

filmaj · 2023-11-17T18:36:04Z

slack_bolt/context/base_context.py

@@ -103,13 +105,23 @@ def matches(self) -> Optional[Tuple]:
        """Returns all the matched parts in message listener's regexp"""
        return self.get("matches")

+    @property
+    def function_execution_id(self) -> Optional[str]:
+        """The `function_execution_id` associated with this request."""


Should we document that this is only available for function_executed events and interactivity events scoped to a function?

Good point 💯 I will add something like "only available for function related events"?

filmaj · 2023-11-17T18:38:08Z

slack_bolt/context/base_context.py

    # --------------------------------

    @property
    def authorize_result(self) -> Optional[AuthorizeResult]:
        """The authorize result resolved for this request."""
        return self.get("authorize_result")

+    @property
+    def function_bot_access_token(self) -> Optional[str]:
+        """The bot token resolved for this function request."""


Same as above re: only available for function_executed events and interactivity events scoped to a function.

filmaj · 2023-11-17T18:39:36Z

slack_bolt/listener_matcher/builtins.py

@@ -176,6 +177,17 @@ def _verify_message_event_type(event_type: str) -> None:
        raise ValueError(error_message_event_type(event_type))


+def function_event(


Can we add a docstring here to clarify what this is for? It is clear to me given the context, but I don't trust my memory to remember this in e.g. a year from now 😅

The event and construct here (Slack Custom Function) is also named in a way that makes it confusing when discussing it in a programming concept (are you talking about the Slack Custom Function, or a Python function? etc.). I think we need to be disciplined about terminology.

Technically the type of the specific event related here is called a function_executed event - perhaps tweaking the naming to match that makes sense too.

I like renaming this function to match the event type 💯 I agree that it aligns better with the terminology

WilliamBergamin · 2023-11-17T19:03:57Z

FYI, PR #987 should fix the failing tests

WilliamBergamin · 2023-11-17T19:18:57Z

@misscoded thanks for the feedback 🙇

I want to confirm that we're going to also support the same utilities currently available in the BoltJS implementation, correct? i.e., inputs, definition, complete, fail

We will definitely support inputs, complete and fail 💯 as for definition I need to confirm this is something we can extract from the payload, I think we can add these helpers in follow up PRs this should make it easier to review and priorities.
This PR aims to be the minimal implementation of the function handler

seratch

looks great to me so far!

codecov · 2023-11-20T04:32:07Z

Codecov Report

Attention: 3 lines in your changes are missing coverage. Please review.

Comparison is base (4b086cf) 91.76% compared to head (fba35ae) 91.96%.

Files	Patch %	Lines
slack_bolt/request/internals.py	93.10%	2 Missing ⚠️
slack_bolt/context/base_context.py	90.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #986      +/-   ##
==========================================
+ Coverage   91.76%   91.96%   +0.20%     
==========================================
  Files         181      190       +9     
  Lines        6312     6509     +197     
==========================================
+ Hits         5792     5986     +194     
- Misses        520      523       +3

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

seratch

while reviewing this PR again, i found a few minor issues

seratch · 2023-11-21T05:46:06Z

slack_bolt/logger/messages.py

+                default_message,
+                f"""
+@app.function("{callback_id}")
+{'async ' if is_async else ''}def handle_{callback_id}_function(body, event, client, logger):


It seems that you can have "-" as part of callback_id. In this case, the generated code can have syntax error in Python. I haven't examined what else can be used for callback_id, so replacing all non-alphanumeric characters to "_" (underscore) should be a safe way to deal with such edge cases.

Good catch 💯 I've opted to follow a similar pattern found in this file, by hardcoding the function name as handle_some_function instead of using the callback_id to dynamically name the function

slack_bolt/middleware/__init__.py

Co-authored-by: Kazuhiro Sera <seratch@gmail.com>

* initial commit * Add complete and fail helper functions * Add function inputs to the context * restore noqa * expose Complete and fail * fix useless changes

WilliamBergamin · 2024-01-25T16:40:15Z

Changed the base branch from main to feat-functions in order to properly create a release candidate with the changes

WilliamBergamin added 8 commits November 15, 2023 16:29

add listener

8ae012d

EOF commit

8c51fed

Improve additions

045a13b

improve function handlers

4250ac2

clean up changes

68109f6

Update utils.py

741d0ed

improve pydocs

0d00542

Clean up PR

5a033ca

WilliamBergamin added enhancement New feature or request area:async area:sync semver:minor labels Nov 16, 2023

WilliamBergamin requested review from seratch and misscoded November 16, 2023 21:34

WilliamBergamin self-assigned this Nov 16, 2023

seratch requested changes Nov 17, 2023

View reviewed changes

WilliamBergamin and others added 4 commits November 17, 2023 09:00

Update slack_bolt/app/app.py

2e5353f

Co-authored-by: Kazuhiro Sera <seratch@gmail.com>

Improve based on feedback

c51f845

fix tests improve imports

054bc36

improve context logic

676035a

misscoded reviewed Nov 17, 2023

View reviewed changes

filmaj approved these changes Nov 17, 2023

View reviewed changes

WilliamBergamin requested a review from seratch November 17, 2023 19:00

Improved based on feedback

8639eff

seratch approved these changes Nov 17, 2023

View reviewed changes

Merge branch 'main' into function_handler

9be21a3

seratch mentioned this pull request Nov 20, 2023

Add remote function support slackapi/java-slack-sdk#1239

Merged

6 tasks

Improve test coverage

d8b8d41

WilliamBergamin marked this pull request as ready for review November 20, 2023 20:01

WilliamBergamin changed the title ~~Introduce The Function Handler~~ Add remote function support Nov 20, 2023

seratch reviewed Nov 21, 2023

View reviewed changes

This was referenced Nov 21, 2023

Add functions.completeSuccess/Error APIs for remote functions slackapi/python-slack-sdk#1432

Merged

Add custom function support slackapi/java-slack-sdk#1241

Open

WilliamBergamin and others added 13 commits November 21, 2023 10:30

Merge branch 'main' into function_handler

34341ad

Update slack_bolt/middleware/__init__.py

5d668c9

Co-authored-by: Kazuhiro Sera <seratch@gmail.com>

improve message reliability

2687f6d

Merge branch 'main' into function_handler

2bb93fb

fix async test

02ed68d

Leverage client.functions_completeError

fc34e43

fix functionComplete invocations

3fc4db8

leverage functions_completeSuccess

6101d51

Merge remote-tracking branch 'upstream/main' into function_handler

120bb30

[feat] add function kwargs injection (#8)

13bf158

* initial commit * Add complete and fail helper functions * Add function inputs to the context * restore noqa * expose Complete and fail * fix useless changes

Merge branch 'main' into function_handler

9348101

Update mock_web_api_server.py

708dea9

Merge branch 'main' into function_handler

fba35ae

WilliamBergamin changed the base branch from main to feat-functions January 25, 2024 16:36

WilliamBergamin merged commit 370cddf into slackapi:feat-functions Jan 25, 2024
23 checks passed

WilliamBergamin deleted the function_handler branch January 25, 2024 16:45

WilliamBergamin mentioned this pull request Jan 25, 2024

Add custom function support #1021

Open

8 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add remote function support #986

Add remote function support #986

WilliamBergamin commented Nov 16, 2023 •

edited

Loading

seratch left a comment

misscoded left a comment

filmaj left a comment

filmaj Nov 17, 2023

WilliamBergamin Nov 17, 2023 •

edited

Loading

filmaj Nov 17, 2023

filmaj Nov 17, 2023

filmaj Nov 17, 2023

WilliamBergamin Nov 17, 2023

WilliamBergamin commented Nov 17, 2023

WilliamBergamin commented Nov 17, 2023

seratch left a comment

codecov bot commented Nov 20, 2023 •

edited

Loading

seratch left a comment

seratch Nov 21, 2023

WilliamBergamin Nov 21, 2023

WilliamBergamin commented Jan 25, 2024

		@@ -176,6 +177,17 @@ def _verify_message_event_type(event_type: str) -> None:
		raise ValueError(error_message_event_type(event_type))


		def function_event(

Add remote function support #986

Add remote function support #986

Conversation

WilliamBergamin commented Nov 16, 2023 • edited Loading

Feedback

Testing

Category

Requirements

seratch left a comment

Choose a reason for hiding this comment

misscoded left a comment

Choose a reason for hiding this comment

filmaj left a comment

Choose a reason for hiding this comment

filmaj Nov 17, 2023

Choose a reason for hiding this comment

WilliamBergamin Nov 17, 2023 • edited Loading

Choose a reason for hiding this comment

filmaj Nov 17, 2023

Choose a reason for hiding this comment

filmaj Nov 17, 2023

Choose a reason for hiding this comment

filmaj Nov 17, 2023

Choose a reason for hiding this comment

WilliamBergamin Nov 17, 2023

Choose a reason for hiding this comment

WilliamBergamin commented Nov 17, 2023

WilliamBergamin commented Nov 17, 2023

seratch left a comment

Choose a reason for hiding this comment

codecov bot commented Nov 20, 2023 • edited Loading

Codecov Report

seratch left a comment

Choose a reason for hiding this comment

seratch Nov 21, 2023

Choose a reason for hiding this comment

WilliamBergamin Nov 21, 2023

Choose a reason for hiding this comment

WilliamBergamin commented Jan 25, 2024

WilliamBergamin commented Nov 16, 2023 •

edited

Loading

WilliamBergamin Nov 17, 2023 •

edited

Loading

codecov bot commented Nov 20, 2023 •

edited

Loading