CHANGELOG.md

2.1.2 (2023-07-31)

It is strongly reccomended you upgrade your bridge, as this release contains security fixes.

🔒 Security

• Fixes for GHSA-vc7j-h8xg-fv5x.

Features

• Add improved error messages in setup widget. (#744)
• Add support for specifying a HTTP proxy to connect to the Slack API. (#750)

Bugfixes

• Fix the provisioner staring once per bridged room. (#751)

Internal Changes

• Update matrix-appservice-bridge to 8.1.2. (#765)

2.1.1 (2023-03-07)

Internal Changes

• Fix provisioning API base URL in setup widget. (#739)
• Update matrix-appservice-bridge to 8.1.1. (#740)

2.1.0 (2023-03-03)

Features

• Add a new UI widget for linking and unlinking channels from within a Matrix room. (#734, #735)

Internal Changes

• Correctly attribute mkarg for documentation contributions. We also reverted commits and recommited them with the correct Author value set. (#729)
• Optimize the Dockerfile to speed up image rebuilds following a code change. (#732)
• Update the provisioning API to use matrix-appservice-bridge. (#733)

2.0.2 (2022-11-30)

No significant changes.

2.0.2-rc2 (2022-11-30)

Bugfixes

• Safely handle errors from admin commands. (#725)

Internal Changes

• Docs: Docker container uses port 5858 unless explicitly modified in config.yaml (#718). Contributed by @mkarg
• Docs: Fixed numbering by fixing indentation (#719). Contributed by @mkarg
• Docs: Run bridge as daemon (#720). Contributed by @mkarg
• Docs: Merge #718, #719 and #720 and reduce abbreviations. (#727)

2.0.2-rc1 (2022-11-28)

Bugfixes

• Correctly set "is_falling_back" flag in thread events so that events in threads are not also displayed as replies. (#709)
• Fix crash in whoami command when the team name of a Slack account is unavailable. (#714)
• Prevent admin commands from being unusable after an invalid command is issued. (#717)
• Improve the calculation of DM names & avatars. (#721)
• Ensure messages you send in a DM from Slack will appear in Matrix, even if the ghost of your Slack account was not initially present in the Matrix DM room. (#722)

Internal Changes

• Update matrix-appservice-bridge to 6.0.0. (#710)
• Remove annoying noisy Didn't handle event log line. (#712)
• Remove IDE-related files from version control. (#715)

2.0.1 (2022-10-06)

This release fixes a bug in our build system that prevented Docker images from being built. Users not using Docker on 2.0.0 are not required to upgrade.

2.0.0 (2022-10-05)

Note, as with 2.0.0-rc1, release requires Node.16 or greater.

Bugfixes

• Add missing reactions:write scope to oauth scopes. (#696)
• Fix PostgreSQL schema 14 not applying cleanly if events containing NULL columns. (#701)
• Fix /metrics and /ready paths requiring authentication. (#704)
• Disallowed the accidental behaviour of puppeting two or more Slack accounts from the same team to the same Matrix user. This would cause all puppeting for the user to stop working. The bridge will now automatically delete any puppeted connections which violate this rule. You will be notified via the bridge when this happens, so you can relink your accounts. (#705)

2.0.0-rc1 (2022-07-29)

This release requires Node.16 or greater.

Features

• New releases will now include Docker images built on the linux/amd64 platform in addition to x86_64. (#656)

Bugfixes

• Improve performance of removing deleted Slack users from rooms. (#649)

Improved Documentation

• Use the matrix-appservice-bridge contributing guide. (#686)

Deprecations and Removals

• The bridge now requires Node.JS 16 or greater. (#690)

Internal Changes

• Don't allow NULL in SQL columns of events, matching the expectation of the models. (#670)
• Fix towncrier script for summarising the newsfiles (#677)
• Switch from npm to yarn for dependency management. (#685)
• Move CI to GitHub Actions. (#688)
• Add new CI workflow to check for signoffs. (#693)

1.11.0 (2022-04-05)

No significant changes.

1.11.0-rc1 (2022-03-21)

Features

• Support bridging Slack message threads with new m.thread relations (MSC3440) (#634, #673)
• Add check to verify if the homeserver <-> bridge connection is working on startup. (#666)

Bugfixes

• Fix: Don't create an internal ping room on every restart (#669)

Internal Changes

• Upgrade dependency axios to 0.26.0 to close a possible vulnerability (#664)
• Remove uses of the deprecated JavaScript function substr() (#665)

1.10.0 (2021-12-22)

No significant changes.

1.10.0-rc3 (2021-12-13)

Bugfixes

• Fix inverted check causing Slack messages to not be relayed to Matrix. Thanks to @ewilderj (#648)

Internal Changes

• Fix a regression in Node 16+ environments where the bridge may occasionally crash when a message wasn't handled successfully. (#646)

1.10.0-rc2 (2021-12-06)

Internal Changes

• Switch to using Debian as a base for Docker images. (#645)

1.10.0-rc1 (2021-11-23)

Bugfixes

• Improve reliability of Matrix users being bridged with correct displayname and avatar (#628)
• Fix an issue where Slack users sometimes have stale displaynames (#631)

Internal Changes

• Use the MembershipQueue for handling joins and leaves in the TeamSyncer. (#633)
• Docker images now use Node 16 (#639)
• Update dependencies, remove unused winston dependencies. (#640)

1.9.0 (2021-10-11)

No significant changes.

1.9.0-rc3 (2021-10-08)

Bugfixes

• Fix a bug where typing in an admin command in the bridge admin room would cause the bridge to immediately exit. (#624)

1.9.0-rc2 (2021-10-08)

Features

• Track the success/failure rate of oauth sessions with the oauth_session_result metric. (#621)
• Make UserActivityTracker configurable (#623)

1.9.0-rc1 (2021-09-30)

Features

• Make the team sync hint to channel admins configurable (#601)
• Add optional bridge blocking upon exceeding a monthly active user limit (#612)
• The bridge now automatically invites users to private rooms if there is a message and they are not joined. (#613)

Bugfixes

• Sync channels and users of a Slack team independently, so that one failure does not cause the other to fail. (#599)
• Fix a crash on startup caused by the homeserver rejecting a join/leave from a ghost when team sync is enabled. (#606)
• Add missing help text for whoami command. (#620)

Internal Changes

• Switched out or pinned several packages that require ESM modules, as we don't want to use ESM modules. (#605)
• Docker images are now automatically build and published via GitHub Actions, replacing DockerHub Autobuilds. (#610)
• Update bridge to matrix-appservice-bridge 3.1.0 (#614)

1.8.0 (2021-04-22)

No significant changes.

1.8.0-rc1 (2021-04-19)

Features

• Add provisioning endpoint to get Slack channel info (#571)
• Add teamSync.xyz.channels.allow_public option to disable public channel syncing (#577)

Bugfixes

• Autocreated public rooms will no longer be encrypted by default (#576)

Improved Documentation

• Mention the need for a classic app in the documentation. (#427)

Internal Changes

• Update to matrix-appservice-bridge 2.6.0-rc1 (#575)
• The unit/integration tests have been moved to the root level, and are not built by default. (#582)
• Regenerate package-lock.json to fix a build issue (#586)
• Config samples: Corrected rtm.logging to rtm.log_level rtm.log_level: "off" is not a valid value and should be "silent" (#587)
• Update to matrix-appservice-bridge 2.6.0 (#589)

1.7.0 (2021-02-11)

No significant changes.

1.7.0-rc1 (2021-02-05)

Features

• Add logout user admin room command (#559)
• Ensure private channels are synchronised on startup. (#563)

Bugfixes

• Fixed a problem where automatically created rooms would not get an alias. (#544)
• Fix a bug where DMs from Slack are not persisted in the DB. (#558)

Internal Changes

• Stop the bridge from emitting "MaxListenersExceededWarning" warnings. (#556)
• Bump package versions (#557)
• Use improved encryption support from matrix-appservice-bridge (#564)

1.6.2 (2021-01-14)

Bugfixes

• Fix metrics bug: Month has been off by one (e.g. January = 0) (#553)

Improved Documentation

• Clarify upgrade steps in documentation. Contributed by Cameron Otsuka. (#545)

1.6.1 (2020-11-06)

Features

• Allow docker to reuse cache when building the image by copying only npm related file before running npm install (#531)

Bugfixes

• Hide typing notifications from puppeted users on Matrix (#528)
• Fix an issue where the bridge may send duplicate messages to Slack when encryption is enabled. (#539)

Improved Documentation

• Improve the installation docs and the sample config file (#389)

Internal Changes

• Added missing encryption config to the schema and sample config. (#538)

1.6.0 (2020-10-02)

No significant changes since the previous RC.

1.6.0-rc2 (2020-10-01)

Bugfixes

• Fix bot responding to its own messages. (#527)

1.6.0-rc1 (2020-10-01)

Features

• New configuration option provisioning.channel_adl to manage which Slack channels may be bridged. New configuration option team_sync.*.allow_private to allow/deny bridging private channels. (#476)
• Support removing reactions from Slack and Matrix messages (#485)
• Add support for bridge message encryption. (#493)
• Add onboarding message for new users when puppeting is enabled (#506)
• Join puppet to Slack channel if they are not already joined when sending a message (#515)
• The help command now distinguishes positional and named parameters. (#520)
• Fixed a bug where Slack messages would not bridge if a mentioned channel lacked an alias (#525)

Bugfixes

• Ensure that the bridge still syncs created and deleted channels, as well as new slack users, when using the RTM API. (#477)
• Do not join the Slack bot to the Matrix side (#478)
• Reduce chance of duplicate messages arriving on Matrix when using puppeting (#482)
• Stop handling the deprecated events channel_join and channel_leave. We already handle the new event types. (#487)
• Update matrix-appservice-bridge dependency to version 2.0 (#491)
• Fix issue where a thread chain on Slack would not correctly chain replies on Matrix (#499)
• OAuth2 URLs no longer break when oauth2.redirect_prefix is missing a trailing slash (#504)
• Fix issue where generated OAuth2s would be malformed (#508)
• Bridge 👍️ and 👎️ reactions more accurately from Slack to Matrix by appending U+FE0F (Emoji-style variant) (#509)

Improved Documentation

• Add documenation to enable puppeting support (#505)
• Reformat feature documentation and include new features (#507)

Internal Changes

• Upgrade dependencies (#484, #521)
• Remove support for removing reactions removal for NeDB (#489)
• Migrate from TSLint to ESLint (#490)
• Fix plenty of ESLint warnings (#502)
• Be stricter about API responses and reduce linter warnings (#510)
• Remove code to deduplicate incoming Matrix events (#516)

1.5.0 (2020-09-01)

Features

• When a user connects their team for the first time, sync members and channels! (#475)

Bugfixes

• Fix schema for puppeting.direct_messages (#474)

1.5.0-rc1 (2020-08-25)

Features

• Add disallow_direct_messages config option to selectively deny users the ability to DM bridged users. (#435)
• Bridge in all Slack members of a channel when connnecting it to a room. (#448)

Bugfixes

• Don't redact Matrix events as a result of the bridge deleting a Slack message. (#431)
• Print the correct appservice port on the console when using the one from the config (#440)
• Fixes the broken admin command "help oauth" (#445)
• The bridge will no longer register deleted Slack users on startup. (#448)
• Fix an issue where sometimes Slack media files would be bridged as a 'm.file' (#450)
• Stop Team Sync from calling Slack's API more rapidly than configured (#454)
• Fix NedbDatastore.getTeam when an error happened or the team doesn't exist (#455)
• Correctly handle TeamSync failures, which displays a warning but does start the bridge. This previously resulted in an uncaught Promise. (#456)
• Fix issue where slack messages would not properly thread together (#459)
• Rename unlink room command to unlink to make it callable. Allow link to be called with a team_id (#462)
• Don't automatically join new users to all public channels (#463)
• Fix issue where bridged Slack files fail silently or upload garbled data. (#466)
• Fix issue where Slack files would not be uploaded to Matrix (#470)

Improved Documentation

• Consistently suggest to use port 5858 for the appservice (#436)

Internal Changes

• Misc improvements to PostgreSQL datastore. Thanks @vitaly-t! (#429)
• Upgrade dependencies (#437)
• Rebrand: Replace mentions of Riot with Element (#438)
• Remove local buildkite files in favour of using the matrix-org/pipelines repo. (#442)
• Admin commands must be a string (#443)
• Add unit tests for AdminCommand (#444)
• Warn if the bot isn't in the admin room (#458)
• Improve event processing time by adding an index to the events table (#469)

1.4.0 (2020-06-23)

No significant changes.

1.4.0-rc1 (2020-05-29)

Features

• Move matrix<->slack account links to a seperate table, and properly logout users. (#419)
• Add bot profile information on startup. (#423)
• Add /ready endpoint (#425)

Bugfixes

• Fix issue which breaks setting up puppeting (#418)
• Fix issue where puppets could not be registered for the same team or mxid twice. (#420)
• Fix bug where puppeted users couldn't edit their own messages (#424)
• Fix bug where users could not become puppeted if they had already logged in via oauth (#426)

Internal Changes

• Fix provisioning.enabled config flag to be recognised in the code, and add ability to disable puppeting from the config. (#411)
• Load configuration schema using absolute path to make it possible to start the service from any directory. (#415)
• Fix team_sync indentation in the sample config. (#416)
• Drop leftover code for oauth with webhooks, as it's not been supported for a long time. (#422)

1.3.2 (2020-05-13)

Internal Changes

• Update to pg-promise 10.5.5 (#410)

1.3.1 (2020-05-13)

Bugfixes

• Fix bridge mistakenly calling the wrong slack endpoint on /channels (#409)

1.3.0 (2020-05-12)

Features

• Add ability to limit the number of teams and rooms via the config (#397)
• Check if a channel is linked to another room, and unauthorize the link if so. (#401)
• Support automatically bridging to the new room on room upgrade (#402)

Bugfixes

• Allow bridging to private channels via the provisioner (#403)
• Fix postgress configurations failing to start when using the offical docker image. (#405)
• Bridge will no longer update user's displayname with a bots name when a bot is modified (#408)

Internal Changes

• Fix exception on missing error in createTeamClient (#404)

1.2.0 (2020-05-07)

No significant changes.

1.2.0-rc1 (2020-04-17)

BREAKING CHANGE - Note that this release requires requests to /_matrix/provision are authenticated with the hs_token.

Features

• Add metrics for active users and rooms (#380)

Bugfixes

• Include server name in the Matrix users regex (#368)
• Fix Slack user updates (e.g. to their Display name) not getting immediately synced with Workspace Sync enabled (#377)
• Fix occasional crash if an error occurs handling a Slack event. (#392)
• SECURITY FIX The bridge now requires authentication on the /_matrix/provision set of endpoints. It requires either an access_token query parameter or a Authorization header containing the hs_token provided in the registration file. (#395)

Improved Documentation

• Change NPM instructions to use the path config/config.yaml (#364)
• Correct database name in a code example to slack_bridge (#365)
• Minor wording changes in getting_started.md (#366)
• Use a descriptive label for a link in README.md (#367)
• Add documentation for Team Sync (#372)

Internal Changes

• Add decorators to provisioning functions (#358)
• Bump minimist from 1.2.0 to 1.2.2 (#362)
• Correct ISlackEvent.user type; remove unused declarations (#374)
• Enable code linting for no-any where it does matter (#375)
• Fix read the docs and add new page to nav bar (#379)
• Upgrade various low-risk dependencies (#381)
• Upgrade uuid dependency (#382)
• Upgrade quick-lru dependency (requires NodeJS >=10) (#383)
• Add Launch config for VS Code and enable SourceMaps (#384)
• Add error and debug logs to .gitignore (#385)
• Remove chalk as a direct dependency (#386)
• Upgrade dependency pg-promise 10, which requires PostgreSQL 11 (#387)
• Fix PostgreSQL errors when a metric activity is recorded twice (#393)
• Updated dependency matrix-appservice-bridge to 1.12.2 (#396)

1.1.0 (2020-02-21)

No significant changes.

1.1.0-rc1 (2020-02-19)

Features

• Add ability to sync Slack channels and users automatically to Matrix (#331)
• Sync Slack membership changes to Matrix (#332)
• Add whoami user command. (#337)
• Create private rooms on demand if it doesn't exist (#340)

Bugfixes

• Fix edits from Matrix appearing as fallback text. (#324)
• Fix issue where Slack edits would sometimes not appear as Matrix edits. (#325)
• Fix issue where messages from the bot would be interpreted as commands. (#329)
• Fix matrix replies not showing up on slack (#336)
• Allow webhook/oauth/event requests with prefixes. (#339)
• Fix issue where slack bot actions may fail (such as listing channels). Also increase the number of channels returned when provisioning (#355)

Internal Changes

• SIGTERM now causes a clean exit (#330)
• Move ghost handing to SlackGhostStore (#335)
• New installations should use a "Classic Slack app" rather than a new Slack App for OAuth. More details in README.md (#356)

1.0.2 (2019-11-13)

Features

• Messages bridged to Slack now get links with text-based content unfurled (#266)

Bugfixes

• Fix Markdown link replacements deleting link text, links, and text between links. (#299)
• Fix Matrix images being sent as the filename only on Slack (#302)
• Mentions will now work if followed by a colon and a space (#320)

Improved Documentation

• Fix minor typos in documentation that made it inconsistent (#306)
• Fix syntax typo for service start command. (#317)

1.0.1 (2019-10-08)

Features

• You can now specify the appservice port in the config. (#295)

Bugfixes

• Fixes to matrix -> slack message formatting to ensure consistent success. (#280)
• Typescript now builds correctly after a typing change on the upstream node-slack library. Thanks @kampka (#288)
• Fix webhooks not being able to set a displayname and erroneously deduplicating messages. (#291)
• Fix issue where migrating slack users to postgres would fail. (#294)

Internal Changes

• Fix compile issues related to Logger (#296)

1.0.0 (2019-10-03)

This release marks the end of the 1.0RC period. Please see UPGRADE for notes on how to upgrade your bridge from 0.3.2 to 1.0.

Features

• Add documentation built by RTD at https://matrix-appservice-slack.rtfd.io (#273)

Bugfixes

• Fix migrator bug where it would not find an access token (#267)
• Fix issue where Slack webhooks would not be able to send messages to Matrix. (#269)
• Fix issue where uploading large files will crash the bridge. (#264)
• Lock around avatar updates so it doesn't race. (#274)

Improved Documentation

• Update documentation for the bridge to include more information on Docker. Thanks @kingoftheconnors. (#168)
• Added migration instructions for docker users (#268)

1.0.0-rc6 (2019-09-27)

Bugfixes

• Do not handle slack tombstone messages as edits (#262)
• Fix issue where metrics would not report user activity ages (#263)

1.0.0-rc5 (2019-09-25)

Bugfixes

• Fix bug where teams would start echoing messages after accepting an oauth request. (#260)
• Fix issue where using RTM on large deployments would trigger Slack to turn off Event subscriptions (#261)

1.0.0-rc4 (2019-09-24)

Bugfixes

• Fix multi-person DMs being marked with the group (private channel) type rather than the mpim type. (#253)
• Connecting an account via OAuth will no longer barf on the lack of a puppeting parameter (#254)
• Don't log stack traces for missing rooms, teams or events (#255)
• Don't log the whole response object when an error occurs when sending slack requests (#256)
• Fix .toUpperCase() errors due to the bridge trying to handle unknown deleted messages (#257)

Internal Changes

• Update datastore.md with a few more options (#239)
• Fix issue where towncrier would wrongly link to matrix-appservice-slack-issues (#251)
• Towncrier should check against develop for changelog changes (#258)

1.0.0-rc3 (2019-09-24)

Bugfixes

• Ensure users enter the correct type of token into the link command (#243)
• Fix issue where the bridge will not start if a team cannot connect to RTM. (#247)

Internal Changes

• Log more information during startup (#246)

1.0.0-rc2 (2019-09-18)

Features

• Suppport puppeted reactions/redactions (#235)

Bugfixes

• Remove option slack_user_token on link command (#236)
• Messages from puppeted accounts are no longer duplicated over the bridge (#237)
• Do not send messages to slack with no content (#238)

1.0.0-rc1 (2019-09-13)

This is the first RC of a major restructure of the bridge's architecture. Please do NOT upgrade production bridges onto this release

Features

• Add caching option to config to limit the number of stored users in memory (#228)
• The bridge now has support for the RTM API. See the README for more information. (#164)
• Support Postgresql and implement generic Datastores. (#186)
• A datastore migration script is included. (#190)
• Add a /health endpoint. (#199)
• Add support for puppeting Slack accounts. (#200)

Bugfixes

• Fix issue where DMs can race while the DM room is being created. (#219)
• Logging out your personal puppeting token no longer logs out the whole workspace. (#220)
• Correctly add reply fallbacks on messages in threads, and edits in threads. Thanks @Cadair. (#169
• Correctly bookeep threads when we reply on matrix. Thanks @Cadair. (#194

Internal Changes

• The project now uses TypeScript for source code (#152)
• The project now has integration testing! (#181)
• The project now uses towncrier for changelog management. (#216)
• Room storage is now handled in a dedicated class (#225)
• We now use the Slack Node library for calls (#185)
• Add CONTRIBUTING.md (#207)

Changes in 0.3.2 (2019-07-22)

Bugfixes:

• this.main should have just been main

Changes in 0.3.1 (2019-07-22)

Bugfixes:

• Fixed issue where invalid slack ghost ids were being used for pills #167.
• Correctly add reply fallbacks on messages in threads, and edits in threads #169. Thanks @Cadair!
• Fix an issue where webhooks would fail to bridge across messages #165.

Changes in 0.3.0 (2019-07-19)

No changes since 0.3.0-rc3

Changes in 0.3.0-rc3 (2019-07-12)

Bugfixes:

• Fix slack -> matrix emote messages
• Stop logging bodies

Changes in 0.3.0-rc2 (2019-07-11)

Bugfixes:

• Remove call to onSlackReactionRemoved (as it's not used)
• teams.db path should use dbdir #156. Thanks @vrutkovs

Changes in 0.3.0-rc1 (2019-07-05)

Features:

Special shoutout to @Cadair for this release, who dedicated a lot of his time to these features.

• Implement message deletion #129.
• Add support for edits #130.
• Add support for reactions #131.
• Add support for threading (using replies) #132.
• Support displayname and avatar lookups for Slack bots #141
• Replace channel mentions with canonical aliases for bridged rooms #146.
• Support slack attachments #126 #147. Thanks @umitalp for the inital groundwork and @Cadair for the cleanup.

Bugfixes:

• Fix the discrepancy between nicks and names in pills and mentions #111. Thanks @Cadair!
• Fix an issue where slack thumbnails were always assumed to be JPEGs #123. Thanks @Berulacks

Misc:

• Update README to include instructions on authentication setup #140. Thanks @ineiti.
• Remove duplication of registration path and tidy example config #143. Thanks @Cadair.
• Add a dockerfile #145. Thanks @Cadair.

Changes in 0.2.0 (2018-10-24)

No changes since rc3

Changes in 0.2.0-rc3 (2018-10-23)

Bugfixes:

• Fix S->M mentions being accidentally escaped. #109 Thanks @Cadair!

Changes in 0.2.0-rc2 (2018-10-20)

Bugfixes:

• Users can now log out from their slack account.
• The emoji key name is now sent if the text could not be replaced.

Changes in 0.2.0-rc1 (2018-10-18)

NOTE: This is the first release of the Slack bridge. 0.1.0 has been the version number for previous efforts but was never an official release. The list below is all the changes merged onto the develop branch.

Features:

• Support for the Slack Bot API to allow users to bridge their communities with more features than using webhooks! #89. Thanks to @perissology for doing the legwork there.
• More provisioning APIs to support the new Bot API bridging methods. #101
• Support triple backtick code syntax #85
• Add support for winston logging through the new bridge component #94
• Allow specifying a dbdir for custom locations of stores #95. Thanks @Cadair!
• Convert Riot Pills to Slack mentions #96. Thanks @Cadair!
• Add support for conversion of snippets to code messages in Matrix #97. Thanks @Cadair!
• Add support for "gitter bridge" style edit messages #98. Thanks @Cadair!
• Implement bridging of Matrix mentions to Slack #99. Thanks @Cadair!

Bugfixes:

• Fallback to userstore for making user pills if the Slack API fails to find a user #84
• Fixed file uploads so they work again #91. Thanks @Cadair!
• Fixed emoji not being substituted on the Matrix side #103.

Misc:

• The bridge now uses matrix-appservice-bridge 1.7.0