Clear publish copy after state update on receiving ACK

Author: Dakshit Babbar

source/core_mqtt.c

@@ -1573,16 +1573,6 @@ static MQTTStatus_t handlePublishAcks( MQTTContext_t * pContext,
     status = MQTT_DeserializeAck( pIncomingPacket, &packetIdentifier, NULL );
     LogInfo( ( "Ack packet deserialized with result: %s.",
                MQTT_Status_strerror( status ) ) );
-    
-    if( ( ackType ==  MQTTPuback ) || ( ackType ==  MQTTPubrec ) )
-    {
-        if( ( status == MQTTSuccess ) &&
-            ( pContext->clearFunction != NULL ) &&
-            ( pContext->clearFunction( pContext, packetIdentifier) != true ) )
-        {
-            status = MQTTPublishClearFailed;
-        }
-    }
 
     if( status == MQTTSuccess )
     {
@@ -1610,6 +1600,16 @@ static MQTTStatus_t handlePublishAcks( MQTTContext_t * pContext,
         }
     }
 
+    if( ( ackType ==  MQTTPuback ) || ( ackType ==  MQTTPubrec ) )
+    {
+        if( ( status == MQTTSuccess ) &&
+            ( pContext->clearFunction != NULL ) &&
+            ( pContext->clearFunction( pContext, packetIdentifier) != true ) )
+        {
+            LogWarn( ( "Clear callback function failed\n" ) );
+        }
+    }
+
     if( status == MQTTSuccess )
     {
         /* Set fields of deserialized struct. */
@@ -3708,10 +3708,6 @@ const char * MQTT_Status_strerror( MQTTStatus_t status )
             str = "MQTTPublishRetrieveFailed";
             break;
 
-        case MQTTPublishClearFailed:
-            str = "MQTTPublishClearFailed";
-            break;
-        
         case MQTTPublishClearAllFailed:
             str = "MQTTPublishClearAllFailed";
             break;

source/include/core_mqtt_serializer.h

@@ -106,7 +106,6 @@ typedef enum MQTTStatus
                                     has failed */
     MQTTPublishRetrieveFailed,      /**< User provided API to retrieve the copy of a publish while reconnecting 
                                     with an unclean session has failed */
-    MQTTPublishClearFailed,         /**< User provided API to clear the copy of a publish on receiving a PUBACK has failed */
     MQTTPublishClearAllFailed       /**< User provided API to clear all the copies of publishes while connecting with a clean 
                                     session has failed */
 } MQTTStatus_t;

test/unit-test/core_mqtt_utest.c

@@ -1235,14 +1235,6 @@ static void expectProcessLoopCalls( MQTTContext_t * const pContext,
         }
     }
 
-    if(expectMoreCalls)
-    {
-        if(pContext->clearFunction == publishClearCallbackFailed)
-        {
-            expectMoreCalls = false;
-        }
-    }
-
     /* Update state based on the packet type (PUB or ACK) being received. */
     if( expectMoreCalls )
     {
@@ -4744,17 +4736,17 @@ void test_MQTT_ProcessLoop_handleIncomingAck_Clear_Publish_Copies( void )
     currentPacketType = MQTT_PACKET_TYPE_PUBACK;
     /* Set expected return values in the loop. */
     resetProcessLoopParams( &expectParams );
-    expectParams.stateAfterDeserialize = MQTTPubAckPending;
-    expectParams.processLoopStatus = MQTTPublishClearFailed;
+    expectParams.stateAfterDeserialize = MQTTPublishDone;
+    expectParams.stateAfterSerialize = MQTTPublishDone;
     expectProcessLoopCalls( &context, &expectParams );
 
     /* Mock the receiving of a PUBREC packet type and expect the appropriate
      * calls made from the process loop. */
     currentPacketType = MQTT_PACKET_TYPE_PUBREC;
     /* Set expected return values in the loop. */
     resetProcessLoopParams( &expectParams );
-    expectParams.stateAfterDeserialize = MQTTPubRecPending;
-    expectParams.processLoopStatus = MQTTPublishClearFailed;
+    expectParams.stateAfterDeserialize = MQTTPubRelSend;
+    expectParams.stateAfterSerialize = MQTTPubCompPending;
     expectProcessLoopCalls( &context, &expectParams );
 
 }
@@ -7095,10 +7087,6 @@ void test_MQTT_Status_strerror( void )
     str = MQTT_Status_strerror( status );
     TEST_ASSERT_EQUAL_STRING( "MQTTPublishRetrieveFailed", str );
 
-    status = MQTTPublishClearFailed;
-    str = MQTT_Status_strerror( status );
-    TEST_ASSERT_EQUAL_STRING( "MQTTPublishClearFailed", str );
-
     status = MQTTPublishClearAllFailed;
     str = MQTT_Status_strerror( status );
     TEST_ASSERT_EQUAL_STRING( "MQTTPublishClearAllFailed", str );