APP-3073: Enhancements on MessageService

[symphony-hong]

Ticket

APP-3073

Description

Enhancements on message service
Move MessageService to package com.symphony.bdk.core.service.message

Make the TemplateException extends RuntimeException -> Remove all the throws TemplateException.

Rename MessageService#send(streamId, template, Object) -> MessageService#sendWithTemplate
Provide MessageService#send(streamId, template) to send a templated message without passing any parameter instead of passing null to the existing method.

Provide method MessageService#send(streamId, message, data, attachment) to send a message with data and attachment (streamId can be replaced by a V4Stream instance)

Small fix on webclient api to perform multipart/form-data request.

Unittest added

Dependencies

List the other pull requests that should be merged before/along this one.

Checklist

• Referenced a ticket in the PR title and in the corresponding section
• Filled properly the description and dependencies, if any
• Unit tests updated or added
• Javadoc added or updated
• Updated the documentation in docs folder

[thibauult]

I do have some concerns regarding breaking changes you've introduced here. Even if we are still in BETA, could we try to make a bit more smoother through deprecation mechanism?

We will clearly define the policy on next spring though (cf. APP-3114)

[symphony-hong]

@symphony-thibault yes clearly this PR will produce some breaking changes as we are still in BETA. I also supposed to open a ticket to update the generator after this PR is finished and merged.

[symphony-youri]

Make the TemplateException extends RuntimeException -> Remove all the throws TemplateException.
-> we see that from the change what would be interesting to state in the commit message is why :)? (the what is visible from the diff, the why is interesting to document in git logs so we can understand the decisions later when we look back at the code ;))

[symphony-hong]

@symphony-thibault @symphony-youri I created a Message model to be used in the message service, added two methods using this model as well. (an example to see how to use it as well)
I still keep the old methods and will refactor the messsage service after we agree that the Message model is okay to use.

[thibauult]

Use Javadoc @deprecated tag to mention that this method will be replaced by send(V4Stream, Message)

[symphony-youri]

Should not we remove it at once since we are in beta?

[thibauult]

I'd ❤️ to have:

final V4Message messageSent = bdk.message().builder()
    .template("/templates/welcome.ftl", values)
    .attachment(inputStream, "toto.txt") // or .attachment(byte[], "toto.txt") or .attachment(File)
    .data(singletonMap("key", "value"))
    .send(stream);

Knowing that message blast will be available soon in the Agent (agent-api-paths-public.yaml) we would also have:

final V4Message messageSent = bdk.message().builder()
    .template("/templates/welcome.ftl", values)
    .attachment(inputStream, "toto.txt")
    .data(singletonMap("key", "value"))
    .send(stream1, stream2, stream3);

[symphony-hong]

@symphony-thibault is it exactly what you suggested? 865bf89#diff-1f276cf993a147eb9c7b918053efb18dL38

[thibauult]

this.createTemporaryAttachmentFile(message.getAttachment()) directly here

[symphony-hong]

I don't know why yet but if I use this.createTemporaryAttachmentFile(message.getAttachment()), method will throw a RuntimeException instead of MessageCreationException and the unittest will fail

[symphony-hong]

because the retry throws every Throwable as RuntimeException

[symphony-hong]

And I would create the temp file outside the retry to avoid new file created if the retry recovery is triggered

[thibauult]

Good job 👍 Will be completed on next sprint with the ability to send multiple attachments, I'll create another ticket