Support SlackFunction and Function Localized Interactivity handling #1567

srajiang · 2022-08-26T20:57:16Z

Todo:

~~Some failing CI/CD, but it looks like it's related to building the @slack/deno-slack-sdk types. And I don't see this issue when I npm install and build locally, so need to investigate~~ Issue was due to breaking change that snuck it's way into a minor(?) version of typescript released on Friday. Pinning to v.4.7.4 resolved the issue for now. Long term we might want to revisit whether or not to keep the version of TS pinned.

Summary

Adds support for Function Localized Interactivity.

Adds a SlackFunction class

Configure a SlackFunction's callbackId, and any expected inputs and outputs in your project's manifest file (json or js).

Use this class to declare your handling logic and register on your app:
Example:

   const myFunc = new SlackFunction('fn_callback_id', () => {});
   app.function(myFunc);

You can also declare optional handlers for block_action and view events related to your function.
Example:
```
   myFunc.action('action_id', actionHandler).view('view_callback_id', viewHandler);
```
Note: app.function().action is not equivalent to app.action() or app.view(). Even though devs will write their interactivity handling logic similarly there are some differences including 1) Function context 2) complete() - ing one's function.

Completing your function

Call the supplied utility complete() in any handler with either outputs or an error or nothing when your function is done.

This tells Slack whether to proceed with any next steps in any workflow this function might be included in. Your outputs should match what is defined in your manifest.

Example:

   const myFunc = new SlackFunction('fn_callback_id', ({ complete }) => {
     // do my work here

     complete() // or
     complete({ outputs: {} }); // or
     complete({ error: {} });
  });

Dev Experience

Try it out yourself: hermes create -t slack-samples/take-your-time -b initial-submission
Use this branch of bolt-js on this branch npm link, then in the sample project npm link @slack/bolt

Here's an example of a best-practice function file.
Note we can add out Slack Function interactivity handlers with constraints / regex
SlackFunction logging notifies devs of Function execution handler activity. This is non-optional to begin with.

function-handler-logging-devxp.mov

Handling throws and promise rejection

function-localized-error-handling.mov

Requirements (place an `x` in each `[ ]`)

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.

srajiang

Left some notes for reviewers. Thanks in advance for your 👀 !

srajiang · 2022-08-26T20:58:40Z

src/App.ts

-   * Register subcription middleware
+   * Register WorkflowStep middleware
+   * 
+   * Not to be confused with next-gen platform Workflows + Functions


Adds some documentation to indicate WorkflowStep is an unrelated legacy feature.

src/App.ts

srajiang · 2022-08-26T21:06:09Z

src/SlackFunction.ts

