ACS Chat: Changes for API version: 2020-11-01-preview3 by Leoaqr · Pull Request #15455 · Azure/azure-sdk-for-python

Leoaqr · 2020-11-19T22:10:27Z

Several changes required by 2020-11-01-preview3 of the API:

Rename Thread Members to Participants
Rename function UpdateThread to UpdateTopic
Rename ReadReceipt to ChatMessageReadReceipt in model
Return message id (string) instead of SendMessageResult (object) when calling send_message
Add a convenience method add_participant for adding 1 participant
Add failed participants check in response header in create_thread function

* Add failed participant check in response header for create_thread method * New convention method add_participant(thread_participant: ChatThreadParticipant) - sync and async

fangchen0601

lgtm. please make sure unit test and live test passed locally. and upload recorded yaml files if needed.

fangchen0601 · 2020-11-19T22:43:09Z

sdk/communication/azure-communication-chat/azure/communication/chat/_shared/response.py

@@ -0,0 +1,8 @@
+# ------------------------------------------------------------------------


the _shared folder is shared between all service SDKs, like SMS SDK has the same folder and same files/methods. Which means adding one method/module to this folder, other teams must do the same.
So I suggest:

Talk to Tural to ask if above is the same case, if yes, ask if this will become a common method that other teams will use, if yes, then your PR is good

If this module and method is only for Chat team, suggest move it to azure/communication/chat/_util.py after talked to Tural.

Thanks for the feedback.
Currently, I don't commit the test files in order to reduce the unnecessary review workload. Yes, I will run and upload new test files after review.

For the helper file in shared folder, what do you think? @turalf

I guess this file is specific to the chat module. If that is the case please keep this file outside of the _shared folder.
Also it seems that this method is used only in 1 file. If you are not planning to use it somewhere else in the future, better to keep in that file.

turalf

Please make sure to add recording files after running live tests locally, once they are available

turalf · 2020-11-25T19:24:00Z

sdk/communication/azure-communication-chat/azure/communication/chat/_shared/response.py

@@ -0,0 +1,8 @@
+# ------------------------------------------------------------------------


I guess this file is specific to the chat module. If that is the case please keep this file outside of the _shared folder.
Also it seems that this method is used only in 1 file. If you are not planning to use it somewhere else in the future, better to keep in that file.

turalf

Lgtm

annatisch · 2020-11-30T18:51:18Z

sdk/communication/azure-communication-chat/azure/communication/chat/_chat_thread_client.py

-        :return: SendChatMessageResult, or the result of cls(response)
-        :rtype: ~azure.communication.chat.SendChatMessageResult
+        :return: str, or the result of cls(response)
+        :rtype: str


This change should not have been made - could we fix it before the next release goes out?
Instead we should use something like this:
return { 'id': send_chat_message_result.id }

Will change accordingly in the next iteration

annatisch · 2020-11-30T18:53:29Z

sdk/communication/azure-communication-chat/azure/communication/chat/_chat_thread_client.py

