serverless/test/unit/lib/utils/logDeprecation.test.js

'use strict';

const sandbox = require('sinon');
const expect = require('chai').expect;
const overrideEnv = require('process-utils/override-env');
const overrideStdoutWrite = require('process-utils/override-stdout-write');
const runServerless = require('../../../utils/run-serverless');
const ServerlessError = require('../../../../lib/serverless-error');

describe('test/unit/lib/utils/logDeprecation.test.js', () => {
  let restoreEnv;
  let originalEnv;

  beforeEach(() => {
    delete require.cache[require.resolve('../../../../lib/utils/logDeprecation')];
    ({ originalEnv, restoreEnv } = overrideEnv({
      whitelist: ['APPDATA', 'HOME', 'PATH', 'TEMP', 'TMP', 'TMPDIR', 'USERPROFILE'],
    }));
  });

  afterEach(() => {
    sandbox.restore();
    restoreEnv();
  });

  it('should log deprecation message if not disabled and first time', () => {
    const logDeprecation = require('../../../../lib/utils/logDeprecation');
    logDeprecation.defaultMode = 'warn';
    let stdoutData = '';
    overrideStdoutWrite(
      (data) => (stdoutData += data),
      () => logDeprecation('CODE1', 'Start using deprecation log')
    );
    expect(stdoutData).to.include('Start using deprecation log');

    expect(stdoutData).to.include('Deprecation warning');
    expect(stdoutData).to.include('https://www.serverless.com/framework/docs/deprecations/#CODE1');
  });

  it('should not log deprecation if disabled in env.SLS_DEPRECATION_DISABLE', () => {
    process.env.SLS_DEPRECATION_DISABLE = 'CODE1';
    const logDeprecation = require('../../../../lib/utils/logDeprecation');

    let stdoutData = '';
    overrideStdoutWrite(
      (data) => (stdoutData += data),
      () => logDeprecation('CODE1', 'Start using deprecation log')
    );
    expect(stdoutData).to.equal('');
  });

  it('should not log deprecation if disabled in serviceConfig', () => {
    // We need original process env variables for npm-conf
    Object.assign(process.env, originalEnv);
    const logDeprecation = require('../../../../lib/utils/logDeprecation');
    return runServerless({
      fixture: 'function',
      configExt: { disabledDeprecations: ['CODE1'] },
      command: 'package',
    }).then(({ serverless }) => {
      const serviceConfig = serverless.service;
      let stdoutData = '';
      overrideStdoutWrite(
        (data) => (stdoutData += data),
        () => logDeprecation('CODE1', 'Start using deprecation log', { serviceConfig })
      );
      expect(stdoutData).to.equal('');
    });
  });

  it('should not log deprecation if disabled by wildcard in env', () => {
    process.env.SLS_DEPRECATION_DISABLE = '*';
    const logDeprecation = require('../../../../lib/utils/logDeprecation');
    let stdoutData = '';
    overrideStdoutWrite(
      (data) => (stdoutData += data),
      () => logDeprecation('CODE1', 'Start using deprecation log')
    );
    expect(stdoutData).to.equal('');
  });

  it('should not log deprecation if disabled by wildcard in service config', () => {
    Object.assign(process.env, originalEnv);
    const logDeprecation = require('../../../../lib/utils/logDeprecation');
    return runServerless({
      fixture: 'function',
      configExt: { disabledDeprecations: '*' },
      command: 'package',
    }).then(({ serverless }) => {
      const serviceConfig = serverless.service;
      let stdoutData = '';
      overrideStdoutWrite(
        (data) => (stdoutData += data),
        () => logDeprecation('CODE1', 'Start using deprecation log', { serviceConfig })
      );
      expect(stdoutData).to.equal('');
    });
  });

  it('should throw on deprecation if env.SLS_DEPRECATION_NOTIFICATION_MODE=error', () => {
    process.env.SLS_DEPRECATION_NOTIFICATION_MODE = 'error';
    const logDeprecation = require('../../../../lib/utils/logDeprecation');
    expect(() => logDeprecation('CODE1', 'Start using deprecation log'))
      .to.throw(ServerlessError)
      .with.property('code', 'REJECTED_DEPRECATION_CODE1');
  });

  it('should throw on deprecation if error notifications mode set in service config', () => {
    const logDeprecation = require('../../../../lib/utils/logDeprecation');
    expect(() =>
      logDeprecation('CODE1', 'Start using deprecation log', {
        serviceConfig: { deprecationNotificationMode: 'error' },
      })
    )
      .to.throw(ServerlessError)
      .with.property('code', 'REJECTED_DEPRECATION_CODE1');
  });

  it('should not log deprecation twice', () => {
    let stdoutData = '';
    overrideStdoutWrite(
      (data) => (stdoutData += data),
      () => {
        const logDeprecation = require('../../../../lib/utils/logDeprecation');
        logDeprecation.defaultMode = 'warn';
        logDeprecation('CODE1', 'Start using deprecation log');
        expect(stdoutData).to.include('Start using deprecation log');
        stdoutData = '';
        logDeprecation('CODE1', 'Start using deprecation log');
      }
    );
    expect(stdoutData).to.equal('');
  });

  it('should expose working `flushBuffered` method', () => {
    let stdoutData = '';
    overrideStdoutWrite(
      (data) => (stdoutData += data),
      () => {
        const logDeprecation = require('../../../../lib/utils/logDeprecation');
        logDeprecation('CODE1', 'First deprecation');
        expect(stdoutData).to.not.include('First deprecation');
        logDeprecation('CODE2', 'Second deprecation');
        expect(stdoutData).to.not.include('Second deprecation');
        logDeprecation.flushBuffered();
      }
    );
    expect(stdoutData).to.include('First deprecation');
    expect(stdoutData).to.include('Second deprecation');
  });

  it('should expose working `printSummary` method', async () => {
    let stdoutData = '';
    await overrideStdoutWrite(
      (data) => (stdoutData += data),
      async () => {
        const logDeprecation = require('../../../../lib/utils/logDeprecation');
        logDeprecation('CODE1', 'First deprecation');
        expect(stdoutData).to.not.include('First deprecation');
        logDeprecation('CODE2', 'Second deprecation');
        expect(stdoutData).to.not.include('Second deprecation');
        await logDeprecation.printSummary();
      }
    );
    expect(stdoutData).to.include('First deprecation');
    expect(stdoutData).to.include('Second deprecation');
  });
});