Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix payload to match Rocket Chat 7.4.1 API #9882

Open
wants to merge 9 commits into
base: main
Choose a base branch
from
Open

Fix payload to match Rocket Chat 7.4.1 API #9882

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
d9a6ef3
Fix payload to match Rocket Chat 7.4 API
broferek Mar 14, 2025
bdab72a
Add a fallback to send payload argument in case the user still intera…
broferek Mar 14, 2025
5e27b45
Fix sanity checks
broferek Mar 14, 2025
a1e8a46
Add changelog fragment of PR #9882
Mar 18, 2025
ee2e635
Add argument option_is_pre740 to keep backward compatibility of the p…
Mar 18, 2025
3a32e46
Add new argument doc
Mar 18, 2025
539207d
Rename new parameter, add missing pieces of information in parameter doc
Mar 19, 2025
33825b7
Use appropriate change label and fix change description. Description …
Mar 19, 2025
b620315
Fix missing punctuation in the new parameter doc block
Mar 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions changelogs/fragments/9882-fix-payload-to-match-rocketchat-740-requirement.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
minor_changes:
- rocketchat - parameter ``option_is_pre740`` has been added to control the format of the old payload (https://github.com/ansible-collections/community.general/pull/9882)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- rocketchat - parameter ``option_is_pre740`` has been added to control the format of the old payload (https://github.com/ansible-collections/community.general/pull/9882)
- rocketchat - option ``is_pre740`` has been added to control the format of the payload. For Rocket.Chat 7.4.0 or newer, it must be set to ``false`` (https://github.com/ansible-collections/community.general/pull/9882).

20 changes: 16 additions & 4 deletions plugins/modules/rocketchat.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,14 @@
elements: dict
description:
- Define a list of attachments.
is_pre740:
description:
- If V(true), the payload matches Rocket Chat prior to 7.4.0 format.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- If V(true), the payload matches Rocket Chat prior to 7.4.0 format.
- If V(true), the payload matches Rocket.Chat prior to 7.4.0 format. This format has been used by the module since its inception, but is no longer supported by Rocket.Chat 7.4.0.

- The default value of the parameter can be set to false in a few months' time.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- The default value of the parameter can be set to false in a few months' time.
- The default value of the option will change to V(false) eventually.

- This parameter will be removed in a future release when Rocket Chat 7.4.0 becomes the minimum supported version.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the official spelling is Rocket.Chat with a period:

Suggested change
- This parameter will be removed in a future release when Rocket Chat 7.4.0 becomes the minimum supported version.
- This parameter will be removed in a future release when Rocket.Chat 7.4.0 becomes the minimum supported version.

(Also it might be that this has been already working with Rocket.Chat for a long time, and it was just that they dropped support for the old way in 7.4.0 - maybe because they thought that nobody is using it anymore since forever.)

type: bool
default: true
version_added: 10.5.0
"""

EXAMPLES = r"""
Expand Down Expand Up @@ -165,7 +173,7 @@
ROCKETCHAT_INCOMING_WEBHOOK = '%s://%s/hooks/%s'


def build_payload_for_rocketchat(module, text, channel, username, icon_url, icon_emoji, link_names, color, attachments):
def build_payload_for_rocketchat(module, text, channel, username, icon_url, icon_emoji, link_names, color, attachments, is_pre740):
payload = {}
if color == "normal" and text is not None:
payload = dict(text=text)
Expand Down Expand Up @@ -195,7 +203,9 @@ def build_payload_for_rocketchat(module, text, channel, username, icon_url, icon
attachment['fallback'] = attachment['text']
payload['attachments'].append(attachment)

payload = "payload=" + module.jsonify(payload)
payload = module.jsonify(payload)
if is_pre740:
payload = "payload=" + module.jsonify(payload)
return payload


Expand Down Expand Up @@ -225,7 +235,8 @@ def main():
link_names=dict(type='int', default=1, choices=[0, 1]),
validate_certs=dict(default=True, type='bool'),
color=dict(type='str', default='normal', choices=['normal', 'good', 'warning', 'danger']),
attachments=dict(type='list', elements='dict', required=False)
attachments=dict(type='list', elements='dict', required=False),
is_pre740=dict(default=True, type='bool')
)
)

Expand All @@ -240,8 +251,9 @@ def main():
link_names = module.params['link_names']
color = module.params['color']
attachments = module.params['attachments']
is_pre740 = module.params['is_pre740']

payload = build_payload_for_rocketchat(module, text, channel, username, icon_url, icon_emoji, link_names, color, attachments)
payload = build_payload_for_rocketchat(module, text, channel, username, icon_url, icon_emoji, link_names, color, attachments, is_pre740)
do_notify_rocketchat(module, domain, token, protocol, payload)

module.exit_json(msg="OK")
Expand Down