nodeDatafileManager.spec.ts

/**
 * Copyright 2022, Optimizely
 *
 * 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 NodeDatafileManager from '../lib/modules/datafile-manager/nodeDatafileManager';
import * as nodeRequest from '../lib/modules/datafile-manager/nodeRequest';
import { Headers, AbortableRequest } from '../lib/modules/datafile-manager/http';
import { advanceTimersByTime, getTimerCount } from './testUtils';

describe('nodeDatafileManager', () => {
  let makeGetRequestSpy: jest.SpyInstance<AbortableRequest, [string, Headers]>;
  beforeEach(() => {
    jest.useFakeTimers();
    makeGetRequestSpy = jest.spyOn(nodeRequest, 'makeGetRequest');
  });

  afterEach(() => {
    jest.restoreAllMocks();
    jest.clearAllTimers();
  });

  it('calls nodeEnvironment.makeGetRequest when started', async () => {
    makeGetRequestSpy.mockReturnValue({
      abort: jest.fn(),
      responsePromise: Promise.resolve({
        statusCode: 200,
        body: '{"foo":"bar"}',
        headers: {},
      }),
    });

    const manager = new NodeDatafileManager({
      sdkKey: '1234',
      autoUpdate: false,
    });
    manager.start();
    expect(makeGetRequestSpy).toBeCalledTimes(1);
    expect(makeGetRequestSpy.mock.calls[0][0]).toBe('https://cdn.optimizely.com/datafiles/1234.json');
    expect(makeGetRequestSpy.mock.calls[0][1]).toEqual({});

    await manager.onReady();
    await manager.stop();
  });

  it('calls nodeEnvironment.makeGetRequest for live update requests', async () => {
    makeGetRequestSpy.mockReturnValue({
      abort: jest.fn(),
      responsePromise: Promise.resolve({
        statusCode: 200,
        body: '{"foo":"bar"}',
        headers: {
          'last-modified': 'Fri, 08 Mar 2019 18:57:17 GMT',
        },
      }),
    });
    const manager = new NodeDatafileManager({
      sdkKey: '1234',
      autoUpdate: true,
    });
    manager.start();
    await manager.onReady();
    await advanceTimersByTime(300000);
    expect(makeGetRequestSpy).toBeCalledTimes(2);
    expect(makeGetRequestSpy.mock.calls[1][0]).toBe('https://cdn.optimizely.com/datafiles/1234.json');
    expect(makeGetRequestSpy.mock.calls[1][1]).toEqual({
      'if-modified-since': 'Fri, 08 Mar 2019 18:57:17 GMT',
    });

    await manager.stop();
  });

  it('defaults to true for autoUpdate', async () => {
    makeGetRequestSpy.mockReturnValue({
      abort: jest.fn(),
      responsePromise: Promise.resolve({
        statusCode: 200,
        body: '{"foo":"bar"}',
        headers: {
          'last-modified': 'Fri, 08 Mar 2019 18:57:17 GMT',
        },
      }),
    });
    const manager = new NodeDatafileManager({
      sdkKey: '1234',
    });
    manager.start();
    await manager.onReady();
    // Should set a timeout for a later update
    expect(getTimerCount()).toBe(1);
    await advanceTimersByTime(300000);
    expect(makeGetRequestSpy).toBeCalledTimes(2);

    await manager.stop();
  });

  it('uses authenticated default datafile url when auth token is provided', async () => {
    makeGetRequestSpy.mockReturnValue({
      abort: jest.fn(),
      responsePromise: Promise.resolve({
        statusCode: 200,
        body: '{"foo":"bar"}',
        headers: {},
      }),
    });
    const manager = new NodeDatafileManager({
      sdkKey: '1234',
      datafileAccessToken: 'abcdefgh',
    });
    manager.start();
    expect(makeGetRequestSpy).toBeCalledTimes(1);
    expect(makeGetRequestSpy).toBeCalledWith(
      'https://config.optimizely.com/datafiles/auth/1234.json',
      expect.anything()
    );
    await manager.stop();
  });

  it('uses public default datafile url when auth token is not provided', async () => {
    makeGetRequestSpy.mockReturnValue({
      abort: jest.fn(),
      responsePromise: Promise.resolve({
        statusCode: 200,
        body: '{"foo":"bar"}',
        headers: {},
      }),
    });
    const manager = new NodeDatafileManager({
      sdkKey: '1234',
    });
    manager.start();
    expect(makeGetRequestSpy).toBeCalledTimes(1);
    expect(makeGetRequestSpy).toBeCalledWith('https://cdn.optimizely.com/datafiles/1234.json', expect.anything());
    await manager.stop();
  });

  it('adds authorization header with bearer token when auth token is provided', async () => {
    makeGetRequestSpy.mockReturnValue({
      abort: jest.fn(),
      responsePromise: Promise.resolve({
        statusCode: 200,
        body: '{"foo":"bar"}',
        headers: {},
      }),
    });
    const manager = new NodeDatafileManager({
      sdkKey: '1234',
      datafileAccessToken: 'abcdefgh',
    });
    manager.start();
    expect(makeGetRequestSpy).toBeCalledTimes(1);
    expect(makeGetRequestSpy).toBeCalledWith(expect.anything(), { Authorization: 'Bearer abcdefgh' });
    await manager.stop();
  });

  it('prefers user provided url template over defaults', async () => {
    makeGetRequestSpy.mockReturnValue({
      abort: jest.fn(),
      responsePromise: Promise.resolve({
        statusCode: 200,
        body: '{"foo":"bar"}',
        headers: {},
      }),
    });
    const manager = new NodeDatafileManager({
      sdkKey: '1234',
      datafileAccessToken: 'abcdefgh',
      urlTemplate: 'https://myawesomeurl/',
    });
    manager.start();
    expect(makeGetRequestSpy).toBeCalledTimes(1);
    expect(makeGetRequestSpy).toBeCalledWith('https://myawesomeurl/', expect.anything());
    await manager.stop();
  });

  it('passes custom headers to makeGetRequest and merges with system headers', async () => {
    makeGetRequestSpy.mockReturnValue({
      abort: jest.fn(),
      responsePromise: Promise.resolve({
        statusCode: 200,
        body: '{"foo":"bar"}',
        headers: {
          'last-modified': 'Fri, 08 Mar 2019 18:57:17 GMT',
        },
      }),
    });
    const manager = new NodeDatafileManager({
      sdkKey: '1234',
      autoUpdate: true,
      customHeaders: {
        'X-Custom-Header': 'custom-value',
        'X-Environment': 'production',
      },
    });
    manager.start();
    await manager.onReady();
    
    // First request should have custom headers
    expect(makeGetRequestSpy).toBeCalledTimes(1);
    expect(makeGetRequestSpy.mock.calls[0][0]).toBe('https://cdn.optimizely.com/datafiles/1234.json');
    expect(makeGetRequestSpy.mock.calls[0][1]).toEqual({
      'X-Custom-Header': 'custom-value',
      'X-Environment': 'production',
    });
    
    // Advance time to trigger second request
    await advanceTimersByTime(300000);
    
    // Second request should have both custom headers AND if-modified-since
    expect(makeGetRequestSpy).toBeCalledTimes(2);
    expect(makeGetRequestSpy.mock.calls[1][0]).toBe('https://cdn.optimizely.com/datafiles/1234.json');
    expect(makeGetRequestSpy.mock.calls[1][1]).toEqual({
      'X-Custom-Header': 'custom-value',
      'X-Environment': 'production',
      'if-modified-since': 'Fri, 08 Mar 2019 18:57:17 GMT',
    });
    
    await manager.stop();
  });
});