mirror of
https://github.com/kremalicious/metamask-extension.git
synced 2024-12-01 21:57:06 +01:00
1304ec7af5
We want to convert NetworkController to TypeScript in order to be able to compare differences in the controller between in this repo and the core repo. To do this, however, we need to convert the dependencies of the controller to TypeScript. As a part of this effort, this commit converts `shared/constants/metametrics` to TypeScript. Note that simple objects have been largely replaced with enums. There are some cases where I even split up some of these objects into multiple enums. Co-authored-by: Mark Stacey <markjstacey@gmail.com>
66 lines
1.9 KiB
JavaScript
66 lines
1.9 KiB
JavaScript
import { MESSAGE_TYPE } from '../../../../../shared/constants/app';
|
|
import { MetaMetricsEventCategory } from '../../../../../shared/constants/metametrics';
|
|
|
|
/**
|
|
* This RPC method is called by the inpage provider whenever it detects the
|
|
* accessing of a non-existent property on our window.web3 shim.
|
|
* We collect this data to understand which sites are breaking due to the
|
|
* removal of our window.web3.
|
|
*/
|
|
|
|
const logWeb3ShimUsage = {
|
|
methodNames: [MESSAGE_TYPE.LOG_WEB3_SHIM_USAGE],
|
|
implementation: logWeb3ShimUsageHandler,
|
|
hookNames: {
|
|
sendMetrics: true,
|
|
getWeb3ShimUsageState: true,
|
|
setWeb3ShimUsageRecorded: true,
|
|
},
|
|
};
|
|
export default logWeb3ShimUsage;
|
|
|
|
/**
|
|
* @typedef {object} LogWeb3ShimUsageOptions
|
|
* @property {Function} sendMetrics - A function that registers a metrics event.
|
|
* @property {Function} getWeb3ShimUsageState - A function that gets web3 shim
|
|
* usage state for the given origin.
|
|
* @property {Function} setWeb3ShimUsageRecorded - A function that records web3 shim
|
|
* usage for a particular origin.
|
|
*/
|
|
|
|
/**
|
|
* @param {import('json-rpc-engine').JsonRpcRequest<unknown>} req - The JSON-RPC request object.
|
|
* @param {import('json-rpc-engine').JsonRpcResponse<true>} res - The JSON-RPC response object.
|
|
* @param {Function} _next - The json-rpc-engine 'next' callback.
|
|
* @param {Function} end - The json-rpc-engine 'end' callback.
|
|
* @param {LogWeb3ShimUsageOptions} options
|
|
*/
|
|
function logWeb3ShimUsageHandler(
|
|
req,
|
|
res,
|
|
_next,
|
|
end,
|
|
{ sendMetrics, getWeb3ShimUsageState, setWeb3ShimUsageRecorded },
|
|
) {
|
|
const { origin } = req;
|
|
if (getWeb3ShimUsageState(origin) === undefined) {
|
|
setWeb3ShimUsageRecorded(origin);
|
|
|
|
sendMetrics(
|
|
{
|
|
event: `Website Accessed window.web3 Shim`,
|
|
category: MetaMetricsEventCategory.InpageProvider,
|
|
referrer: {
|
|
url: origin,
|
|
},
|
|
},
|
|
{
|
|
excludeMetaMetricsId: true,
|
|
},
|
|
);
|
|
}
|
|
|
|
res.result = true;
|
|
return end();
|
|
}
|