-    def update_thread(
+    def update_topic(
        self,
        topic=None,  # type: Optional[str]


If we are updating the topic- the topic parameter should no longer be optional.

annatisch · 2020-11-30T18:54:46Z

sdk/communication/azure-communication-chat/azure/communication/chat/_chat_client.py

+                    participant, reason = invalid_participant_and_reason.split(',', 1)
+                    errors.append('participant ' + participant + ' failed to join thread '
+                    + create_chat_thread_result.id + ' return statue code ' + reason)
+                raise ValueError(errors)


This should not be a ValueError

Several changes required by `2020-11-01-preview3` of the API: - Rename `Thread Members` to `Participants` - Rename function `UpdateThread` to `UpdateTopic` - Rename `ReadReceipt` to `ChatMessageReadReceipt` in model - Return message id (string) instead of SendMessageResult (object) when calling `send_message` - Add a convenience method `add_participant` for adding 1 participant - Add failed participants check in response header in `create_thread` function Misc: - Add updated test record files Co-authored-by: Leo Li <jixli@microsoft.com> Co-authored-by: Rajarshi Sarkar <73562869+sarkar-rajarshi@users.noreply.github.com>

* ACS Chat: Changes for API version: 2020-11-01-preview3 (#15455) Several changes required by `2020-11-01-preview3` of the API: - Rename `Thread Members` to `Participants` - Rename function `UpdateThread` to `UpdateTopic` - Rename `ReadReceipt` to `ChatMessageReadReceipt` in model - Return message id (string) instead of SendMessageResult (object) when calling `send_message` - Add a convenience method `add_participant` for adding 1 participant - Add failed participants check in response header in `create_thread` function Misc: - Add updated test record files Co-authored-by: Leo Li <jixli@microsoft.com> Co-authored-by: Rajarshi Sarkar <73562869+sarkar-rajarshi@users.noreply.github.com> * Update ACS Chat Python SDK align with swagger changes (#15640) - Seperate AzureCommunicationChatServiceOperationsMixin into ChatOperations and ChatThreadOperations - Move invalid participants into errors object in reponse body Co-authored-by: Leo Li <jixli@microsoft.com> * Communication chat - paginated results for participants and readreceipts (#15682) * Failed participant check + single member add * Add failed participant check in response header for create_thread method * New convention method add_participant(thread_participant: ChatThreadParticipant) - sync and async * Add empty line at the end of files * Enable pagination for list participants * Enable pagination for read receipts * conflicts resolved after merge with upstream * update README.md * e2e test fix * bkp commit * updated e2e tests * adding test recording Co-authored-by: Leo Li <jixli@microsoft.com> * Updated swagger changes (#16390) * Updated swagger changes - Generate new models from swagger - ChatMessage.content -> ChatMessageContent instead of 'str' - Remove ChatMessagePriority - Introduce ChatMessageType - Add tests around ChatMessageType deserialization - Generate a repeatability ID by default - Add some test scenarios around repeatability ID - Update all relevant tests - Update sample code - Record new test sessions * Rebase with master - Use CommunicationUserIdentifier * pylint fixes Co-authored-by: Jixing (Leo) Li <lijixing3377@gmail.com> Co-authored-by: Leo Li <jixli@microsoft.com>

* Rsarkar/chat preview3 rebased (#16463) * ACS Chat: Changes for API version: 2020-11-01-preview3 (#15455) Several changes required by `2020-11-01-preview3` of the API: - Rename `Thread Members` to `Participants` - Rename function `UpdateThread` to `UpdateTopic` - Rename `ReadReceipt` to `ChatMessageReadReceipt` in model - Return message id (string) instead of SendMessageResult (object) when calling `send_message` - Add a convenience method `add_participant` for adding 1 participant - Add failed participants check in response header in `create_thread` function Misc: - Add updated test record files Co-authored-by: Leo Li <jixli@microsoft.com> Co-authored-by: Rajarshi Sarkar <73562869+sarkar-rajarshi@users.noreply.github.com> * Update ACS Chat Python SDK align with swagger changes (#15640) - Seperate AzureCommunicationChatServiceOperationsMixin into ChatOperations and ChatThreadOperations - Move invalid participants into errors object in reponse body Co-authored-by: Leo Li <jixli@microsoft.com> * Communication chat - paginated results for participants and readreceipts (#15682) * Failed participant check + single member add * Add failed participant check in response header for create_thread method * New convention method add_participant(thread_participant: ChatThreadParticipant) - sync and async * Add empty line at the end of files * Enable pagination for list participants * Enable pagination for read receipts * conflicts resolved after merge with upstream * update README.md * e2e test fix * bkp commit * updated e2e tests * adding test recording Co-authored-by: Leo Li <jixli@microsoft.com> * Updated swagger changes (#16390) * Updated swagger changes - Generate new models from swagger - ChatMessage.content -> ChatMessageContent instead of 'str' - Remove ChatMessagePriority - Introduce ChatMessageType - Add tests around ChatMessageType deserialization - Generate a repeatability ID by default - Add some test scenarios around repeatability ID - Update all relevant tests - Update sample code - Record new test sessions * Rebase with master - Use CommunicationUserIdentifier * pylint fixes Co-authored-by: Jixing (Leo) Li <lijixing3377@gmail.com> Co-authored-by: Leo Li <jixli@microsoft.com> * Apiview changes (#16560) * apiview fixes - Add missing type hints - return ItemPaged or AsyncItemPaged instead of full classpath Co-authored-by: Jixing (Leo) Li <lijixing3377@gmail.com> Co-authored-by: Leo Li <jixli@microsoft.com>

Leo Li and others added 7 commits November 16, 2020 15:24

point 6

9b37072

point 3

4f152a2

point 4 wait swagger

cadb01f

point 1 + swagger update

e28b300

update topic name

1358a2b

Update _chat_thread_client.py

350449b

Failed participant check + single member add

034cd4b

* Add failed participant check in response header for create_thread method * New convention method add_participant(thread_participant: ChatThreadParticipant) - sync and async

Leoaqr requested review from a team, RezaJooyandeh, ankitarorabit and turalf as code owners November 19, 2020 22:10

Add empty line at the end of files

bcada21

Leoaqr requested review from annatisch, fangchen0601, juancamilor and sarkar-rajarshi November 19, 2020 22:31

fangchen0601 reviewed Nov 19, 2020

View reviewed changes

Resolve some lint issues

a0e2210

Leoaqr force-pushed the feature/communication-chat-preview3 branch from 4b1f836 to a0e2210 Compare November 20, 2020 00:12

Leoaqr changed the base branch from master to feature/communication-chat-preview3 November 20, 2020 00:16

turalf reviewed Nov 25, 2020

View reviewed changes

Leo Li added 3 commits November 25, 2020 17:16

Update for async create_chat_thread

40d3832

Move return_response function to utils.py

e6325b8

Upload new test records

914bbfe

Leoaqr force-pushed the feature/communication-chat-preview3 branch from 9d0e425 to 914bbfe Compare November 26, 2020 01:48

Leoaqr closed this Nov 26, 2020

Leoaqr reopened this Nov 26, 2020

turalf approved these changes Nov 30, 2020

View reviewed changes

Leoaqr merged commit b8c15b2 into Azure:feature/communication-chat-preview3 Nov 30, 2020

annatisch reviewed Nov 30, 2020

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ACS Chat: Changes for API version: 2020-11-01-preview3#15455

ACS Chat: Changes for API version: 2020-11-01-preview3#15455
Leoaqr merged 12 commits intoAzure:feature/communication-chat-preview3from
Leoaqr:feature/communication-chat-preview3

Leoaqr commented Nov 19, 2020

Uh oh!

fangchen0601 left a comment

Uh oh!

fangchen0601 Nov 19, 2020

Uh oh!

Leoaqr Nov 19, 2020

Uh oh!

turalf Nov 25, 2020

Uh oh!

turalf left a comment

Uh oh!

turalf Nov 25, 2020

Uh oh!

turalf left a comment

Uh oh!

annatisch Nov 30, 2020

Uh oh!

Leoaqr Nov 30, 2020

Uh oh!

annatisch Nov 30, 2020

Uh oh!

annatisch Nov 30, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

		@@ -0,0 +1,8 @@
		# ------------------------------------------------------------------------

Conversation

Leoaqr commented Nov 19, 2020

Uh oh!

fangchen0601 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

turalf left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

turalf left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants