Skip to content

stub storage differently so tests work in Firefox and IE #1940

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jul 9, 2019
Merged

stub storage differently so tests work in Firefox and IE #1940

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
bfbaf87
stub storage differently so tests work in Firefox and IE
Feiyang1 Jul 3, 2019
ff0c108
[AUTOMATED]: Prettier Code Styling
Feiyang1 Jul 3, 2019
3cd4fd5
rewrite test setup
Feiyang1 Jul 8, 2019
450bbc8
[AUTOMATED]: Prettier Code Styling
Feiyang1 Jul 8, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
128 changes: 80 additions & 48 deletions packages/performance/src/services/remote_config_service.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,11 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { stub, SinonStub, useFakeTimers, SinonFakeTimers } from 'sinon';
import { stub, useFakeTimers, SinonFakeTimers, SinonStub } from 'sinon';
import { expect } from 'chai';
import { SettingsService } from './settings_service';
import { CONFIG_EXPIRY_LOCAL_STORAGE_KEY } from '../constants';
import { setupApi } from './api_service';
import { setupApi, Api } from './api_service';
import * as iidService from './iid_service';
import { getConfig } from './remote_config_service';
import { FirebaseApp } from '@firebase/app-types';
Expand All @@ -41,11 +41,10 @@ describe('Performance Monitoring > remote_config_service', () => {
const APP_ID = '1:23r:web:fewq';
const API_KEY = 'asdfghjk';

let fetchStub: SinonStub<[RequestInfo, RequestInit?], Promise<Response>>;
let storageGetItemStub: SinonStub<[string], string | null>;
let clock: SinonFakeTimers;

setupApi(self);
const ApiInstance = Api.getInstance();

function storageGetItemFakeFactory(
expiry: string,
Expand All @@ -67,17 +66,47 @@ describe('Performance Monitoring > remote_config_service', () => {
settingsService.tracesSamplingRate = 1;
}

beforeEach(() => {
fetchStub = stub(self, 'fetch');
storageGetItemStub = stub(self.localStorage, 'getItem');
// parameterized beforeEach. Should be called at beginning of each test.
function setup(
storageConfig: { expiry: string; config: string },
fetchConfig?: { reject: boolean; value?: Response }
): {
storageGetItemStub: SinonStub<[string], string | null>;
fetchStub: SinonStub<[RequestInfo, RequestInit?], Promise<Response>>;
} {
const fetchStub = stub(self, 'fetch');

if (fetchConfig) {
fetchConfig.reject
? fetchStub.rejects()
: fetchStub.resolves(fetchConfig.value);
}

stub(iidService, 'getAuthTokenPromise').returns(
Promise.resolve(AUTH_TOKEN)
);

clock = useFakeTimers(GLOBAL_CLOCK_NOW);
SettingsService.prototype.firebaseAppInstance = ({
options: { projectId: PROJECT_ID, appId: APP_ID, apiKey: API_KEY }
} as unknown) as FirebaseApp;
});

// we need to stub the entire localStorage, because storage can't be stubbed in Firefox and IE.
// stubbing on self(window) seems to only work the first time (at least in Firefox), the subsequent
// tests will have the same stub. stub.reset() in afterEach doesn't help either. As a result, we stub on ApiInstance.
// https://github.com/sinonjs/sinon/issues/662
const storageStub = stub(ApiInstance, 'localStorage');
const getItemStub: SinonStub<[string], string | null> = stub();

storageStub.value({
getItem: getItemStub.callsFake(
storageGetItemFakeFactory(storageConfig.expiry, storageConfig.config)
),
setItem: () => {}
});

return { storageGetItemStub: getItemStub, fetchStub };
}

afterEach(() => {
resetSettingsService();
Expand All @@ -88,15 +117,14 @@ describe('Performance Monitoring > remote_config_service', () => {
it('gets the config from the local storage if available and valid', async () => {
// After global clock. Config not expired.
const EXPIRY_LOCAL_STORAGE_VALUE = '1556524895330';
storageGetItemStub.callsFake(
storageGetItemFakeFactory(
EXPIRY_LOCAL_STORAGE_VALUE,
STRINGIFIED_CONFIG
)
);
const { storageGetItemStub: getItemStub } = setup({
expiry: EXPIRY_LOCAL_STORAGE_VALUE,
config: STRINGIFIED_CONFIG
});

await getConfig(IID);

expect(storageGetItemStub).to.be.called;
expect(getItemStub).to.be.called;
expect(SettingsService.getInstance().loggingEnabled).to.be.true;
expect(SettingsService.getInstance().logEndPointUrl).to.equal(LOG_URL);
expect(SettingsService.getInstance().logSource).to.equal(LOG_SOURCE);
Expand All @@ -111,12 +139,12 @@ describe('Performance Monitoring > remote_config_service', () => {
it('does not call remote config if a valid config is in local storage', async () => {
// After global clock. Config not expired.
const EXPIRY_LOCAL_STORAGE_VALUE = '1556524895330';
storageGetItemStub.callsFake(
storageGetItemFakeFactory(
EXPIRY_LOCAL_STORAGE_VALUE,
STRINGIFIED_CONFIG
)
);

const { fetchStub } = setup({
expiry: EXPIRY_LOCAL_STORAGE_VALUE,
config: STRINGIFIED_CONFIG
});

await getConfig(IID);

expect(fetchStub).not.to.be.called;
Expand All @@ -125,16 +153,15 @@ describe('Performance Monitoring > remote_config_service', () => {
it('gets the config from RC if local version is not valid', async () => {
// Expired local config.
const EXPIRY_LOCAL_STORAGE_VALUE = '1556524895320';
storageGetItemStub.callsFake(
storageGetItemFakeFactory(
EXPIRY_LOCAL_STORAGE_VALUE,
'not a valid config and should not be used'
)

const { storageGetItemStub: getItemStub } = setup(
{ expiry: EXPIRY_LOCAL_STORAGE_VALUE, config: STRINGIFIED_CONFIG },
{ reject: false, value: new Response(STRINGIFIED_CONFIG) }
);
fetchStub.resolves(new Response(STRINGIFIED_CONFIG));

await getConfig(IID);

expect(storageGetItemStub).to.be.calledOnce;
expect(getItemStub).to.be.calledOnce;
expect(SettingsService.getInstance().loggingEnabled).to.be.true;
expect(SettingsService.getInstance().logEndPointUrl).to.equal(LOG_URL);
expect(SettingsService.getInstance().logSource).to.equal(LOG_SOURCE);
Expand All @@ -149,13 +176,15 @@ describe('Performance Monitoring > remote_config_service', () => {
it('does not change the default config if call to RC fails', async () => {
// Expired local config.
const EXPIRY_LOCAL_STORAGE_VALUE = '1556524895320';
storageGetItemStub.callsFake(
storageGetItemFakeFactory(
EXPIRY_LOCAL_STORAGE_VALUE,
'not a valid config and should not be used'
)

setup(
{
expiry: EXPIRY_LOCAL_STORAGE_VALUE,
config: 'not a valid config and should not be used'
},
{ reject: true }
);
fetchStub.rejects();

await getConfig(IID);

expect(SettingsService.getInstance().loggingEnabled).to.equal(false);
Expand All @@ -164,17 +193,19 @@ describe('Performance Monitoring > remote_config_service', () => {
it('uses secondary configs if the response does not have all the fields', async () => {
// Expired local config.
const EXPIRY_LOCAL_STORAGE_VALUE = '1556524895320';
storageGetItemStub.callsFake(
storageGetItemFakeFactory(
EXPIRY_LOCAL_STORAGE_VALUE,
'not a valid config and should not be used'
)
);
const STRINGIFIED_PARTIAL_CONFIG = `{"entries":{\
"fpr_vc_network_request_sampling_rate":"0.250000",\
"fpr_vc_session_sampling_rate":"0.250000","fpr_vc_trace_sampling_rate":"0.500000"},\
"state":"UPDATE"}`;
fetchStub.resolves(new Response(STRINGIFIED_PARTIAL_CONFIG));

setup(
{
expiry: EXPIRY_LOCAL_STORAGE_VALUE,
config: 'not a valid config and should not be used'
},
{ reject: false, value: new Response(STRINGIFIED_PARTIAL_CONFIG) }
);

await getConfig(IID);

expect(SettingsService.getInstance().loggingEnabled).to.be.true;
Expand All @@ -183,14 +214,15 @@ describe('Performance Monitoring > remote_config_service', () => {
it('uses secondary configs if the response does not have any fields', async () => {
// Expired local config.
const EXPIRY_LOCAL_STORAGE_VALUE = '1556524895320';
storageGetItemStub.callsFake(
storageGetItemFakeFactory(
EXPIRY_LOCAL_STORAGE_VALUE,
'not a valid config and should not be used'
)
);
const STRINGIFIED_PARTIAL_CONFIG = '{"state":"NO TEMPLATE"}';
fetchStub.resolves(new Response(STRINGIFIED_PARTIAL_CONFIG));

setup(
{
expiry: EXPIRY_LOCAL_STORAGE_VALUE,
config: 'not a valid config and should not be used'
},
{ reject: false, value: new Response(STRINGIFIED_PARTIAL_CONFIG) }
);
await getConfig(IID);

expect(SettingsService.getInstance().loggingEnabled).to.be.true;
Expand Down