Infrastructure/logto
0
Fork 0
mirror of https://github.com/logto-io/logto.git synced 2024-12-16 20:26:19 -05:00
Code Issues Activity

feat(app-insights): support ClickAnalytics plugin

Browse source
This commit is contained in:
Gao Sun 2023-04-20 14:49:09 +08:00
parent be373591a9
commit 4331deb6f2
No known key found for this signature in database
GPG key ID: 13EBE123E4773688
5 changed files with 114 additions and 55 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
.changeset/kind-spoons-retire.md Normal file
View file

@ -0,0 +1,5 @@
---
"@logto/app-insights": minor
---
support ClickAnalytics plugin

2
commitlint.config.cjs
View file

@ -7,7 +7,7 @@ module.exports = {
extends: ['@commitlint/config-conventional'], extends: ['@commitlint/config-conventional'],
rules: { rules: {
'type-enum': [2, 'always', [...rules['type-enum'][2], 'api', 'release']], 'type-enum': [2, 'always', [...rules['type-enum'][2], 'api', 'release']],
'scope-enum': [2, 'always', ['connector', 'console', 'core', 'demo-app', 'test', 'phrases', 'schemas', 'shared', 'ui', 'deps','cli', 'toolkit', 'cloud']], 'scope-enum': [2, 'always', ['connector', 'console', 'core', 'demo-app', 'test', 'phrases', 'schemas', 'shared', 'ui', 'deps','cli', 'toolkit', 'cloud', 'app-insights']],
// Slightly increase the tolerance to allow the appending PR number // Slightly increase the tolerance to allow the appending PR number
...(isCi && { 'header-max-length': [2, 'always', 110] }) ...(isCi && { 'header-max-length': [2, 'always', 110] })
}, },

5
packages/app-insights/package.json
View file

@ -51,8 +51,9 @@
}, },
"prettier": "@silverhand/eslint-config/.prettierrc", "prettier": "@silverhand/eslint-config/.prettierrc",
"dependencies": { "dependencies": {
"@microsoft/applicationinsights-react-js": "^3.4.1", "@microsoft/applicationinsights-clickanalytics-js": "^2.8.12",
"@microsoft/applicationinsights-web": "^2.8.11", "@microsoft/applicationinsights-react-js": "^3.4.2",
"@microsoft/applicationinsights-web": "^2.8.12",
"@silverhand/essentials": "^2.5.0", "@silverhand/essentials": "^2.5.0",
"applicationinsights": "^2.5.0" "applicationinsights": "^2.5.0"
}, },

47
packages/app-insights/src/react.ts
View file

