refactor QueryParams

Author: Feiyang1

packages/database/src/api/Query.ts

@@ -49,7 +49,17 @@ import {
 } from '../core/view/EventRegistration';
 
 import { Repo } from '../core/Repo';
-import { QueryParams } from '../core/view/QueryParams';
+import {
+  QueryParams,
+  limitToFirst,
+  limitToLast,
+  startAfter,
+  startAt,
+  endAt,
+  endBefore,
+  getQueryObject,
+  orderBy
+} from '../core/view/QueryParams';
 import { Reference } from './Reference';
 import { DataSnapshot } from './DataSnapshot';
 
@@ -355,7 +365,7 @@ export class Query {
     return new Query(
       this.repo,
       this.path,
-      this.queryParams_.limitToFirst(limit),
+      limitToFirst(this.queryParams_, limit),
       this.orderByCalled_
     );
   }
@@ -384,7 +394,7 @@ export class Query {
     return new Query(
       this.repo,
       this.path,
-      this.queryParams_.limitToLast(limit),
+      limitToLast(this.queryParams_, limit),
       this.orderByCalled_
     );
   }
@@ -416,7 +426,7 @@ export class Query {
       );
     }
     const index = new PathIndex(parsedPath);
-    const newParams = this.queryParams_.orderBy(index);
+    const newParams = orderBy(this.queryParams_, index);
     Query.validateQueryEndpoints_(newParams);
 
     return new Query(this.repo, this.path, newParams, /*orderByCalled=*/ true);
