feat: deprecate endPaint, remove start and end apis (#248)

lkuangPR · lkuangAlt · web-flow · commit f07e8a3134ba · 2023-11-09T16:14:56.000-08:00
Co-authored-by: Lawrence Kuang &lt;lawrence.kuang@coinbase.com&gt;
diff --git a/__tests__/steps/markStep.spec.ts b/__tests__/steps/markStep.spec.ts
@@ -7,7 +7,7 @@ import * as log from '../../src/log';
 import { metrics } from '../../src/metrics';
 import * as observe from '../../src/observe';
 import { visibility } from '../../src/onVisibilityChange';
-import { clear, end, endPaint, start } from '../../src/steps/markStep';
+import { clear, end, start } from '../../src/steps/markStep';
 import mock from './../_mock';
 
 describe('Perfume', () => {
@@ -81,20 +81,6 @@ describe('Perfume', () => {
     });
   });
 
-  // TODO Fix this test or just deprecate by deprecating end()
-  //describe('endPaint()', () => {
-  //  beforeEach(() => {
-  //    jest.useFakeTimers();
-  //  });
-  //
-  //  it('should call end() after the first setTimeout', () => {
-  //    spy = jest.spyOn(perfume, 'end');
-  //    endPaint('test');
-  //    jest.runAllTimers();
-  //    expect(spy.mock.calls.length).toEqual(1);
-  //  });
-  //});
-
   describe('clear()', () => {
     beforeEach(() => {
       jest.useFakeTimers();
diff --git a/src/perfume.ts b/src/perfume.ts
@@ -1,16 +1,7 @@
 import { initPerfume } from './initPerfume';
 
-import { clear, end, endPaint, markStep, start } from './steps/markStep';
+import { clear, markStep } from './steps/markStep';
 import { markStepOnce } from './steps/markStepOnce';
 import { trackUJNavigation } from './steps/navigationSteps';
 
-export {
-  clear,
-  end,
-  endPaint,
-  initPerfume,
-  markStep,
-  markStepOnce,
-  trackUJNavigation,
-  start,
-};
+export { clear, initPerfume, markStep, markStepOnce, trackUJNavigation };
diff --git a/src/steps/markStep.ts b/src/steps/markStep.ts
@@ -24,7 +24,7 @@ export const markStep = (mark: string) => {
 };
 
 // --------------------- TMP Location Before Deprecation -----------------
-// For start(), end(), endPaint(), clear()
+// For start(), end(), clear()
 
 /**
  * Start performance measurement
@@ -54,15 +54,6 @@ export const start = (markName: string): void => {
   }
 }
 
-/**
- * End performance measurement after first paint from the beging of it
- */
- export const endPaint = (markName: string, customProperties?: object): void => {
-  setTimeout(() => {
-    end(markName, customProperties);
-  });
-}
-
 /**
  * Removes the named mark from the browser's performance entry buffer.
  */
