Fix file operation and download URL issue #291

mobizt · mobizt · commit a6071f63bc11 · 2025-09-12T21:02:49.000+07:00
diff --git a/examples/CloudStorage/Download/Download.ino b/examples/CloudStorage/Download/Download.ino
@@ -5,7 +5,7 @@
  * See examples/App/AppInitialization for more authentication examples.
  *
  * The OAuth2.0 authentication or access token authorization is required for Cloud Storage operations.
- * 
+ *
  * For Google JSON API reference documentation, please visit
  * https://cloud.google.com/storage/docs/json_api/v1/objects/get
  *
@@ -108,14 +108,14 @@ void loop()
         cstorage.download(aClient, GoogleCloudStorage::Parent(STORAGE_BUCKET_ID, "media.mp4"), getFile(media_file), options, processData, "⬇️  downloadTask");
 
         // Async call with AsyncResult for returning result.
-        cstorage.download(aClient, GoogleCloudStorage::Parent(STORAGE_BUCKET_ID, "media.mp4"), getFile(media_file), options, cloudStorageResult);
+        // cstorage.download(aClient, GoogleCloudStorage::Parent(STORAGE_BUCKET_ID, "media.mp4"), getFile(media_file), options, cloudStorageResult);
 
         // Sync call which waits until the operation complete.
-        bool status = cstorage.download(aClient, GoogleCloudStorage::Parent(STORAGE_BUCKET_ID, "media.mp4"), getFile(media_file), options);
-        if (status)
-            Serial.println("🔽 Dowload task (await), complete!✅️");
-        else
-            Firebase.printf("Error, msg: %s, code: %d\n", aClient.lastError().message().c_str(), aClient.lastError().code());
+        // bool status = cstorage.download(aClient, GoogleCloudStorage::Parent(STORAGE_BUCKET_ID, "media.mp4"), getFile(media_file), options);
+        // if (status)
+        //     Serial.println("🔽 Dowload task (await), complete!✅️");
+        // else
+        //     Firebase.printf("Error, msg: %s, code: %d\n", aClient.lastError().message().c_str(), aClient.lastError().code());
 
 #endif
     }
diff --git a/examples/CloudStorage/Upload/Upload.ino b/examples/CloudStorage/Upload/Upload.ino
@@ -5,7 +5,7 @@
  * See examples/App/AppInitialization for more authentication examples.
  *
  * The OAuth2.0 authentication or access token authorization is required for Cloud Storage operations.
- * 
+ *
  * For Google JSON API reference documentation, please visit
  * https://cloud.google.com/storage/docs/json_api/v1/objects/insert
  * https://cloud.google.com/storage/docs/resumable-uploads
@@ -113,14 +113,14 @@ void loop()
         cstorage.upload(aClient, GoogleCloudStorage::Parent(STORAGE_BUCKET_ID, "media.mp4"), getFile(media_file), options, processData, "⬆️  uploadTask");
 
         // Async call with AsyncResult for returning result.
-        cstorage.upload(aClient, GoogleCloudStorage::Parent(STORAGE_BUCKET_ID, "media.mp4"), getFile(media_file), options, cloudStorageResult);
+        // cstorage.upload(aClient, GoogleCloudStorage::Parent(STORAGE_BUCKET_ID, "media.mp4"), getFile(media_file), options, cloudStorageResult);
 
         // Sync call which waits until the operation complete.
-        bool status = cstorage.upload(aClient, GoogleCloudStorage::Parent(STORAGE_BUCKET_ID, "media.mp4"), getFile(media_file), options);
-        if (status)
-            Serial.println("🔼 Upload task(await), complete!✅️");
-        else
-            Firebase.printf("Error, msg: %s, code: %d\n", aClient.lastError().message().c_str(), aClient.lastError().code());
+        // bool status = cstorage.upload(aClient, GoogleCloudStorage::Parent(STORAGE_BUCKET_ID, "media.mp4"), getFile(media_file), options);
+        // if (status)
+        //     Serial.println("🔼 Upload task(await), complete!✅️");
+        // else
+        //     Firebase.printf("Error, msg: %s, code: %d\n", aClient.lastError().message().c_str(), aClient.lastError().code());
 #endif
     }
 
