Skip to content

Make event params optional in logEvent #2226

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.

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 2 commits into from
Oct 1, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion packages/analytics-types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ export interface FirebaseAnalytics {
*/
logEvent(
eventName: EventNameString,
eventParams: EventParams,
eventParams?: EventParams,
options?: AnalyticsCallOptions
): void;

Expand Down
24 changes: 24 additions & 0 deletions packages/analytics/src/functions.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,18 @@ describe('FirebaseAnalytics methods', () => {
);
});

it('logEvent() with no event params calls gtag function correctly', () => {
logEvent(gtagStub, analyticsId, EventName.VIEW_ITEM);

expect(gtagStub).to.have.been.calledWith(
GtagCommand.EVENT,
EventName.VIEW_ITEM,
{
'send_to': analyticsId
}
);
});

it('logEvent() globally calls gtag function correctly', () => {
logEvent(
gtagStub,
Expand All @@ -71,6 +83,18 @@ describe('FirebaseAnalytics methods', () => {
);
});

it('logEvent() with no event params globally calls gtag function correctly', () => {
logEvent(gtagStub, analyticsId, EventName.ADD_TO_CART, undefined, {
global: true
});

expect(gtagStub).to.have.been.calledWith(
GtagCommand.EVENT,
EventName.ADD_TO_CART,
{}
);
});

it('setCurrentScreen() calls gtag correctly (instance)', async () => {
setCurrentScreen(gtagStub, analyticsId, 'home');
expect(gtagStub).to.have.been.calledWith(GtagCommand.CONFIG, analyticsId, {
Expand Down
4 changes: 2 additions & 2 deletions packages/analytics/src/functions.ts
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,10 @@ export function logEvent(
gtagFunction: Gtag,
analyticsId: string,
eventName: string,
eventParams: EventParams,
eventParams?: EventParams,
options?: AnalyticsCallOptions
): void {
let params: EventParams | ControlParams = eventParams;
let params: EventParams | ControlParams = eventParams || {};
if (!options || !options.global) {
params = { ...eventParams, 'send_to': analyticsId };
}
Expand Down
2 changes: 1 addition & 1 deletion packages/firebase/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4298,7 +4298,7 @@ declare namespace firebase.analytics {
*/
logEvent<T extends string>(
eventName: CustomEventName<T>,
eventParams: { [key: string]: any },
eventParams?: { [key: string]: any },
options?: firebase.analytics.AnalyticsCallOptions
): void;

Expand Down