Test.Sandwich.Formatters.Slack.Internal

Documentation

postMessage :: (MonadError Text m, MonadIO m) => SlackConfig -> ChannelName -> Text -> [Value] -> Maybe [Value] -> m Value

updateMessage :: (MonadError Text m, MonadIO m) => SlackConfig -> ChannelName -> Text -> Text -> [Value] -> Maybe [Value] -> m ()

encode' :: ToJSON a => a -> Text

makeSlackCall :: (MonadError Text m, MonadIO m) => SlackConfig -> String -> Value -> m Value

(??) :: MonadError e m => Maybe a -> e -> m a infixl 7

toMarkdown :: FailureReason -> Text

callStackToMarkdown :: SlackFormatterShowCallStacks -> CallStack -> Text

showCallStack :: CallStack -> Text

createProgressBar :: SlackConfig -> ChannelName -> Maybe Int64 -> ProgressBarInfo -> IO (Either Text ProgressBar)

Create a progress bar message on the given channel. Returns a ProgressBar which can be used to update the message by calling updateProgressBar.

updateProgressBar :: SlackConfig -> Maybe Int64 -> ProgressBar -> ProgressBarInfo -> IO (Either Text ())

Update an existing progress bar.

Internal

getMessage :: ProgressBarInfo -> Text

getAttachments :: ProgressBarInfo -> [Value]

addMessageToBlocks :: Text -> Maybe [Value] -> Maybe [Value]

truncateBlocksIfNecessary :: Maybe Int64 -> [Value] -> [Value]

This is kind of wasteful, because it requires encoding every block to get the lengths. It's also a little rough because it won't exactly match the length of the encoded blocks list (with brackets etc.) and doesn't take into account the rest of the message. Hopefully it's close enough to correct, but TODO find a way to do the truncating efficiently as part of encoding the message onto the wire.

barSized :: Double -> Text

newtype SlackConfig

Configuration options needed to connect to the Slack API

Constructors

SlackConfig

Fields

• slackApiToken :: Text

  Slack API token

Instances

Show SlackConfig

Defined in Test.Sandwich.Formatters.Slack.Internal.Types

Methods

showsPrec :: Int -> SlackConfig -> ShowS

show :: SlackConfig -> String

showList :: [SlackConfig] -> ShowS

data ProgressBarInfo

The state of a progress bar message.

Constructors

ProgressBarInfo

Fields

• progressBarInfoTopMessage :: Maybe Text

  Message to show above the progress bar

• progressBarInfoBottomMessage :: Maybe Text

  Message to show below the progress bar

• progressBarInfoSize :: Maybe Double

  Size of the progress bar, a Double from 0 to 100

• progressBarInfoAttachments :: Maybe [ProgressBarAttachment]

  Slack attachments for the message

• progressBarInfoBlocks :: Maybe [Value]

  Structured blocks, using the Slack Block Kit

data ProgressBarAttachment

A Slack attachment.

Constructors

ProgressBarAttachment

Fields

• progressBarAttachmentText :: Text

  Attachment text

• progressBarAttachmentColor :: Text

  Attachment color

Instances

ToJSON ProgressBarAttachment

Defined in Test.Sandwich.Formatters.Slack.Internal.Types

Methods

toJSON :: ProgressBarAttachment -> Value

toEncoding :: ProgressBarAttachment -> Encoding

toJSONList :: [ProgressBarAttachment] -> Value

toEncodingList :: [ProgressBarAttachment] -> Encoding

data ProgressBar

An opaque type representing an existing Slack message.

Constructors

ProgressBar

Fields

• progressBarTs :: Text
• progressBarChannel :: Text

data SlackFormatterShowCallStacks

Constructors

SlackFormatterNoCallStacks

Don't include callstacks in failure messages

SlackFormatterTopNCallStackFrames Int

Include the top N stack frames

SlackFormatterFullCallStack

Include the full callstack

type ChannelName = Text