@@ -428,7 +438,7 @@ export class Query {
   orderByKey(): Query {
     validateArgCount('Query.orderByKey', 0, 0, arguments.length);
     this.validateNoPreviousOrderByCall_('Query.orderByKey');
-    const newParams = this.queryParams_.orderBy(KEY_INDEX);
+    const newParams = orderBy(this.queryParams_, KEY_INDEX);
     Query.validateQueryEndpoints_(newParams);
     return new Query(this.repo, this.path, newParams, /*orderByCalled=*/ true);
   }
@@ -439,7 +449,7 @@ export class Query {
   orderByPriority(): Query {
     validateArgCount('Query.orderByPriority', 0, 0, arguments.length);
     this.validateNoPreviousOrderByCall_('Query.orderByPriority');
-    const newParams = this.queryParams_.orderBy(PRIORITY_INDEX);
+    const newParams = orderBy(this.queryParams_, PRIORITY_INDEX);
     Query.validateQueryEndpoints_(newParams);
     return new Query(this.repo, this.path, newParams, /*orderByCalled=*/ true);
   }
@@ -450,7 +460,7 @@ export class Query {
   orderByValue(): Query {
     validateArgCount('Query.orderByValue', 0, 0, arguments.length);
     this.validateNoPreviousOrderByCall_('Query.orderByValue');
-    const newParams = this.queryParams_.orderBy(VALUE_INDEX);
+    const newParams = orderBy(this.queryParams_, VALUE_INDEX);
     Query.validateQueryEndpoints_(newParams);
     return new Query(this.repo, this.path, newParams, /*orderByCalled=*/ true);
   }
@@ -463,7 +473,7 @@ export class Query {
     validateFirebaseDataArg('Query.startAt', 1, value, this.path, true);
     validateKey('Query.startAt', 2, name, true);
 
-    const newParams = this.queryParams_.startAt(value, name);
+    const newParams = startAt(this.queryParams_, value, name);
     Query.validateLimit_(newParams);
     Query.validateQueryEndpoints_(newParams);
     if (this.queryParams_.hasStart()) {
@@ -490,7 +500,7 @@ export class Query {
     validateFirebaseDataArg('Query.startAfter', 1, value, this.path, false);
     validateKey('Query.startAfter', 2, name, true);
 
-    const newParams = this.queryParams_.startAfter(value, name);
+    const newParams = startAfter(this.queryParams_, value, name);
     Query.validateLimit_(newParams);
     Query.validateQueryEndpoints_(newParams);
     if (this.queryParams_.hasStart()) {
@@ -511,7 +521,7 @@ export class Query {
     validateFirebaseDataArg('Query.endAt', 1, value, this.path, true);
     validateKey('Query.endAt', 2, name, true);
 
-    const newParams = this.queryParams_.endAt(value, name);
+    const newParams = endAt(this.queryParams_, value, name);
     Query.validateLimit_(newParams);
     Query.validateQueryEndpoints_(newParams);
     if (this.queryParams_.hasEnd()) {
@@ -532,7 +542,7 @@ export class Query {
     validateFirebaseDataArg('Query.endBefore', 1, value, this.path, false);
     validateKey('Query.endBefore', 2, name, true);
 
-    const newParams = this.queryParams_.endBefore(value, name);
+    const newParams = endBefore(this.queryParams_, value, name);
     Query.validateLimit_(newParams);
     Query.validateQueryEndpoints_(newParams);
     if (this.queryParams_.hasEnd()) {
@@ -589,7 +599,7 @@ export class Query {
    * An object representation of the query parameters used by this Query.
    */
   queryObject(): object {
-    return this.queryParams_.getQueryObject();
+    return getQueryObject(this.queryParams_);
   }
 
   queryIdentifier(): string {

packages/database/src/core/ReadonlyRestClient.ts

@@ -28,6 +28,7 @@ import { ServerActions } from './ServerActions';
 import { RepoInfo } from './RepoInfo';
 import { AuthTokenProvider } from './AuthTokenProvider';
 import { Query } from '../api/Query';
+import { toRestQueryStringParameters } from './view/QueryParams';
 
 /**
  * An implementation of ServerActions that communicates with the server via REST requests.
@@ -94,9 +95,9 @@ export class ReadonlyRestClient extends ServerActions {
     const thisListen = {};
     this.listens_[listenId] = thisListen;
 
-    const queryStringParameters = query
-      .getQueryParams()
-      .toRestQueryStringParameters();
+    const queryStringParameters = toRestQueryStringParameters(
+      query.getQueryParams()
+    );
 
     this.restRequest_(
       pathString + '.json',
@@ -136,9 +137,9 @@ export class ReadonlyRestClient extends ServerActions {
   }
 
   get(query: Query): Promise<string> {
-    const queryStringParameters = query
-      .getQueryParams()
-      .toRestQueryStringParameters();
+    const queryStringParameters = toRestQueryStringParameters(
+      query.getQueryParams()
+    );
 
     const pathString = query.path.toString();
 

packages/database/src/core/view/QueryParams.ts

@@ -203,7 +203,7 @@ export class QueryParams {
   }
 }
 
-function getNodeFilter(queryParams: QueryParams): NodeFilter {
+export function getNodeFilter(queryParams: QueryParams): NodeFilter {
   if (queryParams.loadsAllData()) {
     return new IndexedFilter(queryParams.getIndex());
   } else if (queryParams.hasLimit()) {
@@ -333,7 +333,7 @@ export function endBefore(
   return params;
 }
 
-function orderBy(queryParams: QueryParams, index: Index): QueryParams {
+export function orderBy(queryParams: QueryParams, index: Index): QueryParams {
   const newParams = queryParams.copy();
   newParams.index_ = index;
   return newParams;
@@ -349,7 +349,7 @@ export function toRestQueryStringParameters(
 ): Record<string, string | number> {
   const qs: Record<string, string | number> = {};
 
-  if (this.isDefault()) {
+  if (queryParams.isDefault()) {
     return qs;
   }
 

packages/database/src/core/view/View.ts

@@ -34,6 +34,7 @@ import { Node } from '../snap/Node';
 import { Path, pathGetFront, pathIsEmpty } from '../util/Path';
 import { WriteTreeRef } from '../WriteTree';
 import { CancelEvent, Event } from './Event';
+import { getNodeFilter } from './QueryParams';
 
 /**
  * A view represents a specific location and query that has 1 or more event registrations.
@@ -54,7 +55,7 @@ export class View {
     const params = this.query_.getQueryParams();
 
     const indexFilter = new IndexedFilter(params.getIndex());
-    const filter = params.getNodeFilter();
+    const filter = getNodeFilter(params);
 
     this.processor_ = new ViewProcessor(filter);