add api to get allApps (#1327)

* add api to get allApps

* add more test cases

* format code

* review comments

* format code

---------

Co-authored-by: Cynthia Jiang <[email protected]>

Author: cynthiajoan

.gitignore

@@ -10,6 +10,9 @@ __pycache__/
 **/build/
 **/.externalNativeBuild/
 
+### IDE generated files
+.vscode/
+
 # Unencrypted secret files
 google-services.json
 GoogleService-Info.plist

app/integration_test/src/integration_test.cc

@@ -23,6 +23,7 @@
 #include "app_framework.h"            // NOLINT
 #include "firebase_test_framework.h"  // NOLINT
 
+using ::testing::UnorderedElementsAre;
 // The TO_STRING macro is useful for command line defined strings as the quotes
 // get stripped.
 #define TO_STRING_EXPAND(X) #X
@@ -65,4 +66,34 @@ TEST_F(FirebaseAppTest, TestDefaultAppWithDefaultOptions) {
   default_app = nullptr;
 }
 
+TEST_F(FirebaseAppTest, TestGetAll) {
+  EXPECT_EQ(firebase::App::GetApps().size(), 0);
+
+  firebase::App* default_app = firebase::App::Create(APP_CREATE_PARAMS);
+  EXPECT_THAT(firebase::App::GetApps(), UnorderedElementsAre(default_app));
+
+  firebase::App* second_app =
+      firebase::App::Create(firebase::AppOptions(), "2ndApp");
+  EXPECT_THAT(firebase::App::GetApps(),
+              UnorderedElementsAre(default_app, second_app));
+
+  firebase::App* third_app =
+      firebase::App::Create(firebase::AppOptions(), "3rdApp");
+  EXPECT_THAT(firebase::App::GetApps(),
+              UnorderedElementsAre(default_app, second_app, third_app));
+
+  delete third_app;
+  third_app = nullptr;
+  EXPECT_THAT(firebase::App::GetApps(),
+              UnorderedElementsAre(default_app, second_app));
+
+  delete default_app;
+  default_app = nullptr;
+  EXPECT_THAT(firebase::App::GetApps(), UnorderedElementsAre(second_app));
+
+  delete second_app;
+  second_app = nullptr;
+  EXPECT_EQ(firebase::App::GetApps().size(), 0);
+}
+
 }  // namespace firebase_testapp_automated

app/src/app_android.cc

@@ -20,6 +20,7 @@
 #include <string.h>
 
 #include <string>
+#include <vector>
 
 #include "app/src/app_common.h"
 #include "app/src/assert.h"
@@ -509,6 +510,8 @@ App* App::GetInstance(const char* name) {
   return app_common::FindAppByName(name);
 }
 
+std::vector<App*> App::GetApps() { return app_common::GetAllApps(); }
+
 JNIEnv* App::GetJNIEnv() const { return util::GetThreadsafeJNIEnv(java_vm()); }
 
 static void RegisterLibraryWithVersionRegistrar(JNIEnv* env,

app/src/app_common.cc

@@ -338,6 +338,19 @@ App* GetAnyApp() {
   return nullptr;
 }
 
+std::vector<App*> GetAllApps() {
+  std::vector<App*> result;
+  App* const default_app = GetDefaultApp();
+  MutexLock lock(*g_app_mutex);
+  if (g_apps) {
+    for (auto it = g_apps->begin(); it != g_apps->end(); ++it) {
+      if (it->second->app != default_app) result.push_back(it->second->app);
+    }
+    if (default_app) result.push_back(default_app);
+  }
+  return result;
+}
+
 void RemoveApp(App* app) {
   assert(app);
   MutexLock lock(*g_app_mutex);

app/src/app_common.h

@@ -21,6 +21,7 @@
 
 #include <map>
 #include <string>
+#include <vector>
 
 #include "app/src/include/firebase/app.h"
 #include "app/src/logger.h"
@@ -60,6 +61,9 @@ App* GetDefaultApp();
 // will be returned.
 App* GetAnyApp();
 
+// Get all existing apps
+std::vector<App*> GetAllApps();
+
 // Remove an app from the set of apps.
 // Call this method before destroying an app.
 void RemoveApp(App* app);

app/src/app_desktop.cc

@@ -21,6 +21,7 @@
 #include <fstream>
 #include <memory>
 #include <string>
+#include <vector>
 
 #include "app/src/app_common.h"
 #include "app/src/function_registry.h"
@@ -167,6 +168,8 @@ App* App::GetInstance(const char* name) {  // NOLINT
   return app_common::FindAppByName(name);
 }
 
+std::vector<App*> App::GetApps() { return app_common::GetAllApps(); }
+
 #ifdef INTERNAL_EXPERIMENTAL
 internal::FunctionRegistry* App::function_registry() {
   return &internal_->function_registry;

app/src/app_ios.mm

@@ -281,6 +281,8 @@ static void PlatformOptionsToAppOptions(FIROptions* platform_options, AppOptions
 
 App* App::GetInstance(const char* name) { return app_common::FindAppByName(name); }
 
+std::vector<App*> App::GetApps() { return app_common::GetAllApps(); }
+
 void App::RegisterLibrary(const char* library, const char* version, void* /* platform_resource */) {
   [FIRApp registerLibrary:@(library) withVersion:@(version)];
   app_common::RegisterLibrariesFromUserAgent(

app/src/app_stub.cc

@@ -66,6 +66,8 @@ App* App::GetInstance(const char* name) {
   return app_common::FindAppByName(name);
 }
 
+std::vector<App*> App::GetApps() { return app_common::GetAllApps(); }
+
 #ifdef INTERNAL_EXPERIMENTAL
 internal::FunctionRegistry* App::function_registry() {
   return static_cast<internal::FunctionRegistry*>(data_);

app/src/include/firebase/app.h

@@ -26,6 +26,7 @@
 #include <map>
 #include <memory>
 #include <string>
+#include <vector>
 
 #if FIREBASE_PLATFORM_IOS || FIREBASE_PLATFORM_TVOS
 #ifdef __OBJC__
@@ -570,6 +571,11 @@ class App {
   /// Get the App with the given name, or nullptr if none have been created.
   static App* GetInstance(const char* name);
 
+#if !defined(DOXYGEN)
+  /// Get all the apps, including the default one.
+  static std::vector<App*> GetApps();
+#endif  //! defined(DOXYGEN), to hide the api from public documentation.
+
 #ifndef SWIG
 // <SWIG>
 // Unity doesn't need the JNI from here, it has its method to access JNI.

app/src/util_android.h

@@ -614,8 +614,7 @@ METHOD_LOOKUP_DECLARATION(double_class, DOUBLE_METHODS);
   X(Equals, "equals",               \
     "(Ljava/lang/Object;)Z"),       \
   X(Name, "name",                   \
-    "()Ljava/lang/String;")         \
-// clang-format on
+    "()Ljava/lang/String;")  // clang-format on
 METHOD_LOOKUP_DECLARATION(enum_class, ENUM_METHODS);
 
 // clang-format off