fixup! util: extend oc_endpoint_addresses_t by custom on change callback

.github/workflows/ctt-test.yml

@@ -28,7 +28,7 @@ jobs:
 
       - name: Archive results
         if: success() || failure()
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: logs
           path: results/*.octt

.github/workflows/plgd-device-test-with-cfg.yml

@@ -109,12 +109,13 @@ jobs:
           docker run --rm --network=host -v `pwd`/${{ env.CERT_PATH }}:/pki_certs ${{ env.TEST_CLOUD_SERVER_IMAGE }} \
             -test.parallel 1 -test.v
 
-      - name: Get output file name
+      - name: Generate file name and artifact name
         if: ${{ inputs.coverage }}
         id: coverage
         run: |
           SUFFIX=`echo "-DCMAKE_BUILD_TYPE=${{ inputs.build_type }} ${{ inputs.build_args }} ${{ inputs.name }} -DBUILD_TESTING=ON" | sha1sum | cut -f 1 -d ' '`
           echo "filename=coverage-plgd-device-${SUFFIX}.json" >> $GITHUB_OUTPUT
+          echo "artifact=plgd-device-${SUFFIX}-coverage" >> $GITHUB_OUTPUT
 
       - name: Gather coverage data
         if: ${{ inputs.coverage }}
@@ -129,9 +130,9 @@ jobs:
 
       - name: Upload coverage data
         if: ${{ inputs.coverage }}
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
-          name: plgd-device-coverage
+          name: ${{ steps.coverage.outputs.artifact }}
           path: data/coverage/${{ steps.coverage.outputs.filename }}
           if-no-files-found: error
           retention-days: 1

.github/workflows/plgd-hub-test-with-cfg.yml

@@ -103,12 +103,13 @@ jobs:
       - name: Run plgd hub tests image
         run: docker run --rm --network=host ${{ inputs.hub_args }} ${{ env.TEST_CLOUD_SERVER_IMAGE }}
 
-      - name: Get output file name
+      - name: Generate file name and artifact name
         if: ${{ inputs.coverage }}
         id: coverage
         run: |
           SUFFIX=`echo "-DCMAKE_BUILD_TYPE=${{ inputs.build_type }} ${{ inputs.build_args }} ${{ inputs.args }} ${{ inputs.docker_args }} ${{ inputs.hub_args }} ${{ inputs.name }} -DBUILD_TESTING=ON" | sha1sum | cut -f 1 -d ' '`
           echo "filename=coverage-plgd-hub-${SUFFIX}.json" >> $GITHUB_OUTPUT
+          echo "artifact=plgd-hub-${SUFFIX}-coverage" >> $GITHUB_OUTPUT
 
       - name: Gather coverage data
         if: ${{ inputs.coverage }}
@@ -122,9 +123,9 @@ jobs:
 
       - name: Upload coverage data
         if: ${{ inputs.coverage }}
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
-          name: plgd-hub-coverage
+          name: ${{ steps.coverage.outputs.artifact }}
           path: data/coverage/${{ steps.coverage.outputs.filename }}
           if-no-files-found: error
           retention-days: 1

.github/workflows/sonar-cloud-analysis.yml

@@ -113,9 +113,10 @@ jobs:
           build-wrapper-linux-x86-64 --out-dir ${{ env.BUILD_WRAPPER_OUT_DIR }} cmake --build build --verbose --target client-server-static --target all
 
       - name: Get coverage from all tests job
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
-          path: tools/
+          merge-multiple: true
+          path: tools/coverage/
 
       - name: Install gcovr
         run: |
@@ -126,7 +127,7 @@ jobs:
         run: |
           cd tools
           # ls -lR .
-          gcovr --add-tracefile "unit-test-coverage/*coverage*.json" --add-tracefile "plgd-device-coverage/*coverage*.json" --add-tracefile "plgd-hub-coverage/*coverage*.json"  --sonarqube --output "coverage.xml" --verbose
+          gcovr --add-tracefile "coverage/*coverage*.json" --sonarqube --output "coverage.xml" --verbose
 
       - name: Run sonar-scanner
         env:

.github/workflows/unit-test-with-cfg.yml

@@ -119,12 +119,13 @@ jobs:
           cd build
           ctest --verbose --label-regex "oc-unittest"
 
-      - name: Get output file name
+      - name: Generate file name and artifact name
         if: ${{ inputs.coverage }}
         id: coverage
         run: |
           SUFFIX=`echo "-DCMAKE_BUILD_TYPE=${{ inputs.build_type }} ${{ steps.cmake_flags.outputs.compiler }} ${{ inputs.build_args }} -DBUILD_TESTING=ON" | sha1sum | cut -f 1 -d ' '`
           echo "filename=coverage-unix-${SUFFIX}.json" >> $GITHUB_OUTPUT
+          echo "artifact=unit-test-${SUFFIX}-coverage" >> $GITHUB_OUTPUT
 
       - name: Collect coverage data
         if: ${{ inputs.coverage }}
@@ -135,9 +136,9 @@ jobs:
 
       - name: Upload coverage data
         if: ${{ inputs.coverage }}
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
-          name: unit-test-coverage
+          name: ${{ steps.coverage.outputs.artifact }}
           path: tools/${{ steps.coverage.outputs.filename }}
           if-no-files-found: error
           retention-days: 1

api/cloud/oc_cloud_context.c

@@ -60,8 +60,8 @@ need_to_reinitialize_cloud_storage(const oc_cloud_context_t *ctx)
   return cloud_is_deregistering(ctx);
 }
 
-static void
-cloud_on_server_change(void *data)
+void
+cloud_context_on_server_change(void *data)
 {
   oc_cloud_context_t *ctx = (oc_cloud_context_t *)data;
   if (ctx->cloud_manager) {
@@ -97,7 +97,7 @@ cloud_context_init(size_t device)
   ctx->cloud_ep_state = OC_SESSION_DISCONNECTED;
   ctx->cloud_ep = oc_new_endpoint();
   ctx->selected_identity_cred_id = -1;
-  oc_cloud_store_initialize(&ctx->store, cloud_on_server_change, ctx);
+  oc_cloud_store_initialize(&ctx->store, cloud_context_on_server_change, ctx);
   oc_cloud_store_load(&ctx->store);
   ctx->store.status &=
     ~(OC_CLOUD_LOGGED_IN | OC_CLOUD_TOKEN_EXPIRY | OC_CLOUD_REFRESHED_TOKEN |

api/cloud/oc_cloud_context_internal.h

@@ -171,6 +171,10 @@ void cloud_context_clear_access_token(oc_cloud_context_t *ctx) OC_NONNULL();
 bool cloud_context_has_refresh_token(const oc_cloud_context_t *ctx)
   OC_NONNULL();
 
+/** @brief Callback invoekd by ctx::store::ci_servers when the selected cloud
+ * server is changed  */
+void cloud_context_on_server_change(void *data) OC_NONNULL();
+
 /** @brief Initialize the registration context */
 void oc_cloud_registration_context_init(oc_cloud_registration_context_t *regctx,
                                         const oc_endpoint_addresses_t *servers)

