arraySum and log10

Author: MarkDuckworth

packages/firestore/src/api_pipelines.ts

@@ -167,6 +167,8 @@ export {
   error,
   ifAbsent,
   join,
+  log10,
+  arraySum,
   Expression,
   AliasedExpression,
   Field,

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

@@ -2081,7 +2081,11 @@ export abstract class Expression implements ProtoValueSerializable, UserData {
   ifAbsent(elseExpression: unknown): Expression;
 
   ifAbsent(elseValueOrExpression: Expression | unknown): Expression {
-    return new FunctionExpression('if_absent', [this, valueToDefaultExpr(elseValueOrExpression)], 'ifAbsent');
+    return new FunctionExpression(
+      'if_absent',
+      [this, valueToDefaultExpr(elseValueOrExpression)],
+      'ifAbsent'
+    );
   }
 
   /**
@@ -2111,9 +2115,40 @@ export abstract class Expression implements ProtoValueSerializable, UserData {
   join(delimiter: string): Expression;
 
   join(delimeterValueOrExpression: string | Expression): Expression {
-    return new FunctionExpression('join', [this, valueToDefaultExpr(delimeterValueOrExpression)], 'join');
+    return new FunctionExpression(
+      'join',
+      [this, valueToDefaultExpr(delimeterValueOrExpression)],
+      'join'
+    );
   }
 
+  /**
+   * Creates an expression that computes the base-10 logarithm of a numeric value.
+   *
+   * ```typescript
+   * // Compute the base-10 logarithm of the 'value' field.
+   * field("value").log10();
+   * ```
+   *
+   * @return A new {@code Expr} representing the base-10 logarithm of the numeric value.
+   */
+  log10(): FunctionExpression {
+    return new FunctionExpression('log10', [this]);
+  }
+
+  /**
+   * Creates an expression that computes the sum of the elements in an array.
+   *
+   * ```typescript
+   * // Compute the sum of the elements in the 'scores' field.
+   * field("scores").arraySum();
+   * ```
+   *
+   * @return A new {@code Expr} representing the sum of the elements in the array.
+   */
+  arraySum(): FunctionExpression {
+    return new FunctionExpression('sum', [this]);
+  }
 
   // TODO(new-expression): Add new expression method definitions above this line
 
@@ -6861,7 +6896,11 @@ export function currentTimestamp(): FunctionExpression {
  * @return A new Expression representing the error() operation.
  */
 export function error(message: string): Expression {
-  return new FunctionExpression('error', [constant(message)], 'currentTimestamp');
+  return new FunctionExpression(
+    'error',
+    [constant(message)],
+    'currentTimestamp'
+  );
 }
 
 /**
@@ -7391,9 +7430,17 @@ export function ifAbsent(ifFieldName: string, elseExpr: Expression): Expression;
  * @param elseValue The value that will be returned if [ifFieldName] is absent.
  * @return A new Expression representing the ifAbsent operation.
  */
-export function ifAbsent(ifFieldName: string | Expression, elseValue: Expression | unknown): Expression;
-export function ifAbsent(fieldNameOrExpression: string | Expression, elseValue: Expression | unknown): Expression {
-  return fieldOrExpression(fieldNameOrExpression).ifAbsent(valueToDefaultExpr(elseValue));
+export function ifAbsent(
+  ifFieldName: string | Expression,
+  elseValue: Expression | unknown
+): Expression;
+export function ifAbsent(
+  fieldNameOrExpression: string | Expression,
+  elseValue: Expression | unknown
+): Expression {
+  return fieldOrExpression(fieldNameOrExpression).ifAbsent(
+    valueToDefaultExpr(elseValue)
+  );
 }
 
 /**
@@ -7422,7 +7469,10 @@ export function join(arrayFieldName: string, delimiter: string): Expression;
  * @param delimiterExpression The expression that evaluates to the delimiter string.
  * @return A new Expression representing the join operation.
  */
-export function join(arrayExpression: Expression, delimiterExpression: Expression): Expression;
+export function join(
+  arrayExpression: Expression,
+  delimiterExpression: Expression
+): Expression;
 
 /**
  * Creates an expression that joins the elements of an array into a string.
@@ -7436,7 +7486,10 @@ export function join(arrayExpression: Expression, delimiterExpression: Expressio
  * @param delimiter The string to use as a delimiter.
  * @return A new Expression representing the join operation.
  */
-export function join(arrayExpression: Expression, delimiter: string): Expression;
+export function join(
+  arrayExpression: Expression,
+  delimiter: string
+): Expression;
 
 /**
  * Creates an expression that joins the elements of an array into a string.
@@ -7450,9 +7503,75 @@ export function join(arrayExpression: Expression, delimiter: string): Expression
  * @param delimiterExpression The expression that evaluates to the delimiter string.
  * @return A new Expression representing the join operation.
  */
-export function join(arrayFieldName: string, delimiterExpression: Expression): Expression;
-export function join(fieldNameOrExpression: string | Expression, delimiterValueOrExpression: Expression | string): Expression {
-  return fieldOrExpression(fieldNameOrExpression).join(valueToDefaultExpr(delimiterValueOrExpression));
+export function join(
+  arrayFieldName: string,
+  delimiterExpression: Expression
+): Expression;
+export function join(
+  fieldNameOrExpression: string | Expression,
+  delimiterValueOrExpression: Expression | string
+): Expression {
+  return fieldOrExpression(fieldNameOrExpression).join(
+    valueToDefaultExpr(delimiterValueOrExpression)
+  );
+}
+
+/**
+ * Creates an expression that computes the base-10 logarithm of a numeric value.
+ *
+ * ```typescript
+ * // Compute the base-10 logarithm of the 'value' field.
+ * log10("value");
+ * ```
+ *
+ * @param fieldName The name of the field to compute the base-10 logarithm of.
+ * @return A new `Expr` representing the base-10 logarithm of the numeric value.
+ */
+export function log10(fieldName: string): FunctionExpression;
+
+/**
+ * Creates an expression that computes the base-10 logarithm of a numeric value.
+ *
+ * ```typescript
+ * // Compute the base-10 logarithm of the 'value' field.
+ * log10(field("value"));
+ * ```
+ *
+ * @param expression An expression evaluating to a numeric value, which the base-10 logarithm will be computed for.
+ * @return A new `Expr` representing the base-10 logarithm of the numeric value.
+ */
+export function log10(expression: Expression): FunctionExpression;
+export function log10(expr: Expression | string): FunctionExpression {
+  return fieldOrExpression(expr).log10();
+}
+
+/**
+ * Creates an expression that computes the sum of the elements in an array.
+ *
+ * ```typescript
+ * // Compute the sum of the elements in the 'scores' field.
+ * arraySum("scores");
+ * ```
+ *
+ * @param fieldName The name of the field to compute the sum of.
+ * @return A new `Expr` representing the sum of the elements in the array.
+ */
+export function arraySum(fieldName: string): FunctionExpression;
+
+/**
+ * Creates an expression that computes the sum of the elements in an array.
+ *
+ * ```typescript
+ * // Compute the sum of the elements in the 'scores' field.
+ * arraySum(field("scores"));
+ * ```
+ *
+ * @param expression An expression evaluating to a numeric array, which the sum will be computed for.
+ * @return A new `Expr` representing the sum of the elements in the array.
+ */
+export function arraySum(expression: Expression): FunctionExpression;
+export function arraySum(expr: Expression | string): FunctionExpression {
+  return fieldOrExpression(expr).arraySum();
 }
 
 // TODO(new-expression): Add new top-level expression function definitions above this line

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

@@ -141,7 +141,11 @@ import {
   abs,
   concat,
   error,
-  currentTimestamp, ifAbsent, join
+  currentTimestamp,
+  ifAbsent,
+  join,
+  log10,
+  arraySum
 } from '../util/pipeline_export';
 
 use(chaiAsPromised);
@@ -3821,6 +3825,36 @@ apiDescribe.only('Pipelines', persistence => {
       });
     });
 
+    it('can compute the base-10 logarithm of a numeric value', async () => {
+      const snapshot = await execute(
+        firestore
+          .pipeline()
+          .collection(randomCol.path)
+          .where(field('title').equal('The Lord of the Rings'))
+          .limit(1)
+          .select(field('rating').log10().as('log10Rating'))
+      );
+      expect(snapshot.results[0]!.data().log10Rating).to.be.closeTo(
+        0.672,
+        0.001
+      );
+    });
+
+    it('can compute the base-10 logarithm of a numeric value with the top-level function', async () => {
+      const snapshot = await execute(
+        firestore
+          .pipeline()
+          .collection(randomCol.path)
+          .where(field('title').equal('The Lord of the Rings'))
+          .limit(1)
+          .select(log10('rating').as('log10Rating'))
+      );
+      expect(snapshot.results[0]!.data().log10Rating).to.be.closeTo(
+        0.672,
+        0.001
+      );
+    });
+
     it('can concat fields', async () => {
       const snapshot = await execute(
         firestore
@@ -3845,28 +3879,28 @@ apiDescribe.only('Pipelines', persistence => {
           .pipeline()
           .collection(randomCol.path)
           .limit(1)
-          .addFields(
-            currentTimestamp().as('now')
-          )
+          .addFields(currentTimestamp().as('now'))
           .select('now')
       );
-      let now = snapshot.results[0].get('now') as Timestamp;
+      const now = snapshot.results[0].get('now') as Timestamp;
       expect(now).instanceof(Timestamp);
-      expect(now.toDate().getUTCSeconds() - (new Date()).getUTCSeconds()).lessThan(5000);
+      expect(
+        now.toDate().getUTCSeconds() - new Date().getUTCSeconds()
+      ).lessThan(5000);
     });
 
-    it('supports error', async () => {
+    // Not implemented in backend
+    it.skip('supports error', async () => {
       const snapshot = await execute(
         firestore
           .pipeline()
           .collection(randomCol.path)
           .limit(1)
-          .select(
-            isError(error('test error')).as('error')
-          ));
+          .select(isError(error('test error')).as('error'))
+      );
 
       expectResults(snapshot, {
-        'error': true,
+        'error': true
       });
     });
 
@@ -3876,14 +3910,17 @@ apiDescribe.only('Pipelines', persistence => {
           .pipeline()
           .collection(randomCol.path)
           .limit(1)
-          .replaceWith(map({
-            title: 'foo'
-          }))
+          .replaceWith(
+            map({
+              title: 'foo'
+            })
+          )
           .select(
             ifAbsent('title', 'default title').as('title'),
             field('name').ifAbsent('default name').as('name'),
-            field('name').ifAbsent(field('title')).as('nameOrTitle'),
-          ));
+            field('name').ifAbsent(field('title')).as('nameOrTitle')
+          )
+      );
 
       expectResults(snapshot, {
         title: 'foo',
@@ -3892,27 +3929,57 @@ apiDescribe.only('Pipelines', persistence => {
       });
     });
 
-    it.only('supports join', async () => {
+    it('supports join', async () => {
       const snapshot = await execute(
         firestore
           .pipeline()
           .collection(randomCol.path)
           .limit(1)
-          .replaceWith(map({
-            tags: ['foo', 'bar', 'baz'],
-            delimeter: '|'
-          }))
-          .select(
-            join('tags', ',').as('csv'),
-            field('tags').join('|').as('or')
-          ));
+          .replaceWith(
+            map({
+              tags: ['foo', 'bar', 'baz'],
+              delimeter: '|'
+            })
+          )
+          .select(join('tags', ',').as('csv'), field('tags').join('|').as('or'))
+      );
 
       expectResults(snapshot, {
         csv: 'foo,bar,baz',
         or: 'foo|bar|baz'
       });
     });
 
+    it('can compute the sum of the elements in an array', async () => {
+      const snapshot = await execute(
+        firestore
+          .pipeline()
+          .collection(randomCol.path)
+          .where(field('title').equal('The Lord of the Rings'))
+          .limit(1)
+          .addFields(array([150, 200]).as('sales'))
+          .select(field('sales').arraySum().as('totalSales'))
+      );
+      expectResults(snapshot, {
+        totalSales: 350
+      });
+    });
+
+    it('can compute the sum of the elements in an array with the top-level function', async () => {
+      const snapshot = await execute(
+        firestore
+          .pipeline()
+          .collection(randomCol.path)
+          .where(field('title').equal('The Lord of the Rings'))
+          .limit(1)
+          .addFields(array([150, 200]).as('sales'))
+          .select(arraySum('sales').as('totalSales'))
+      );
+      expectResults(snapshot, {
+        totalSales: 350
+      });
+    });
+
     // TODO(new-expression): Add new expression tests above this line
   });