From add99ea4642ad11cedb36997f77c25ce296e7732 Mon Sep 17 00:00:00 2001 From: aafanasi Date: Tue, 4 Apr 2023 15:38:36 -0300 Subject: [PATCH 1/4] MTSDK-180 Document Known Issue - This pr is to add a documentation about know issue and the way to resolve it. --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index e3b614f1..b39e4d7e 100644 --- a/README.md +++ b/README.md @@ -57,3 +57,9 @@ implementation 'cloud.genesys:messenger-transport-mobile-sdk:' ## Documentation Detailed documentation for Messenger Transport, including how to use the SDK and how to contribute to the project, can be found on the [Wiki](https://github.com/MyPureCloud/genesys-messenger-transport-mobile-sdk/wiki). + +## Known Issues + +| Issue | Description | Details | Resolution | Affected Version | +|------------------------------------------------------------------------------------------|--------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------| +| completionHandler does not return response to `fetchDeploymentConfig()` and `nextPage()` | This issue is caused by a bug in the underlying network engine's `Ktor`. | If the Logging plugin is installed, the Ktor client can deadlock or block after BODY START is printed to the console. Although the response is still returned to the calling function, any future requests will block. | On Ktor `2.x` this issue was resolved. It is recommended to use Transport `2.3.0` or higher, that implements `Ktor 2.x`. In case a lower version is required, make sure to disable Ktor Login Plugin by setting the `logging=false` in the Configuration object on iOS. | iOS Transport `2.2.0` and lower | From e12f7ee347a92ad71b0c0b21e280987cb87a7aa5 Mon Sep 17 00:00:00 2001 From: aafanasi Date: Tue, 4 Apr 2023 15:41:04 -0300 Subject: [PATCH 2/4] MTSDK-180 Document Known Issue - This pr is to add a documentation about know issue and the way to resolve it. --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index b39e4d7e..14e64448 100644 --- a/README.md +++ b/README.md @@ -60,6 +60,6 @@ Detailed documentation for Messenger Transport, including how to use the SDK and ## Known Issues -| Issue | Description | Details | Resolution | Affected Version | -|------------------------------------------------------------------------------------------|--------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------| -| completionHandler does not return response to `fetchDeploymentConfig()` and `nextPage()` | This issue is caused by a bug in the underlying network engine's `Ktor`. | If the Logging plugin is installed, the Ktor client can deadlock or block after BODY START is printed to the console. Although the response is still returned to the calling function, any future requests will block. | On Ktor `2.x` this issue was resolved. It is recommended to use Transport `2.3.0` or higher, that implements `Ktor 2.x`. In case a lower version is required, make sure to disable Ktor Login Plugin by setting the `logging=false` in the Configuration object on iOS. | iOS Transport `2.2.0` and lower | +| Issue | Description | Details | Resolution | Affected Version | +| --- | --- | --- | --- | --- | +| completionHandler does not return response to `fetchDeploymentConfig()` and `nextPage()` | This issue is caused by a bug in the underlying network engine's `Ktor`.| If the Logging plugin is installed, the Ktor client can deadlock or block after BODY START is printed to the console. Although the response is still returned to the calling function, any future requests will block. | On Ktor `2.x` this issue was resolved. It is recommended to use Transport `2.3.0` or higher, that implements `Ktor 2.x`. In case a lower version is required, make sure to disable Ktor Login Plugin by setting the `logging=false` in the Configuration object on iOS. | iOS Transport `2.2.0` and lower | From a14e8ddbac14e7ee50a01a71d73c0ac22e5256ac Mon Sep 17 00:00:00 2001 From: aafanasi Date: Tue, 4 Apr 2023 15:53:05 -0300 Subject: [PATCH 3/4] MTSDK-180 Document Known Issue - Improve wording --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 14e64448..2639529e 100644 --- a/README.md +++ b/README.md @@ -62,4 +62,4 @@ Detailed documentation for Messenger Transport, including how to use the SDK and | Issue | Description | Details | Resolution | Affected Version | | --- | --- | --- | --- | --- | -| completionHandler does not return response to `fetchDeploymentConfig()` and `nextPage()` | This issue is caused by a bug in the underlying network engine's `Ktor`.| If the Logging plugin is installed, the Ktor client can deadlock or block after BODY START is printed to the console. Although the response is still returned to the calling function, any future requests will block. | On Ktor `2.x` this issue was resolved. It is recommended to use Transport `2.3.0` or higher, that implements `Ktor 2.x`. In case a lower version is required, make sure to disable Ktor Login Plugin by setting the `logging=false` in the Configuration object on iOS. | iOS Transport `2.2.0` and lower | +| completionHandler does not return response to `fetchDeploymentConfig()` and `nextPage()` | This issue is caused by a bug in an older version of `Ktor`, the engine's underlying network engine.| If the Logging plugin is installed, the Ktor client can deadlock or block after BODY START is printed to the console. Although the response is still returned to the calling function, any future requests will block. | On Ktor `2.x` this issue was resolved. It is recommended to use Transport `2.3.0` or higher, that implements `Ktor 2.x`. In case a lower version is required, make sure to disable Ktor Login Plugin by setting the `logging=false` in the Configuration object on iOS. | iOS Transport `2.2.0` and lower | From 2e02d7da842cb97c6a617fe334dcf7209ee4b4be Mon Sep 17 00:00:00 2001 From: aafanasi Date: Wed, 5 Apr 2023 14:43:36 -0300 Subject: [PATCH 4/4] MTSDK-180 Document Know Issue - Improve spelling --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 2639529e..163ebb8c 100644 --- a/README.md +++ b/README.md @@ -62,4 +62,4 @@ Detailed documentation for Messenger Transport, including how to use the SDK and | Issue | Description | Details | Resolution | Affected Version | | --- | --- | --- | --- | --- | -| completionHandler does not return response to `fetchDeploymentConfig()` and `nextPage()` | This issue is caused by a bug in an older version of `Ktor`, the engine's underlying network engine.| If the Logging plugin is installed, the Ktor client can deadlock or block after BODY START is printed to the console. Although the response is still returned to the calling function, any future requests will block. | On Ktor `2.x` this issue was resolved. It is recommended to use Transport `2.3.0` or higher, that implements `Ktor 2.x`. In case a lower version is required, make sure to disable Ktor Login Plugin by setting the `logging=false` in the Configuration object on iOS. | iOS Transport `2.2.0` and lower | +| completionHandler does not return response to `fetchDeploymentConfig()` and `nextPage()` | This issue is caused by a bug in an older version of `Ktor`, the Transport SDK's underlying network engine.| If the Logging plugin is installed, the Ktor client can deadlock or block after BODY START is printed to the console. Although the response is still returned to the calling function, any future requests will block. | On Ktor `2.x` this issue was resolved. It is recommended to use Transport `2.3.0` or higher, that implements `Ktor 2.x`. In case a lower version is required, make sure to disable Ktor Login Plugin by setting the `logging=false` in the Configuration object on iOS. | iOS Transport `2.2.0` and lower |