@@ -46,83 +113,412 @@ export class SlackFunction {
  private callbackId: string;

  /**
-   * @description fn to to process corresponding
+   * @description handler to to process corresponding


Deno Slack SDK is using the terminology "handlers" to I am being consistent with them.

srajiang · 2022-08-26T21:07:30Z

src/cli/get-manifest.js

-  if (manifestJS) {
-    manifest = merge(manifest, manifestJS, { arrayMerge: unionMerge });
-  }
+  let manifest = getManifestData(cwd);


Moved the body of this logic out into a more generalized getManifestData() which can also be called from other parts of App or from SlackFunction.

src/SlackFunction.ts

src/types/functions/index.ts

filmaj

Tested out the app, happy path works great!

Sad path (i.e. introduce an exception in userland code) blows up the process. Left a comment in / near / around the code area. Not sure what we expect to happen in that situation.

Overall excellent work!

P.S. thanks for adding the JSDocs while you were at it 🙇

src/App.ts

src/SlackFunction.ts

filmaj · 2022-08-29T21:11:20Z

src/SlackFunction.ts

+          this.logger.debug('🚀 Executing my main handler:', this.handler);
+          return await this.runHandler(args);
+        } catch (error) {
+          this.logger.error('⚠️ Something went wrong executing:', this.handler);


I wanted to check what this log looks like but I couldn't trip it.

I edited the function body to throw an error, then this is the output I see:

[DEBUG] socket-mode:SocketModeClient:0 Received a message on the WebSocket: {"envelope_id": ... very long payload here truncated} [DEBUG] socket-mode:SocketModeClient:0 Calling ack() - type: events_api, envelope_id: 523882e6-c036-43ba-8e7a-e5c15c7f7007, data: undefined [DEBUG] socket-mode:SocketModeClient:0 send() method was called in state: connected, state hierarchy: connected,ready [DEBUG] socket-mode:SocketModeClient:0 Sending a WebSocket message: {"envelope_id":"523882e6-c036-43ba-8e7a-e5c15c7f7007","payload":{}} [DEBUG] bolt-app initialized [DEBUG] bolt-app No conversation ID for incoming event [DEBUG] SlackFunction: [review_approval] 🚀 Executing my main handler: [AsyncFunction: notifyApprover] /Users/fmaj/src/slapp-BoltJSHermes/listeners/functions/request-approval.js:12 throw new Error('boomsies'); ^ Error: boomsies at SlackFunction.notifyApprover [as handler] (/Users/fmaj/src/slapp-BoltJSHermes/listeners/functions/request-approval.js:12:9) at SlackFunction.runHandler (/Users/fmaj/src/bolt-js/dist/SlackFunction.js:60:18) at Array.<anonymous> (/Users/fmaj/src/bolt-js/dist/SlackFunction.js:184:39) at invokeMiddleware (/Users/fmaj/src/bolt-js/dist/middleware/process.js:12:53) at next (/Users/fmaj/src/bolt-js/dist/middleware/process.js:13:29) at Array.<anonymous> (/Users/fmaj/src/bolt-js/dist/conversation-store.js:67:15) at invokeMiddleware (/Users/fmaj/src/bolt-js/dist/middleware/process.js:12:53) at Object.next (/Users/fmaj/src/bolt-js/dist/middleware/process.js:13:29) at Array.<anonymous> (/Users/fmaj/src/bolt-js/dist/middleware/builtin.js:273:20) at invokeMiddleware (/Users/fmaj/src/bolt-js/dist/middleware/process.js:12:53) bolt-app local run exited with code 1

Note also that this kills the entire process. Pretty weird as I would assume this try/catch block would catch it. Guess not. Is this expected? I would have expected to see "Something went wrong", and possibly also for the process not to die. Whatever the expectation is, let's make sure to add a test for this behaviour if we can.

Yeah, so the return await ing in the line you highlighted looks right, but I missed an await in runHandler, so that was immediately fulfilling with undefined, and then getting returned out all the way up, bypassing my well-intentioned catch block. I've simplified code little bit and I think it's much clearer now. Added a test for the case as well.

src/SlackFunction.ts

codecov · 2022-08-29T22:03:56Z

Codecov Report

❗ No coverage uploaded for pull request base (future@b22a7fd). Click here to learn what that means.
The diff coverage is n/a.

@@            Coverage Diff            @@
##             future    #1567   +/-   ##
=========================================
  Coverage          ?   80.61%           
=========================================
  Files             ?       20           
  Lines             ?     1764           
  Branches          ?      502           
=========================================
  Hits              ?     1422           
  Misses            ?      221           
  Partials          ?      121

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

srajiang · 2022-08-29T22:07:48Z

package.json

@@ -93,7 +93,7 @@
    "source-map-support": "^0.5.12",
    "ts-node": "^8.1.0",
    "tsd": "^0.22.0",
-    "typescript": "^4.1.0"
+    "typescript": "4.7.4"


Caret let 4.8.2 of typescript into the mix. This version has breaking changes, which were causing ts compiler complaints on npm install of @slack/deno-slack-sdk. Pinning to the latest compatible version.

srajiang

Thanks @filmaj for the review! 🙇 I think I've resolved all of the inline comments!

src/App.ts

src/SlackFunction.ts

srajiang · 2022-08-29T23:21:41Z

src/SlackFunction.ts

+          this.logger.debug('🚀 Executing my main handler:', this.handler);
+          return await this.runHandler(args);
+        } catch (error) {
+          this.logger.error('⚠️ Something went wrong executing:', this.handler);


Yeah, so the return await ing in the line you highlighted looks right, but I missed an await in runHandler, so that was immediately fulfilling with undefined, and then getting returned out all the way up, bypassing my well-intentioned catch block. I've simplified code little bit and I think it's much clearer now. Added a test for the case as well.

srajiang · 2022-08-30T18:16:57Z

src/types/actions/dialog-action.ts

@@ -1,4 +1,8 @@
 /**
+ * Dialogs were a way to trigger interactions with users in messaging.


Left a note about this feature as being legacy (though not deprecated)

filmaj

Yeeeuhhhh epic work 🥇

srajiang · 2022-08-30T18:24:57Z

src/types/view/index.ts

@@ -55,7 +56,7 @@ export interface ViewSubmitAction {
  view: ViewOutput;
  api_app_id: string;
  token: string;
-  trigger_id: string; // undocumented
+  trigger_id?: string; // undocumented


trigger_id and token changes here as well as the similar change in BlockActions type is to reflect the fact that now in certain cases (aka when the payload is sent with FunctionContext, the trigger_id will NOT be included).

srajiang · 2022-08-30T19:17:12Z

src/SlackFunction.ts

+      actionIdOrConstraints;
+
+    // declare our valid constraints keys
+    const validConstraintsKeys: ActionConstraintsKeys = ['action_id', 'block_id', 'callback_id', 'type'];


These constraints keys types are here to help us make sure we're never declaring validConstraintsKeys that are not corresponding to the underlying ActionConstraints or ViewsConstraints types.

seratch

Looks good to me 👍 Thanks a lot for working on this

…tivity context

…1567) * Support SlackFunction and Function Localized Interactivity handling

srajiang changed the title ~~Future function interactivity~~ Support SlackFunction and Function Localized Interactivity handling Aug 26, 2022

srajiang force-pushed the future-function-interactivity branch 3 times, most recently from 265a89f to c9981db Compare August 26, 2022 21:10

srajiang commented Aug 26, 2022

View reviewed changes

srajiang marked this pull request as ready for review August 26, 2022 21:45

srajiang self-assigned this Aug 26, 2022

srajiang added the enhancement M-T: A feature request for new functionality label Aug 26, 2022

srajiang requested review from seratch, filmaj, WilliamBergamin, hello-ashleyintech and stevengill August 26, 2022 21:47

srajiang force-pushed the future-function-interactivity branch from c9981db to 73e0f1e Compare August 26, 2022 22:06

seratch reviewed Aug 26, 2022

View reviewed changes

src/SlackFunction.ts Outdated Show resolved Hide resolved

src/SlackFunction.ts Show resolved Hide resolved

src/types/functions/index.ts Outdated Show resolved Hide resolved

srajiang force-pushed the future-function-interactivity branch 2 times, most recently from d40ec6e to a32dd14 Compare August 26, 2022 23:11

filmaj reviewed Aug 29, 2022

View reviewed changes

srajiang commented Aug 29, 2022

View reviewed changes

srajiang requested review from filmaj and seratch August 29, 2022 23:24

srajiang mentioned this pull request Aug 30, 2022

[beta] Add app.function support #1383

Closed

2 tasks

srajiang added the semver:major label Aug 30, 2022

srajiang commented Aug 30, 2022

View reviewed changes

filmaj approved these changes Aug 30, 2022

View reviewed changes

srajiang commented Aug 30, 2022

View reviewed changes

srajiang force-pushed the future-function-interactivity branch from e124960 to 9d6d22f Compare August 30, 2022 22:54

seratch approved these changes Aug 31, 2022

View reviewed changes

srajiang and others added 16 commits August 31, 2022 09:44

Add run script hook

ac525e9

Update Function (#1536)

5e8d03e

merge

07f3a4f

Override token for function and function interactivity events

bbddd25

completeSuccess() and completeError() --> complete()

aa25971

Extend actions types to include function context and function interac…

668e388

…tivity context

Extend app.function to register action + view handlers

b6501ef

Pin typescript version

86fba82

Change node import type

ef261ac

Improve comment value

766f615

Add test for runHandler error

64039b2

Remove DefineDatastore from exports

2bfbcbb

Update FunctionExectionContext to reflect payload changes

e3b3ce2

botAccessToken renamed slackFunctionBotAccessToken

83b45a6

Tweak language

e2f2fd4

Bump deno to major

de0b2c2

srajiang force-pushed the future branch from 2b83ead to b22a7fd Compare August 31, 2022 16:45

srajiang force-pushed the future-function-interactivity branch from 812f851 to de0b2c2 Compare August 31, 2022 16:46

srajiang merged commit 1c7cff8 into future Aug 31, 2022

seratch mentioned this pull request Aug 31, 2022

[future beta] Add basic remote function interactivity slackapi/bolt-python#715

Merged

8 tasks

srajiang added a commit that referenced this pull request Sep 8, 2022

Support SlackFunction and Function Localized Interactivity handling (#…

208def6

…1567) * Support SlackFunction and Function Localized Interactivity handling

srajiang deleted the future-function-interactivity branch September 9, 2022 17:53

srajiang added a commit that referenced this pull request Sep 9, 2022

Support SlackFunction and Function Localized Interactivity handling (#…

7b86236

…1567) * Support SlackFunction and Function Localized Interactivity handling

srajiang added a commit that referenced this pull request Sep 9, 2022

Support SlackFunction and Function Localized Interactivity handling (#…

e283c9a

…1567) * Support SlackFunction and Function Localized Interactivity handling

srajiang added a commit that referenced this pull request Sep 13, 2022

Support SlackFunction and Function Localized Interactivity handling (#…

7f1b7f1

…1567) * Support SlackFunction and Function Localized Interactivity handling

srajiang added a commit that referenced this pull request Sep 28, 2022

Support SlackFunction and Function Localized Interactivity handling (#…

d11bf13

…1567) * Support SlackFunction and Function Localized Interactivity handling

hello-ashleyintech pushed a commit that referenced this pull request Oct 14, 2022

Support SlackFunction and Function Localized Interactivity handling (#…

52b2e6a

…1567) * Support SlackFunction and Function Localized Interactivity handling

hello-ashleyintech mentioned this pull request Nov 2, 2022

Add in block_suggestion interactivity handler support #1645

Merged

5 tasks

srajiang added a commit that referenced this pull request Nov 11, 2022

Support SlackFunction and Function Localized Interactivity handling (#…

881388e

…1567) * Support SlackFunction and Function Localized Interactivity handling

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support SlackFunction and Function Localized Interactivity handling #1567

Support SlackFunction and Function Localized Interactivity handling #1567

srajiang commented Aug 26, 2022 •

edited

Loading

srajiang left a comment

srajiang Aug 26, 2022

srajiang Aug 26, 2022

srajiang Aug 26, 2022

filmaj left a comment

filmaj Aug 29, 2022

srajiang Aug 29, 2022

codecov bot commented Aug 29, 2022 •

edited

Loading

srajiang Aug 29, 2022 •

edited

Loading

srajiang left a comment

srajiang Aug 29, 2022

srajiang Aug 30, 2022

filmaj left a comment

srajiang Aug 30, 2022 •

edited

Loading

srajiang Aug 30, 2022

seratch left a comment

		@@ -1,4 +1,8 @@
		/**
		* Dialogs were a way to trigger interactions with users in messaging.

Support SlackFunction and Function Localized Interactivity handling #1567

Support SlackFunction and Function Localized Interactivity handling #1567

Conversation

srajiang commented Aug 26, 2022 • edited Loading

Summary

Dev Experience

Requirements (place an x in each [ ])

srajiang left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

filmaj left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov bot commented Aug 29, 2022 • edited Loading

Codecov Report

srajiang Aug 29, 2022 • edited Loading

Choose a reason for hiding this comment

srajiang left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

filmaj left a comment

Choose a reason for hiding this comment

srajiang Aug 30, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

seratch left a comment

Choose a reason for hiding this comment

srajiang commented Aug 26, 2022 •

edited

Loading

Requirements (place an `x` in each `[ ]`)

codecov bot commented Aug 29, 2022 •

edited

Loading

srajiang Aug 29, 2022 •

edited

Loading

srajiang Aug 30, 2022 •

edited

Loading