slackapi/hubot-slack

SlackBot#send() support for a callback function

Open

#473 opened on Apr 13, 2018

View on GitHub
 (0 comments) (6 reactions) (0 assignees)CoffeeScript (2,339 stars) (637 forks)batch import
enhancementgood first issue

Description

Description

in order to know anything about a message after it has been sent, there needs to be a way to run a callback after the chat.postMessage() method completes.

it seems that the Response#send() (from Hubot core) method will invoke the adapter's send() method with the final item in the messages... array set to a function, if the user's script specified one.

this means that all we need to do is pass that callback function into the SlackClient#send() method and make sure it's used as the callback (we can set a default value of a noop function if not).

this support should also be extended to reply() and setTopic().

this would unlock use cases such as #91

Requirements (place an x in each of the [ ])

  • 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 searched for any related issues and avoided creating a duplicate issue.

Contributor guide

Tech stack
nodejsjavascript
Domain
apibackend
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Understanding of Hubot adapter patternBasic JavaScript/Node.js
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Look at the send method in the SlackBot adapter (likely in src/slackbot.coffee). Implement a callback parameter that defaults to a noop function and pass it to the underlying SlackClient.send() call. Also update reply() and setTopic() similarly. Refer to Hubot's documentation on Response#send for how the callback is passed.