Stabilize the tracker reference to avoid duplicate events.

Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
This commit is contained in:
Eric Peterson
2021-09-16 15:31:34 +02:00
parent 1ff7386291
commit 11582dacc2
3 changed files with 58 additions and 23 deletions
@@ -99,8 +99,7 @@ const TrackNavigation = ({
useEffect(() => {
analytics.captureEvent('navigate', `${pathname}${search}${hash}`);
// eslint-disable-next-line react-hooks/exhaustive-deps
}, [pathname, search, hash]);
}, [analytics, pathname, search, hash]);
return null;
};
@@ -0,0 +1,51 @@
/*
* Copyright 2021 The Backstage Authors
*
* 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 { AnalyticsApi, AnalyticsEventAttributes } from '../apis';
import { AnalyticsContextValue } from './';
export class Tracker {
constructor(
private readonly analyticsApi: AnalyticsApi,
private context: AnalyticsContextValue = {},
) {}
setContext(context: AnalyticsContextValue) {
this.context = context;
}
captureEvent(
action: string,
subject: string,
{
value,
attributes,
}: { value?: number; attributes?: AnalyticsEventAttributes } = {},
) {
try {
this.analyticsApi.captureEvent({
action,
subject,
value,
attributes,
context: this.context,
});
} catch (e) {
// eslint-disable-next-line no-console
console.warn('Error during analytics event capture. %o', e);
}
}
}
@@ -15,31 +15,16 @@
*/
import { useAnalyticsContext } from './AnalyticsContext';
import {
analyticsApiRef,
AnalyticsTracker,
} from '../apis/definitions/AnalyticsApi';
import { useApi } from '../apis';
import { analyticsApiRef, AnalyticsTracker, useApi } from '../apis';
import { useRef } from 'react';
import { Tracker } from './Tracker';
function useTracker(): AnalyticsTracker {
const analyticsApi = useApi(analyticsApiRef);
const tracker = useRef(new Tracker(analyticsApi));
const context = useAnalyticsContext();
return {
captureEvent: (action, subject, { value, attributes } = {}) => {
try {
analyticsApi.captureEvent({
action,
subject,
value,
attributes,
context,
});
} catch (e) {
// eslint-disable-next-line no-console
console.warn('Error during analytics event capture. %o', e);
}
},
};
tracker.current.setContext(context);
return tracker.current;
}
/**