diff --git a/examples/FirestoreDatabase/Documents/CreateDocument/CreateDocument.ino b/examples/FirestoreDatabase/Documents/CreateDocument/CreateDocument.ino
@@ -95,10 +95,7 @@ void loop()
         // e.g. "collection/document/subcollection", the document with autogenerated ID will be created
         // e.g. "collection/document/subcollection/bvOHWMu8xTOrO8aeGk9h"
 
-        // There are some restrictions about the document ID and API endpoints which you have to know
-        // when working with this library.
-
-        // 1. Document ID Restrictions
+        // Document ID Restrictions
         //////////////////////////////
 
         // The document ID must consist of valid UTF-8 characters with 1,500 bytes maximum.
@@ -114,14 +111,6 @@ void loop()
         // In the console, you can create the ancestor document "test_doc_creation/doc_1" before running this example
         // to avoid non-existent ancestor documents case.
 
-        // 2. REST API restrictions
-        ///////////////////////////
-
-        // As mentioned above, the document path will be used as the path parameter and
-        // query parameter of the REST API endpoint (URL).
-        // To ensures that the information is transmitted accurately and without corruption, the
-        // document path that contains some special characters should be URL-encoded.
-
         // For the Firestore data model, plesae see https://firebase.google.com/docs/firestore/data-model
 
         // We will create the documents in the path "test_doc_creation/doc_1/col_1/data_?"
diff --git a/examples/Messaging/WebClient/fcm.html b/examples/Messaging/WebClient/fcm.html
diff --git a/examples/RealtimeDatabase/StreamPerformanceTest/index.html b/examples/RealtimeDatabase/StreamPerformanceTest/index.html
diff --git a/examples/Storage/Download/Download.ino b/examples/Storage/Download/Download.ino
@@ -99,14 +99,14 @@ void loop()
         // storage.download(aClient, FirebaseStorage::Parent(STORAGE_BUCKET_ID, "media.mp4", "access token"), getFile(media_file), processData, "downloadTask");
 
         // Async call with AsyncResult for returning result.
-        storage.download(aClient, FirebaseStorage::Parent(STORAGE_BUCKET_ID, "media.mp4"), getFile(media_file), storageResult);
+        // storage.download(aClient, FirebaseStorage::Parent(STORAGE_BUCKET_ID, "media.mp4"), getFile(media_file), storageResult);
 
         // Sync call which waits until the operation complete.
-        bool status = storage.download(aClient, FirebaseStorage::Parent(STORAGE_BUCKET_ID, "media.mp4"), getFile(media_file));
-        if (status)
-            Serial.println("🔽 Dowload task (await), complete!✅️");
-        else
-            Firebase.printf("Error, msg: %s, code: %d\n", aClient.lastError().message().c_str(), aClient.lastError().code());
+        // bool status = storage.download(aClient, FirebaseStorage::Parent(STORAGE_BUCKET_ID, "media.mp4"), getFile(media_file));
+        // if (status)
+        //     Serial.println("🔽 Dowload task (await), complete!✅️");
+        // else
+        //     Firebase.printf("Error, msg: %s, code: %d\n", aClient.lastError().message().c_str(), aClient.lastError().code());
 #endif
     }
 
diff --git a/examples/Storage/Upload/Upload.ino b/examples/Storage/Upload/Upload.ino
@@ -97,14 +97,14 @@ void loop()
         storage.upload(aClient, FirebaseStorage::Parent(STORAGE_BUCKET_ID, "media.mp4"), getFile(media_file), "video/mp4", processData, "⬆️  uploadTask");
 
         // Async call with AsyncResult for returning result.
-        storage.upload(aClient, FirebaseStorage::Parent(STORAGE_BUCKET_ID, "media.mp4"), getFile(media_file), "video/mp4", storageResult);
+        // storage.upload(aClient, FirebaseStorage::Parent(STORAGE_BUCKET_ID, "media.mp4"), getFile(media_file), "video/mp4", storageResult);
 
         // Sync call which waits until the operation complete.
