deprecate-test.js

'use strict';

const { expect } = require('chai');
const { deprecate } = require('../../../lib/debug');

describe('deprecate', function () {
  it('it throws when the description argument is missing', function () {
    expect(() => {
      deprecate();
    }).to.throw('ASSERTION FAILED: When calling `deprecate`, you must provide a description as the first argument.');

    expect(() => {
      deprecate('');
    }).to.throw('ASSERTION FAILED: When calling `deprecate`, you must provide a description as the first argument.');
  });

  it('it throws when the condition argument is missing', function () {
    expect(() => {
      deprecate('description');
    }).to.throw('ASSERTION FAILED: When calling `deprecate`, you must provide a condition as the second argument.');
  });

  it('it throws when the options argument is missing', function () {
    expect(() => {
      deprecate('description', true);
    }).to.throw(
      'ASSERTION FAILED: When calling `deprecate`, you must provide an options object as the third argument. The options object must include the `for`, `id`, `since` and `until` options (`url` is optional).'
    );

    expect(() => {
      deprecate('description', undefined);
    }).to.throw(
      'ASSERTION FAILED: When calling `deprecate`, you must provide an options object as the third argument. The options object must include the `for`, `id`, `since` and `until` options (`url` is optional).'
    );

    expect(() => {
      deprecate('description', false, null);
    }).to.throw(
      'ASSERTION FAILED: When calling `deprecate`, you must provide an options object as the third argument. The options object must include the `for`, `id`, `since` and `until` options (`url` is optional).'
    );
  });

  it('it throws when the `for` option is missing', function () {
    expect(() => {
      deprecate('description', true, {});
    }).to.throw('ASSERTION FAILED: When calling `deprecate`, you must provide the `for` option.');
  });

  it('it throws when the `id` option is missing', function () {
    expect(() => {
      deprecate('description', true, {
        for: 'foo',
      });
    }).to.throw('ASSERTION FAILED: When calling `deprecate`, you must provide the `id` option.');
  });

  it('it throws when the `since` option is missing', function () {
    expect(() => {
      deprecate('description', true, {
        for: 'foo',
        id: 'foo',
      });
    }).to.throw(
      'ASSERTION FAILED: When calling `deprecate`, you must provide the `since` option. `since` must include the `available` and/or the `enabled` option.'
    );
  });

  it('it throws when both the `since.available` and `since.enabled` options are missing', function () {
    expect(() => {
      deprecate('description', true, {
        for: 'foo',
        id: 'foo',
        since: {},
      });
    }).to.throw(
      'ASSERTION FAILED: When calling `deprecate`, you must provide the `since.available` and/or the `since.enabled` option.'
    );
  });

  it('it throws when the `since.available` option is not a valid SemVer version', function () {
    expect(() => {
      deprecate('description', true, {
        for: 'foo',
        id: 'foo',
        since: {
          available: 'foo',
        },
      });
    }).to.throw('ASSERTION FAILED: `since.available` must be a valid SemVer version.');
  });

  it('it throws when the `since.enabled` option is not a valid SemVer version', function () {
    expect(() => {
      deprecate('description', true, {
        for: 'foo',
        id: 'foo',
        since: {
          enabled: 'foo',
        },
      });
    }).to.throw('ASSERTION FAILED: `since.enabled` must be a valid SemVer version.');
  });

  it('it throws when the `until` option is not a valid SemVer version', function () {
    expect(() => {
      deprecate('description', true, {
        for: 'foo',
        id: 'foo',
        since: {
          available: '4.0.0',
          enabled: '4.0.0',
        },
      });
    }).to.throw(
      'ASSERTION FAILED: When calling `deprecate`, you must provide a valid SemVer version for the `until` option.'
    );

    expect(() => {
      deprecate('description', true, {
        for: 'foo',
        id: 'foo',
        since: {
          available: '4.0.0',
          enabled: '4.0.0',
        },
        until: 'foo',
      });
    }).to.throw(
      'ASSERTION FAILED: When calling `deprecate`, you must provide a valid SemVer version for the `until` option.'
    );
  });

  it('it does nothing when the condition argument is truthy', function () {
    let message = deprecate('description', true, {
      for: 'foo',
      id: 'foo',
      since: {
        available: '4.0.0',
        enabled: '4.0.0',
      },
      until: '5.0.0',
    });

    expect(message).to.be.undefined;
  });

  it('it displays a deprecation message when the condition argument is falsy', function () {
    let message = deprecate('description', false, {
      for: 'foo',
      id: 'foo',
      since: {
        available: '4.0.0',
        enabled: '4.0.0',
      },
      until: '5.0.0',
    });

    expect(message).to.be.equal('DEPRECATION: description [ID: foo]');
  });

  it('it includes the `url` option in the deprecation message when provided', function () {
    let message = deprecate('description', false, {
      for: 'foo',
      id: 'foo',
      since: {
        available: '4.0.0',
        enabled: '4.0.0',
      },
      until: '5.0.0',
      url: 'https://example.com',
    });

    expect(message).to.be.equal('DEPRECATION: description [ID: foo] See https://example.com for more details.');
  });
});