Functions and Storage deprecated Error variables (#9569)

paulb777 · web-flow · commit 111d8d6ad1a1 · 2022-04-06T08:56:09.000-04:00
* Functions and Storage deprecated Error variables

* Test build fixes

* one more test build issue

* Review

* style
diff --git a/FirebaseFunctions/CHANGELOG.md b/FirebaseFunctions/CHANGELOG.md
@@ -1,3 +1,7 @@
+# v8.15.0
+- [deprecated] The global variables `FIRFunctionsErrorDomain` and `FIRFunctionsErrorDetailsKey` are
+  deprecated and will be removed in v9.0.0. (#9569)
+
 # v8.9.0
 - [fixed] Add watchOS support for Swift Package Manager (#8864).
 
diff --git a/FirebaseFunctions/Sources/FIRFunctions+Internal.h b/FirebaseFunctions/Sources/FIRFunctions+Internal.h
@@ -66,4 +66,10 @@ NS_ASSUME_NONNULL_BEGIN
 
 @end
 
+// The error domain for codes in the FIRFunctionsErrorCode enum.
+FOUNDATION_EXPORT NSString *const FIRFunctionsErrorDomainInternal;
+
+// The key for finding error details in the NSError userInfo.
+FOUNDATION_EXPORT NSString *const FIRFunctionsErrorDetailsKeyInternal;
+
 NS_ASSUME_NONNULL_END
diff --git a/FirebaseFunctions/Sources/FIRFunctions.m b/FirebaseFunctions/Sources/FIRFunctions.m
@@ -296,7 +296,7 @@ - (void)callFunction:(NSString *)name
     }
     if (![responseJSON isKindOfClass:[NSDictionary class]]) {
       NSDictionary *userInfo = @{NSLocalizedDescriptionKey : @"Response was not a dictionary."};
-      error = [NSError errorWithDomain:FIRFunctionsErrorDomain
+      error = [NSError errorWithDomain:FIRFunctionsErrorDomainInternal
                                   code:FIRFunctionsErrorCodeInternal
                               userInfo:userInfo];
       if (completion) {
@@ -311,7 +311,7 @@ - (void)callFunction:(NSString *)name
     }
     if (!dataJSON) {
       NSDictionary *userInfo = @{NSLocalizedDescriptionKey : @"Response is missing data field."};
-      error = [NSError errorWithDomain:FIRFunctionsErrorDomain
+      error = [NSError errorWithDomain:FIRFunctionsErrorDomainInternal
                                   code:FIRFunctionsErrorCodeInternal
                               userInfo:userInfo];
       if (completion) {
diff --git a/FirebaseFunctions/Sources/FUNError.m b/FirebaseFunctions/Sources/FUNError.m
@@ -20,7 +20,9 @@
 NS_ASSUME_NONNULL_BEGIN
 
 NSString *const FIRFunctionsErrorDomain = @"com.firebase.functions";
+NSString *const FIRFunctionsErrorDomainInternal = @"com.firebase.functions";
 NSString *const FIRFunctionsErrorDetailsKey = @"details";
+NSString *const FIRFunctionsErrorDetailsKeyInternal = @"details";
 
 /**
  * Takes an HTTP status code and returns the corresponding FIRFunctionsErrorCode error code.
@@ -138,7 +140,7 @@ FIRFunctionsErrorCode FIRFunctionsErrorCodeForHTTPStatus(NSInteger status) {
 
 NSError *_Nullable FUNErrorForCode(FIRFunctionsErrorCode code) {
   NSDictionary *userInfo = @{NSLocalizedDescriptionKey : FUNDescriptionForErrorCode(code)};
-  return [NSError errorWithDomain:FIRFunctionsErrorDomain code:code userInfo:userInfo];
+  return [NSError errorWithDomain:FIRFunctionsErrorDomainInternal code:code userInfo:userInfo];
 }
 
 NSError *_Nullable FUNErrorForResponse(NSInteger status,
@@ -188,9 +190,9 @@ FIRFunctionsErrorCode FIRFunctionsErrorCodeForHTTPStatus(NSInteger status) {
   NSMutableDictionary *userInfo = [NSMutableDictionary dictionary];
   userInfo[NSLocalizedDescriptionKey] = description;
   if (details) {
-    userInfo[FIRFunctionsErrorDetailsKey] = details;
+    userInfo[FIRFunctionsErrorDetailsKeyInternal] = details;
   }
-  return [NSError errorWithDomain:FIRFunctionsErrorDomain code:code userInfo:userInfo];
+  return [NSError errorWithDomain:FIRFunctionsErrorDomainInternal code:code userInfo:userInfo];
 }
 
 NS_ASSUME_NONNULL_END
diff --git a/FirebaseFunctions/Sources/FUNSerializer.m b/FirebaseFunctions/Sources/FUNSerializer.m
@@ -14,6 +14,7 @@
 
 #import "FirebaseFunctions/Sources/FUNSerializer.h"
 
+#import "FirebaseFunctions/Sources/FIRFunctions+Internal.h"
 #import "FirebaseFunctions/Sources/FUNUsageValidation.h"
 #import "FirebaseFunctions/Sources/Public/FirebaseFunctions/FIRError.h"
 
@@ -137,7 +138,7 @@ - (id)encode:(id)object {
   NSDictionary *userInfo = @{
     NSLocalizedDescriptionKey : description,
   };
-  return [NSError errorWithDomain:FIRFunctionsErrorDomain
+  return [NSError errorWithDomain:FIRFunctionsErrorDomainInternal
                              code:FIRFunctionsErrorCodeInternal
                          userInfo:userInfo];
 }
diff --git a/FirebaseFunctions/Sources/Public/FirebaseFunctions/FIRError.h b/FirebaseFunctions/Sources/Public/FirebaseFunctions/FIRError.h
@@ -17,13 +17,17 @@
 NS_ASSUME_NONNULL_BEGIN
 
 // The error domain for codes in the FIRFunctionsErrorCode enum.
-FOUNDATION_EXPORT NSString *const FIRFunctionsErrorDomain NS_SWIFT_NAME(FunctionsErrorDomain);
+FOUNDATION_EXPORT NSString *const FIRFunctionsErrorDomain NS_SWIFT_NAME(FunctionsErrorDomain)
+    DEPRECATED_MSG_ATTRIBUTE("The variable will be unavailable in a future release,"
+                             " but the string will not change.");
 
 // The key for finding error details in the NSError userInfo.
 // clang-format off
-// clang-format12 merges the next two lines.
+// clang-format14 merges the next two lines.
 FOUNDATION_EXPORT NSString *const FIRFunctionsErrorDetailsKey
-    NS_SWIFT_NAME(FunctionsErrorDetailsKey);
+    NS_SWIFT_NAME(FunctionsErrorDetailsKey)
+    DEPRECATED_MSG_ATTRIBUTE("The variable will be unavailable from Objective C in a future release,"
+                             " but the string will not change.");
 // clang-format on
 
 /**
diff --git a/FirebaseFunctions/Tests/Integration/FIRIntegrationTests.m b/FirebaseFunctions/Tests/Integration/FIRIntegrationTests.m
@@ -208,7 +208,7 @@ - (void)testExplicitError {
             XCTAssertEqual(FIRFunctionsErrorCodeOutOfRange, error.code);
             XCTAssertEqualObjects(@"explicit nope", error.userInfo[NSLocalizedDescriptionKey]);
             NSDictionary *expectedDetails = @{@"start" : @10, @"end" : @20, @"long" : @30L};
-            XCTAssertEqualObjects(expectedDetails, error.userInfo[FIRFunctionsErrorDetailsKey]);
+            XCTAssertEqualObjects(expectedDetails, error.userInfo[@"details"]);
             [expectation fulfill];
           }];
   [self waitForExpectations:@[ expectation ] timeout:10];
@@ -235,7 +235,7 @@ - (void)testTimeout {
         XCTAssertNotNil(error);
         XCTAssertEqual(FIRFunctionsErrorCodeDeadlineExceeded, error.code);
         XCTAssertEqualObjects(@"DEADLINE EXCEEDED", error.userInfo[NSLocalizedDescriptionKey]);
-        XCTAssertNil(error.userInfo[FIRFunctionsErrorDetailsKey]);
+        XCTAssertNil(error.userInfo[@"details"]);
         [expectation fulfill];
       }];
   [self waitForExpectations:@[ expectation ] timeout:10];
diff --git a/FirebaseFunctions/Tests/SwiftIntegration/IntegrationTests.swift b/FirebaseFunctions/Tests/SwiftIntegration/IntegrationTests.swift
@@ -377,7 +377,7 @@ class IntegrationTests: XCTestCase {
         XCTAssertEqual(FunctionsErrorCode.outOfRange.rawValue, error.code)
         XCTAssertEqual("explicit nope", error.localizedDescription)
         XCTAssertEqual(["start": 10 as Int32, "end": 20 as Int32, "long": 30],
-                       error.userInfo[FunctionsErrorDetailsKey] as! [String: Int32])
+                       error.userInfo["details"] as! [String: Int32])
         expectation.fulfill()
       } catch {
         XCTAssert(false, "Failed to unwrap the function result: \(error)")
@@ -399,7 +399,7 @@ class IntegrationTests: XCTestCase {
         XCTAssertEqual(FunctionsErrorCode.outOfRange.rawValue, error.code)
         XCTAssertEqual("explicit nope", error.localizedDescription)
         XCTAssertEqual(["start": 10 as Int32, "end": 20 as Int32, "long": 30],
-                       error.userInfo[FunctionsErrorDetailsKey] as! [String: Int32])
+                       error.userInfo["details"] as! [String: Int32])
         return
       }
       XCTAssertFalse(true, "Failed to throw error for missing result")
@@ -451,7 +451,7 @@ class IntegrationTests: XCTestCase {
         let error = try XCTUnwrap(error! as NSError)
         XCTAssertEqual(FunctionsErrorCode.deadlineExceeded.rawValue, error.code)
         XCTAssertEqual("DEADLINE EXCEEDED", error.localizedDescription)
-        XCTAssertNil(error.userInfo[FunctionsErrorDetailsKey])
+        XCTAssertNil(error.userInfo["details"])
         expectation.fulfill()
       } catch {
         XCTAssert(false, "Failed to unwrap the function result: \(error)")
@@ -473,7 +473,7 @@ class IntegrationTests: XCTestCase {
         let error = try XCTUnwrap(error) as NSError
         XCTAssertEqual(FunctionsErrorCode.deadlineExceeded.rawValue, error.code)
         XCTAssertEqual("DEADLINE EXCEEDED", error.localizedDescription)
-        XCTAssertNil(error.userInfo[FunctionsErrorDetailsKey])
+        XCTAssertNil(error.userInfo["details"])
         return
       }
       XCTAssertFalse(true, "Failed to throw error for missing result")
diff --git a/FirebaseFunctions/Tests/Unit/FUNSerializerTests.m b/FirebaseFunctions/Tests/Unit/FUNSerializerTests.m
@@ -88,7 +88,7 @@ - (void)testDecodeInvalidLong {
   NSNumber *actual = [serializer decode:input error:&error];
   XCTAssertNil(actual);
   XCTAssertNotNil(error);
-  XCTAssertEqualObjects(FIRFunctionsErrorDomain, error.domain);
+  XCTAssertEqualObjects(@"com.firebase.functions", error.domain);
   XCTAssertEqual(FIRFunctionsErrorCodeInternal, error.code);
 }
 
diff --git a/FirebaseFunctionsSwift/Tests/IntegrationTests.swift b/FirebaseFunctionsSwift/Tests/IntegrationTests.swift
@@ -429,7 +429,7 @@ class IntegrationTests: XCTestCase {
         XCTAssertEqual(FunctionsErrorCode.outOfRange.rawValue, error.code)
         XCTAssertEqual("explicit nope", error.localizedDescription)
         XCTAssertEqual(["start": 10 as Int32, "end": 20 as Int32, "long": 30],
-                       error.userInfo[FunctionsErrorDetailsKey] as! [String: Int32])
+                       error.userInfo["details"] as! [String: Int32])
         expectation.fulfill()
         return
       }
@@ -454,7 +454,7 @@ class IntegrationTests: XCTestCase {
         XCTAssertEqual(FunctionsErrorCode.outOfRange.rawValue, error.code)
         XCTAssertEqual("explicit nope", error.localizedDescription)
         XCTAssertEqual(["start": 10 as Int32, "end": 20 as Int32, "long": 30],
-                       error.userInfo[FunctionsErrorDetailsKey] as! [String: Int32])
+                       error.userInfo["details"] as! [String: Int32])
       }
     }
   #endif
@@ -514,7 +514,7 @@ class IntegrationTests: XCTestCase {
         let error = error as NSError
         XCTAssertEqual(FunctionsErrorCode.deadlineExceeded.rawValue, error.code)
         XCTAssertEqual("DEADLINE EXCEEDED", error.localizedDescription)
-        XCTAssertNil(error.userInfo[FunctionsErrorDetailsKey])
+        XCTAssertNil(error.userInfo["details"])
         expectation.fulfill()
         return
       }
@@ -539,7 +539,7 @@ class IntegrationTests: XCTestCase {
         let error = error as NSError
         XCTAssertEqual(FunctionsErrorCode.deadlineExceeded.rawValue, error.code)
         XCTAssertEqual("DEADLINE EXCEEDED", error.localizedDescription)
-        XCTAssertNil(error.userInfo[FunctionsErrorDetailsKey])
+        XCTAssertNil(error.userInfo["details"])
       }
     }
   #endif
diff --git a/FirebaseStorage/CHANGELOG.md b/FirebaseStorage/CHANGELOG.md
@@ -1,3 +1,7 @@
+# 8.15.0
+- [deprecated] The global variable `FIRStorageErrorDomain` is deprecated and will
+  be removed in a future release (#9569).
+
 # 8.5.0
 - [fixed] Fixed an issue where Storage could not connect to local emulators using
   http (#8389).
diff --git a/FirebaseStorage/Sources/FIRStorageConstants.m b/FirebaseStorage/Sources/FIRStorageConstants.m
@@ -39,6 +39,7 @@
 NSString *const kFIRStorageResponseBody = @"ResponseBody";
 
 NSString *const FIRStorageErrorDomain = @"FIRStorageErrorDomain";
+NSString *const FIRStorageErrorDomainInternal = @"FIRStorageErrorDomain";
 
 NSString *const kFIRStorageInvalidDataFormat = @"Invalid data returned from the server: %@";
 NSString *const kFIRStorageInvalidObserverStatus =
diff --git a/FirebaseStorage/Sources/FIRStorageErrors.h b/FirebaseStorage/Sources/FIRStorageErrors.h
@@ -67,4 +67,6 @@ NS_ASSUME_NONNULL_BEGIN
 
 @end
 
+FOUNDATION_EXPORT NSString *const FIRStorageErrorDomainInternal;
+
 NS_ASSUME_NONNULL_END
diff --git a/FirebaseStorage/Sources/FIRStorageErrors.m b/FirebaseStorage/Sources/FIRStorageErrors.m
@@ -113,7 +113,9 @@ + (NSError *)errorWithCode:(FIRStorageErrorCode)code
 
   errorDictionary[NSLocalizedDescriptionKey] = errorMessage;
 
-  NSError *err = [NSError errorWithDomain:FIRStorageErrorDomain code:code userInfo:errorDictionary];
+  NSError *err = [NSError errorWithDomain:FIRStorageErrorDomainInternal
+                                     code:code
+                                 userInfo:errorDictionary];
   return err;
 }
 
@@ -182,7 +184,7 @@ + (NSError *)errorWithInvalidRequest:(NSData *)request {
 }
 
 + (NSError *)errorWithCustomMessage:(NSString *)errorMessage {
-  return [NSError errorWithDomain:FIRStorageErrorDomain
+  return [NSError errorWithDomain:FIRStorageErrorDomainInternal
                              code:FIRStorageErrorCodeUnknown
                          userInfo:@{NSLocalizedDescriptionKey : errorMessage}];
 }
diff --git a/FirebaseStorage/Sources/FIRStorageUploadTask.m b/FirebaseStorage/Sources/FIRStorageUploadTask.m
@@ -212,7 +212,7 @@ - (BOOL)isContentToUploadValid:(NSError **)outError {
         userInfo[NSUnderlyingErrorKey] = fileReachabilityError;
       }
 
-      *outError = [NSError errorWithDomain:FIRStorageErrorDomain
+      *outError = [NSError errorWithDomain:FIRStorageErrorDomainInternal
                                       code:FIRStorageErrorCodeUnknown
                                   userInfo:userInfo];
     }
diff --git a/FirebaseStorage/Sources/FIRStorageUtils.m b/FirebaseStorage/Sources/FIRStorageUtils.m
@@ -133,7 +133,7 @@ + (NSString *)encodedURLForPath:(FIRStoragePath *)path {
 }
 
 + (NSError *)storageErrorWithDescription:(NSString *)description code:(NSInteger)code {
-  return [NSError errorWithDomain:FIRStorageErrorDomain
+  return [NSError errorWithDomain:FIRStorageErrorDomainInternal
                              code:code
                          userInfo:@{NSLocalizedDescriptionKey : description}];
 }
diff --git a/FirebaseStorage/Sources/Public/FirebaseStorage/FIRStorageConstants.h b/FirebaseStorage/Sources/Public/FirebaseStorage/FIRStorageConstants.h
@@ -112,7 +112,10 @@ typedef NS_ENUM(NSInteger, FIRStorageTaskStatus) {
 /**
  * Firebase Storage error domain.
  */
-FOUNDATION_EXPORT NSString *const FIRStorageErrorDomain NS_SWIFT_NAME(StorageErrorDomain);
+FOUNDATION_EXPORT NSString *const FIRStorageErrorDomain NS_SWIFT_NAME(StorageErrorDomain)
+    DEPRECATED_MSG_ATTRIBUTE(
+        "The variable will be unavailable from Objective C in a future release,"
+        " but the string will not change.");
 
 /**
  * Enum representing the errors raised by Firebase Storage.
diff --git a/FirebaseStorage/Tests/Unit/FIRStorageReferenceTests.m b/FirebaseStorage/Tests/Unit/FIRStorageReferenceTests.m
@@ -176,8 +176,10 @@ - (void)testReferenceWithNonExistentFileFailsWithCompletion {
         [expectation fulfill];
         XCTAssertNotNil(error);
         XCTAssertNil(metadata);
-
+#pragma clang diagnostic push
+#pragma clang diagnostic ignored "-Wdeprecated-declarations"
         XCTAssertEqualObjects(error.domain, FIRStorageErrorDomain);
+#pragma clang diagnostic pop
         XCTAssertEqual(error.code, FIRStorageErrorCodeUnknown);
         NSString *expectedDescription = [NSString
             stringWithFormat:@"File at URL: %@ is not reachable. "
@@ -203,8 +205,10 @@ - (void)testReferenceWithNilFileURLFailsWithCompletion {
         [expectation fulfill];
         XCTAssertNotNil(error);
         XCTAssertNil(metadata);
-
+#pragma clang diagnostic push
+#pragma clang diagnostic ignored "-Wdeprecated-declarations"
         XCTAssertEqualObjects(error.domain, FIRStorageErrorDomain);
+#pragma clang diagnostic pop
         XCTAssertEqual(error.code, FIRStorageErrorCodeUnknown);
         NSString *expectedDescription = [NSString
             stringWithFormat:@"File at URL: %@ is not reachable. "
diff --git a/FirebaseStorage/Tests/Unit/FIRStorageTokenAuthorizerTests.m b/FirebaseStorage/Tests/Unit/FIRStorageTokenAuthorizerTests.m
@@ -86,9 +86,12 @@ - (void)testSuccessfulAuth {
 - (void)testUnsuccessfulAuth {
   XCTestExpectation *expectation = [self expectationWithDescription:@"testUnsuccessfulAuth"];
 
+#pragma clang diagnostic push
+#pragma clang diagnostic ignored "-Wdeprecated-declarations"
   NSError *authError = [NSError errorWithDomain:FIRStorageErrorDomain
                                            code:FIRStorageErrorCodeUnauthenticated
                                        userInfo:nil];
+#pragma clang diagnostic pop
   FIRAuthInteropFake *failedAuth = [[FIRAuthInteropFake alloc] initWithToken:nil
                                                                       userID:nil
                                                                        error:authError];
@@ -109,7 +112,10 @@ - (void)testUnsuccessfulAuth {
         NSDictionary<NSString *, NSString *> *headers = self.fetcher.request.allHTTPHeaderFields;
         NSString *authHeader = [headers objectForKey:@"Authorization"];
         XCTAssertNil(authHeader);
+#pragma clang diagnostic push
+#pragma clang diagnostic ignored "-Wdeprecated-declarations"
         XCTAssertEqualObjects(error.domain, FIRStorageErrorDomain);
+#pragma clang diagnostic pop
         XCTAssertEqual(error.code, FIRStorageErrorCodeUnauthenticated);
         [expectation fulfill];
       }];

Original file line number	Diff line number	Diff line change
`@@ -88,7 +88,7 @@ - (void)testDecodeInvalidLong {`
`88`	`88`	`NSNumber *actual = [serializer decode:input error:&error];`
`89`	`89`	`XCTAssertNil(actual);`
`90`	`90`	`XCTAssertNotNil(error);`
`91`		`- XCTAssertEqualObjects(FIRFunctionsErrorDomain, error.domain);`
	`91`	`+ XCTAssertEqualObjects(@"com.firebase.functions", error.domain);`
`92`	`92`	`XCTAssertEqual(FIRFunctionsErrorCodeInternal, error.code);`
`93`	`93`	`}`
`94`	`94`
Original file line number	Diff line number	Diff line change
`@@ -429,7 +429,7 @@ class IntegrationTests: XCTestCase {`
`429`	`429`	`XCTAssertEqual(FunctionsErrorCode.outOfRange.rawValue, error.code)`
`430`	`430`	`XCTAssertEqual("explicit nope", error.localizedDescription)`
`431`	`431`	`XCTAssertEqual(["start": 10 as Int32, "end": 20 as Int32, "long": 30],`
`432`		`- error.userInfo[FunctionsErrorDetailsKey] as! [String: Int32])`
	`432`	`+ error.userInfo["details"] as! [String: Int32])`
`433`	`433`	`expectation.fulfill()`
`434`	`434`	`return`
`435`	`435`	`}`
`@@ -454,7 +454,7 @@ class IntegrationTests: XCTestCase {`
`454`	`454`	`XCTAssertEqual(FunctionsErrorCode.outOfRange.rawValue, error.code)`
`455`	`455`	`XCTAssertEqual("explicit nope", error.localizedDescription)`
`456`	`456`	`XCTAssertEqual(["start": 10 as Int32, "end": 20 as Int32, "long": 30],`
`457`		`- error.userInfo[FunctionsErrorDetailsKey] as! [String: Int32])`
	`457`	`+ error.userInfo["details"] as! [String: Int32])`
`458`	`458`	`}`
`459`	`459`	`}`
`460`	`460`	`#endif`
`@@ -514,7 +514,7 @@ class IntegrationTests: XCTestCase {`
`514`	`514`	`let error = error as NSError`
`515`	`515`	`XCTAssertEqual(FunctionsErrorCode.deadlineExceeded.rawValue, error.code)`
`516`	`516`	`XCTAssertEqual("DEADLINE EXCEEDED", error.localizedDescription)`
`517`		`- XCTAssertNil(error.userInfo[FunctionsErrorDetailsKey])`
	`517`	`+ XCTAssertNil(error.userInfo["details"])`
`518`	`518`	`expectation.fulfill()`
`519`	`519`	`return`
`520`	`520`	`}`
`@@ -539,7 +539,7 @@ class IntegrationTests: XCTestCase {`
`539`	`539`	`let error = error as NSError`
`540`	`540`	`XCTAssertEqual(FunctionsErrorCode.deadlineExceeded.rawValue, error.code)`
`541`	`541`	`XCTAssertEqual("DEADLINE EXCEEDED", error.localizedDescription)`
`542`		`- XCTAssertNil(error.userInfo[FunctionsErrorDetailsKey])`
	`542`	`+ XCTAssertNil(error.userInfo["details"])`
`543`	`543`	`}`
`544`	`544`	`}`
`545`	`545`	`#endif`