Add list handling in the send_custom_json method on facebook.py

[silvasara]

Proposed changes:

• Add list handling in the send_custom_json method on channels/facebook.py.
• Resolves Type error in facebook.py #5657

Status (please check what you already did):

• added some tests for the functionality
• updated the documentation
• updated the changelog (please check changelog for instructions)
• reformat files using black (please check Readme for instructions)

[sara-tagger]

Thanks for submitting a pull request 🚀 @wochinge will take a look at it as soon as possible ✨

[wochinge]

Hi @silvasara

Thanks for your contribution!
Can you please add tests for this?

[silvasara]

@wochinge I don't know if I can do the tests, but I'll try. Where would I put this test? The only test I found for this file was this:

rasa/tests/core/test_channels.py

Lines 146 to 165 in 0ccfa20

	def test_facebook_channel():
	# START DOC INCLUDE
	from rasa.core.channels.facebook import FacebookInput
	input_channel = FacebookInput(
	fb_verify="YOUR_FB_VERIFY",
	# you need tell facebook this token, to confirm your URL
	fb_secret="YOUR_FB_SECRET", # your app secret
	fb_access_token="YOUR_FB_PAGE_ACCESS_TOKEN"
	# token for the page you subscribed to
	)
	s = rasa.core.run.configure_app([input_channel], port=5004)
	# END DOC INCLUDE
	# the above marker marks the end of the code snipped included
	# in the docs
	routes_list = utils.list_routes(s)
	assert routes_list["fb_webhook.health"].startswith("/webhooks/facebook")
	assert routes_list["fb_webhook.webhook"].startswith("/webhooks/facebook/webhook")

[wochinge]

@silvasara Yep, it would go into test_channels. You can also create a new file test_facebook.py in tests.core.channels and move all facebook tests there

[CLAassistant]

All committers have signed the CLA.

[jppgomes]

Hello, I checked the missing tests for the correction, can I implement and send the pr? @wochinge

[wochinge]

@jppgomes Sure! It would be a pleasure!

[wochinge]

can you please change the items in this file back? These hooks should work as they are once you do poetry install in the cloned repository

[wochinge]

this doesn't test send_custom_json - we need to call the actual code in this test (same in the one below)

[wochinge]

pop gets and removes stuff from the list - do we really want that?

[wavymazy]

Hi guys, I'm the author of the post for this issue. I had some time today so I though might as well update this PR.

Context:

I have retested the issue with Facebook to understand where it comes from.
The issue stems from the custom template/response if you have any. Basically, if we follow the template (https://rasa.com/docs/rasa/responses/#custom-output-payloads), it is said that we can send any arbitrary output we want. But what will end up happening if we have 2 "type" items (under "blocks"), is that the output will be a list (under "blocks"). The MessengerBot.send_custom_json() previously didn't handle this well at all.

Example of a custom Json that would cause issues:

{
        "blocks": [
            {"type": "title", "text": {"text": "Conversation progress"}},
            {
                "type": "progression_bar",
                "text": {"text": "progression 1", "level": "1"},
            },
        ]
    }

Propose solution:

I think the best way to handle this is by only looking for the sender ID in the custom template only if that template is of type Dict. Otherwise we could use the ID that is given as a function paramter.

[wochinge]

that would be awesome if you could wrap this up @wavymazy .

Otherwise we could use the ID that is given as a function paramter.

Would do you mean by this?

[wavymazy]

Hi @wochinge,

Unfortunately it seems I can't make a direct change to this PR unless given access.

With regards to your question, the ID I'm refering to is the recipient_id that is given as a paramter.

async def send_custom_json( self, recipient_id: Text, json_message: Dict[Text, Any], **kwargs: Any ) -> None:

[wochinge]

@wavymazy How about forking the fork / cherry-picking the commits and then you create a new PR?

[wavymazy]

Ok @wochinge. I can try this.

[wavymazy]

Hi, @wochinge, I created my PR, cherry picking from this one (link : #8332).

[wochinge]

Awesome! I'll close this one then.