react-native-firebase/packages/firestore/e2e/WriteBatch/set.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.
 *
 */

describe('firestore.WriteBatch.set()', () => {
  it('throws if a DocumentReference instance is not provided', () => {
    try {
      firebase
        .firestore()
        .batch()
        .set(123);
      return Promise.reject(new Error('Did not throw an Error.'));
    } catch (error) {
      error.message.should.containEql("'documentRef' expected instance of a DocumentReference");
      return Promise.resolve();
    }
  });

  it('throws if a DocumentReference firestore instance is different', () => {
    try {
      const app2 = firebase.app('secondaryFromNative');
      const docRef = firebase.firestore(app2).doc('v6/foo');
      firebase
        .firestore()
        .batch()
        .set(docRef);
      return Promise.reject(new Error('Did not throw an Error.'));
    } catch (error) {
      error.message.should.containEql(
        "'documentRef' provided DocumentReference is from a different Firestore instance",
      );
      return Promise.resolve();
    }
  });

  it('throws if a data is not an object', () => {
    try {
      const docRef = firebase.firestore().doc('v6/foo');
      firebase
        .firestore()
        .batch()
        .set(docRef, 123);
      return Promise.reject(new Error('Did not throw an Error.'));
    } catch (error) {
      error.message.should.containEql("'data' must be an object");
      return Promise.resolve();
    }
  });

  it('throws if a options is not an object', () => {
    try {
      const docRef = firebase.firestore().doc('v6/foo');
      firebase
        .firestore()
        .batch()
        .set(docRef, {}, 123);
      return Promise.reject(new Error('Did not throw an Error.'));
    } catch (error) {
      error.message.should.containEql("'options' must be an object");
      return Promise.resolve();
    }
  });

  it('throws if merge and mergeFields is provided', () => {
    try {
      const docRef = firebase.firestore().doc('v6/foo');
      firebase
        .firestore()
        .batch()
        .set(
          docRef,
          {},
          {
            merge: true,
            mergeFields: ['123'],
          },
        );
      return Promise.reject(new Error('Did not throw an Error.'));
    } catch (error) {
      error.message.should.containEql("'options' must not contain both 'merge' & 'mergeFields'");
      return Promise.resolve();
    }
  });

  it('throws if merge is not a boolean', () => {
    try {
      const docRef = firebase.firestore().doc('v6/foo');
      firebase
        .firestore()
        .batch()
        .set(
          docRef,
          {},
          {
            merge: 'true',
          },
        );
      return Promise.reject(new Error('Did not throw an Error.'));
    } catch (error) {
      error.message.should.containEql("'options.merge' must be a boolean value");
      return Promise.resolve();
    }
  });

  it('throws if mergeFields is not an array', () => {
    try {
      const docRef = firebase.firestore().doc('v6/foo');
      firebase
        .firestore()
        .batch()
        .set(
          docRef,
          {},
          {
            mergeFields: '[]',
          },
        );
      return Promise.reject(new Error('Did not throw an Error.'));
    } catch (error) {
      error.message.should.containEql("'options.mergeFields' must be an array");
      return Promise.resolve();
    }
  });

  it('throws if mergeFields item is not valid', () => {
    try {
      const docRef = firebase.firestore().doc('v6/foo');
      firebase
        .firestore()
        .batch()
        .set(
          docRef,
          {},
          {
            mergeFields: [123],
          },
        );
      return Promise.reject(new Error('Did not throw an Error.'));
    } catch (error) {
      error.message.should.containEql(
        "'options.mergeFields' all fields must be of type string or FieldPath",
      );
      return Promise.resolve();
    }
  });

  it('throws if string fieldpath is invalid', () => {
    try {
      const docRef = firebase.firestore().doc('v6/foo');
      firebase
        .firestore()
        .batch()
        .set(
          docRef,
          {},
          {
            mergeFields: ['.foo.bar'],
          },
        );
      return Promise.reject(new Error('Did not throw an Error.'));
    } catch (error) {
      error.message.should.containEql("'options.mergeFields' Invalid field path");
      return Promise.resolve();
    }
  });

  it('accepts string fieldpath & FieldPath', () => {
    const docRef = firebase.firestore().doc('v6/foo');
    firebase
      .firestore()
      .batch()
      .set(
        docRef,
        {},
        {
          mergeFields: ['foo.bar', new firebase.firestore.FieldPath('foo', 'bar')],
        },
      );
  });

  it('adds the DocumentReference to the internal writes', () => {
    const docRef = firebase.firestore().doc('v6/foo');
    const wb = firebase
      .firestore()
      .batch()
      .set(
        docRef,
        { foo: 'bar' },
        { mergeFields: [new firebase.firestore.FieldPath('foo', 'bar')] },
      );
    wb._writes.length.should.eql(1);
    const expected = {
      path: 'v6/foo',
      type: 'SET',
      options: jet.contextify({
        mergeFields: jet.contextify(['foo.bar']),
      }),
    };
    wb._writes[0].should.containEql(jet.contextify(expected));
  });
});