ran-boilerplate/functions/node_modules/@firebase/util/test/errors.test.ts

React . Apollo (GraphQL) . Next.js Toolkit

/**
 * Copyright 2017 Google Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file 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.
 */
import { assert } from 'chai';
import { ErrorFactory, ErrorList, patchCapture } from '../src/errors';

type Err = 'generic-error' | 'file-not-found' | 'anon-replace';

let errors = {
  'generic-error': 'Unknown error',
  'file-not-found': "Could not find file: '{$file}'",
  'anon-replace': 'Hello, {$repl_}!'
} as ErrorList<Err>;

let error = new ErrorFactory<Err>('fake', 'Fake', errors);

describe('FirebaseError', () => {
  it('create', () => {
    let e = error.create('generic-error');
    assert.equal(e.code, 'fake/generic-error');
    assert.equal(e.message, 'Fake: Unknown error (fake/generic-error).');
  });

  it('String replacement', () => {
    let e = error.create('file-not-found', { file: 'foo.txt' });
    assert.equal(e.code, 'fake/file-not-found');
    assert.equal(
      e.message,
      "Fake: Could not find file: 'foo.txt' (fake/file-not-found)."
    );
    assert.equal((e as any).file, 'foo.txt');
  });

  it('Anonymous String replacement', () => {
    let e = error.create('anon-replace', { repl_: 'world' });
    assert.equal(e.code, 'fake/anon-replace');
    assert.equal(e.message, 'Fake: Hello, world! (fake/anon-replace).');
    assert.isUndefined((e as any).repl_);
  });

  it('Missing template', () => {
    // Cast to avoid compile-time error.
    let e = error.create(('no-such-code' as any) as Err);
    assert.equal(e.code, 'fake/no-such-code');
    assert.equal(e.message, 'Fake: Error (fake/no-such-code).');
  });

  it('Missing replacement', () => {
    let e = error.create('file-not-found', { fileX: 'foo.txt' });
    assert.equal(e.code, 'fake/file-not-found');
    assert.equal(
      e.message,
      "Fake: Could not find file: '<file?>' (fake/file-not-found)."
    );
  });
});

// Run the stack trace tests with, and without, Error.captureStackTrace
let realCapture = patchCapture();
stackTests(realCapture);
stackTests(undefined);

function stackTests(fakeCapture: any) {
  let saveCapture: any;

  describe(
    'Error#stack tests - Error.captureStackTrace is ' +
      (fakeCapture ? 'defined' : 'NOT defined'),
    () => {
      before(() => {
        saveCapture = patchCapture(fakeCapture);
      });

      after(() => {
        patchCapture(saveCapture);
      });

      it('has stack', () => {
        let e = error.create('generic-error');
        // Multi-line match trick - .* does not match \n
        assert.match(e.stack, /FirebaseError[\s\S]/);
      });

      it('stack frames', () => {
        try {
          dummy1();
          assert.ok(false);
        } catch (e) {
          assert.match(e.stack, /dummy2[\s\S]*?dummy1/);
        }
      });
    }
  );
}

function dummy1() {
  dummy2();
}

function dummy2() {
  let error = new ErrorFactory<Err>('dummy', 'Dummy', errors);
  throw error.create('generic-error');
}