[Amazon] StopConnect for UDC in Android tv-casting-app

Updated Android & iOS tv-casting-app to send stopConnect command when user
exits UDC before confirming passcode

Changes
1. ConnectionExampleFragment.java track if user confirmed passcode or
   not
2. ConnectionExampleFragment.java onDestroy() send stopConnect() if user
   has not confirmed passcode
3. MCConnectionExampleViewModel track if user confirmed passcode or not
4. MCConnectionExampleView trigger stopConnect when Connecting view
   dissapear

Test
1. Manually verfied stopConnect works for normal UDC and commissioner generated
   passcode UDC
2. Manually verified alternating attempt of normal UDC and commissioner generated
   passcode UDC works
3. Manually verified stopConnect is not called in other states other than
   pending passcode confirmation

Author: yuenton-amazon

examples/tv-casting-app/android/App/app/src/main/java/com/matter/casting/ConnectionExampleFragment.java

@@ -42,6 +42,14 @@
 
 /** A {@link Fragment} to Verify or establish a connection with a selected Casting Player. */
 public class ConnectionExampleFragment extends Fragment {
+  enum ConnectionState {
+      PENDING_PASSCODE_CONFIRMATION,
+      CONNECTING,
+      CONNECTED,
+      FAILED,
+      CANCELLED,
+  }
+
   private static final String TAG = ConnectionExampleFragment.class.getSimpleName();
   // Time (in sec) to keep the commissioning window open, if commissioning is required.
   // Must be >= 3 minutes.
@@ -58,6 +66,7 @@ public class ConnectionExampleFragment extends Fragment {
   private TextView commissionerDeclarationErrorTextView;
   private Button connectionFragmentNextButton;
   private AlertDialog passcodeDialog;
+  private ConnectionState connection_state = ConnectionState.PENDING_PASSCODE_CONFIRMATION;
 
   public ConnectionExampleFragment(
       CastingPlayer targetCastingPlayer, boolean useCommissionerGeneratedPasscode) {
@@ -171,6 +180,7 @@ public void handle(Void v) {
                           getActivity()
                               .runOnUiThread(
                                   () -> {
+                                    connection_state = ConnectionState.CONNECTED;
                                     connectionFragmentStatusTextView.setText(
                                         "Successfully connected to Casting Player with device name: "
                                             + targetCastingPlayer.getDeviceName()
@@ -188,6 +198,7 @@ public void handle(MatterError err) {
                           getActivity()
                               .runOnUiThread(
                                   () -> {
+                                    connection_state = ConnectionState.FAILED;
                                     connectionFragmentStatusTextView.setText(
                                         "Casting Player connection failed due to: " + err + "\n\n");
                                   });
@@ -262,6 +273,21 @@ public void handle(CommissionerDeclaration cd) {
             });
   }
 
+  @Override
+  public void onDestroy() {
+    super.onDestroy();
+    Log.i(TAG, "onDestroy(), connection_state: " + connection_state);
+
+    // Only stop connection if we are pending passcode confirmation
+    // We cannot stop connection once continueConnecting() is called
+    if (connection_state == ConnectionState.PENDING_PASSCODE_CONFIRMATION) {
+      MatterError err = targetCastingPlayer.stopConnecting();
+      if (err.hasError()) {
+        Log.e(TAG, "Going back before connection finishes but stopConnecting() failed due to: " + err);
+      }
+    }
+  }
+
   private void displayPasscodeInputDialog(Context context) {
     AlertDialog.Builder builder = new AlertDialog.Builder(context);
 
@@ -328,7 +354,9 @@ public void onClick(DialogInterface dialog, int which) {
 
             MatterError err = targetCastingPlayer.continueConnecting();
 
-            if (err.hasError()) {
+            if (!err.hasError()) {
+              connection_state = ConnectionState.CONNECTING;
+            } else {
               MatterError finalErr = err;
               getActivity()
                   .runOnUiThread(
@@ -363,7 +391,9 @@ public void onClick(DialogInterface dialog, int which) {
             connectionFragmentStatusTextView.setText(
                 "Connection attempt with Casting Player cancelled by the Casting Client/Commissionee user. \n\nRoute back to exit. \n\n");
             MatterError err = targetCastingPlayer.stopConnecting();
-            if (err.hasError()) {
+            if (!err.hasError()) {
+              connection_state = ConnectionState.CANCELLED;
+            } else {
               MatterError finalErr = err;
               getActivity()
                   .runOnUiThread(

examples/tv-casting-app/darwin/TvCasting/TvCasting/MCConnectionExampleView.swift

@@ -88,6 +88,9 @@ struct MCConnectionExampleView: View {
                 viewModel.connect(selectedCastingPlayer: self.selectedCastingPlayer, useCommissionerGeneratedPasscode: self.useCommissionerGeneratedPasscode)
             }
         })
+        .onDisappear(perform: {
+            viewModel.cancelConnectionAttempt(selectedCastingPlayer: self.selectedCastingPlayer)
+        })
     }
 }
 

examples/tv-casting-app/darwin/TvCasting/TvCasting/MCConnectionExampleViewModel.swift

@@ -25,6 +25,8 @@ class MCConnectionExampleViewModel: ObservableObject {
 
     var passcodeAlertController: UIAlertController?
 
+    var pendingPasscodeConfirmation: Bool = true;
+    
     // VendorId of the MCEndpoint on the MCCastingPlayer that the MCCastingApp desires to interact with after connection
     let kDesiredEndpointVendorId: UInt16 = 65521;
 
@@ -42,13 +44,33 @@ class MCConnectionExampleViewModel: ObservableObject {
 
     @Published var errorCodeDescription: String?
 
+    func cancelConnectionAttempt(selectedCastingPlayer: MCCastingPlayer?) {
+        DispatchQueue.main.async {
+            // Only stop connection if we are pending passcode confirmation
+            // We cannot stop connection once continueConnecting() is called
+            if self.pendingPasscodeConfirmation {
+                self.Log.info("MCConnectionExampleViewModel cancelConnect(). User navigating back from ConnectionView")
+                let err = selectedCastingPlayer?.stopConnecting()
+                if err == nil {
+                    self.pendingPasscodeConfirmation = false;
+                    self.connectionStatus = "User cancelled the connection attempt with CastingPlayer.stopConnecting()."
+                    self.Log.info("MCConnectionExampleViewModel cancelConnect() MCCastingPlayer.stopConnecting() succeeded.")
+                } else {
+                    self.connectionStatus = "Cancel connection failed due to: \(String(describing: err))."
+                    self.Log.error("MCConnectionExampleViewModel cancelConnect() MCCastingPlayer.stopConnecting() failed due to: \(err)")
+                }
+            }
+        }
+    }
+
     func connect(selectedCastingPlayer: MCCastingPlayer?, useCommissionerGeneratedPasscode: Bool) {
         self.Log.info("MCConnectionExampleViewModel.connect() useCommissionerGeneratedPasscode: \(String(describing: useCommissionerGeneratedPasscode))")
 
         let connectionCompleteCallback: (Swift.Error?) -> Void = { err in
             self.Log.error("MCConnectionExampleViewModel connect() completed with: \(err)")
             DispatchQueue.main.async {
                 if err == nil {
+                    self.pendingPasscodeConfirmation = false;
                     self.connectionSuccess = true
                     if useCommissionerGeneratedPasscode {
                         self.connectionStatus = "Successfully connected to Casting Player using the Casting Player/Commissioner-Generated passcode!"
@@ -125,6 +147,7 @@ class MCConnectionExampleViewModel: ObservableObject {
                             self.Log.info("MCConnectionExampleViewModel connect() commissionerDeclarationCallback, calling MCCastingPlayer.continueConnecting()")
                             let errContinue = selectedCastingPlayer?.continueConnecting()
                             if errContinue == nil {
+                                self.pendingPasscodeConfirmation = false;
                                 self.connectionStatus = "Continuing to connect with user entered passcode: \(userEnteredPasscode)"
                             } else {
                                 self.connectionStatus = "Continue Connecting to Casting Player failed with: \(String(describing: errContinue)) \n\nRoute back and try again."
@@ -142,6 +165,7 @@ class MCConnectionExampleViewModel: ObservableObject {
                             self.Log.info("MCConnectionExampleViewModel connect() commissionerDeclarationCallback, Connection attempt cancelled by the user, calling MCCastingPlayer.stopConnecting()")
                             let err = selectedCastingPlayer?.stopConnecting()
                             self.connectionSuccess = false
+                            self.pendingPasscodeConfirmation = false;
                             if err == nil {
                                 self.connectionStatus = "User cancelled the connection attempt with CastingPlayer. \n\nRoute back to exit."
                                 self.Log.info("MCConnectionExampleViewModel connect() commissionerDeclarationCallback, User cancelled the connection attempt with MCCastingPlayer, MCCastingPlayer.stopConnecting() succeeded.")
@@ -180,7 +204,10 @@ class MCConnectionExampleViewModel: ObservableObject {
 
         self.Log.info("MCConnectionExampleViewModel.connect() calling MCCastingPlayer.verifyOrEstablishConnection()")
         let err = selectedCastingPlayer?.verifyOrEstablishConnection(with: connectionCallbacks, identificationDeclarationOptions: identificationDeclarationOptions)
-        if err != nil {
+        if err == nil {
+            self.pendingPasscodeConfirmation = true;
+        } else {
+            self.pendingPasscodeConfirmation = false;
             self.Log.error("MCConnectionExampleViewModel connect(), MCCastingPlayer.verifyOrEstablishConnection() failed due to: \(err)")
         }
     }

examples/tv-casting-app/tv-casting-common/core/CastingPlayer.cpp

@@ -228,11 +228,6 @@ CHIP_ERROR CastingPlayer::ContinueConnecting()
 
 CHIP_ERROR CastingPlayer::StopConnecting()
 {
-    VerifyOrReturnValue(
-        mIdOptions.mCommissionerPasscode, CHIP_ERROR_INCORRECT_STATE,
-        ChipLogError(AppServer,
-                     "CastingPlayer::StopConnecting() mIdOptions.mCommissionerPasscode == false, ContinueConnecting() should only "
-                     "be called when the CastingPlayer/Commissioner-Generated passcode commissioning flow is in progress."););
     // Calling the internal StopConnecting() API with the shouldSendIdentificationDeclarationMessage set to true to notify the
     // CastingPlayer/Commissioner that the commissioning session was cancelled by the Casting Client/Commissionee user. This will
     // result in the Casting Client/Commissionee sending a CancelPasscode IdentificationDeclaration message to the CastingPlayer.