Skip to content

Commit

Permalink
Add PerformanceEventTiming API, according to the standard
Browse files Browse the repository at this point in the history
Summary:
Changelog: [Internal]

This adds definition of `PerformanceEventTiming` interface, according to the W3C standard, so that [event timing](https://www.w3.org/TR/event-timing) data can be reported from native (the C++ part is in the next diff).

See here: https://www.w3.org/TR/event-timing/#performanceeventtiming

Reviewed By: christophpurrer

Differential Revision: D42279486

fbshipit-source-id: 0dfbcd6e5a08fc1b89651bd35b24fb4e731f8b05
  • Loading branch information
rshest authored and facebook-github-bot committed Dec 29, 2022
1 parent 988a231 commit afd954e
Show file tree
Hide file tree
Showing 4 changed files with 111 additions and 44 deletions.
4 changes: 2 additions & 2 deletions Libraries/WebPerformance/Performance.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@
* @flow strict
*/

import type {HighResTimeStamp} from './PerformanceObserver';
import type {HighResTimeStamp} from './PerformanceEntry';

import warnOnce from '../Utilities/warnOnce';
import NativePerformance from './NativePerformance';
import {PerformanceEntry} from './PerformanceObserver';
import {PerformanceEntry} from './PerformanceEntry';

type DetailType = mixed;

Expand Down
45 changes: 45 additions & 0 deletions Libraries/WebPerformance/PerformanceEntry.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
/**
* Copyright (c) Meta Platforms, Inc. and affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*
* @format
* @flow strict
*/

export type HighResTimeStamp = number;
export type PerformanceEntryType = 'mark' | 'measure' | 'event' | 'first-input';

export class PerformanceEntry {
name: string;
entryType: PerformanceEntryType;
startTime: HighResTimeStamp;
duration: HighResTimeStamp;

constructor(init: {
name: string,
entryType: PerformanceEntryType,
startTime: HighResTimeStamp,
duration: HighResTimeStamp,
}) {
this.name = init.name;
this.entryType = init.entryType;
this.startTime = init.startTime;
this.duration = init.duration;
}

toJSON(): {
name: string,
entryType: PerformanceEntryType,
startTime: HighResTimeStamp,
duration: HighResTimeStamp,
} {
return {
name: this.name,
entryType: this.entryType,
startTime: this.startTime,
duration: this.duration,
};
}
}
39 changes: 39 additions & 0 deletions Libraries/WebPerformance/PerformanceEventTiming.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
/**
* Copyright (c) Meta Platforms, Inc. and affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*
* @format
* @flow strict
*/

import type {HighResTimeStamp} from './PerformanceEntry';

import {PerformanceEntry} from './PerformanceEntry';

export class PerformanceEventTiming extends PerformanceEntry {
processingStart: HighResTimeStamp;
processingEnd: HighResTimeStamp;
interactionId: number;

constructor(init: {
name: string,
startTime?: HighResTimeStamp,
duration?: HighResTimeStamp,
processingStart?: HighResTimeStamp,
processingEnd?: HighResTimeStamp,
interactionId?: number,
isFirstInput?: boolean,
}) {
super({
name: init.name,
entryType: init.isFirstInput === true ? 'first-input' : 'measure',
startTime: init.startTime ?? 0,
duration: init.duration ?? 0,
});
this.processingStart = init.processingStart ?? 0;
this.processingEnd = init.processingEnd ?? 0;
this.interactionId = init.interactionId ?? 0;
}
}
67 changes: 25 additions & 42 deletions Libraries/WebPerformance/PerformanceObserver.js
Original file line number Diff line number Diff line change
Expand Up @@ -12,47 +12,14 @@ import type {
RawPerformanceEntry,
RawPerformanceEntryType,
} from './NativePerformanceObserver';
import type {PerformanceEntryType} from './PerformanceEntry';

import warnOnce from '../Utilities/warnOnce';
import NativePerformanceObserver, {
RawPerformanceEntryTypeValues,
} from './NativePerformanceObserver';

export type HighResTimeStamp = number;
export type PerformanceEntryType = 'mark' | 'measure' | 'event' | 'first-input';

export class PerformanceEntry {
name: string;
entryType: PerformanceEntryType;
startTime: HighResTimeStamp;
duration: HighResTimeStamp;

constructor(init: {
name: string,
entryType: PerformanceEntryType,
startTime: HighResTimeStamp,
duration: HighResTimeStamp,
}) {
this.name = init.name;
this.entryType = init.entryType;
this.startTime = init.startTime;
this.duration = init.duration;
}

toJSON(): {
name: string,
entryType: PerformanceEntryType,
startTime: HighResTimeStamp,
duration: HighResTimeStamp,
} {
return {
name: this.name,
entryType: this.entryType,
startTime: this.startTime,
duration: this.duration,
};
}
}
import {PerformanceEntry} from './PerformanceEntry';
import {PerformanceEventTiming} from './PerformanceEventTiming';

function rawToPerformanceEntryType(
type: RawPerformanceEntryType,
Expand All @@ -74,12 +41,28 @@ function rawToPerformanceEntryType(
}

function rawToPerformanceEntry(entry: RawPerformanceEntry): PerformanceEntry {
return new PerformanceEntry({
name: entry.name,
entryType: rawToPerformanceEntryType(entry.entryType),
startTime: entry.startTime,
duration: entry.duration,
});
if (
entry.entryType === RawPerformanceEntryTypeValues.EVENT ||
entry.entryType === RawPerformanceEntryTypeValues.FIRST_INPUT
) {
return new PerformanceEventTiming({
name: entry.name,
startTime: entry.startTime,
duration: entry.duration,
processingStart: entry.processingStart,
processingEnd: entry.processingEnd,
interactionId: entry.interactionId,
isFirstInput:
entry.entryType === RawPerformanceEntryTypeValues.FIRST_INPUT,
});
} else {
return new PerformanceEntry({
name: entry.name,
entryType: rawToPerformanceEntryType(entry.entryType),
startTime: entry.startTime,
duration: entry.duration,
});
}
}

export type PerformanceEntryList = $ReadOnlyArray<PerformanceEntry>;
Expand Down

0 comments on commit afd954e

Please sign in to comment.