Fix: Correct include path for list_result.h in StorageReferenceInternal

This commit corrects the #include path for the public
`firebase/storage/list_result.h` header within the desktop platform's
`StorageReferenceInternal` implementation
(`storage/src/desktop/storage_reference_desktop.cc`). I changed the path from a relative "firebase/storage/list_result.h" to a more
explicit "storage/src/include/firebase/storage/list_result.h" to
resolve a potential build issue.

Include paths for Android and iOS platforms were reviewed and found
to be correctly handling the inclusion of `firebase/storage/list_result.h`
via their respective `StorageReferenceInternal` header files using
standard include paths.

Additionally, I removed a minor extraneous agent-added comment
from `storage/src/ios/storage_reference_ios.h`.

I ran the code formatting script after these changes.

Author: google-labs-jules[bot]

storage/integration_test/src/integration_test.cc

@@ -1624,11 +1624,12 @@ TEST_F(FirebaseStorageTest, TestInvalidatingReferencesWhenDeletingApp) {
 }
 
 // Test the StorageReference::ListAll() method.
-// This test currently only verifies that the stubbed method returns an empty result.
+// This test currently only verifies that the stubbed method returns an empty
+// result.
 TEST_F(FirebaseStorageTest, TestListAll) {
   if (skip_tests_) return;
 
-  firebase::storage::Storage* storage = storage_; // Use the member variable
+  firebase::storage::Storage* storage = storage_;  // Use the member variable
   firebase::storage::StorageReference reference = storage->GetReference();
 
   firebase::Future<firebase::storage::ListResult> future = reference.ListAll();
@@ -1647,11 +1648,12 @@ TEST_F(FirebaseStorageTest, TestListAll) {
 }
 
 // Test the StorageReference::List() method with no page token.
-// This test currently only verifies that the stubbed method returns an empty result.
+// This test currently only verifies that the stubbed method returns an empty
+// result.
 TEST_F(FirebaseStorageTest, TestListNoPageToken) {
   if (skip_tests_) return;
 
-  firebase::storage::Storage* storage = storage_; // Use the member variable
+  firebase::storage::Storage* storage = storage_;  // Use the member variable
   firebase::storage::StorageReference reference = storage->GetReference();
 
   firebase::Future<firebase::storage::ListResult> future = reference.List();
@@ -1670,16 +1672,17 @@ TEST_F(FirebaseStorageTest, TestListNoPageToken) {
 }
 
 // Test the StorageReference::List() method with a page token.
-// This test currently only verifies that the stubbed method returns an empty result
-// and that the page token is passed (though not used by the stub).
+// This test currently only verifies that the stubbed method returns an empty
+// result and that the page token is passed (though not used by the stub).
 TEST_F(FirebaseStorageTest, TestListWithPageToken) {
   if (skip_tests_) return;
 
-  firebase::storage::Storage* storage = storage_; // Use the member variable
+  firebase::storage::Storage* storage = storage_;  // Use the member variable
   firebase::storage::StorageReference reference = storage->GetReference();
   const char* page_token = "test_page_token";
 
-  firebase::Future<firebase::storage::ListResult> future = reference.List(page_token);
+  firebase::Future<firebase::storage::ListResult> future =
+      reference.List(page_token);
   WaitForCompletion(future, "List (with page token)");
 
   ASSERT_EQ(future.status(), firebase::kFutureStatusComplete);

storage/src/android/list_result_android.h

@@ -6,8 +6,8 @@
 #include <vector>
 
 #include "firebase/storage/storage_reference.h"
-#include "storage/src/android/storage_reference_android.h"
 #include "storage/src/android/storage_internal_android.h"
+#include "storage/src/android/storage_reference_android.h"
 
 namespace firebase {
 namespace storage {

storage/src/android/storage_reference_android.cc

@@ -23,7 +23,7 @@
 #include "app/src/include/firebase/app.h"
 #include "app/src/util_android.h"
 #include "storage/src/android/controller_android.h"
-#include "storage/src/android/list_result_android.h" // Defines the android internal::ListResultInternal
+#include "storage/src/android/list_result_android.h"  // Defines the android internal::ListResultInternal
 #include "storage/src/android/metadata_android.h"
 #include "storage/src/android/storage_android.h"
 #include "storage/src/include/firebase/storage.h"
@@ -736,13 +736,13 @@ jint StorageReferenceInternal::CppByteUploaderReadBytes(
 }
 
 Future<ListResult> StorageReferenceInternal::ListAll() {
-  StorageReference self(this); // Public self for future context
+  StorageReference self(this);  // Public self for future context
   ReferenceCountedFutureImpl* ref_future =
       future()->Alloc<ListResult>(kStorageReferenceFnCount);
   Future<ListResult> future = MakeFuture(ref_future, self);
 
-  internal::ListResultInternal* list_pimpl =
-      new internal::ListResultInternal(this, nullptr); // 'this' is StorageReferenceInternal* (Android)
+  internal::ListResultInternal* list_pimpl = new internal::ListResultInternal(
+      this, nullptr);  // 'this' is StorageReferenceInternal* (Android)
 
   ListResult result_to_complete(list_pimpl);
 
@@ -751,7 +751,7 @@ Future<ListResult> StorageReferenceInternal::ListAll() {
 }
 
 Future<ListResult> StorageReferenceInternal::List(const char* page_token) {
-  StorageReference self(this); // Public self for future context
+  StorageReference self(this);  // Public self for future context
   ReferenceCountedFutureImpl* ref_future =
       future()->Alloc<ListResult>(kStorageReferenceFnCount);
   Future<ListResult> future = MakeFuture(ref_future, self);

storage/src/android/storage_reference_android.h

@@ -22,9 +22,9 @@
 #include "app/src/include/firebase/internal/common.h"
 #include "app/src/reference_counted_future_impl.h"
 #include "app/src/util_android.h"
+#include "firebase/storage/list_result.h"
 #include "storage/src/android/storage_android.h"
 #include "storage/src/include/firebase/storage/storage_reference.h"
-#include "firebase/storage/list_result.h"
 
 namespace firebase {
 namespace storage {

storage/src/common/list_result.cc

@@ -1,25 +1,25 @@
 // File: storage/src/common/list_result.cc
 
 #include "firebase/storage/list_result.h"
-#include "app/src/include/firebase/internal/platform.h"
+
 #include "app/src/cleanup_notifier.h"
+#include "app/src/include/firebase/internal/platform.h"
 #include "app/src/log.h"
 #include "firebase/storage/storage_reference.h"
 
-// Platform-specific headers that define internal::ListResultInternal (the PIMPL class)
-// and internal::StorageInternal (for CleanupNotifier context).
+// Platform-specific headers that define internal::ListResultInternal (the PIMPL
+// class) and internal::StorageInternal (for CleanupNotifier context).
 #if FIREBASE_PLATFORM_ANDROID
 #include "storage/src/android/list_result_android.h"
 #include "storage/src/android/storage_internal_android.h"
 #elif FIREBASE_PLATFORM_IOS || FIREBASE_PLATFORM_TVOS
 #include "storage/src/ios/list_result_ios.h"
 #include "storage/src/ios/storage_internal_ios.h"
-#else // Desktop
+#else  // Desktop
 #include "storage/src/desktop/list_result_desktop.h"
 #include "storage/src/desktop/storage_internal_desktop.h"
 #endif
 
-
 namespace firebase {
 namespace storage {
 
@@ -43,7 +43,10 @@ class ListResultInternalCommon {
     // Relies on ListResultInternal having associated_storage_internal().
     StorageInternal* storage_ctx = pimpl_obj->associated_storage_internal();
     if (storage_ctx == nullptr) {
-        LogWarning("ListResultInternal %p has no associated StorageInternal for cleanup.", pimpl_obj);
+      LogWarning(
+          "ListResultInternal %p has no associated StorageInternal for "
+          "cleanup.",
+          pimpl_obj);
     }
     return storage_ctx;
   }
@@ -52,10 +55,12 @@ class ListResultInternalCommon {
   static void CleanupPublicListResultObject(void* public_obj_void) {
     ListResult* public_obj = reinterpret_cast<ListResult*>(public_obj_void);
     if (public_obj) {
-        LogDebug("CleanupNotifier: Cleaning up ListResult %p.", public_obj);
-        DeleteInternal(public_obj);
+      LogDebug("CleanupNotifier: Cleaning up ListResult %p.", public_obj);
+      DeleteInternal(public_obj);
     } else {
-        LogWarning("CleanupNotifier: CleanupPublicListResultObject called with null object.");
+      LogWarning(
+          "CleanupNotifier: CleanupPublicListResultObject called with null "
+          "object.");
     }
   }
 
@@ -65,12 +70,15 @@ class ListResultInternalCommon {
     if (!pimpl_obj) return;
     StorageInternal* storage_ctx = GetStorageInternalContext(pimpl_obj);
     if (storage_ctx) {
-      storage_ctx->cleanup().RegisterObject(public_obj, CleanupPublicListResultObject);
-      LogDebug("ListResult %p (PIMPL %p) registered for cleanup.",
-               public_obj, pimpl_obj);
+      storage_ctx->cleanup().RegisterObject(public_obj,
+                                            CleanupPublicListResultObject);
+      LogDebug("ListResult %p (PIMPL %p) registered for cleanup.", public_obj,
+               pimpl_obj);
     } else {
-      LogWarning("Could not register ListResult %p for cleanup: no StorageInternal context.",
-                 public_obj);
+      LogWarning(
+          "Could not register ListResult %p for cleanup: no StorageInternal "
+          "context.",
+          public_obj);
     }
   }
 
@@ -81,14 +89,18 @@ class ListResultInternalCommon {
     StorageInternal* storage_ctx = GetStorageInternalContext(pimpl_obj);
     if (storage_ctx) {
       storage_ctx->cleanup().UnregisterObject(public_obj);
-      LogDebug("ListResult %p (associated with PIMPL %p) unregistered from cleanup.",
-               public_obj, pimpl_obj);
+      LogDebug(
+          "ListResult %p (associated with PIMPL %p) unregistered from cleanup.",
+          public_obj, pimpl_obj);
     } else {
-        LogWarning("Could not unregister ListResult %p: no StorageInternal context.", public_obj);
+      LogWarning(
+          "Could not unregister ListResult %p: no StorageInternal context.",
+          public_obj);
     }
   }
 
-  // Deletes the PIMPL object, unregisters from cleanup, and nulls the pointer in public_obj.
+  // Deletes the PIMPL object, unregisters from cleanup, and nulls the pointer
+  // in public_obj.
   static void DeleteInternal(ListResult* public_obj) {
     FIREBASE_ASSERT(public_obj != nullptr);
     if (!public_obj->internal_) return;
@@ -108,8 +120,7 @@ const std::vector<StorageReference> ListResult::s_empty_items_;
 const std::vector<StorageReference> ListResult::s_empty_prefixes_;
 const std::string ListResult::s_empty_page_token_;
 
-ListResult::ListResult() : internal_(nullptr) {
-}
+ListResult::ListResult() : internal_(nullptr) {}
 
 ListResult::ListResult(internal::ListResultInternal* internal_pimpl)
     : internal_(internal_pimpl) {
@@ -135,7 +146,7 @@ ListResult& ListResult::operator=(const ListResult& other) {
   if (this == &other) {
     return *this;
   }
-  internal::ListResultInternalCommon::DeleteInternal(this); // Clean up current
+  internal::ListResultInternalCommon::DeleteInternal(this);  // Clean up current
 
   if (other.internal_) {
     internal::StorageReferenceInternal* sri_context =
@@ -150,8 +161,10 @@ ListResult& ListResult::operator=(const ListResult& other) {
 ListResult::ListResult(ListResult&& other) : internal_(other.internal_) {
   other.internal_ = nullptr;
   if (internal_) {
-    // New public object 'this' takes ownership. Unregister 'other', register 'this'.
-    internal::ListResultInternalCommon::UnregisterFromCleanup(&other, internal_);
+    // New public object 'this' takes ownership. Unregister 'other', register
+    // 'this'.
+    internal::ListResultInternalCommon::UnregisterFromCleanup(&other,
+                                                              internal_);
     internal::ListResultInternalCommon::RegisterForCleanup(this, internal_);
   }
 }
@@ -160,14 +173,15 @@ ListResult& ListResult::operator=(ListResult&& other) {
   if (this == &other) {
     return *this;
   }
-  internal::ListResultInternalCommon::DeleteInternal(this); // Clean up current
+  internal::ListResultInternalCommon::DeleteInternal(this);  // Clean up current
 
   internal_ = other.internal_;
   other.internal_ = nullptr;
 
   if (internal_) {
     // Similar to move constructor: unregister 'other', register 'this'.
-    internal::ListResultInternalCommon::UnregisterFromCleanup(&other, internal_);
+    internal::ListResultInternalCommon::UnregisterFromCleanup(&other,
+                                                              internal_);
     internal::ListResultInternalCommon::RegisterForCleanup(this, internal_);
   }
   return *this;

storage/src/common/storage_reference.cc

@@ -14,10 +14,10 @@
 
 #include "storage/src/include/firebase/storage/storage_reference.h"
 
-#include "firebase/storage/list_result.h"
 #include "app/src/assert.h"
 #include "app/src/future_manager.h"
 #include "app/src/include/firebase/internal/platform.h"
+#include "firebase/storage/list_result.h"
 
 // Platform-specific ListResultInternal definition is no longer needed here.
 // #if FIREBASE_PLATFORM_ANDROID

storage/src/desktop/list_result_desktop.cc

@@ -15,14 +15,16 @@ ListResultInternal::ListResultInternal(
     prefixes_ = other_to_copy_from->prefixes_;
     page_token_ = other_to_copy_from->page_token_;
   }
-  // If other_to_copy_from is null, members are default-initialized (empty for stub).
+  // If other_to_copy_from is null, members are default-initialized (empty for
+  // stub).
 }
 
 // Destructor is default. Members are cleaned up automatically.
 // Lifecycle of this PIMPL object is managed by the public ListResult class
 // via ListResultInternalCommon static helpers.
 
-// Accessor methods (items(), prefixes(), page_token()) are inline in the header.
+// Accessor methods (items(), prefixes(), page_token()) are inline in the
+// header.
 
 }  // namespace internal
 }  // namespace storage

storage/src/desktop/list_result_desktop.h

@@ -6,39 +6,44 @@
 #include <vector>
 
 #include "firebase/storage/storage_reference.h"
-#include "storage/src/desktop/storage_reference_desktop.h"
 #include "storage/src/desktop/storage_internal_desktop.h"
+#include "storage/src/desktop/storage_reference_desktop.h"
 
 namespace firebase {
 namespace storage {
 namespace internal {
 
 /// Desktop platform's internal implementation for ListResult.
-/// This class holds the data for a list operation specific to the desktop platform.
-/// Its lifecycle is managed by the public ListResult class via static helpers.
+/// This class holds the data for a list operation specific to the desktop
+/// platform. Its lifecycle is managed by the public ListResult class via static
+/// helpers.
 class ListResultInternal {
  public:
   /// Constructor.
-  /// @param[in] platform_sri The desktop StorageReferenceInternal this list result
+  /// @param[in] platform_sri The desktop StorageReferenceInternal this list
+  /// result
   ///                         is associated with; used for context.
   /// @param[in] other_to_copy_from If not null, initializes this instance by
   ///                               copying data from other_to_copy_from.
   explicit ListResultInternal(
       StorageReferenceInternal* platform_sri,
       const ListResultInternal* other_to_copy_from = nullptr);
 
-  // Destructor is default as members clean themselves up and lifecycle is external.
+  // Destructor is default as members clean themselves up and lifecycle is
+  // external.
 
   const std::vector<StorageReference>& items() const { return items_; }
   const std::vector<StorageReference>& prefixes() const { return prefixes_; }
   const std::string& page_token() const { return page_token_; }
 
-  /// Provides access to the StorageReferenceInternal this object is associated with.
+  /// Provides access to the StorageReferenceInternal this object is associated
+  /// with.
   StorageReferenceInternal* storage_reference_internal() const {
     return platform_sri_;
   }
 
-  /// Provides access to the StorageInternal context, typically for cleanup registration.
+  /// Provides access to the StorageInternal context, typically for cleanup
+  /// registration.
   StorageInternal* associated_storage_internal() const {
     return platform_sri_ ? platform_sri_->storage_internal() : nullptr;
   }
@@ -47,7 +52,8 @@ class ListResultInternal {
   // Disallow copy assignment; copy construction is handled via the constructor.
   ListResultInternal& operator=(const ListResultInternal&);
 
-  StorageReferenceInternal* platform_sri_; // Associated StorageReference, not owned.
+  StorageReferenceInternal*
+      platform_sri_;  // Associated StorageReference, not owned.
 
   // Data for list results (stubs are empty).
   std::vector<StorageReference> items_;

storage/src/desktop/storage_reference_desktop.cc

@@ -30,15 +30,17 @@
 #include "app/src/thread.h"
 #include "storage/src/common/common_internal.h"
 #include "storage/src/desktop/controller_desktop.h"
+#include "storage/src/desktop/list_result_desktop.h"  // Defines the desktop internal::ListResultInternal
 #include "storage/src/desktop/metadata_desktop.h"
 #include "storage/src/desktop/storage_desktop.h"
 #include "storage/src/include/firebase/storage.h"
 #include "storage/src/include/firebase/storage/common.h"
-#include "firebase/storage/list_result.h"
-#include "storage/src/desktop/list_result_desktop.h" // Defines the desktop internal::ListResultInternal
+#include "storage/src/include/firebase/storage/list_result.h"
 
-// Note: app/src/future_manager.h is indirectly included via storage_reference_desktop.h -> reference_counted_future_impl.h
-// Note: app/src/include/firebase/app.h is indirectly included via storage_reference_desktop.h
+// Note: app/src/future_manager.h is indirectly included via
+// storage_reference_desktop.h -> reference_counted_future_impl.h Note:
+// app/src/include/firebase/app.h is indirectly included via
+// storage_reference_desktop.h
 
 namespace firebase {
 namespace storage {
@@ -704,7 +706,7 @@ ReferenceCountedFutureImpl* StorageReferenceInternal::future() {
 }
 
 Future<ListResult> StorageReferenceInternal::ListAll() {
-  StorageReference self(this); // Create public object from internal 'this'
+  StorageReference self(this);  // Create public object from internal 'this'
   ReferenceCountedFutureImpl* ref_future =
       future()->Alloc<ListResult>(kStorageReferenceFnCount);
   Future<ListResult> future = MakeFuture(ref_future, self);
@@ -719,7 +721,7 @@ Future<ListResult> StorageReferenceInternal::ListAll() {
 }
 
 Future<ListResult> StorageReferenceInternal::List(const char* page_token) {
-  StorageReference self(this); // Create public object from internal 'this'
+  StorageReference self(this);  // Create public object from internal 'this'
   ReferenceCountedFutureImpl* ref_future =
       future()->Alloc<ListResult>(kStorageReferenceFnCount);
   Future<ListResult> future = MakeFuture(ref_future, self);