Skip to content

Commit bd198fe

Browse files
fadi-georgefadi-george
authored
Merge pull request #1355 from OneSignal/fadi/sdk-2916-web-sdk-email-prompt-doesnt-allow-an-email-subscription
Allow Adding Sms / Email before Login
2 parents 7013e9d + 55e9843 commit bd198fe

48 files changed

Lines changed: 823 additions & 611 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎__test__/constants/constants.ts‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
import { NotificationType } from 'src/shared/subscriptions/constants';
2+
13
export const APP_ID = '34fcbe85-278d-4fd2-a4ec-0f80e95072c5';
24

35
export const PUSH_TOKEN = 'https://fcm.googleapis.com/fcm/send/01010101010101';
@@ -13,3 +15,19 @@ export const SUB_ID_2 = '7777777777-8888888888-9999999999';
1315
export const SUB_ID_3 = '1010101010-1111111111-2222222222';
1416

1517
export const DEVICE_OS = '56';
18+
19+
export const BASE_IDENTITY = {
20+
properties: {
21+
language: 'en',
22+
timezone_id: 'America/Los_Angeles',
23+
},
24+
refresh_device_metadata: true,
25+
};
26+
27+
export const BASE_SUB = {
28+
device_model: '',
29+
device_os: '56',
30+
enabled: true,
31+
notification_types: NotificationType.Subscribed,
32+
sdk: __VERSION__,
33+
};

‎__test__/setupTests.ts‎

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
1+
import OneSignalApi from 'src/shared/api/OneSignalApi';
2+
import { ConfigIntegrationKind } from 'src/shared/config/constants';
13
import { clearAll } from 'src/shared/database/client';
24
import { DEFAULT_USER_AGENT } from './constants';
5+
import TestContext from './support/environment/TestContext';
36
import { server } from './support/mocks/server';
47

