react-native-firebase/packages/database/e2e/reference/transaction.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 { PATH, seed, wipe } = require('../helpers');

const TEST_PATH = `${PATH}/transaction`;
const NOOP = () => {};

describe('database().ref().transaction()', () => {
  before(() => seed(TEST_PATH));
  after(() => wipe(TEST_PATH));

  it('throws if no transactionUpdate is provided', async () => {
    try {
      await firebase
        .database()
        .ref(TEST_PATH)
        .transaction();
      return Promise.reject(new Error('Did not throw an Error.'));
    } catch (error) {
      error.message.should.containEql("'transactionUpdate' must be a function");
      return Promise.resolve();
    }
  });

  it('throws if onComplete is not a function', async () => {
    try {
      await firebase
        .database()
        .ref()
        .transaction(NOOP, 'foo');
      return Promise.reject(new Error('Did not throw an Error.'));
    } catch (error) {
      error.message.should.containEql("'onComplete' must be a function if provided");
      return Promise.resolve();
    }
  });

  it('throws if applyLocally is not a boolean', async () => {
    try {
      await firebase
        .database()
        .ref()
        .transaction(NOOP, NOOP, 'foo');
      return Promise.reject(new Error('Did not throw an Error.'));
    } catch (error) {
      error.message.should.containEql("'applyLocally' must be a boolean value if provided");
      return Promise.resolve();
    }
  });

  it('updates the value via a transaction', async () => {
    const ref = firebase
      .database()
      .ref(TEST_PATH)
      .child('transaction');
    await ref.set(1);

    const { committed, snapshot } = await ref.transaction(value => {
      return value + 1;
    });

    should.equal(committed, true, 'Transaction did not commit.');
    snapshot.val().should.equal(2);
  });

  it('aborts transaction if undefined returned', async () => {
    const ref = firebase
      .database()
      .ref(TEST_PATH)
      .child('transaction');
    await ref.set(1);

    return new Promise((resolve, reject) => {
      ref.transaction(
        () => {
          return undefined;
        },
        (error, committed) => {
          if (error) {
            return reject(error);
          }

          if (!committed) {
            return resolve();
          }

          return reject(new Error('Transaction did not abort commit.'));
        },
      );
    });
  });

  it('passes valid data through the callback', async () => {
    const ref = firebase
      .database()
      .ref(TEST_PATH)
      .child('transaction');
    await ref.set(1);

    return new Promise((resolve, reject) => {
      ref.transaction(
        $ => {
          return $ + 1;
        },
        (error, committed, snapshot) => {
          if (error) {
            return reject(error);
          }

          if (!committed) {
            return reject(new Error('Transaction aborted when it should not have done'));
          }

          should.equal(snapshot.val(), 2);
          return resolve();
        },
      );
    });
  });

  it('throws when an error occurs', async () => {
    const ref = firebase.database().ref('nope');

    try {
      await ref.transaction($ => {
        return $ + 1;
      });
      return Promise.reject(new Error('Did not throw error.'));
    } catch (error) {
      error.message.should.containEql("Client doesn't have permission to access the desired data");
      return Promise.resolve();
    }
  });

  it('passes error back to the callback', async () => {
    const ref = firebase.database().ref('nope');

    return new Promise((resolve, reject) => {
      ref
        .transaction(
          $ => {
            return $ + 1;
          },
          (error, committed, snapshot) => {
            if (snapshot !== null) {
              return reject(new Error('Snapshot should not be available'));
            }

            if (committed === true) {
              return reject(new Error('Transaction should not have committed'));
            }

            error.message.should.containEql(
              "Client doesn't have permission to access the desired data",
            );
            return resolve();
          },
        )
        .catch(() => {
          // catch unhandled rejection
        });
    });
  });

  it('sets a value if one does not exist', async () => {
    const ref = firebase
      .database()
      .ref(TEST_PATH)
      .child('create');
    await ref.remove(); // Ensure it's clear

    const value = Date.now();

    return new Promise((resolve, reject) => {
      ref.transaction(
        $ => {
          if ($ === null) {
            return { foo: value };
          }

          throw new Error('Value should not exist');
        },
        (error, committed, snapshot) => {
          if (error) {
            return reject(error);
          }

          if (!committed) {
            return reject(new Error('Transaction should have committed'));
          }

          snapshot.val().should.eql(
            jet.contextify({
              foo: value,
            }),
          );
          return resolve();
        },
      );
    });
  });
});