feat(auth): enable emulator support on desktop (#1423)

cynthiajoan · Cynthia Jiang · web-flow · commit 669b0fbf4e0e · 2023-08-10T15:28:50.000-07:00
* add auth emulator support

* fix ios number parse

* update the documentation part

* reduce lint warning

* more lint warnings

* code format

* use environment to decide using emulator or not

* fix a typo

* add readme entry for FirebaseApp.GetApps()

* update for review comment

* add missing `

* make json request always do restrict json

* add readme info

* prepare for review

* some minor tweak

* code format

* update review comments

* update the unit test after request json change

---------

Co-authored-by: Cynthia Jiang &lt;cynthiajiang@google.com&gt;
diff --git a/app/rest/request_json.h b/app/rest/request_json.h
@@ -41,6 +41,7 @@ class RequestJson : public Request {
   explicit RequestJson(const char* schema) : application_data_(new FbsTypeT()) {
     flatbuffers::IDLOptions fbs_options;
     fbs_options.skip_unexpected_fields_in_json = true;
+    fbs_options.strict_json = true;
     parser_.reset(new flatbuffers::Parser(fbs_options));
 
     bool parse_status = parser_->Parse(schema);
diff --git a/app/rest/tests/request_json_test.cc b/app/rest/tests/request_json_test.cc
@@ -64,8 +64,8 @@ TEST(RequestJsonTest, UpdatePostFields) {
   request.set_token("abc");
   EXPECT_EQ(
       "{\n"
-      "  token: \"abc\",\n"
-      "  number: 123\n"
+      "  \"token\": \"abc\",\n"
+      "  \"number\": 123\n"
       "}\n",
       request.options().post_fields);
 }
diff --git a/auth/src/android/auth_android.cc b/auth/src/android/auth_android.cc
@@ -195,10 +195,12 @@ void CheckEmulator(AuthData* auth_data) {
 
   // Use emulator as long as this env variable is set, regardless its value.
   if (std::getenv("USE_AUTH_EMULATOR") == nullptr) {
-    LogDebug("Using Auth Prod for testing.");
+    LogInfo("Using Auth Prod for testing.");
     return;
   }
 
+  LogInfo("Using Auth Emulator for testing.");
+
   // Use AUTH_EMULATOR_PORT if it is set to non empty string,
   // otherwise use the default port.
   uint32_t port = std::stoi(kEmulatorPort);
diff --git a/auth/src/desktop/rpcs/auth_request.cc b/auth/src/desktop/rpcs/auth_request.cc
@@ -88,22 +88,23 @@ std::string AuthRequest::GetUrl() {
   } else {
     std::string url(kHttp);
     url += emulator_url;
+    url += "/";
     url += kServerURL;
     return url;
   }
 }
 
 void AuthRequest::CheckEmulator() {
   if (!emulator_url.empty()) {
-    LogDebug("Emulator Url already set: %s", emulator_url.c_str());
+    LogInfo("Emulator Url already set: %s", emulator_url.c_str());
     return;
   }
   // Use emulator as long as this env variable is set, regardless its value.
   if (std::getenv("USE_AUTH_EMULATOR") == nullptr) {
-    LogDebug("Using Auth Prod for testing.");
+    LogInfo("Using Auth Prod for testing.");
     return;
   }
-
+  LogInfo("Using Auth Emulator.");
   emulator_url.append(kEmulatorLocalHost);
   emulator_url.append(":");
   // Use AUTH_EMULATOR_PORT if it is set to non empty string,
diff --git a/auth/src/ios/auth_ios.mm b/auth/src/ios/auth_ios.mm
@@ -160,10 +160,10 @@ void UpdateCurrentUser(AuthData *auth_data) {
 void CheckEmulator(AuthData *auth_data) {
   // Use emulator as long as this env variable is set, regardless its value.
   if (std::getenv("USE_AUTH_EMULATOR") == nullptr) {
-    LogDebug("Using Auth Prod for testing.");
+    LogInfo("Using Auth Prod for testing.");
     return;
   }
-
+  LogInfo("Using Auth Emulator.");
   // Use AUTH_EMULATOR_PORT if it is set to non empty string,
   // otherwise use the default port.
   uint32_t port = std::stoi(kEmulatorPort);
diff --git a/auth/tests/desktop/rpcs/create_auth_uri_test.cc b/auth/tests/desktop/rpcs/create_auth_uri_test.cc
@@ -36,8 +36,8 @@ TEST(CreateAuthUriTest, TestCreateAuthUriRequest) {
       request.options().url);
   EXPECT_EQ(
       "{\n"
-      "  identifier: \"email\",\n"
-      "  continueUri: \"http://localhost\"\n"
+      "  \"identifier\": \"email\",\n"
+      "  \"continueUri\": \"http://localhost\"\n"
       "}\n",
       request.options().post_fields);
 }
diff --git a/auth/tests/desktop/rpcs/delete_account_test.cc b/auth/tests/desktop/rpcs/delete_account_test.cc
@@ -37,7 +37,7 @@ TEST(DeleteAccountTest, TestDeleteAccountRequest) {
       request.options().url);
   EXPECT_EQ(
       "{\n"
-      "  idToken: \"token\"\n"
+      "  \"idToken\": \"token\"\n"
       "}\n",
       request.options().post_fields);
 }
diff --git a/auth/tests/desktop/rpcs/get_account_info_test.cc b/auth/tests/desktop/rpcs/get_account_info_test.cc
@@ -36,7 +36,7 @@ TEST(GetAccountInfoTest, TestGetAccountInfoRequest) {
       request.options().url);
   EXPECT_EQ(
       "{\n"
-      "  idToken: \"token\"\n"
+      "  \"idToken\": \"token\"\n"
       "}\n",
       request.options().post_fields);
 }
diff --git a/auth/tests/desktop/rpcs/get_oob_confirmation_code_test.cc b/auth/tests/desktop/rpcs/get_oob_confirmation_code_test.cc
@@ -40,8 +40,8 @@ TEST(GetOobConfirmationCodeTest, SendVerifyEmailRequest) {
       request->options().url);
   EXPECT_EQ(
       "{\n"
-      "  idToken: \"token\",\n"
-      "  requestType: \"VERIFY_EMAIL\"\n"
+      "  \"idToken\": \"token\",\n"
+      "  \"requestType\": \"VERIFY_EMAIL\"\n"
       "}\n",
       request->options().post_fields);
 }
@@ -56,8 +56,8 @@ TEST(GetOobConfirmationCodeTest, SendPasswordResetEmailRequest) {
       request->options().url);
   EXPECT_EQ(
       "{\n"
-      "  email: \"email\",\n"
-      "  requestType: \"PASSWORD_RESET\"\n"
+      "  \"email\": \"email\",\n"
+      "  \"requestType\": \"PASSWORD_RESET\"\n"
       "}\n",
       request->options().post_fields);
 }
diff --git a/auth/tests/desktop/rpcs/reset_password_test.cc b/auth/tests/desktop/rpcs/reset_password_test.cc
@@ -35,8 +35,8 @@ TEST(ResetPasswordTest, TestResetPasswordRequest) {
       request.options().url);
   EXPECT_EQ(
       "{\n"
-      "  oobCode: \"oob\",\n"
-      "  newPassword: \"password\"\n"
+      "  \"oobCode\": \"oob\",\n"
+      "  \"newPassword\": \"password\"\n"
       "}\n",
       request.options().post_fields);
 }
diff --git a/auth/tests/desktop/rpcs/secure_token_test.cc b/auth/tests/desktop/rpcs/secure_token_test.cc
@@ -34,8 +34,8 @@ TEST(SecureTokenTest, TestSetRefreshRequest) {
             request.options().url);
   EXPECT_EQ(
       "{\n"
-      "  grantType: \"refresh_token\",\n"
-      "  refreshToken: \"token123\"\n"
+      "  \"grantType\": \"refresh_token\",\n"
+      "  \"refreshToken\": \"token123\"\n"
       "}\n",
       request.options().post_fields);
 }
diff --git a/auth/tests/desktop/rpcs/set_account_info_test.cc b/auth/tests/desktop/rpcs/set_account_info_test.cc
@@ -41,9 +41,9 @@ TEST(SetAccountInfoTest, TestSetAccountInfoRequest_UpdateEmail) {
       request->options().url);
   EXPECT_EQ(
       "{\n"
-      "  email: \"fakeemail\",\n"
-      "  returnSecureToken: true,\n"
-      "  idToken: \"token\"\n"
+      "  \"email\": \"fakeemail\",\n"
+      "  \"returnSecureToken\": true,\n"
+      "  \"idToken\": \"token\"\n"
       "}\n",
       request->options().post_fields);
 }
@@ -60,9 +60,9 @@ TEST(SetAccountInfoTest, TestSetAccountInfoRequest_UpdatePassword) {
       request->options().url);
   EXPECT_EQ(
       "{\n"
-      "  password: \"fakepassword\",\n"
-      "  returnSecureToken: true,\n"
-      "  idToken: \"token\"\n"
+      "  \"password\": \"fakepassword\",\n"
+      "  \"returnSecureToken\": true,\n"
+      "  \"idToken\": \"token\"\n"
       "}\n",
       request->options().post_fields);
 }
@@ -79,10 +79,10 @@ TEST(SetAccountInfoTest, TestSetAccountInfoRequest_UpdateProfile_Full) {
       request->options().url);
   EXPECT_EQ(
       "{\n"
-      "  displayName: \"New Name\",\n"
-      "  returnSecureToken: true,\n"
-      "  idToken: \"token\",\n"
-      "  photoUrl: \"new_url\"\n"
+      "  \"displayName\": \"New Name\",\n"
+      "  \"returnSecureToken\": true,\n"
+      "  \"idToken\": \"token\",\n"
+      "  \"photoUrl\": \"new_url\"\n"
       "}\n",
       request->options().post_fields);
 }
@@ -99,9 +99,9 @@ TEST(SetAccountInfoTest, TestSetAccountInfoRequest_UpdateProfile_Partial) {
       request->options().url);
   EXPECT_EQ(
       "{\n"
-      "  returnSecureToken: true,\n"
-      "  idToken: \"token\",\n"
-      "  photoUrl: \"new_url\"\n"
+      "  \"returnSecureToken\": true,\n"
+      "  \"idToken\": \"token\",\n"
+      "  \"photoUrl\": \"new_url\"\n"
       "}\n",
       request->options().post_fields);
 }
@@ -117,9 +117,9 @@ TEST(SetAccountInfoTest, TestSetAccountInfoRequest_UpdateProfile_DeleteFields) {
       request->options().url);
   EXPECT_EQ(
       "{\n"
-      "  returnSecureToken: true,\n"
-      "  idToken: \"token\",\n"
-      "  deleteAttribute: [\n"
+      "  \"returnSecureToken\": true,\n"
+      "  \"idToken\": \"token\",\n"
+      "  \"deleteAttribute\": [\n"
       "    \"DISPLAY_NAME\",\n"
       "    \"PHOTO_URL\"\n"
       "  ]\n"
@@ -140,10 +140,10 @@ TEST(SetAccountInfoTest,
       request->options().url);
   EXPECT_EQ(
       "{\n"
-      "  returnSecureToken: true,\n"
-      "  idToken: \"token\",\n"
-      "  photoUrl: \"new_url\",\n"
-      "  deleteAttribute: [\n"
+      "  \"returnSecureToken\": true,\n"
+      "  \"idToken\": \"token\",\n"
+      "  \"photoUrl\": \"new_url\",\n"
+      "  \"deleteAttribute\": [\n"
       "    \"DISPLAY_NAME\"\n"
       "  ]\n"
       "}\n",
@@ -162,9 +162,9 @@ TEST(SetAccountInfoTest, TestSetAccountInfoRequest_Unlink) {
       request->options().url);
   EXPECT_EQ(
       "{\n"
-      "  returnSecureToken: true,\n"
-      "  idToken: \"token\",\n"
-      "  deleteProvider: [\n"
+      "  \"returnSecureToken\": true,\n"
+      "  \"idToken\": \"token\",\n"
+      "  \"deleteProvider\": [\n"
       "    \"fakeprovider\"\n"
       "  ]\n"
       "}\n",
diff --git a/auth/tests/desktop/rpcs/sign_up_new_user_test.cc b/auth/tests/desktop/rpcs/sign_up_new_user_test.cc
@@ -35,7 +35,7 @@ TEST(SignUpNewUserTest, TestAnonymousSignInRequest) {
       request.options().url);
   EXPECT_EQ(
       "{\n"
-      "  returnSecureToken: true\n"
+      "  \"returnSecureToken\": true\n"
       "}\n",
       request.options().post_fields);
 }
@@ -50,10 +50,10 @@ TEST(SignUpNewUserTest, TestEmailPasswordSignInRequest) {
       request.options().url);
   EXPECT_EQ(
       "{\n"
-      "  email: \"e@mail\",\n"
-      "  password: \"pwd\",\n"
-      "  displayName: \"rabbit\",\n"
-      "  returnSecureToken: true\n"
+      "  \"email\": \"e@mail\",\n"
+      "  \"password\": \"pwd\",\n"
+      "  \"displayName\": \"rabbit\",\n"
+      "  \"returnSecureToken\": true\n"
       "}\n",
       request.options().post_fields);
 }
diff --git a/auth/tests/desktop/rpcs/verify_custom_token_test.cc b/auth/tests/desktop/rpcs/verify_custom_token_test.cc
@@ -36,8 +36,8 @@ TEST(VerifyCustomTokenTest, TestVerifyCustomTokenRequest) {
       request.options().url);
   EXPECT_EQ(
       "{\n"
-      "  returnSecureToken: true,\n"
-      "  token: \"token123\"\n"
+      "  \"returnSecureToken\": true,\n"
+      "  \"token\": \"token123\"\n"
       "}\n",
       request.options().post_fields);
 }
diff --git a/auth/tests/desktop/rpcs/verify_password_test.cc b/auth/tests/desktop/rpcs/verify_password_test.cc
@@ -35,9 +35,9 @@ TEST(VerifyPasswordTest, TestVerifyPasswordRequest) {
       request.options().url);
   EXPECT_EQ(
       "{\n"
-      "  email: \"abc@email\",\n"
-      "  password: \"pwd\",\n"
-      "  returnSecureToken: true\n"
+      "  \"email\": \"abc@email\",\n"
+      "  \"password\": \"pwd\",\n"
+      "  \"returnSecureToken\": true\n"
       "}\n",
       request.options().post_fields);
 }
diff --git a/release_build_files/readme.md b/release_build_files/readme.md
@@ -627,6 +627,12 @@ workflow use only during the development of your app, not for publicly shipping
 code.
 
 ## Release Notes
+### Next Release
+-   Changes
+    - Auth: Add Firebase Auth Emulator support. Set the environment variable
+      USE_AUTH_EMULATOR=yes (and optionally AUTH_EMULATOR_PORT, default 9099) 
+      to connect to the local Firebase Auth Emulator.
+
 ### 11.4.0
 -   Changes
     - General (Android): Update to Firebase Android BoM version 32.2.2.

Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@ TEST(DeleteAccountTest, TestDeleteAccountRequest) {`
`37`	`37`	`request.options().url);`
`38`	`38`	`EXPECT_EQ(`
`39`	`39`	`"{\n"`
`40`		`- " idToken: \"token\"\n"`
	`40`	`+ " \"idToken\": \"token\"\n"`
`41`	`41`	`"}\n",`
`42`	`42`	`request.options().post_fields);`
`43`	`43`	`}`
Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@ TEST(GetAccountInfoTest, TestGetAccountInfoRequest) {`
`36`	`36`	`request.options().url);`
`37`	`37`	`EXPECT_EQ(`
`38`	`38`	`"{\n"`
`39`		`- " idToken: \"token\"\n"`
	`39`	`+ " \"idToken\": \"token\"\n"`
`40`	`40`	`"}\n",`
`41`	`41`	`request.options().post_fields);`
`42`	`42`	`}`