Remove isNull, isNotNull, isNan, isNotNan, error expressions

Author: MarkDuckworth

dev/src/pipelines/expression.ts

@@ -651,36 +651,6 @@ export abstract class Expression
     return new BooleanExpression('not_equal_any', [this, exprOthers]);
   }
 
-  /**
-   * @beta
-   * Creates an expression that checks if this expression evaluates to 'NaN' (Not a Number).
-   *
-   * ```typescript
-   * // Check if the result of a calculation is NaN
-   * field("value").divide(0).isNan();
-   * ```
-   *
-   * @return A new `Expression` representing the 'isNan' check.
-   */
-  isNan(): BooleanExpression {
-    return new BooleanExpression('is_nan', [this]);
-  }
-
-  /**
-   * @beta
-   * Creates an expression that checks if this expression evaluates to 'Null'.
-   *
-   * ```typescript
-   * // Check if the result of a calculation is NaN
-   * field("value").isNull();
-   * ```
-   *
-   * @return A new `Expression` representing the 'isNull' check.
-   */
-  isNull(): BooleanExpression {
-    return new BooleanExpression('is_null', [this]);
-  }
-
   /**
    * @beta
    * Creates an expression that checks if a field exists in the document.
@@ -1728,36 +1698,6 @@ export abstract class Expression
     return new BooleanExpression('is_absent', [this]);
   }
 
-  /**
-   * @beta
-   * Creates an expression that checks if tbe result of an expression is not null.
-   *
-   * ```typescript
-   * // Check if the value of the 'name' field is not null
-   * field("name").isNotNull();
-   * ```
-   *
-   * @return A new {@code BooleanExpression} representing the 'isNotNull' check.
-   */
-  isNotNull(): BooleanExpression {
-    return new BooleanExpression('is_not_null', [this]);
-  }
-
-  /**
-   * @beta
-   * Creates an expression that checks if the results of this expression is NOT 'NaN' (Not a Number).
-   *
-   * ```typescript
-   * // Check if the result of a calculation is NOT NaN
-   * field("value").divide(0).isNotNan();
-   * ```
-   *
-   * @return A new {@code Expression} representing the 'isNan' check.
-   */
-  isNotNan(): BooleanExpression {
-    return new BooleanExpression('is_not_nan', [this]);
-  }
-
   /**
    * @beta
    * Creates an expression that removes a key from the map produced by evaluating this expression.
@@ -3068,99 +3008,6 @@ export function isAbsent(value: Expression | string): BooleanExpression {
   return fieldOrExpression(value).isAbsent();
 }
 
-/**
- * @beta
- * Creates an expression that checks if an expression evaluates to 'NaN' (Not a Number).
- *
- * ```typescript
- * // Check if the result of a calculation is NaN
- * isNull(field("value").divide(0));
- * ```
- *
- * @param value The expression to check.
- * @return A new {@code Expression} representing the 'isNull' check.
- */
-export function isNull(value: Expression): BooleanExpression;
-
-/**
- * @beta
- * Creates an expression that checks if a field's value evaluates to 'NaN' (Not a Number).
- *
- * ```typescript
- * // Check if the result of a calculation is NaN
- * isNull("value");
- * ```
- *
- * @param value The name of the field to check.
- * @return A new {@code Expression} representing the 'isNull' check.
- */
-export function isNull(value: string): BooleanExpression;
-export function isNull(value: Expression | string): BooleanExpression {
-  return fieldOrExpression(value).isNull();
-}
-
-/**
- * @beta
- * Creates an expression that checks if tbe result of an expression is not null.
- *
- * ```typescript
- * // Check if the value of the 'name' field is not null
- * isNotNull(field("name"));
- * ```
- *
- * @param value The expression to check.
- * @return A new {@code Expression} representing the 'isNotNull' check.
- */
-export function isNotNull(value: Expression): BooleanExpression;
-
-/**
- * @beta
- * Creates an expression that checks if tbe value of a field is not null.
- *
- * ```typescript
- * // Check if the value of the 'name' field is not null
- * isNotNull("name");
- * ```
- *
- * @param value The name of the field to check.
- * @return A new {@code Expression} representing the 'isNotNull' check.
- */
-export function isNotNull(value: string): BooleanExpression;
-export function isNotNull(value: Expression | string): BooleanExpression {
-  return fieldOrExpression(value).isNotNull();
-}
-
-/**
- * @beta
- * Creates an expression that checks if the results of this expression is NOT 'NaN' (Not a Number).
- *
- * ```typescript
- * // Check if the result of a calculation is NOT NaN
- * isNotNaN(field("value").divide(0));
- * ```
- *
- * @param value The expression to check.
- * @return A new {@code Expression} representing the 'isNotNaN' check.
- */
-export function isNotNan(value: Expression): BooleanExpression;
-
-/**
- * @beta
- * Creates an expression that checks if the results of this expression is NOT 'NaN' (Not a Number).
- *
- * ```typescript
- * // Check if the value of a field is NOT NaN
- * isNotNaN("value");
- * ```
- *
- * @param value The name of the field to check.
- * @return A new {@code Expression} representing the 'isNotNaN' check.
- */
-export function isNotNan(value: string): BooleanExpression;
-export function isNotNan(value: Expression | string): BooleanExpression {
-  return fieldOrExpression(value).isNotNan();
-}
-
 /**
  * @beta
  * Creates an expression that removes a key from the map at the specified field name.
@@ -4960,37 +4807,6 @@ export function exists(valueOrField: Expression | string): BooleanExpression {
   return fieldOrExpression(valueOrField).exists();
 }
 
-/**
- * @beta
- * Creates an expression that checks if an expression evaluates to 'NaN' (Not a Number).
- *
- * ```typescript
- * // Check if the result of a calculation is NaN
- * isNan(field("value").divide(0));
- * ```
- *
- * @param value The expression to check.
- * @return A new {@code Expression} representing the 'isNan' check.
- */
-export function isNan(value: Expression): BooleanExpression;
-
-/**
- * @beta
- * Creates an expression that checks if a field's value evaluates to 'NaN' (Not a Number).
- *
- * ```typescript
- * // Check if the result of a calculation is NaN
- * isNan("value");
- * ```
- *
- * @param fieldName The name of the field to check.
- * @return A new {@code Expression} representing the 'isNan' check.
- */
-export function isNan(fieldName: string): BooleanExpression;
-export function isNan(value: Expression | string): BooleanExpression {
-  return fieldOrExpression(value).isNan();
-}
-
 /**
  * @beta
  * Creates an expression that reverses a string.
@@ -6699,22 +6515,6 @@ export function currentTimestamp(): FunctionExpression {
   return new FunctionExpression('current_timestamp', []);
 }
 
-/**
- * @beta
- * Creates an expression that raises an error with the given message. This could be useful for
- * debugging purposes.
- *
- * ```typescript
- * // Raise an error with the message "simulating an evaluation error".
- * error("simulating an evaluation error")
- * ```
- *
- * @return A new Expression representing the error() operation.
- */
-export function error(message: string): Expression {
-  return new FunctionExpression('error', [constant(message)]);
-}
-
 /**
  * @beta
  * Creates an expression that performs a logical 'AND' operation on multiple filter conditions.

dev/src/pipelines/index.ts

@@ -71,16 +71,12 @@ export {
   toUpper,
   toLower,
   vectorLength,
-  isNotNan,
   exists,
-  isNotNull,
   isAbsent,
   ifError,
   isError,
-  isNan,
   substring,
   documentId,
-  isNull,
   arrayContainsAll,
   constant,
   Field,
@@ -124,7 +120,6 @@ export {
   concat,
   join,
   currentTimestamp,
-  error,
   arrayConcat,
   // TODO(new-expression): Add new expression exports above this line
 } from './expression';

dev/system-test/pipeline.ts

@@ -54,16 +54,12 @@ import {
   toUpper,
   toLower,
   vectorLength,
-  isNotNan,
   exists,
-  isNotNull,
   isAbsent,
   ifError,
   isError,
-  isNan,
   substring,
   documentId,
-  isNull,
   arrayContainsAll,
   mapRemove,
   mapMerge,
@@ -119,7 +115,6 @@ import {
   join,
   arraySum,
   currentTimestamp,
-  error,
   arrayConcat,
   // TODO(new-expression): add new expression imports above this line
 } from '../src/pipelines';
@@ -2701,8 +2696,8 @@ describe.only('Pipeline class', () => {
         .sort(field('rating').descending())
         .limit(1)
         .select(
-          isNull('rating').as('ratingIsNull'),
-          isNan('rating').as('ratingIsNaN'),
+          equal('rating', null).as('ratingIsNull'),
+          equal('rating', NaN).as('ratingIsNaN'),
           isError(divide(constant(1), constant(0))).as('isError'),
           ifError(divide(constant(1), constant(0)), constant('was error')).as(
             'ifError'
@@ -2714,8 +2709,8 @@ describe.only('Pipeline class', () => {
             .not()
             .as('ifErrorBooleanExpression'),
           isAbsent('foo').as('isAbsent'),
-          isNotNull('title').as('titleIsNotNull'),
-          isNotNan('cost').as('costIsNotNan'),
+          notEqual('title', null).as('titleIsNotNull'),
+          notEqual('cost', NaN).as('costIsNotNan'),
           exists('fooBarBaz').as('fooBarBazExists'),
           field('title').exists().as('titleExists')
         )
@@ -2739,8 +2734,8 @@ describe.only('Pipeline class', () => {
         .sort(field('rating').descending())
         .limit(1)
         .select(
-          field('rating').isNull().as('ratingIsNull'),
-          field('rating').isNan().as('ratingIsNaN'),
+          field('rating').equal(null).as('ratingIsNull'),
+          field('rating').equal(NaN).as('ratingIsNaN'),
           divide(constant(1), constant(0)).isError().as('isError'),
           divide(constant(1), constant(0))
             .ifError(constant('was error'))
@@ -2751,8 +2746,8 @@ describe.only('Pipeline class', () => {
             .not()
             .as('ifErrorBooleanExpression'),
           field('foo').isAbsent().as('isAbsent'),
-          field('title').isNotNull().as('titleIsNotNull'),
-          field('cost').isNotNan().as('costIsNotNan')
+          field('title').notEqual(null).as('titleIsNotNull'),
+          field('cost').notEqual(NaN).as('costIsNotNan')
         )
         .execute();
       expectResults(snapshot, {
@@ -3929,21 +3924,6 @@ describe.only('Pipeline class', () => {
       ).lessThan(5000);
     });
 
-    // Not implemented in backend
-    // eslint-disable-next-line no-restricted-properties
-    it.skip('supports error', async () => {
-      const snapshot = await firestore
-        .pipeline()
-        .collection(randomCol.path)
-        .limit(1)
-        .select(isError(error('test error')).as('error'))
-        .execute();
-
-      expectResults(snapshot, {
-        error: true,
-      });
-    });
-
     it('supports ifAbsent', async () => {
       const snapshot = await firestore
         .pipeline()