From f39e854f73a1d6e940234cb39d1064f11d119400 Mon Sep 17 00:00:00 2001 From: sacOO7 Date: Fri, 15 Nov 2024 22:00:02 +0530 Subject: [PATCH 1/3] Spec CHA-RL1i marked as removed since it's not needed as per CHA-RC1 --- textile/chat-features.textile | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/textile/chat-features.textile b/textile/chat-features.textile index 87d623da..6da5a356 100644 --- a/textile/chat-features.textile +++ b/textile/chat-features.textile @@ -97,8 +97,8 @@ h4(#rooms-lifecycle-operations). Room Lifecycle Operations *** @(CHA-RL1h4)@ @[Testable]@ If the underlying Realtime Channel entered the @FAILED@ state, then the room status will transition to @FAILED@, using the error from the realtime channels `attach()` call as the @cause@ field of the @ErrorInfo@. The status code shall be @500@ and the error code whatever attachment error code corresponds to the feature that has failed, per "the error code list":#error-codes. The same error shall be thrown as the result of the @ATTACH@ operation. *** @(CHA-RL1h5)@ @[Testable]@ When the room enters the @FAILED@ status as a result of @CHA-RL1h4@, asynchronously with respect to @CHA-RL1h4@, then the room will detach all channels that are not in the @FAILED@ state. *** @(CHA-RL1h6)@ @[Testable]@ If, when performing @CHA-RL1h5@, a channel fails to detach on command, then the detach operation will be repeated until such a time that all channels have detached successfully. -** @(CHA-RL1i)@ Because of the singleton pattern that the core SDKs implement with regards to channels, subsequent instances of a room will use the same underlying realtime channels if the realtime channels are not properly @released@ as part of cleaning up the previous room instance before the new instance is used. Therefore, it is important to ensure that releasing operations (per "@CHA-RC1d@"#CHA-RC1d) have completed before a new room can be attached (to avoid channel objects leaking between instances of rooms). -*** @(CHA-RL1i1)@ @[Testable]@ If a room instance is in the process of being released and cleaned up (per "@CHA-RC1d@"#CHA-RC1d), then the @ATTACH@ operation of a subsequent instance of the same room shall wait for the release operation of the previous to complete before commencing. +** @(CHA-RL1i)@ This specification point has been removed, since it's not needed as per CHA-RC1. +*** @(CHA-RL1i1)@ @[Testable]@ This specification point has been removed, since it's not needed as per CHA-RC1. * @(CHA-RL2)@ A room must be explicitly detached via the @DETACH@ operation. ** @(CHA-RL2a)@ @[Testable]@ If the room status is already @DETACHED@, then this operation is a no-op. ** @(CHA-RL2b)@ @[Testable]@ If the room is in the @RELEASING@ status, the operation shall be rejected with an @ErrorInfo@ with the @RoomIsReleasing@ error code from the "chat-specific error codes":#error-codes. From f6eb99ef34454f13f8c26fd47a07f435053798c3 Mon Sep 17 00:00:00 2001 From: sachin shinde Date: Fri, 22 Nov 2024 13:35:23 +0530 Subject: [PATCH 2/3] Update textile/chat-features.textile Rephrase CHA-RL1i statement Co-authored-by: Andy Ford --- textile/chat-features.textile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/textile/chat-features.textile b/textile/chat-features.textile index 6da5a356..dbad5439 100644 --- a/textile/chat-features.textile +++ b/textile/chat-features.textile @@ -97,7 +97,7 @@ h4(#rooms-lifecycle-operations). Room Lifecycle Operations *** @(CHA-RL1h4)@ @[Testable]@ If the underlying Realtime Channel entered the @FAILED@ state, then the room status will transition to @FAILED@, using the error from the realtime channels `attach()` call as the @cause@ field of the @ErrorInfo@. The status code shall be @500@ and the error code whatever attachment error code corresponds to the feature that has failed, per "the error code list":#error-codes. The same error shall be thrown as the result of the @ATTACH@ operation. *** @(CHA-RL1h5)@ @[Testable]@ When the room enters the @FAILED@ status as a result of @CHA-RL1h4@, asynchronously with respect to @CHA-RL1h4@, then the room will detach all channels that are not in the @FAILED@ state. *** @(CHA-RL1h6)@ @[Testable]@ If, when performing @CHA-RL1h5@, a channel fails to detach on command, then the detach operation will be repeated until such a time that all channels have detached successfully. -** @(CHA-RL1i)@ This specification point has been removed, since it's not needed as per CHA-RC1. +** @(CHA-RL1i)@ This specification point has been removed. It was superseded by CHA-RC1f. *** @(CHA-RL1i1)@ @[Testable]@ This specification point has been removed, since it's not needed as per CHA-RC1. * @(CHA-RL2)@ A room must be explicitly detached via the @DETACH@ operation. ** @(CHA-RL2a)@ @[Testable]@ If the room status is already @DETACHED@, then this operation is a no-op. From bc9471778765547e814d8f67a732d8f6154e306f Mon Sep 17 00:00:00 2001 From: sachin shinde Date: Fri, 22 Nov 2024 18:35:15 +0530 Subject: [PATCH 3/3] Update textile/chat-features.textile Rephrased as per CHA-RC1 Co-authored-by: Andy Ford --- textile/chat-features.textile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/textile/chat-features.textile b/textile/chat-features.textile index dbad5439..a2a90337 100644 --- a/textile/chat-features.textile +++ b/textile/chat-features.textile @@ -98,7 +98,7 @@ h4(#rooms-lifecycle-operations). Room Lifecycle Operations *** @(CHA-RL1h5)@ @[Testable]@ When the room enters the @FAILED@ status as a result of @CHA-RL1h4@, asynchronously with respect to @CHA-RL1h4@, then the room will detach all channels that are not in the @FAILED@ state. *** @(CHA-RL1h6)@ @[Testable]@ If, when performing @CHA-RL1h5@, a channel fails to detach on command, then the detach operation will be repeated until such a time that all channels have detached successfully. ** @(CHA-RL1i)@ This specification point has been removed. It was superseded by CHA-RC1f. -*** @(CHA-RL1i1)@ @[Testable]@ This specification point has been removed, since it's not needed as per CHA-RC1. +*** @(CHA-RL1i1)@ @[Testable]@ This specification point has been removed. It was made redundant by the introduction of @CHA-RC1@. * @(CHA-RL2)@ A room must be explicitly detached via the @DETACH@ operation. ** @(CHA-RL2a)@ @[Testable]@ If the room status is already @DETACHED@, then this operation is a no-op. ** @(CHA-RL2b)@ @[Testable]@ If the room is in the @RELEASING@ status, the operation shall be rejected with an @ErrorInfo@ with the @RoomIsReleasing@ error code from the "chat-specific error codes":#error-codes.