react-native-firebase/packages/firestore/e2e/Query/where.e2e.js

/*
 * Copyright (c) 2016-present Invertase Limited & Contributors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this library except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */

const { wipe } = require('../helpers');

describe('firestore().collection().where()', () => {
  before(() => wipe());

  it('throws if fieldPath is invalid', () => {
    try {
      firebase
        .firestore()
        .collection('v6')
        .where(123);
      return Promise.reject(new Error('Did not throw an Error.'));
    } catch (error) {
      error.message.should.containEql("'fieldPath' must be a string or instance of FieldPath");
      return Promise.resolve();
    }
  });

  it('throws if fieldPath string is invalid', () => {
    try {
      firebase
        .firestore()
        .collection('v6')
        .where('.foo.bar');
      return Promise.reject(new Error('Did not throw an Error.'));
    } catch (error) {
      error.message.should.containEql("'fieldPath' Invalid field path");
      return Promise.resolve();
    }
  });

  it('throws if operator string is invalid', () => {
    try {
      firebase
        .firestore()
        .collection('v6')
        .where('foo.bar', '!');
      return Promise.reject(new Error('Did not throw an Error.'));
    } catch (error) {
      error.message.should.containEql("'opStr' is invalid");
      return Promise.resolve();
    }
  });

  it('throws if query contains multiple array-contains', () => {
    try {
      firebase
        .firestore()
        .collection('v6')
        .where('foo.bar', 'array-contains', 123)
        .where('foo.bar', 'array-contains', 123);
      return Promise.reject(new Error('Did not throw an Error.'));
    } catch (error) {
      error.message.should.containEql('Queries only support a single array-contains filter');
      return Promise.resolve();
    }
  });

  it('throws if value is not defined', () => {
    try {
      firebase
        .firestore()
        .collection('v6')
        .where('foo.bar', 'array-contains');
      return Promise.reject(new Error('Did not throw an Error.'));
    } catch (error) {
      error.message.should.containEql("'value' argument expected");
      return Promise.resolve();
    }
  });

  it('throws if null value and no equal operator', () => {
    try {
      firebase
        .firestore()
        .collection('v6')
        .where('foo.bar', 'array-contains', null);
      return Promise.reject(new Error('Did not throw an Error.'));
    } catch (error) {
      error.message.should.containEql('You can only perform equals comparisons on null');
      return Promise.resolve();
    }
  });

  it('allows null to be used with equal operator', () => {
    firebase
      .firestore()
      .collection('v6')
      .where('foo.bar', '==', null);
  });

  it('throws if multiple inequalities on different paths is provided', () => {
    try {
      firebase
        .firestore()
        .collection('v6')
        .where('foo.bar', '>', 123)
        .where('bar', '>', 123);
      return Promise.reject(new Error('Did not throw an Error.'));
    } catch (error) {
      error.message.should.containEql('All where filters with an inequality');
      return Promise.resolve();
    }
  });

  it('allows inequality on the same path', () => {
    firebase
      .firestore()
      .collection('v6')
      .where('foo.bar', '>', 123)
      .where(new firebase.firestore.FieldPath('foo', 'bar'), '>', 1234);
  });

  it('throws if in query with no array value', () => {
    try {
      firebase
        .firestore()
        .collection('v6')
        .where('foo.bar', 'in', '123');
      return Promise.reject(new Error('Did not throw an Error.'));
    } catch (error) {
      error.message.should.containEql('A non-empty array is required');
      return Promise.resolve();
    }
  });

  it('throws if array-contains-any query with no array value', () => {
    try {
      firebase
        .firestore()
        .collection('v6')
        .where('foo.bar', 'array-contains-any', '123');
      return Promise.reject(new Error('Did not throw an Error.'));
    } catch (error) {
      error.message.should.containEql('A non-empty array is required');
      return Promise.resolve();
    }
  });

  it('throws if in query array length is greater than 10', () => {
    try {
      firebase
        .firestore()
        .collection('v6')
        .where('foo.bar', 'in', [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11]);
      return Promise.reject(new Error('Did not throw an Error.'));
    } catch (error) {
      error.message.should.containEql('maximum of 10 elements in the value');
      return Promise.resolve();
    }
  });

  it('throws if query has multiple array-contains-any filter', () => {
    try {
      firebase
        .firestore()
        .collection('v6')
        .where('foo.bar', 'array-contains-any', [1])
        .where('foo.bar', 'array-contains-any', [2]);
      return Promise.reject(new Error('Did not throw an Error.'));
    } catch (error) {
      error.message.should.containEql("You cannot use more than one 'array-contains-any' filter");
      return Promise.resolve();
    }
  });

  it('throws if query has array-contains-any & in filter', () => {
    try {
      firebase
        .firestore()
        .collection('v6')
        .where('foo.bar', 'array-contains-any', [1])
        .where('foo.bar', 'in', [2]);
      return Promise.reject(new Error('Did not throw an Error.'));
    } catch (error) {
      error.message.should.containEql(
        "You cannot use 'in' filters with 'array-contains-any' filters",
      );
      return Promise.resolve();
    }
  });

  it('throws if query has multiple in filter', () => {
    try {
      firebase
        .firestore()
        .collection('v6')
        .where('foo.bar', 'in', [1])
        .where('foo.bar', 'in', [2]);
      return Promise.reject(new Error('Did not throw an Error.'));
    } catch (error) {
      error.message.should.containEql("You cannot use more than one 'in' filter");
      return Promise.resolve();
    }
  });

  it('throws if query has in & array-contains-any filter', () => {
    try {
      firebase
        .firestore()
        .collection('v6')
        .where('foo.bar', 'in', [1])
        .where('foo.bar', 'array-contains-any', [2]);
      return Promise.reject(new Error('Did not throw an Error.'));
    } catch (error) {
      error.message.should.containEql(
        "You cannot use 'array-contains-any' filters with 'in' filters",
      );
      return Promise.resolve();
    }
  });

  /* Queries */

  it('returns with where equal filter', async () => {
    const colRef = firebase.firestore().collection('v6/filter/equal');

    const search = Date.now();
    await Promise.all([
      colRef.add({ foo: search }),
      colRef.add({ foo: search }),
      colRef.add({ foo: search + 1234 }),
    ]);

    const snapshot = await colRef.where('foo', '==', search).get();

    snapshot.size.should.eql(2);
    snapshot.forEach(s => {
      s.data().foo.should.eql(search);
    });
  });

  it('returns with where greater than filter', async () => {
    const colRef = firebase.firestore().collection('v6/filter/greater');

    const search = Date.now();
    await Promise.all([
      colRef.add({ foo: search - 1234 }),
      colRef.add({ foo: search }),
      colRef.add({ foo: search + 1234 }),
      colRef.add({ foo: search + 1234 }),
    ]);

    const snapshot = await colRef.where('foo', '>', search).get();

    snapshot.size.should.eql(2);
    snapshot.forEach(s => {
      s.data().foo.should.eql(search + 1234);
    });
  });

  it('returns with where greater than or equal filter', async () => {
    const colRef = firebase.firestore().collection('v6/filter/greaterequal');

    const search = Date.now();
    await Promise.all([
      colRef.add({ foo: search - 1234 }),
      colRef.add({ foo: search }),
      colRef.add({ foo: search + 1234 }),
      colRef.add({ foo: search + 1234 }),
    ]);

    const snapshot = await colRef.where('foo', '>=', search).get();

    snapshot.size.should.eql(3);
    snapshot.forEach(s => {
      s.data().foo.should.be.aboveOrEqual(search);
    });
  });

  it('returns with where less than filter', async () => {
    const colRef = firebase.firestore().collection('v6/filter/less');

    const search = -Date.now();
    await Promise.all([
      colRef.add({ foo: search + -1234 }),
      colRef.add({ foo: search + -1234 }),
      colRef.add({ foo: search }),
    ]);

    const snapshot = await colRef.where('foo', '<', search).get();

    snapshot.size.should.eql(2);
    snapshot.forEach(s => {
      s.data().foo.should.be.below(search);
    });
  });

  it('returns with where less than or equal filter', async () => {
    const colRef = firebase.firestore().collection('v6/filter/lessequal');

    const search = -Date.now();
    await Promise.all([
      colRef.add({ foo: search + -1234 }),
      colRef.add({ foo: search + -1234 }),
      colRef.add({ foo: search }),
      colRef.add({ foo: search + 1234 }),
    ]);

    const snapshot = await colRef.where('foo', '<=', search).get();

    snapshot.size.should.eql(3);
    snapshot.forEach(s => {
      s.data().foo.should.be.belowOrEqual(search);
    });
  });

  it('returns with where array-contains filter', async () => {
    const colRef = firebase.firestore().collection('v6/filter/array-contains');

    const match = Date.now();
    await Promise.all([
      colRef.add({ foo: [1, '2', match] }),
      colRef.add({ foo: [1, '2', match.toString()] }),
      colRef.add({ foo: [1, '2', match.toString()] }),
    ]);

    const snapshot = await colRef.where('foo', 'array-contains', match.toString()).get();
    const expected = [1, '2', match.toString()];

    snapshot.size.should.eql(2);
    snapshot.forEach(s => {
      s.data().foo.should.eql(jet.contextify(expected));
    });
  });

  it('returns with in filter', async () => {
    const colRef = firebase.firestore().collection('v6/filter/in');

    await Promise.all([
      colRef.add({ status: 'Ordered' }),
      colRef.add({ status: 'Ready to Ship' }),
      colRef.add({ status: 'Ready to Ship' }),
      colRef.add({ status: 'Incomplete' }),
    ]);

    const expect = ['Ready to Ship', 'Ordered'];
    const snapshot = await colRef.where('status', 'in', expect).get();
    snapshot.size.should.eql(3);

    snapshot.forEach(s => {
      s.data().status.should.equalOneOf(...expect);
    });
  });

  it('returns with array-contains-any filter', async () => {
    const colRef = firebase.firestore().collection('v6/filter/array-contains-any');

    await Promise.all([
      colRef.add({ category: ['Appliances', 'Housewares', 'Cooking'] }),
      colRef.add({ category: ['Appliances', 'Electronics', 'Nursery'] }),
      colRef.add({ category: ['Audio/Video', 'Electronics'] }),
      colRef.add({ category: ['Beauty'] }),
    ]);

    const expect = ['Appliances', 'Electronics'];
    const snapshot = await colRef.where('category', 'array-contains-any', expect).get();
    snapshot.size.should.eql(3); // 2nd record should only be returned once
  });
});