Fix payload to match Rocket Chat 7.4.1 API #9882

broferek · 2025-03-14T10:51:42Z

SUMMARY

This PR fixes the following error with Rocket Chat 7.4.1

"error":"Unexpected token \'p\\', \\\\"payload{\\\\\"t\\\\\"... is not valid JSON"

ISSUE TYPE

Bugfix Pull Request

COMPONENT NAME

Rocket Chat

ansibullbot · 2025-03-14T10:54:53Z

cc @Deepakkothandan
click here for bot help

felixfontein · 2025-03-14T12:09:28Z

Thanks for your contribution! This is a duplicate of #9869 (and has the same problems I mentioned in #9869 (comment)).

felixfontein · 2025-03-14T12:28:38Z

See also #9869 (comment).

…cts with a Rocket Chat version < 7.4.0

russoz · 2025-03-16T02:28:25Z

Hi @broferek ,

I reckon one way to avoid the request duplication is to create a feature flag - a new parameter to the module, it could be a bool, indicating whether the module should behave as pre-7.4.0 or post-7.4.0. Set the default to pre-7.4.0 to keep backward compatibility but deprecate that default value so that users will know they need to use the post-7.4.0 setting.

plugins/modules/rocketchat.py

russoz · 2025-03-16T02:34:13Z

Also, please add a changelog fragment.

…ayload

broferek · 2025-03-18T11:05:32Z

Hi @russoz See my latest commits. I tried to follow your suggestions.

russoz

Hi @broferek, thanks for the updates! Got a couple of adjustments and suggestions.

changelogs/fragments/9882-fix-payload-to-match-rocketchat-740-requirement.yml

plugins/modules/rocketchat.py

…about future plans for the parameter is now set at the parameter doc level

broferek · 2025-03-19T08:09:05Z

Hi @russoz, I think I got everything right this time. Thanks to review it.

russoz

Minor nit in the doc block, other than that LGTM

plugins/modules/rocketchat.py

broferek · 2025-03-21T08:18:29Z

@russoz Thanks for your feedback. The missing punctuation has been fixed. I guess we are good to merge now.

felixfontein

Sorry for not having managed to read through this earlier, I also have some docs suggestions :)

felixfontein · 2025-03-21T21:10:11Z

changelogs/fragments/9882-fix-payload-to-match-rocketchat-740-requirement.yml

@@ -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)


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).

felixfontein · 2025-03-21T21:11:19Z

plugins/modules/rocketchat.py

+    description:
+      - If V(true), the payload matches Rocket Chat prior to 7.4.0 format.
+      - The default value of the parameter can be set to false in a few months' time.
+      - This parameter will be removed in a future release when Rocket Chat 7.4.0 becomes the minimum supported version.


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.)

felixfontein · 2025-03-21T21:12:12Z

plugins/modules/rocketchat.py

+  is_pre740:
+    description:
+      - If V(true), the payload matches Rocket Chat prior to 7.4.0 format.
+      - The default value of the parameter can be set to false in a few months' time.


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.

felixfontein · 2025-03-21T21:12:42Z

plugins/modules/rocketchat.py

@@ -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.


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.

Fix payload to match Rocket Chat 7.4 API

d9a6ef3

ansibullbot added bug This issue/PR relates to a bug module module new_contributor Help guide this first time contributor plugins plugin (any type) small_patch Hopefully easy to review labels Mar 14, 2025

felixfontein added check-before-release PR will be looked at again shortly before release and merged if possible. backport-9 Automatically create a backport for the stable-9 branch backport-10 Automatically create a backport for the stable-10 branch labels Mar 14, 2025

felixfontein mentioned this pull request Mar 14, 2025

Rocketchat webhook payload without "payload=" #9869

Open

Add a fallback to send payload argument in case the user still intera…

bdab72a

…cts with a Rocket Chat version < 7.4.0

This comment was marked as resolved.

Sign in to view

ansibullbot added ci_verified Push fixes to PR branch to re-run CI needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR labels Mar 14, 2025