@ -1,10 +1,18 @@
import { type ClickAnalyticsPlugin } from '@microsoft/applicationinsights-clickanalytics-js';
import { type IClickAnalyticsConfiguration } from '@microsoft/applicationinsights-clickanalytics-js/types/Interfaces/Datamodel.js';
import type { ReactPlugin, withAITracking } from '@microsoft/applicationinsights-react-js'; import type { ReactPlugin, withAITracking } from '@microsoft/applicationinsights-react-js';
import type { ApplicationInsights } from '@microsoft/applicationinsights-web'; import type { ApplicationInsights, ITelemetryPlugin } from '@microsoft/applicationinsights-web';
import { type Optional } from '@silverhand/essentials'; import { conditional, conditionalArray, type Optional } from '@silverhand/essentials';
import { type ComponentType } from 'react'; import { type ComponentType } from 'react';
export type SetupConfig = {
connectionString?: string;
clickPlugin?: IClickAnalyticsConfiguration;
};
class AppInsightsReact { class AppInsightsReact {
protected reactPlugin?: ReactPlugin; protected reactPlugin?: ReactPlugin;
protected clickAnalyticsPlugin?: ClickAnalyticsPlugin;
protected withAITracking?: typeof withAITracking; protected withAITracking?: typeof withAITracking;
protected appInsights?: ApplicationInsights; protected appInsights?: ApplicationInsights;
@ -16,10 +24,12 @@ class AppInsightsReact {
return this.appInsights?.trackPageView.bind(this.appInsights); return this.appInsights?.trackPageView.bind(this.appInsights);
} }
async setup(cloudRole: string, connectionString_?: string): Promise<boolean> { async setup(cloudRole: string, config?: string | SetupConfig): Promise<boolean> {
const connectionStringFromConfig =
typeof config === 'string' ? config : config?.connectionString;
// The string needs to be normalized since it may contain '"' // The string needs to be normalized since it may contain '"'
const connectionString = ( const connectionString = (
connectionString_ ?? process.env.APPLICATIONINSIGHTS_CONNECTION_STRING connectionStringFromConfig ?? process.env.APPLICATIONINSIGHTS_CONNECTION_STRING
)?.replace(/^"?(.*)"?$/g, '$1'); )?.replace(/^"?(.*)"?$/g, '$1');
if (!connectionString) { if (!connectionString) {
@ -31,18 +41,45 @@ class AppInsightsReact {
} }
try { try {
// Lazy load ApplicationInsights modules
const { ReactPlugin, withAITracking } = await import( const { ReactPlugin, withAITracking } = await import(
'@microsoft/applicationinsights-react-js' '@microsoft/applicationinsights-react-js'
); );
const { ApplicationInsights } = await import('@microsoft/applicationinsights-web'); const { ApplicationInsights } = await import('@microsoft/applicationinsights-web');
// Conditionally load ClickAnalytics plugin
const clickAnalyticsConfig = conditional(typeof config === 'object' && config.clickPlugin);
const initClickAnalyticsPlugin = async () => {
const { ClickAnalyticsPlugin } = await import(
'@microsoft/applicationinsights-clickanalytics-js'
);
return new ClickAnalyticsPlugin();
};
// Assign React props
// https://github.com/microsoft/applicationinsights-react-js#readme // https://github.com/microsoft/applicationinsights-react-js#readme
this.withAITracking = withAITracking; this.withAITracking = withAITracking;
this.reactPlugin = new ReactPlugin(); this.reactPlugin = new ReactPlugin();
// Assign ClickAnalytics prop
this.clickAnalyticsPlugin = conditional(
clickAnalyticsConfig && (await initClickAnalyticsPlugin())
);
// Init ApplicationInsights instance
this.appInsights = new ApplicationInsights({ this.appInsights = new ApplicationInsights({
config: { config: {
connectionString, connectionString,
enableAutoRouteTracking: false, enableAutoRouteTracking: false,
extensions: [this.reactPlugin], extensions: conditionalArray<ITelemetryPlugin>(
this.reactPlugin,
this.clickAnalyticsPlugin
),
extensionConfig: conditional(
this.clickAnalyticsPlugin && {
[this.clickAnalyticsPlugin.identifier]: clickAnalyticsConfig,
}
),
}, },
}); });

110
pnpm-lock.yaml
View file

@ -35,12 +35,15 @@ importers:
packages/app-insights: packages/app-insights:
dependencies: dependencies:
'@microsoft/applicationinsights-clickanalytics-js':
specifier: ^2.8.12
version: 2.8.12(tslib@2.4.1)
'@microsoft/applicationinsights-react-js': '@microsoft/applicationinsights-react-js':
specifier: ^3.4.1 specifier: ^3.4.2
version: 3.4.1(history@5.3.0)(react@18.2.0)(tslib@2.4.1) version: 3.4.2(history@5.3.0)(react@18.2.0)(tslib@2.4.1)
'@microsoft/applicationinsights-web': '@microsoft/applicationinsights-web':
specifier: ^2.8.11 specifier: ^2.8.12
version: 2.8.11(tslib@2.4.1) version: 2.8.12(tslib@2.4.1)
'@silverhand/essentials': '@silverhand/essentials':
specifier: ^2.5.0 specifier: ^2.5.0
version: 2.5.0 version: 2.5.0
@ -7237,86 +7240,99 @@ packages:
resolution: {integrity: sha512-H1rQc1ZOHANWBvPcW+JpGwr+juXSxM8Q8YCkm3GhZd8REu1fHR3z99CErO1p9pkcfcxZnMdIZdIsXkOHY0NilA==} resolution: {integrity: sha512-H1rQc1ZOHANWBvPcW+JpGwr+juXSxM8Q8YCkm3GhZd8REu1fHR3z99CErO1p9pkcfcxZnMdIZdIsXkOHY0NilA==}
dev: true dev: true
/@microsoft/applicationinsights-analytics-js@2.8.11(tslib@2.4.1): /@microsoft/applicationinsights-analytics-js@2.8.12(tslib@2.4.1):
resolution: {integrity: sha512-RwGnRDIAjyX/5yDJOueGfQkKwg7B1FTeIsv4wJ303CJD2wKSxxhE9rqYIPl5tKGqzv/uzmE/fiKuqiVlp7vcLg==} resolution: {integrity: sha512-Gz6j3dCCiuSq8ks0ci2uXRZidxn8v28sGQ6xF/vpNv8/gjpV0k3vcFxzlMGEoEjVls6BkH8vYiu80JAwRb1Q4A==}
peerDependencies: peerDependencies:
tslib: '*' tslib: '*'
dependencies: dependencies:
'@microsoft/applicationinsights-common': 2.8.11(tslib@2.4.1) '@microsoft/applicationinsights-common': 2.8.12(tslib@2.4.1)
'@microsoft/applicationinsights-core-js': 2.8.11(tslib@2.4.1) '@microsoft/applicationinsights-core-js': 2.8.12(tslib@2.4.1)
'@microsoft/applicationinsights-shims': 2.0.2 '@microsoft/applicationinsights-shims': 2.0.2
'@microsoft/dynamicproto-js': 1.1.8 '@microsoft/dynamicproto-js': 1.1.9
tslib: 2.4.1 tslib: 2.4.1
dev: false dev: false
/@microsoft/applicationinsights-channel-js@2.8.11(tslib@2.4.1): /@microsoft/applicationinsights-channel-js@2.8.12(tslib@2.4.1):
resolution: {integrity: sha512-DGDNzT4DMlSvUzWjA4y3tDg47+QYOPV+W07vlfdPwGgLwrl4n6Q4crrW8Y/IOpthHAKDU8rolSAUvP3NqxPi4Q==} resolution: {integrity: sha512-tBJnZ/eK/W3gVVgfS0kPDheiaZQeOJeZD2pOlSwnQeynmymbfVMqGwrTDBC8fsZCqwsfdgGoToLOwup8JyEgvQ==}
peerDependencies: peerDependencies:
tslib: '*' tslib: '*'
dependencies: dependencies:
'@microsoft/applicationinsights-common': 2.8.11(tslib@2.4.1) '@microsoft/applicationinsights-common': 2.8.12(tslib@2.4.1)
'@microsoft/applicationinsights-core-js': 2.8.11(tslib@2.4.1) '@microsoft/applicationinsights-core-js': 2.8.12(tslib@2.4.1)
'@microsoft/applicationinsights-shims': 2.0.2 '@microsoft/applicationinsights-shims': 2.0.2
'@microsoft/dynamicproto-js': 1.1.8 '@microsoft/dynamicproto-js': 1.1.9
tslib: 2.4.1 tslib: 2.4.1
dev: false dev: false
/@microsoft/applicationinsights-common@2.8.11(tslib@2.4.1): /@microsoft/applicationinsights-clickanalytics-js@2.8.12(tslib@2.4.1):
resolution: {integrity: sha512-Cxu4gRajkYv9buEtrcLGHK97AqGK62feN9jH9/JSjUSiSFhbnWtYvEg1EMqMI/P4pneu53yLJloITB+TKwmK7A==} resolution: {integrity: sha512-V9Ls9QpJ5TIrTyBZrMZpeNCm5Oa0nrtJN3WtVtWJnbuby20/ivxveMh25DrJgxcOIkgLcp+KJCtmVhKViccvEw==}
peerDependencies: peerDependencies:
tslib: '*' tslib: '*'
dependencies: dependencies:
'@microsoft/applicationinsights-core-js': 2.8.11(tslib@2.4.1) '@microsoft/applicationinsights-common': 2.8.12(tslib@2.4.1)
'@microsoft/applicationinsights-core-js': 2.8.12(tslib@2.4.1)
'@microsoft/applicationinsights-properties-js': 2.8.12(tslib@2.4.1)
'@microsoft/applicationinsights-shims': 2.0.2 '@microsoft/applicationinsights-shims': 2.0.2
'@microsoft/dynamicproto-js': 1.1.8 '@microsoft/dynamicproto-js': 1.1.9
tslib: 2.4.1 tslib: 2.4.1
dev: false dev: false
/@microsoft/applicationinsights-core-js@2.8.11(tslib@2.4.1): /@microsoft/applicationinsights-common@2.8.12(tslib@2.4.1):
resolution: {integrity: sha512-6ScXplyb9Zb0K6TQRfqStm20j5lIe/Dslf65ozows6ibDcKkWl2ZdqzFhymVJZz1WRNpSyD4aA8qnqmslIER6g==} resolution: {integrity: sha512-7mxXaR6nHb23NG0xzf56ab5dqCDcG/gAM8MC9e0eCudE8EZ95nHwi1Mmnko6GCE6pzn4WjeHheId3YBETzYT7w==}
peerDependencies:
tslib: '*'
dependencies:
'@microsoft/applicationinsights-core-js': 2.8.12(tslib@2.4.1)
'@microsoft/applicationinsights-shims': 2.0.2
'@microsoft/dynamicproto-js': 1.1.9
tslib: 2.4.1
dev: false
/@microsoft/applicationinsights-core-js@2.8.12(tslib@2.4.1):
resolution: {integrity: sha512-lA4epwWPBJ4awx07QQVCkoxygsl0qiTNoSYaR63hRE56ybu4kpp3tpYo/AfOI1DZMgKB8H0EwDz4vVmzUT3p/A==}
peerDependencies: peerDependencies:
tslib: '*' tslib: '*'
dependencies: dependencies:
'@microsoft/applicationinsights-shims': 2.0.2 '@microsoft/applicationinsights-shims': 2.0.2
'@microsoft/dynamicproto-js': 1.1.8 '@microsoft/dynamicproto-js': 1.1.9
tslib: 2.4.1 tslib: 2.4.1
dev: false dev: false
/@microsoft/applicationinsights-dependencies-js@2.8.11(tslib@2.4.1): /@microsoft/applicationinsights-dependencies-js@2.8.12(tslib@2.4.1):
resolution: {integrity: sha512-eCjNouBvvnu+E3jLdfQgSIx3AUvmBDd14ZJNOjkvsaURhgRyWkBX3enT+RjrVrqyNQ74ZpHZpIJEqj90l28SsA==} resolution: {integrity: sha512-o+i7idIiE/Ew9GRHdonX7fcTs85TPhbIrcOhMn+gxAlwH7ttUPK0XNk4wrMwIy3t9k4jo0slEA7uxBZkTpN8cQ==}
peerDependencies: peerDependencies:
tslib: '*' tslib: '*'
dependencies: dependencies:
'@microsoft/applicationinsights-common': 2.8.11(tslib@2.4.1) '@microsoft/applicationinsights-common': 2.8.12(tslib@2.4.1)
'@microsoft/applicationinsights-core-js': 2.8.11(tslib@2.4.1) '@microsoft/applicationinsights-core-js': 2.8.12(tslib@2.4.1)
'@microsoft/applicationinsights-shims': 2.0.2 '@microsoft/applicationinsights-shims': 2.0.2
'@microsoft/dynamicproto-js': 1.1.8 '@microsoft/dynamicproto-js': 1.1.9
tslib: 2.4.1 tslib: 2.4.1
dev: false dev: false
/@microsoft/applicationinsights-properties-js@2.8.11(tslib@2.4.1): /@microsoft/applicationinsights-properties-js@2.8.12(tslib@2.4.1):
resolution: {integrity: sha512-cuX8jwycBYX81SXmGTNK7JSJod3l8l3FIH0HPgPayCQy7CdHYlfKPTKE9q3I9qD1GO/3ER9yozuKpE+12Wk/2w==} resolution: {integrity: sha512-1U5vgWOfQi3NxfknG3eTTI7sqUQrIG0q1jlweKRToPzQi/jEJbUXc4rENmGZG5+UMwdSYcotlefkTnhXHgF+5g==}
peerDependencies: peerDependencies:
tslib: '*' tslib: '*'
dependencies: dependencies:
'@microsoft/applicationinsights-common': 2.8.11(tslib@2.4.1) '@microsoft/applicationinsights-common': 2.8.12(tslib@2.4.1)
'@microsoft/applicationinsights-core-js': 2.8.11(tslib@2.4.1) '@microsoft/applicationinsights-core-js': 2.8.12(tslib@2.4.1)
'@microsoft/applicationinsights-shims': 2.0.2 '@microsoft/applicationinsights-shims': 2.0.2
'@microsoft/dynamicproto-js': 1.1.8 '@microsoft/dynamicproto-js': 1.1.9
tslib: 2.4.1 tslib: 2.4.1
dev: false dev: false
/@microsoft/applicationinsights-react-js@3.4.1(history@5.3.0)(react@18.2.0)(tslib@2.4.1): /@microsoft/applicationinsights-react-js@3.4.2(history@5.3.0)(react@18.2.0)(tslib@2.4.1):
resolution: {integrity: sha512-oosMkymmkkulUdFcUbqKc64Li0KpItmV/pClOr4DCLAxbitCjHDkKdxodvpUzMHVs1ko9cHP360oc1QVXprhXQ==} resolution: {integrity: sha512-9i1wIs5YQEoSKJPKoW6DY6XCrBbmc+HhMJEIl6svhxbEK6afzPTjp+Gc2yc2TS/nr7qai033LC8FyLOoZVq8sg==}
peerDependencies: peerDependencies:
history: '>= 4.10.1' history: '>= 4.10.1'
react: '>= 17.0.1 || ^18.0.0' react: '>= 17.0.1 || ^18.0.0'
tslib: '*' tslib: '*'
dependencies: dependencies:
'@microsoft/applicationinsights-common': 2.8.11(tslib@2.4.1) '@microsoft/applicationinsights-common': 2.8.12(tslib@2.4.1)
'@microsoft/applicationinsights-core-js': 2.8.11(tslib@2.4.1) '@microsoft/applicationinsights-core-js': 2.8.12(tslib@2.4.1)
'@microsoft/applicationinsights-shims': 2.0.2 '@microsoft/applicationinsights-shims': 2.0.2
'@microsoft/dynamicproto-js': 1.1.8 '@microsoft/dynamicproto-js': 1.1.9
history: 5.3.0 history: 5.3.0
react: 18.2.0 react: 18.2.0
tslib: 2.4.1 tslib: 2.4.1
@ -7330,24 +7346,24 @@ packages:
resolution: {integrity: sha512-2IHAOaLauc8qaAitvWS+U931T+ze+7MNWrDHY47IENP5y2UA0vqJDu67kWZDdpCN1fFC77sfgfB+HV7SrKshnQ==} resolution: {integrity: sha512-2IHAOaLauc8qaAitvWS+U931T+ze+7MNWrDHY47IENP5y2UA0vqJDu67kWZDdpCN1fFC77sfgfB+HV7SrKshnQ==}
dev: false dev: false
/@microsoft/applicationinsights-web@2.8.11(tslib@2.4.1): /@microsoft/applicationinsights-web@2.8.12(tslib@2.4.1):
resolution: {integrity: sha512-cLJl3MLQtvbwXU0hvFLl6S2/rIdoZKpZL8cvdaT0cXqd5XIiMbeUOxWHLf2hxT8IlIeVlu5nnFILeRYOFZowvw==} resolution: {integrity: sha512-f2wWxNV/JG+qiK6GAeKrKmO9a7TLI6vdQZXuG/escU9sFtP0Lhsz0dFOF7kmkTc4Uv7zuv46DCA6MO6P0XSz9g==}
peerDependencies: peerDependencies:
tslib: '*' tslib: '*'
dependencies: dependencies:
'@microsoft/applicationinsights-analytics-js': 2.8.11(tslib@2.4.1) '@microsoft/applicationinsights-analytics-js': 2.8.12(tslib@2.4.1)
'@microsoft/applicationinsights-channel-js': 2.8.11(tslib@2.4.1) '@microsoft/applicationinsights-channel-js': 2.8.12(tslib@2.4.1)
'@microsoft/applicationinsights-common': 2.8.11(tslib@2.4.1) '@microsoft/applicationinsights-common': 2.8.12(tslib@2.4.1)
'@microsoft/applicationinsights-core-js': 2.8.11(tslib@2.4.1) '@microsoft/applicationinsights-core-js': 2.8.12(tslib@2.4.1)
'@microsoft/applicationinsights-dependencies-js': 2.8.11(tslib@2.4.1) '@microsoft/applicationinsights-dependencies-js': 2.8.12(tslib@2.4.1)
'@microsoft/applicationinsights-properties-js': 2.8.11(tslib@2.4.1) '@microsoft/applicationinsights-properties-js': 2.8.12(tslib@2.4.1)
'@microsoft/applicationinsights-shims': 2.0.2 '@microsoft/applicationinsights-shims': 2.0.2
'@microsoft/dynamicproto-js': 1.1.8 '@microsoft/dynamicproto-js': 1.1.9
tslib: 2.4.1 tslib: 2.4.1
dev: false dev: false
/@microsoft/dynamicproto-js@1.1.8: /@microsoft/dynamicproto-js@1.1.9:
resolution: {integrity: sha512-j4ZgOZRtX0LTUgKq+4tRQotgwH03HH/mLkYbcgFBBJ9XKTDc4NIGzZeam2UQMzwz+5IVN0SXexNbbsz5B0b/og==} resolution: {integrity: sha512-n1VPsljTSkthsAFYdiWfC+DKzK2WwcRp83Y1YAqdX552BstvsDjft9YXppjUzp11BPsapDoO1LDgrDB0XVsfNQ==}
dev: false dev: false
/@mischnic/json-sourcemap@0.1.0: /@mischnic/json-sourcemap@0.1.0: