mirror of
https://github.com/facebook/react-native.git
synced 2025-11-01 09:14:26 +00:00
Dmytro Voronkevych
923b77aef9
Summary: Renaming methods in UserFlow to match other APIs Reviewed By: swillard13 Differential Revision: D24078270 fbshipit-source-id: c3a65d440e389d7b3c76de7706372265584353c8
125 lines
2.9 KiB
JavaScript
125 lines
2.9 KiB
JavaScript
/**
|
|
* Copyright (c) Facebook, Inc. and its 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
|
|
*/
|
|
|
|
'use strict';
|
|
|
|
const AUTO_INSTANCE_KEY = -1;
|
|
|
|
type FlowId = {
|
|
markerId: number,
|
|
instanceKey: number,
|
|
};
|
|
|
|
/**
|
|
* API for tracking reliability of your user interactions
|
|
*
|
|
* Example:
|
|
* const flowId = UserFlow.newFlowId(QuickLogItentifiersExample.EXAMPLE_EVENT);
|
|
* ...
|
|
* UserFlow.start(flowId, "user_click");
|
|
* ...
|
|
* UserFlow.addAnnotation(flowId, "cached", "true");
|
|
* ...
|
|
* UserFlow.addPoint(flowId, "reload");
|
|
* ...
|
|
* UserFlow.endSuccess(flowId);
|
|
*/
|
|
const UserFlow = {
|
|
/**
|
|
* Creates FlowId from markerId and instanceKey.
|
|
* You will pass FlowId in every other method of UserFlow API.
|
|
*
|
|
* By default, instanceKey will generate unique instance every time you call userFlowGetId with markerId only.
|
|
*/
|
|
newFlowId(markerId: number, instanceKey: number = AUTO_INSTANCE_KEY): FlowId {
|
|
var resolvedInstanceKey = instanceKey;
|
|
if (instanceKey === AUTO_INSTANCE_KEY) {
|
|
if (global.nativeUserFlowNextInstanceKey) {
|
|
resolvedInstanceKey = global.nativeUserFlowNextInstanceKey();
|
|
} else {
|
|
// There is no JSI methods installed, API won't do anything
|
|
resolvedInstanceKey = 0;
|
|
}
|
|
}
|
|
return {
|
|
markerId: markerId,
|
|
instanceKey: resolvedInstanceKey,
|
|
};
|
|
},
|
|
|
|
start(flowId: FlowId, triggerSource: string): void {
|
|
if (global.nativeUserFlowStart) {
|
|
global.nativeUserFlowStart(
|
|
flowId.markerId,
|
|
flowId.instanceKey,
|
|
triggerSource,
|
|
);
|
|
}
|
|
},
|
|
|
|
addAnnotation(
|
|
flowId: FlowId,
|
|
annotationName: string,
|
|
annotationValue: string,
|
|
): void {
|
|
if (global.nativeUserFlowAddAnnotation) {
|
|
global.nativeUserFlowAddAnnotation(
|
|
flowId.markerId,
|
|
flowId.instanceKey,
|
|
annotationName,
|
|
annotationValue,
|
|
);
|
|
}
|
|
},
|
|
|
|
addPoint(flowId: FlowId, pointName: string): void {
|
|
if (global.nativeUserFlowAddPoint) {
|
|
global.nativeUserFlowAddPoint(
|
|
flowId.markerId,
|
|
flowId.instanceKey,
|
|
pointName,
|
|
);
|
|
}
|
|
},
|
|
|
|
endSuccess(flowId: FlowId): void {
|
|
if (global.nativeUserFlowEndSuccess) {
|
|
global.nativeUserFlowEndSuccess(flowId.markerId, flowId.instanceKey);
|
|
}
|
|
},
|
|
|
|
endFailure(
|
|
flowId: FlowId,
|
|
errorName: string,
|
|
debugInfo: ?string = null,
|
|
): void {
|
|
if (global.nativeUserFlowEndFail) {
|
|
global.nativeUserFlowEndFail(
|
|
flowId.markerId,
|
|
flowId.instanceKey,
|
|
errorName,
|
|
debugInfo,
|
|
);
|
|
}
|
|
},
|
|
|
|
endCancel(flowId: FlowId, cancelReason: string): void {
|
|
if (global.nativeUserFlowEndCancel) {
|
|
global.nativeUserFlowEndCancel(
|
|
flowId.markerId,
|
|
flowId.instanceKey,
|
|
cancelReason,
|
|
);
|
|
}
|
|
},
|
|
};
|
|
|
|
module.exports = UserFlow;
|