-        bool status = storage.upload(aClient, FirebaseStorage::Parent(STORAGE_BUCKET_ID, "media.mp4"), getFile(media_file), "video/mp4");
-         if (status)
-            Serial.println("🔼 Upload task(await), complete!✅️");
-        else
-            Firebase.printf("Error, msg: %s, code: %d\n", aClient.lastError().message().c_str(), aClient.lastError().code());
+        // bool status = storage.upload(aClient, FirebaseStorage::Parent(STORAGE_BUCKET_ID, "media.mp4"), getFile(media_file), "video/mp4");
+        // if (status)
+        //     Serial.println("🔼 Upload task(await), complete!✅️");
+        // else
+        //     Firebase.printf("Error, msg: %s, code: %d\n", aClient.lastError().message().c_str(), aClient.lastError().code());
 #endif
     }
 
diff --git a/library.json b/library.json
@@ -1,6 +1,6 @@
 {
   "name": "FirebaseClient",
-  "version": "2.1.8",
+  "version": "2.1.9",
   "keywords": "communication, REST, esp32, esp8266, arduino",
   "description": "Async Firebase Client library for Arduino.",
   "repository": {
diff --git a/library.properties b/library.properties
@@ -1,6 +1,6 @@
 name=FirebaseClient
 
-version=2.1.8
+version=2.1.9
 
 author=Mobizt
 
diff --git a/src/core/AsyncClient/AsyncClient.h b/src/core/AsyncClient/AsyncClient.h
@@ -590,8 +590,8 @@ class AsyncClientClass PUBLIC_DATABASE_RESULT_IMPL_BASE
                         sData->response.val[resns::payload] += (char *)temp;
                         mem.release(&temp);
                     }
-                     
-                     // gzip header + trailer length
+
+                    // gzip header + trailer length
                     if (res == -1 && sData->response.flags.gzip && sData->response.chunkInfo.dataPos <= 15)
                         res = 0;
 
@@ -833,7 +833,9 @@ class AsyncClientClass PUBLIC_DATABASE_RESULT_IMPL_BASE
             // It should set in readPayload when decodeChunks returns -1.
             if (!sData->response.flags.chunks)
                 sData->response.flags.payload_remaining = false;
+
 #if defined(ENABLE_FS)
+            // Close file when uploading response complete.
             sData->request.closeFile();
 #endif
 
@@ -1005,7 +1007,6 @@ class AsyncClientClass PUBLIC_DATABASE_RESULT_IMPL_BASE
         clear(sData->request.val[reqns::header]);
         sData->request.addRequestHeader(method, path, extras);
         sData->request.addHostHeader(sData->request.getHost(true, &sData->response.val[resns::location]).c_str());
-
         sData->auth_used = options.auth_used;
 
         if (!options.auth_used)
diff --git a/src/core/AsyncClient/ResponseHandler.h b/src/core/AsyncClient/ResponseHandler.h
@@ -78,7 +78,7 @@ struct res_handler
 
     int httpCode = 0, statusCode = 0;
     response_flags flags;
-    size_t payloadLen = 0, payloadRead = 0;
+    size_t payloadLen = 0, payloadRead = 0, xx=0;
     auth_error_t error;
     uint8_t *toFill = nullptr;
     uint16_t toFillLen = 0, toFillIndex = 0;
diff --git a/src/core/AsyncClient/SlotManager.h b/src/core/AsyncClient/SlotManager.h
@@ -219,6 +219,19 @@ class SlotManager PUBLIC_DATABASE_RESULT_IMPL_BASE
         bool download_status = sData->download && sData->aResult.setDownloadProgress();
         bool upload_status = sData->upload && sData->upload_progress_enabled && sData->aResult.setUploadProgress();
 
+        if (sData->upload && sData->aResult.upload_data.progress == 100)
+        {
+            // Defer the complete upload progress when the payload does not set yet.
+            if (sData->aResult.val[ares_ns::data_payload].length() == 0)
+                upload_status = false;
+        }
+
+#if defined(ENABLE_FS)
+        // Close file when downloading complete.
+        if (sData->download && sData->aResult.download_data.progress == 100 && sData->request.file_data.file_status == file_config_data::file_status_opened)
+            sData->request.closeFile();
+#endif
+
         if (getResult(sData))
         {
             if (sseTimeout || setData || error_notify_timeout || download_status || upload_status)
@@ -253,7 +266,7 @@ class SlotManager PUBLIC_DATABASE_RESULT_IMPL_BASE
 
             // In case external async result was set, when upload complete,
             // we need to reset the internal async result upload status to prevent redundant complete messages.
-            if (sData->aResult.upload_data.progress == 100)
+            if (sData->aResult.upload_data.progress == 100 && upload_status)
                 sData->aResult.upload_data.reset();
         }
     }
