treat the ns= query param as the namespace name if it is present (#2060)

* treat `ns=` query param as the namespace name if it is present

* [AUTOMATED]: Prettier Code Styling

* record ns queryparam override in RepoInfo class

* [AUTOMATED]: Prettier Code Styling

* update database test suite

* more descriptive RepoInfo member name

* Add to changelog

Author: jmwski

packages/database/CHANGELOG.md

@@ -1,9 +1,11 @@
 # Unreleased
 - [fixed] Fixed an issue that caused `.info/serverTimeOffset` events not to fire (#2043).
+- [changed] Treat `ns` url query parameter as the default Realtime Database
+  namespace name.
 
 # 6.3.4
 - [fixed] Fixed an issue where multi-byte UTF-8 characters would not be written correctly when using `firebase.js` or `firebase-database.js` (#2035).
 
 # 6.0.0
-- [changed] Improved consistency between the type annotations for `Query.on`/`Reference.on`, 
-  `Query.off`/`Reference.off` and `Query.once`/`Reference.once` (#1188, #1204).
+- [changed] Improved consistency between the type annotations for `Query.on`/`Reference.on`,
+  `Query.off`/`Reference.off` and `Query.once`/`Reference.once` (#1188, #1204).

packages/database/src/core/RepoInfo.ts

@@ -42,15 +42,20 @@ export class RepoInfo {
     public secure: boolean,
     public namespace: string,
     public webSocketOnly: boolean,
-    public persistenceKey: string = ''
+    public persistenceKey: string = '',
+    public includeNamespaceInQueryParams: boolean = false
   ) {
     this.host = host.toLowerCase();
     this.domain = this.host.substr(this.host.indexOf('.') + 1);
     this.internalHost = PersistentStorage.get('host:' + host) || this.host;
   }
 
   needsQueryParam(): boolean {
-    return this.host !== this.internalHost || this.isCustomHost();
+    return (
+      this.host !== this.internalHost ||
+      this.isCustomHost() ||
+      this.includeNamespaceInQueryParams
+    );
   }
 
   isCacheableHost(): boolean {

packages/database/src/core/RepoManager.ts

@@ -19,7 +19,7 @@ import { FirebaseApp } from '@firebase/app-types';
 import { safeGet } from '@firebase/util';
 import { Repo } from './Repo';
 import { fatal, FIREBASE_DATABASE_EMULATOR_HOST_VAR } from './util/util';
-import { parseRepoInfo, parseURL } from './util/libs/parser';
+import { parseRepoInfo, parseDatabaseURL } from './util/libs/parser';
 import { validateUrl } from './util/validation';
 import './Repo_transaction';
 import { Database } from '../api/Database';

packages/database/src/core/util/libs/parser.ts

@@ -69,8 +69,8 @@ function decodeQuery(queryString: string): { [key: string]: string } {
 export const parseRepoInfo = function(
   dataURL: string
 ): { repoInfo: RepoInfo; path: Path } {
-  const parsedUrl = parseURL(dataURL),
-    namespace = parsedUrl.subdomain;
+  const parsedUrl = parseDatabaseURL(dataURL),
+    namespace = parsedUrl.namespace;
 
   if (parsedUrl.domain === 'firebase') {
     fatal(
@@ -101,7 +101,9 @@ export const parseRepoInfo = function(
       parsedUrl.host,
       parsedUrl.secure,
       namespace,
-      webSocketOnly
+      webSocketOnly,
+      /*persistenceKey=*/ '',
+      /*includeNamespaceInQueryParams=*/ namespace != parsedUrl.subdomain
     ),
     path: new Path(parsedUrl.pathString)
   };
@@ -110,9 +112,9 @@ export const parseRepoInfo = function(
 /**
  *
  * @param {!string} dataURL
- * @return {{host: string, port: number, domain: string, subdomain: string, secure: boolean, scheme: string, pathString: string}}
+ * @return {{host: string, port: number, domain: string, subdomain: string, secure: boolean, scheme: string, pathString: string, namespace: string}}
  */
-export const parseURL = function(
+export const parseDatabaseURL = function(
   dataURL: string
 ): {
   host: string;
@@ -122,12 +124,14 @@ export const parseURL = function(
   secure: boolean;
   scheme: string;
   pathString: string;
+  namespace: string;
 } {
   // Default to empty strings in the event of a malformed string.
   let host = '',
     domain = '',
     subdomain = '',
-    pathString = '';
+    pathString = '',
+    namespace = '';
 
   // Always default to SSL, unless otherwise specified.
   let secure = true,
@@ -175,14 +179,16 @@ export const parseURL = function(
       // Normalize namespaces to lowercase to share storage / connection.
       domain = parts[1];
       subdomain = parts[0].toLowerCase();
+      // We interpret the subdomain of a 3 component URL as the namespace name.
+      namespace = subdomain;
     } else if (parts.length === 2) {
       domain = parts[0];
     } else if (parts[0].slice(0, colonInd).toLowerCase() === 'localhost') {
       domain = 'localhost';
     }
-    // Support `ns` query param if subdomain not already set
-    if (subdomain === '' && 'ns' in queryParams) {
-      subdomain = queryParams['ns'];
+    // Always treat the value of the `ns` as the namespace name if it is present.
+    if ('ns' in queryParams) {
+      namespace = queryParams['ns'];
     }
   }
 
@@ -193,6 +199,7 @@ export const parseURL = function(
     subdomain,
     secure,
     scheme,
-    pathString
+    pathString,
+    namespace
   };
 };

packages/database/test/database.test.ts

@@ -81,10 +81,10 @@ describe('Database Tests', function() {
     expect(db.ref().toString()).to.equal('http://localhost:80/');
   });
 
-  it('Only reads ns query param when subdomain not set', function() {
+  it('Reads ns query param even when subdomain is set', function() {
     var db = defaultApp.database('http://bar.firebaseio.com?ns=foo');
     expect(db).to.be.ok;
-    expect(db.repo_.repoInfo_.namespace).to.equal('bar');
+    expect(db.repo_.repoInfo_.namespace).to.equal('foo');
     expect(db.ref().toString()).to.equal('https://bar.firebaseio.com/');
   });