feat: add telemetry to companion #1117
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -15,3 +15,6 @@ | |
| /coverage | ||
| /.nyc_output | ||
| /add-on/manifest.json | ||
|
|
||
| .DS_Store | ||
| .vscode | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -23,6 +23,7 @@ import createRuntimeChecks from './runtime-checks.js' | |
| import { createContextMenus, findValueForContext, contextMenuCopyAddressAtPublicGw, contextMenuCopyRawCid, contextMenuCopyCanonicalAddress, contextMenuViewOnGateway, contextMenuCopyPermalink, contextMenuCopyCidAddress } from './context-menus.js' | ||
| import { registerSubdomainProxy } from './http-proxy.js' | ||
| import { runPendingOnInstallTasks } from './on-installed.js' | ||
| import { handleConsentFromState, startSession, endSession, trackView } from './telemetry.js' | ||
| const log = debug('ipfs-companion:main') | ||
| log.error = debug('ipfs-companion:main:error') | ||
|
|
||
|
|
@@ -33,6 +34,7 @@ export default async function init () { | |
| // INIT | ||
| // =================================================================== | ||
| let ipfs // ipfs-api instance | ||
| /** @type {import('../types.js').CompanionState} */ | ||
| let state // avoid redundant API reads by utilizing local cache of various states | ||
| let dnslinkResolver | ||
| let ipfsPathValidator | ||
|
|
@@ -55,8 +57,11 @@ export default async function init () { | |
| runtime = await createRuntimeChecks(browser) | ||
| state = initState(options) | ||
| notify = createNotifier(getState) | ||
| // ensure consent is set properly on app init | ||
| handleConsentFromState(state) | ||
|
|
||
| if (state.active) { | ||
| startSession() | ||
| // It's ok for this to fail, node might be unavailable or mis-configured | ||
| try { | ||
| ipfs = await initIpfsClient(browser, state) | ||
|
|
@@ -167,6 +172,15 @@ export default async function init () { | |
| const result = validIpfsOrIpns(path) ? resolveToPublicUrl(path) : null | ||
| return Promise.resolve({ pubGwUrlForIpfsOrIpnsPath: result }) | ||
| } | ||
| if (request.telemetry) { | ||
| return Promise.resolve(onTelemetryMessage(request.telemetry, sender)) | ||
| } | ||
| } | ||
|
|
||
| function onTelemetryMessage (request, sender) { | ||
|
|
||
| if (request.trackView) { | ||
| return trackView(request.trackView) | ||
| } | ||
| } | ||
|
|
||
| // PORTS (connection-based messaging) | ||
|
|
@@ -366,11 +380,11 @@ export default async function init () { | |
| // https://github.com/ipfs-shipyard/ipfs-companion/issues/398 | ||
| if (runtime.isFirefox && ipfsPathValidator.isIpfsPageActionsContext(url)) { | ||
| if (sameGateway(url, state.gwURL) || sameGateway(url, state.apiURL)) { | ||
| await browser.pageAction.setIcon({ tabId, path: '/icons/ipfs-logo-on.svg' }) | ||
| await browser.pageAction.setTitle({ tabId, title: browser.i18n.getMessage('pageAction_titleIpfsAtCustomGateway') }) | ||
| } else { | ||
| await browser.pageAction.setIcon({ tabId, path: '/icons/ipfs-logo-off.svg' }) | ||
| await browser.pageAction.setTitle({ tabId, title: browser.i18n.getMessage('pageAction_titleIpfsAtPublicGateway') }) | ||
| } | ||
| await browser.pageAction.show(tabId) | ||
| } | ||
|
|
@@ -554,6 +568,8 @@ export default async function init () { | |
| await registerSubdomainProxy(getState, runtime) | ||
| shouldRestartIpfsClient = true | ||
| shouldStopIpfsClient = !state.active | ||
| // Any time the extension switches active state, start or stop the current session. | ||
| state.active ? startSession() : endSession() | ||
|
There was a problem hiding this comment. If state.active is changed, and state is true-ish, start session. Otherwise, end session. There was a problem hiding this comment. @whizzzkid @lidel is there a better place to do this There was a problem hiding this comment. for now this should be ok, in the future we might wanna have a message being broadcast and such listeners can subscribe to those. |
||
| break | ||
| case 'ipfsNodeType': | ||
| if (change.oldValue !== braveNodeType && change.newValue === braveNodeType) { | ||
|
|
@@ -620,6 +636,8 @@ export default async function init () { | |
| break | ||
| } | ||
| } | ||
| // ensure consent is set properly on state changes | ||
| handleConsentFromState(state) | ||
|
|
||
| if ((state.active && shouldRestartIpfsClient) || shouldStopIpfsClient) { | ||
| try { | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| import MetricsProvider from '@ipfs-shipyard/ignite-metrics/vanilla' | ||
| import debug from 'debug' | ||
|
|
||
| const log = debug('ipfs-companion:telemetry') | ||
|
|
||
| const metricsProvider = new MetricsProvider({ | ||
| appKey: '393f72eb264c28a1b59973da1e0a3938d60dc38a', | ||
| autoTrack: false, | ||
| storageProvider: null | ||
| }) | ||
|
|
||
| /** | ||
| * | ||
| * @param {import('../types.js').CompanionState} state | ||
| * @returns {void} | ||
| */ | ||
| export function handleConsentFromState (state) { | ||
| const telemetryGroups = { | ||
| minimal: state?.telemetryGroupMinimal || false, | ||
| performance: state?.telemetryGroupPerformance || false, | ||
| ux: state?.telemetryGroupUx || false, | ||
| feedback: state?.telemetryGroupFeedback || false, | ||
| location: state?.telemetryGroupLocation || false | ||
| } | ||
| for (const [groupName, isEnabled] of Object.entries(telemetryGroups)) { | ||
| if (isEnabled) { | ||
| log(`Adding consent for '${groupName}'`) | ||
| metricsProvider.addConsent(groupName) | ||
| } else { | ||
| log(`Removing consent for '${groupName}'`) | ||
| metricsProvider.removeConsent(groupName) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| const ignoredViewsRegex = [] | ||
| export function trackView (view) { | ||
| log('trackView called for view: ', view) | ||
| metricsProvider.trackView(view, ignoredViewsRegex) | ||
| } | ||
|
|
||
| export const startSession = (...args) => metricsProvider.startSession(...args) | ||
| export const endSession = (...args) => metricsProvider.endSession(...args) |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@SgtPooki to address
Need to remove these since we wont be using them for now