Support the RTDB emulator

Author: schmidt-sebastian

Example/Database/Tests/Integration/FIRDatabaseTests.m

@@ -53,7 +53,6 @@ - (void) testDatabaseForApp {
 - (void) testDatabaseForAppWithInvalidURLs {
 XCTAssertThrows([selfdatabaseForURL:nil]);
 XCTAssertThrows([selfdatabaseForURL:@"not-a-url"]);
-XCTAssertThrows([selfdatabaseForURL:@"http://fblocal.com"]);
 XCTAssertThrows([selfdatabaseForURL:@"http://x.example.com/paths/are/bad"]);
 }
 
@@ -95,7 +94,6 @@ - (void)testDatabaseForAppWithInvalidCustomURLs {
 XCTAssertThrows([FIRDatabase databaseForApp:app URL:nil]);
 #pragma clang diagnostic pop
 XCTAssertThrows([FIRDatabase databaseForApp:app URL:@"not-a-url"]);
-XCTAssertThrows([FIRDatabase databaseForApp:app URL:@"http://fblocal.com"]);
 XCTAssertThrows([FIRDatabase databaseForApp:app URL:@"http://x.fblocal.com:9000/paths/are/bad"]);
 }
 

Example/Database/Tests/Unit/FUtilitiesTest.m

@@ -50,6 +50,43 @@ - (void)testUrlParsedWithoutSchema {
 XCTAssertEqualObjects(parsedUrl.path, [FPath empty]);
 }
 
+- (void)testUrlParsedUsesSpaceInsteadOfPlus {
+ FParsedUrl *parsedUrl = [FUtilities parseUrl:@"repo.firebaseio.com/+"];
+XCTAssertEqualObjects(parsedUrl.path, [FPath pathWithString:@"/ "]);
+}
+
+- (void)testUrlParsedWithSpecialCharacters {
+ FParsedUrl *parsedUrl = [FUtilities parseUrl:@"repo.firebaseio.com/a%b&c@d/space: /non-ascii:ø"];
+XCTAssertEqualObjects(parsedUrl.path, [FPath pathWithString:@"/a%b&c@d/space: /non-ascii:ø"]);
+}
+
+- (void)testUrlParsedWithNamespace {
+ FParsedUrl *parsedUrl = [FUtilities parseUrl:@"repo.firebaseio.com/foo/bar?ns=mrschmidt"];
+XCTAssertEqualObjects(parsedUrl.path, [FPath pathWithString:@"/foo/bar"]);
+// The subdomain takes precedence if one is provided
+XCTAssertEqualObjects(parsedUrl.repoInfo.namespace, @"repo");
+
+ parsedUrl = [FUtilities parseUrl:@"localhost/?ns=mrschmidt"];
+XCTAssertEqualObjects(parsedUrl.repoInfo.namespace, @"mrschmidt");
+
+ parsedUrl = [FUtilities parseUrl:@"127.0.0.1:9000/?ns=mrschmidt"];
+XCTAssertEqualObjects(parsedUrl.repoInfo.namespace, @"mrschmidt");
+}
+
+- (void)testUrlParsedWithSslDetection {
+// Hosts with custom ports are considered non-secure
+ FParsedUrl *parsedUrl = [FUtilities parseUrl:@"repo.firebaseio.com:9000"];
+XCTAssertFalse(parsedUrl.repoInfo.secure);
+
+// Hosts with omitted ports are considered secure
+ parsedUrl = [FUtilities parseUrl:@"repo.firebaseio.com"];
+XCTAssertTrue(parsedUrl.repoInfo.secure);
+
+// Localhost is special-cased as insecure
+ parsedUrl = [FUtilities parseUrl:@"localhost"];
+XCTAssertFalse(parsedUrl.repoInfo.secure);
+}
+
 - (void)testDefaultCacheSizeIs10MB {
 XCTAssertEqual([FTestHelpers defaultConfig].persistenceCacheSizeBytes, (NSUInteger)10*1024*1024);
 XCTAssertEqual([FTestHelpers configForName:@"test-config"].persistenceCacheSizeBytes, (NSUInteger)10*1024*1024);

Firebase/Database/CHANGELOG.md

@@ -1,3 +1,10 @@
+# Unreleased
+-[feature] The SDK adds support for the Firebase Database Emulator. To connect
+ to the emulator, specify "http://<emulator_host>/" as your Database URL
+ (via `Database.database(url:)`).
+ If you refer to your emulator host by IP rather than by domain name, you may
+ also need to specify a namespace ("http://<emulator_host>/?ns=<project_id>").
+
 # v6.0.0
 -[removed] Remove deprecated `childByAppendingPath` API. (#2763)
 

Firebase/Database/Core/FRepoInfo.m

@@ -36,7 +36,7 @@ - (id) initWithHost:(NSString*)aHost isSecure:(bool)isSecure withNamespace:(NSSt
  self = [superinit];
 if (self) {
  host = aHost;
- domain = [host substringFromIndex:[host rangeOfString:@"."].location+1];
+ domain = [host containsString:@"."] ? [host substringFromIndex:[host rangeOfString:@"."].location+1] : host;
  secure = isSecure;
  namespace = aNamespace;
 

Firebase/Database/Utilities/FUtilities.m

@@ -122,54 +122,82 @@ + (NSString *) decodePath:(NSString *)pathString {
 return [NSStringstringWithFormat:@"/%@", [decodedPieces componentsJoinedByString:@"/"]];
 }
 
-+ (FParsedUrl *) parseUrl:(NSString *)url {
-NSString* original = url;
-//NSURL* n = [[NSURL alloc] initWithString:url]
++ (NSString *) extractPathFromUrlString:(NSString *)url {
+NSString* path = url;
 
-NSString* host;
-NSString* namespace;
-bool secure;
+NSRange schemeIndex = [path rangeOfString:@"//"];
+if (schemeIndex.location != NSNotFound) {
+ path = [path substringFromIndex:schemeIndex.location + 2];
+ }
 
-NSString* scheme = nil;
- FPath* path = nil;
-NSRange colonIndex = [url rangeOfString:@"//"];
-if (colonIndex.location != NSNotFound) {
- scheme = [url substringToIndex:colonIndex.location - 1];
- url = [url substringFromIndex:colonIndex.location + 2];
+NSUInteger pathIndex = [path rangeOfString:@"/"].location;
+if (pathIndex != NSNotFound) {
+ path = [path substringFromIndex:pathIndex + 1];
+ } else {
+ path = @"";
  }
-NSInteger slashIndex = [url rangeOfString:@"/"].location;
-if (slashIndex == NSNotFound) {
- slashIndex = url.length;
+
+NSUInteger queryParamIndex = [path rangeOfString:@"?"].location;
+if (queryParamIndex != NSNotFound) {
+ path = [path substringToIndex:queryParamIndex];
  }
 
- host = [[url substringToIndex:slashIndex] lowercaseString];
-if (slashIndex >= url.length) {
- url = @"";
- } else {
- url = [url substringFromIndex:slashIndex + 1];
+return path;
+}
+
++ (FParsedUrl *) parseUrl:(NSString *)url {
+// For backwards compatibility, support URLs without schemes on iOS.
+if (![url containsString:@"://"]) {
+ url = [@"http://"stringByAppendingString:url];
+ }
+
+NSString* originalPathString = [selfextractPathFromUrlString:url];
+
+// Sanitize the database URL by removing the path component, which may contain invalid URL characters.
+NSString* sanitizedUrlWithoutPath = [url stringByReplacingOccurrencesOfString:originalPathString withString:@""];
+NSURLComponents *urlComponents = [NSURLComponentscomponentsWithString:sanitizedUrlWithoutPath];
+if (!urlComponents) {
+ [NSExceptionraise:@"Failed to parse database URL"format:@"Failed to parse database URL: %@", url];
  }
 
-NSArray *parts = [host componentsSeparatedByString:@"."];
+NSString* host = [urlComponents.host lowercaseString];
+NSString* namespace;
+bool secure;
+
+if (urlComponents.port != nil) {
+ secure = [urlComponents.scheme isEqualToString:@"https"];
+ host = [host stringByAppendingFormat:@":%@", urlComponents.port];
+ } elseif ( [urlComponents.host isEqualToString:@"localhost"]) {
+ secure = NO;
+ } else {
+ secure = YES;
+ };
+
+NSArray *parts = [urlComponents.host componentsSeparatedByString:@"."];
 if([parts count] == 3) {
-NSInteger colonIndex = [[parts objectAtIndex:2] rangeOfString:@":"].location;
-if (colonIndex != NSNotFound) {
-// we have a port, use the provided scheme
- secure = [scheme isEqualToString:@"https"];
- } else {
- secure = YES;
+ namespace = [parts[0] lowercaseString];
+ } else {
+// Attempt to extract namespace from "ns" query param.
+NSArray *queryItems = urlComponents.queryItems;
+NSMutableArray *someIDs = [NSMutableArraynew];
+for (NSURLQueryItem *item in queryItems) {
+if ([item.name isEqualToString:@"ns"]) {
+ namespace = item.value;
+break;
+ }
  }
 
- namespace = [[parts objectAtIndex:0] lowercaseString];
-NSString* pathString = [selfdecodePath:[NSStringstringWithFormat:@"/%@", url]];
- path = [[FPath alloc] initWith:pathString];
- }
-else {
- [NSExceptionraise:@"No Firebase database specified."format:@"No Firebase database found for input: %@", url];
+if (!namespace) {
+ namespace = [parts[0] lowercaseString];
+ }
  }
 
+
+NSString* pathString = [selfdecodePath:[NSStringstringWithFormat:@"/%@", originalPathString]];
+ FPath * path = [[FPath alloc] initWith:pathString];
  FRepoInfo* repoInfo = [[FRepoInfo alloc] initWithHost:host isSecure:secure withNamespace:namespace];
 
-FFLog(@"I-RDB095002", @"---> Parsed (%@) to: (%@,%@); ns=(%@); path=(%@)", original, [repoInfo description], [repoInfo connectionURL], repoInfo.namespace, [path description]);
+FFLog(@"I-RDB095002", @"---> Parsed (%@) to: (%@,%@); ns=(%@); path=(%@)", url, [repoInfo description], [repoInfo connectionURL], repoInfo.namespace, [path description]);
 
  FParsedUrl* parsedUrl = [[FParsedUrl alloc] init];
  parsedUrl.repoInfo = repoInfo;