Fix sanity checks

5e27b45

ansibullbot removed ci_verified Push fixes to PR branch to re-run CI small_patch Hopefully easy to review needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR labels Mar 14, 2025

russoz reviewed Mar 16, 2025

View reviewed changes

plugins/modules/rocketchat.py Outdated Show resolved Hide resolved

broferek pushed a commit to broferek/community.general that referenced this pull request Mar 18, 2025

Add changelog fragment of issue ansible-collections#9882

28420d3

ludovic added 2 commits March 18, 2025 11:46

Add changelog fragment of PR ansible-collections#9882

a1e8a46

Add argument option_is_pre740 to keep backward compatibility of the p…

ee2e635

…ayload

This comment was marked as resolved.

Sign in to view

ansibullbot added ci_verified Push fixes to PR branch to re-run CI needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR labels Mar 18, 2025

Add new argument doc

3a32e46

ansibullbot removed ci_verified Push fixes to PR branch to re-run CI needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR labels Mar 18, 2025

felixfontein removed the backport-9 Automatically create a backport for the stable-9 branch label Mar 18, 2025

russoz reviewed Mar 18, 2025

View reviewed changes

changelogs/fragments/9882-fix-payload-to-match-rocketchat-740-requirement.yml Outdated Show resolved Hide resolved

plugins/modules/rocketchat.py Outdated Show resolved Hide resolved

ludovic added 2 commits March 19, 2025 08:56

Rename new parameter, add missing pieces of information in parameter doc

539207d

Use appropriate change label and fix change description. Description …

33825b7

…about future plans for the parameter is now set at the parameter doc level

russoz reviewed Mar 20, 2025

View reviewed changes

plugins/modules/rocketchat.py Outdated Show resolved Hide resolved

Fix missing punctuation in the new parameter doc block

b620315

felixfontein reviewed Mar 21, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix payload to match Rocket Chat 7.4.1 API #9882

Fix payload to match Rocket Chat 7.4.1 API #9882

broferek commented Mar 14, 2025

ansibullbot commented Mar 14, 2025

felixfontein commented Mar 14, 2025

felixfontein commented Mar 14, 2025

This comment was marked as resolved.

russoz commented Mar 16, 2025

russoz commented Mar 16, 2025

This comment was marked as resolved.

broferek commented Mar 18, 2025 •

edited

Loading

russoz left a comment

broferek commented Mar 19, 2025

russoz left a comment

broferek commented Mar 21, 2025

felixfontein left a comment

felixfontein Mar 21, 2025

felixfontein Mar 21, 2025

felixfontein Mar 21, 2025

felixfontein Mar 21, 2025

		@@ -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)

	- 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).

	- 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.

	- 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.

	- 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.

Fix payload to match Rocket Chat 7.4.1 API #9882

Are you sure you want to change the base?

Fix payload to match Rocket Chat 7.4.1 API #9882

Conversation

broferek commented Mar 14, 2025

SUMMARY

ISSUE TYPE

COMPONENT NAME

ansibullbot commented Mar 14, 2025

felixfontein commented Mar 14, 2025

felixfontein commented Mar 14, 2025

This comment was marked as resolved.

russoz commented Mar 16, 2025

russoz commented Mar 16, 2025

This comment was marked as resolved.

broferek commented Mar 18, 2025 • edited Loading

russoz left a comment

Choose a reason for hiding this comment

broferek commented Mar 19, 2025

russoz left a comment

Choose a reason for hiding this comment

broferek commented Mar 21, 2025

felixfontein left a comment

Choose a reason for hiding this comment

felixfontein Mar 21, 2025

Choose a reason for hiding this comment

felixfontein Mar 21, 2025

Choose a reason for hiding this comment

felixfontein Mar 21, 2025

Choose a reason for hiding this comment

felixfontein Mar 21, 2025

Choose a reason for hiding this comment

broferek commented Mar 18, 2025 •

edited

Loading