api/cloud/oc_cloud_endpoints.c

@@ -68,11 +68,14 @@ oc_cloud_endpoint_addresses_set(oc_endpoint_addresses_t *ea,
   }
 
 #if OC_DBG_IS_ENABLED
+  // GCOVR_EXCL_START
   char selected_id[OC_UUID_LEN] = { 0 };
   oc_uuid_to_str(&selected_uuid, selected_id, OC_UUID_LEN);
-  OC_CLOUD_DBG(
-    "reinitialized cloud endpoint addresses, selected cloud (uri: %s, sid: %s)",
-    oc_string(*selected_uri), selected_id);
+  OC_CLOUD_DBG("reinitialized cloud endpoint addresses, selected cloud (uri: "
+               "%s, sid: %s)",
+               selected_uri != NULL ? oc_string(*selected_uri) : "NULL",
+               selected_id);
+  // GCOVR_EXCL_STOP
 #endif /* OC_DBG_IS_ENABLED */
   if (srep.servers == NULL) {
     return true;

api/cloud/oc_cloud_manager.c

@@ -256,28 +256,6 @@ cloud_start_process(oc_cloud_context_t *ctx)
   _oc_signal_event_loop();
 }
 
-static uint64_t
-refresh_token_expires_in_ms(int64_t expires_in_ms)
-{
-  if (expires_in_ms <= 0) {
-    return 0;
-  }
-
-  if (expires_in_ms > (int64_t)MILLISECONDS_PER_HOUR) {
-    // if time is more than 1h then set expires to (expires_in_ms - 10min).
-    return (uint64_t)(expires_in_ms - (int64_t)(10 * MILLISECONDS_PER_MINUTE));
-  }
-  if (expires_in_ms > (int64_t)(4 * MILLISECONDS_PER_MINUTE)) {
-    // if time is more than 240sec then set expires to (expires_in_ms - 2min).
-    return (uint64_t)(expires_in_ms - (int64_t)(2 * MILLISECONDS_PER_MINUTE));
-  }
-  if (expires_in_ms > (int64_t)(20 * MILLISECONDS_PER_SECOND)) {
-    // if time is more than 20sec then set expires to (expires_in_ms - 10sec).
-    return (uint64_t)(expires_in_ms - (int64_t)(10 * MILLISECONDS_PER_SECOND));
-  }
-  return (uint64_t)expires_in_ms;
-}
-
 static bool
 cloud_is_connection_error_or_timeout(oc_status_t code)
 {
@@ -388,7 +366,7 @@ cloud_manager_handle_redirect_response(oc_cloud_context_t *ctx,
       oc_endpoint_addresses_add(&ctx->store.ci_servers,
                                 oc_endpoint_address_make_view_with_uuid(
                                   oc_string_view2(redirecturi), sid)) == NULL) {
-    OC_ERR("failed to add server to the list");
+    OC_CLOUD_ERR("failed to add server to the list");
     return false;
   }
 
@@ -697,6 +675,26 @@ on_keepalive_response(oc_cloud_context_t *ctx, bool response_received,
   return true;
 }
 
+uint64_t
+cloud_manager_calculate_refresh_token_expiration(uint64_t expires_in_ms)
+{
+  assert(expires_in_ms > 0);
+
+  if (expires_in_ms > (uint64_t)MILLISECONDS_PER_HOUR) {
+    // if time is more than 1h then set expires to (expires_in_ms - 10min).
+    return expires_in_ms - (uint64_t)(10 * MILLISECONDS_PER_MINUTE);
+  }
+  if (expires_in_ms > (int64_t)(4 * MILLISECONDS_PER_MINUTE)) {
+    // if time is more than 240sec then set expires to (expires_in_ms - 2min).
+    return expires_in_ms - (uint64_t)(2 * MILLISECONDS_PER_MINUTE);
+  }
+  if (expires_in_ms > (int64_t)(20 * MILLISECONDS_PER_SECOND)) {
+    // if time is more than 20sec then set expires to (expires_in_ms - 10sec).
+    return expires_in_ms - (uint64_t)(10 * MILLISECONDS_PER_SECOND);
+  }
+  return (uint64_t)0;
+}
+
 static void
 cloud_manager_login_handler(oc_client_response_t *data)
 {
@@ -720,8 +718,8 @@ cloud_manager_login_handler(oc_client_response_t *data)
     if (ctx->store.expires_in > 0) {
       oc_reset_delayed_callback_ms(
         ctx, cloud_manager_refresh_token_async,
-        refresh_token_expires_in_ms(ctx->store.expires_in *
-                                    MILLISECONDS_PER_SECOND));
+        cloud_manager_calculate_refresh_token_expiration(
+          ctx->store.expires_in * MILLISECONDS_PER_SECOND));
     }
     oc_reset_delayed_callback(ctx, cloud_manager_callback_handler_async, 0);
     return;

api/cloud/oc_cloud_manager_internal.h

@@ -64,6 +64,20 @@ bool cloud_manager_handle_redirect_response(oc_cloud_context_t *ctx,
                                             const oc_rep_t *payload)
   OC_NONNULL();
 
+/**
+ * @brief Calculate the expiration time of the refresh token.
+ *
+ * The expiration time is used to determine when the refresh token should be
+ * refreshed. It should be less than the actual expiration time of the token, so
+ * it can be refreshed before it really expires.
+ *
+ *
+ * @param expires_in_ms expires_in value in milliseconds (must be >0)
+ * @return uint64_t expiration time in milliseconds
+ */
+uint64_t cloud_manager_calculate_refresh_token_expiration(
+  uint64_t expires_in_ms);
+
 /**
  * @brief Parse refresh token response retrieved from the server and store the
  * data to cloud context.

api/cloud/oc_cloud_rd.c

@@ -274,10 +274,12 @@ cloud_delete_resources(oc_cloud_context_t *ctx)
   }
 
 #if OC_DBG_IS_ENABLED
+  // GCOVR_EXCL_START
   for (const oc_link_t *link = partition.not_deleted; link != NULL;
        link = link->next) {
     OC_CLOUD_DBG("link(ins=%" PRId64 ") not unpublished", link->ins);
   }
+  // GCOVR_EXCL_STOP
 #endif /* OC_DBG_IS_ENABLED */
   ctx->rd_delete_resources = partition.not_deleted;
   rd_link_free(&partition.deleted);
@@ -369,7 +371,7 @@ oc_cloud_publish_resources(size_t device)
 {
   oc_cloud_context_t *ctx = oc_cloud_get_context(device);
   if (ctx == NULL) {
-    OC_ERR("cannot publish resource: invalid device(%zu)", device);
+    OC_CLOUD_ERR("cannot publish resource: invalid device(%zu)", device);
     return -1;
   }
   publish_published_resources(ctx);

api/cloud/oc_cloud_resource.c

@@ -157,15 +157,15 @@ cloud_update_from_request(oc_cloud_context_t *ctx, const oc_request_t *request)
   if (sid != NULL) {
     oc_string_view_t sidv = oc_string_view2(sid);
     if (oc_str_to_uuid_v1(sidv.data, sidv.length, &data.sid) < 0) {
-      OC_ERR("failed parsing sid(%s)", sidv.data);
+      OC_CLOUD_ERR("failed parsing sid(%s)", sidv.data);
       return false;
     }
   }
 
   const oc_rep_t *ci_servers = oc_rep_get_by_type_and_key(
     request->request_payload, OC_REP_OBJECT_ARRAY,
     OCF_COAPCLOUDCONF_PROP_CISERVERS,
-    OC_CHAR_ARRAY_LEN(OCF_COAPCLOUDCONF_PROP_CISERVER));
+    OC_CHAR_ARRAY_LEN(OCF_COAPCLOUDCONF_PROP_CISERVERS));
   if (ci_servers != NULL) {
     data.ci_servers = ci_servers->value.object_array;
   }

api/cloud/oc_cloud_store.c

@@ -121,7 +121,7 @@ oc_cloud_store_dump(const oc_cloud_store_t *store)
   long ret = oc_storage_data_save(OC_CLOUD_STORE_NAME, store->device,
                                   store_encode_cloud, store);
   if (ret <= 0) {
-    OC_ERR("cannot dump cloud to storage: error(%ld)", ret);
+    OC_CLOUD_ERR("cannot dump cloud to storage: error(%ld)", ret);
     return false;
   }
   return true;
@@ -304,7 +304,7 @@ oc_cloud_store_decode(const oc_rep_t *rep, oc_cloud_store_t *store)
   // copy data to store
   if ((csd.ci_server != NULL || csd.ci_servers != NULL) &&
       !cloud_store_set_servers(store, csd.ci_server, csd.sid, csd.ci_servers)) {
-    OC_WRN("failed to set cloud servers from storage");
+    OC_CLOUD_WRN("failed to set cloud servers from storage");
   }
 
   if (csd.auth_provider != NULL) {
@@ -332,7 +332,7 @@ store_decode_cloud(const oc_rep_t *rep, size_t device, void *data)
   (void)device;
   oc_cloud_store_t *store = (oc_cloud_store_t *)data;
   if (!oc_cloud_store_decode(rep, store)) {
-    OC_ERR("cannot load cloud: cannot decode representation");
+    OC_CLOUD_ERR("cannot load cloud: cannot decode representation");
     return -1;
   }
   return 0;
@@ -343,11 +343,11 @@ oc_cloud_store_load(oc_cloud_store_t *store)
 {
   if (oc_storage_data_load(OC_CLOUD_STORE_NAME, store->device,
                            store_decode_cloud, store) <= 0) {
-    OC_DBG("failed to load cloud from storage");
+    OC_CLOUD_DBG("failed to load cloud from storage");
     oc_cloud_store_reinitialize(store);
     return false;
   }
-  OC_DBG("cloud loaded from storage");
+  OC_CLOUD_DBG("cloud loaded from storage");
   return true;
 }
 

api/cloud/rd_client.c

@@ -158,7 +158,7 @@ rd_prepare_write_buffer(oc_write_buffer_t *wb, char *buffer, size_t buffer_size,
   // enough room to write the "di={id}" part
   if (buffer_size <=
       /*di=*/3 + id.length) {
-    OC_ERR("buffer too small");
+    OC_CLOUD_ERR("buffer too small");
     return false;
   }
   wb->buffer = buffer;
@@ -212,10 +212,10 @@ rd_delete_send_packet(const oc_endpoint_t *endpoint, oc_string_view_t query,
                       void *data)
 {
   rd_delete_packet_t *pkt = (rd_delete_packet_t *)data;
-  OC_DBG("Unpublishing links (query=%s)", query.data);
+  OC_CLOUD_DBG("Unpublishing links (query=%s)", query.data);
   if (!oc_do_delete(OC_RSRVD_RD_URI, endpoint, query.data, pkt->handler,
                     pkt->qos, pkt->user_data)) {
-    OC_ERR("failed to unpublish links (query=%s)", query.data);
+    OC_CLOUD_ERR("failed to unpublish links (query=%s)", query.data);
     return false;
   }
   return true;