diff --git a/src/core/Auth/AuthBase.h b/src/core/Auth/AuthBase.h
@@ -45,15 +45,15 @@ namespace firebase_ns
     enum auth_token_type
     {
         auth_unknown_token,
-        auth_user_id_token,
-        auth_sa_access_token,
-        auth_sa_custom_token,
-        auth_id_token,
-        auth_access_token,
-        auth_custom_token,
-        auth_refresh_token,
-        auth_user_signup,
-        auth_user_reset_password,
+        auth_user_id_token, // Id token using email/password credentials
+        auth_sa_access_token, // access token using service account credentials
+        auth_sa_custom_token, // Id token with custom UID and claims using service account credentials
+        auth_id_token, // Id token
+        auth_access_token, // access token
+        auth_custom_token, // Id token with custom UID and claims
+        auth_refresh_token, // refresh token
+        auth_user_signup2, // signup
+        auth_user_reset_password2, // reset password
     };
 
     enum user_auth_data_type
diff --git a/src/core/Core.h b/src/core/Core.h
@@ -7,7 +7,7 @@
 #undef FIREBASE_CLIENT_VERSION
 #endif
 
-#define FIREBASE_CLIENT_VERSION "2.1.8"
+#define FIREBASE_CLIENT_VERSION "2.1.9"
 
 static void sys_idle()
 {
diff --git a/src/core/Options.h b/src/core/Options.h
@@ -170,7 +170,7 @@
 #endif
 #endif
 
-#define FIREBASE_DEFAULT_TS 1618971013
+#define FIREBASE_DEFAULT_TS 1757665447
 
 #define FIREBASE_RECONNECTION_TIMEOUT_MSEC 5000
 
diff --git a/src/core/Utils/URL.h b/src/core/Utils/URL.h
@@ -16,7 +16,7 @@ class URLUtil
 {
 public:
     /* Append a parameter to URL */
-    bool addParam(String &url, const String &key, const String &val, bool &hasParam, bool allowEmptyValue = false)
+    bool addParam(String &url, const String &key, const String &val, bool &hasParam, bool allowEmptyValue = false, bool isEncode = false)
     {
         if (!allowEmptyValue && val.length() == 0)
             return false;
@@ -34,7 +34,7 @@ class URLUtil
             _key += "=";
 
         url += _key;
-        url += val;
+        url += isEncode ? encode(val) : val;
         hasParam = true;
         return true;
     }
@@ -143,7 +143,7 @@ class URLUtil
     String downloadURL(const String &bucketId, const String &object)
     {
         String url;
-        sut.printTo(url, 500, "https://firebasestorage.googleapis.com/v0/b/%s/o/%s?alt=media&token=a82781ce-a115-442f-bac6-a52f7f63b3e8", bucketId.c_str(), object.c_str());
+        sut.printTo(url, 500, "https://firebasestorage.googleapis.com/v0/b/%s/o/%s?alt=media&token=a82781ce-a115-442f-bac6-a52f7f63b3e8", encode(bucketId).c_str(), encode(object).c_str());
         return url.c_str();
     }
 
diff --git a/src/firestore/FirestoreBase.h b/src/firestore/FirestoreBase.h
@@ -183,7 +183,7 @@ class FirestoreBase : public AppBase
         options.payload = document.c_str();
         sut.printTo(options.extras, options.collectionId.length(), "/documents/%s", options.collectionId.c_str());
         bool hasQueryParams = false;
-        uut.addParam(options.extras, "documentId", options.documentId, hasQueryParams);
+        uut.addParam(options.extras, "documentId", options.documentId, hasQueryParams, true);
         options.extras += mask.getQuery("mask", hasQueryParams);
         req_data aReq(&aClient, reqns::http_post, slot_options_t(false, false, async, false, false, false), &options, result, cb, uid);
         asyncRequest(aReq);

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "FirebaseClient",`
`3`		`- "version": "2.1.8",`
	`3`	`+ "version": "2.1.9",`
`4`	`4`	`"keywords": "communication, REST, esp32, esp8266, arduino",`
`5`	`5`	`"description": "Async Firebase Client library for Arduino.",`
`6`	`6`	`"repository": {`