Add abs expression and did formatting

Author: MarkDuckworth

packages/firestore/src/lite-api/expressions.ts

@@ -1102,6 +1102,20 @@ export abstract class Expression implements ProtoValueSerializable, UserData {
     return new FunctionExpression('floor', [this]);
   }
 
+  /**
+   * Creates an expression that computes the absolute value of a numeric value.
+   *
+   * ```typescript
+   * // Compute the absolute value of the 'price' field.
+   * field("price").abs();
+   * ```
+   *
+   * @return A new {@code Expr} representing the absolute value of the numeric value.
+   */
+  abs(): FunctionExpression {
+    return new FunctionExpression('abs', [this]);
+  }
+
   /**
    * Creates an expression that computes e to the power of this expression.
    *
@@ -2674,11 +2688,7 @@ export class BooleanExpression extends FunctionExpression {
    * @return A new {@code Expr} representing the 'ifError' operation.
    */
   ifError(catchValue: BooleanExpression): BooleanExpression {
-    return new BooleanExpression(
-      'if_error',
-      [this, catchValue],
-      'ifError'
-    );
+    return new BooleanExpression('if_error', [this, catchValue], 'ifError');
   }
 }
 
@@ -2909,7 +2919,10 @@ export function ifError(
   tryExpr: Expression,
   catchValue: unknown
 ): FunctionExpression {
-  if (tryExpr instanceof BooleanExpression && catchValue instanceof BooleanExpression) {
+  if (
+    tryExpr instanceof BooleanExpression &&
+    catchValue instanceof BooleanExpression
+  ) {
     return tryExpr.ifError(catchValue);
   } else {
     return tryExpr.ifError(valueToDefaultExpr(catchValue));
@@ -7079,6 +7092,25 @@ export function stringReverse(expr: Expression | string): FunctionExpression {
   return fieldOrExpression(expr).stringReverse();
 }
 
+/**
+ * Creates an expression that computes the absolute value of a numeric value.
+ *
+ * @param expr The expression to compute the absolute value of.
+ * @return A new {@code Expr} representing the absolute value of the numeric value.
+ */
+export function abs(expr: Expression): FunctionExpression;
+
+/**
+ * Creates an expression that computes the absolute value of a numeric value.
+ *
+ * @param fieldName The field to compute the absolute value of.
+ * @return A new {@code Expr} representing the absolute value of the numeric value.
+ */
+export function abs(fieldName: string): FunctionExpression;
+export function abs(expr: Expression | string): FunctionExpression {
+  return fieldOrExpression(expr).abs();
+}
+
 // TODO(new-expression): Add new top-level expression function definitions above this line
 
 /**

packages/firestore/test/integration/api/pipeline.test.ts

@@ -45,7 +45,8 @@ import {
   log,
   sqrt,
   stringReverse,
-  length
+  length,
+  abs
 } from '../../../src/lite-api/expressions';
 import { PipelineSnapshot } from '../../../src/lite-api/pipeline-result';
 import { addEqualityMatcher } from '../../util/equality_matcher';
@@ -2583,9 +2584,12 @@ apiDescribe.only('Pipelines', persistence => {
             ifError(divide(constant(1), constant(0)), constant('was error')).as(
               'ifError'
             ),
-            ifError(divide(constant(1), constant(0)).greaterThan(1), constant(true)).not().as(
-              'ifErrorBooleanExpression'
-            ),
+            ifError(
+              divide(constant(1), constant(0)).greaterThan(1),
+              constant(true)
+            )
+              .not()
+              .as('ifErrorBooleanExpression'),
             isAbsent('foo').as('isAbsent'),
             isNotNull('title').as('titleIsNotNull'),
             isNotNan('cost').as('costIsNotNan'),
@@ -2619,9 +2623,11 @@ apiDescribe.only('Pipelines', persistence => {
             divide(constant(1), constant(0))
               .ifError(constant('was error'))
               .as('ifError'),
-            divide(constant(1), constant(0)).greaterThan(1).ifError(constant(true)).not().as(
-              'ifErrorBooleanExpression'
-            ),
+            divide(constant(1), constant(0))
+              .greaterThan(1)
+              .ifError(constant(true))
+              .not()
+              .as('ifErrorBooleanExpression'),
             field('foo').isAbsent().as('isAbsent'),
             field('title').isNotNull().as('titleIsNotNull'),
             field('cost').isNotNan().as('costIsNotNan')
@@ -3765,6 +3771,30 @@ apiDescribe.only('Pipelines', persistence => {
       expectResults(snapshot, { reverseTitle: '4891' });
     });
 
+    it('testAbs', async () => {
+      const snapshot = await execute(
+        firestore
+          .pipeline()
+          .collection(randomCol.path)
+          .limit(1)
+          .select(
+            constant(-10).as('neg10'),
+            constant(-22.22).as('neg22'),
+            constant(1).as('pos1')
+          )
+          .select(
+            abs('neg10').as('10'),
+            abs(field('neg22')).as('22'),
+            field('pos1').as('1')
+          )
+      );
+      expectResults(snapshot, {
+        '10': 10,
+        '22': 22.22,
+        '1': 1
+      });
+    });
+
     // TODO(new-expression): Add new expression tests above this line
   });
 

packages/firestore/test/lite/pipeline.test.ts

@@ -99,7 +99,7 @@ import {
   arrayLength,
   charLength,
   divide,
-  byteLength,
+  abs,
   not,
   toLower,
   toUpper,
@@ -1903,6 +1903,20 @@ describe('Firestore Pipelines', () => {
       });
     });
 
+    it('testAbs', async () => {
+      const snapshot = await execute(
+        firestore
+          .pipeline()
+          .collection(randomCol.path)
+          .where(equal('title', 'To Kill a Mockingbird'))
+          .select(abs(field('rating')).as('absRating'))
+          .limit(1)
+      );
+      expectResults(snapshot, {
+        absRating: 4.2
+      });
+    });
+
     it('testComparisonOperators', async () => {
       const snapshot = await execute(
         firestore