58
beforeAll(() =>
@@ -9,15 +12,15 @@ beforeAll(() =>
912
);
1013

1114
beforeEach(async () => {
12-
if (typeof OneSignal !== 'undefined') {
13-
OneSignal.coreDirector?.operationRepo.clear();
14-
OneSignal.emitter?.removeAllListeners();
15-
}
1615
await clearAll();
1716
});
1817

1918
afterEach(() => {
2019
server.resetHandlers();
20+
if (typeof OneSignal !== 'undefined') {
21+
OneSignal.coreDirector?.operationRepo.clear();
22+
OneSignal.emitter?.removeAllListeners();
23+
}
2124
});
2225

2326
afterAll(() => server.close());
@@ -44,3 +47,12 @@ Object.defineProperty(navigator, 'userAgent', {
4447
value: DEFAULT_USER_AGENT,
4548
writable: true,
4649
});
50+
51+
export const mockJsonp = () => {
52+
const serverConfig = TestContext.getFakeServerAppConfig(
53+
ConfigIntegrationKind.Custom,
54+
);
55+
vi.spyOn(OneSignalApi, 'jsonpLib').mockImplementation((_, fn) => {
56+
fn(null, serverConfig);
57+
});
58+
};

‎__test__/support/environment/TestEnvironment.ts‎

Lines changed: 19 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,46 @@
11
import { ONESIGNAL_ID } from '__test__/constants';
2+
import { mockJsonp } from '__test__/setupTests';
23
import type {
34
AppUserConfig,
45
ConfigIntegrationKindValue,
56
ServerAppConfig,
67
} from 'src/shared/config/types';
78
import type { RecursivePartial } from 'src/shared/context/types';
89
import { updateIdentityModel } from '../helpers/setup';
9-
import {
10-
initOSGlobals,
11-
stubDomEnvironment,
12-
stubNotification,
13-
} from './TestEnvironmentHelpers';
10+
import { initOSGlobals, stubNotification } from './TestEnvironmentHelpers';
1411

1512
export interface TestEnvironmentConfig {
1613
userConfig?: AppUserConfig;
17-
initOptions?: any;
1814
initUserAndPushSubscription?: boolean; // default: false - initializes User & PushSubscription in UserNamespace (e.g. creates an anonymous user)
19-
environment?: string;
2015
permission?: NotificationPermission;
2116
addPrompts?: boolean;
2217
url?: string;
23-
userAgent?: string;
2418
overrideServerConfig?: RecursivePartial<ServerAppConfig>;
2519
integration?: ConfigIntegrationKindValue;
26-
useMockedIdentity?: boolean;
2720
}
21+
Object.defineProperty(document, 'readyState', {
22+
value: 'complete',
23+
writable: true,
24+
});
2825

2926
export class TestEnvironment {
30-
static async initialize(config: TestEnvironmentConfig = {}) {
31-
// reset db & localStorage
32-
// await clearAll();
33-
const oneSignal = await initOSGlobals(config);
27+
static initialize(config: TestEnvironmentConfig = {}) {
28+
mockJsonp();
29+
const oneSignal = initOSGlobals(config);
3430
OneSignal.coreDirector.operationRepo.queue = [];
3531

36-
// if (config.useMockedIdentity) {
3732
updateIdentityModel('onesignal_id', ONESIGNAL_ID);
38-
// }
3933

40-
await stubDomEnvironment(config);
41-
config.environment = 'dom';
34+
// Set URL if provided
35+
if (config.url) {
36+
Object.defineProperty(window, 'location', {
37+
value: new URL(config.url),
38+
writable: true,
39+
});
40+
}
41+
42+
window.isSecureContext = true;
43+
4244
stubNotification(config);
4345
return oneSignal;
4446
}

‎__test__/support/environment/TestEnvironmentHelpers.ts‎

Lines changed: 5 additions & 82 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,23 @@
1-
import { type DOMWindow, JSDOM, ResourceLoader } from 'jsdom';
21
import CoreModule from 'src/core/CoreModule';
32
import { SubscriptionModel } from 'src/core/models/SubscriptionModel';
43
import { ModelChangeTags } from 'src/core/types/models';
5-
import { db } from 'src/shared/database/client';
64
import { setPushToken } from 'src/shared/database/subscription';
7-
import {
8-
NotificationType,
9-
SubscriptionType,
10-
} from 'src/shared/subscriptions/constants';
5+
import { SubscriptionType } from 'src/shared/subscriptions/constants';
116
import { CoreModuleDirector } from '../../../src/core/CoreModuleDirector';
127
import NotificationsNamespace from '../../../src/onesignal/NotificationsNamespace';
138
import OneSignal from '../../../src/onesignal/OneSignal';
149
import { ONESIGNAL_EVENTS } from '../../../src/onesignal/OneSignalEvents';
1510
import UserNamespace from '../../../src/onesignal/UserNamespace';
1611
import Context from '../../../src/page/models/Context';
17-
import { getSlidedownElement } from '../../../src/page/slidedown/SlidedownElement';
1812
import Emitter from '../../../src/shared/libraries/Emitter';
19-
import { CUSTOM_LINK_CSS_CLASSES } from '../../../src/shared/slidedown/constants';
20-
import {
21-
DEFAULT_USER_AGENT,
22-
DEVICE_OS,
23-
ONESIGNAL_ID,
24-
SUB_ID_3,
25-
} from '../../constants';
13+
import { BASE_SUB, ONESIGNAL_ID, SUB_ID_3 } from '../../constants';
2614
import MockNotification from '../mocks/MockNotification';
2715
import TestContext from './TestContext';
2816
import { type TestEnvironmentConfig } from './TestEnvironment';
2917

3018
declare const global: any;
3119

32-
export async function initOSGlobals(config: TestEnvironmentConfig = {}) {
20+
export function initOSGlobals(config: TestEnvironmentConfig = {}) {
3321
global.OneSignal = OneSignal;
3422
global.OneSignal.EVENTS = ONESIGNAL_EVENTS;
3523
global.OneSignal.config = TestContext.getFakeMergedConfig(config);
@@ -53,60 +41,6 @@ export function stubNotification(config: TestEnvironmentConfig) {
5341
global.Notification.permission = config.permission
5442
? config.permission
5543
: global.Notification.permission;
56-
57-
// window is only defined in dom environment, not in SW
58-
if (config.environment === 'dom') {
59-
global.window.Notification = global.Notification;
60-
}
61-
}
62-
63-
export async function stubDomEnvironment(config: TestEnvironmentConfig) {
64-
if (!config) {
65-
config = {};
66-
}
67-
68-
let url = 'https://localhost:3001/webpush/sandbox?https=1';
69-
70-
if (config.url) {
71-
url = config.url.toString();
72-
global.location = url;
73-
}
74-
75-
let html = '<!doctype html><html><head></head><body></body></html>';
76-
77-
if (config.addPrompts) {
78-
html = `<!doctype html><html><head>\
79-
<div class="${CUSTOM_LINK_CSS_CLASSES.containerClass}"></div>\
80-
<div class="${CUSTOM_LINK_CSS_CLASSES.containerClass}"></div>\
81-
</head><body>\
82-
${getSlidedownElement({}).outerHTML}</div></body></html>`;
83-
}
84-
85-
const resourceLoader = new ResourceLoader({
86-
userAgent: config.userAgent
87-
? config.userAgent.toString()
88-
: DEFAULT_USER_AGENT.toString(),
89-
});
90-
91-
// global document object must be defined for `getSlidedownElement` to work correctly.
92-
// this line initializes the document object
93-
const dom = new JSDOM(html, {
94-
resources: resourceLoader,
95-
url: url,
96-
contentType: 'text/html',
97-
runScripts: 'dangerously',
98-
pretendToBeVisual: true,
99-
});
100-
101-
const windowDef = dom.window;
102-
(windowDef as any).location = url;
103-
104-
const windowTop: DOMWindow = windowDef;
105-
dom.reconfigure({ url, windowTop });
106-
global.window = windowDef;
107-
global.window.isSecureContext = true;
108-
global.document = windowDef.document;
109-
return dom;
11044
}
11145

11246
export const createPushSub = ({
@@ -120,14 +54,10 @@ export const createPushSub = ({
12054
} = {}) => {
12155
const pushSubscription = new SubscriptionModel();
12256
pushSubscription.initializeFromJson({
123-
device_model: '',
124-
device_os: DEVICE_OS,
125-
enabled: true,
57+
...BASE_SUB,
12658
id,
127-
notification_types: NotificationType.Subscribed,
12859
onesignalId,
12960
token,
130-
sdk: __VERSION__,
13161
type: SubscriptionType.ChromePush,
13262
});
13363
return pushSubscription;
@@ -160,15 +90,8 @@ export const setupSubModelStore = async ({
16090
await setPushToken(pushModel.token);
16191
OneSignal.coreDirector.subscriptionModelStore.replaceAll(
16292
[pushModel],
163-
ModelChangeTags.NO_PROPOGATE,
93+
ModelChangeTags.NO_PROPAGATE,
16494
);
16595

166-
await vi.waitUntil(async () => {
167-
const subscription = (await db.getAll('subscriptions'))[0];
168-
return (
169-
subscription.id === pushModel.id && subscription.token === pushModel.token
170-
);
171-
});
172-
17396
return pushModel;
17497
};

‎__test__/support/helpers/requests.ts‎

Lines changed: 23 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,21 @@
11
import { http, HttpResponse } from 'msw';
22
import type { ISubscription, IUserProperties } from 'src/core/types/api';
3-
import { ConfigIntegrationKind } from 'src/shared/config/constants';
3+
import type { NotificationIcons } from 'src/shared/notifications/types';
44
import { APP_ID, ONESIGNAL_ID, SUB_ID } from '../../constants';
5-
import TestContext from '../environment/TestContext';
65
import { server } from '../mocks/server';
76

87
// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
98
// configs
10-
const serverConfig = TestContext.getFakeServerAppConfig(
11-
ConfigIntegrationKind.Custom,
12-
);
13-
14-
export const mockServerConfig = () => {
15-
return http.get('**/sync/*/web', ({ request }) => {
16-
const url = new URL(request.url);
17-
const callbackParam = url.searchParams.get('callback');
18-
return new HttpResponse(
19-
`${callbackParam}(${JSON.stringify(serverConfig)})`,
20-
{
21-
headers: {
22-
'Content-Type': 'application/javascript',
23-
},
24-
},
25-
);
26-
});
27-
};
289
export const mockPageStylesCss = () => {
29-
return http.get(
30-
'https://onesignal.com/sdks/web/v16/OneSignalSDK.page.styles.css',
31-
() => {
32-
return new HttpResponse('/* CSS */', {
33-
headers: { 'Content-Type': 'text/css' },
34-
});
35-
},
10+
server.use(
11+
http.get(
12+
'https://onesignal.com/sdks/web/v16/OneSignalSDK.page.styles.css',
13+
() => {
14+
return new HttpResponse('/* CSS */', {
15+
headers: { 'Content-Type': 'text/css' },
16+
});
17+
},
18+
),
3619
);
3720
};
3821

@@ -397,3 +380,16 @@ export const setSendCustomEventResponse = () =>
397380
status: 200,
398381
callback: sendCustomEventFn,
399382
});
383+
384+
// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
385+
// icons
386+
export const getNotificationIcons = () =>
387+
server.use(
388+
http.get('**/apps/:appId/icon', () => {
389+
return HttpResponse.json<NotificationIcons>({
390+
chrome: 'https://onesignal.com/icon.png',
391+
firefox: 'https://onesignal.com/icon.png',
392+
safari: 'https://onesignal.com/icon.png',
393+
});
394+
}),
395+
);

0 commit comments

Comments
 (0)