Skip to content

Remove vscode-common dependency and migrate to telemetry package #2174

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dgolovin merged 2 commits into from
Jun 16, 2021
Merged

Remove vscode-common dependency and migrate to telemetry package #2174

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
14b9ce1
Remove vscode-common dependency and migrate to telemetry package
dgolovin Jun 16, 2021
94888be
Let extension to work normally in case of telemetry init failure
dgolovin Jun 16, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Jenkinsfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ node('rhel8'){
def packageJson = readJSON file: 'package.json'

stage('Package') {
packageJson.extensionDependencies = ["ms-kubernetes-tools.vscode-kubernetes-tools", "redhat.vscode-commons"]
packageJson.extensionDependencies = ["ms-kubernetes-tools.vscode-kubernetes-tools"]
writeJSON file: 'package.json', json: packageJson, pretty: 4
sh 'node ./out/build/update-readme.js'
sh "vsce package -o openshift-connector-${packageJson.version}-${env.BUILD_NUMBER}.vsix"
Expand Down
14 changes: 7 additions & 7 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 7 additions & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@
},
"dependencies": {
"@kubernetes/client-node": "^0.13.0",
"@redhat-developer/vscode-redhat-telemetry": "0.0.13",
"@redhat-developer/vscode-redhat-telemetry": "0.1.1",
"base64-inline-loader": "^1.1.1",
"binary-search": "^1.3.6",
"byline": "^5.0.0",
Expand Down Expand Up @@ -1469,6 +1469,12 @@
"type": "object",
"title": "OpenShift Connector",
"properties": {
"redhat.telemetry.enabled": {
"type": "boolean",
"default": null,
"markdownDescription": "Enable usage data and errors to be sent to Red Hat servers. Read our [privacy statement](https://developers.redhat.com/article/tool-data-collection).",
"scope": "window"
},
"openshiftConnector.showWelcomePage": {
"title": "Show Welcome Page",
"type": "boolean",
Expand Down
4 changes: 2 additions & 2 deletions src/extension.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ import {
env
} from 'vscode';
import path = require('path');
import sendTelemetry from './telemetry';
import { startTelemetry } from './telemetry';
import { OpenShiftExplorer } from './explorer';
import { Cluster } from './openshift/cluster';
import { Component } from './openshift/component';
Expand Down Expand Up @@ -143,7 +143,7 @@ export async function activate(extensionContext: ExtensionContext): Promise<any>

OdoImpl.Instance.loadWorkspaceComponents(null);

sendTelemetry('activation');
startTelemetry(extensionContext);

return {
verifyBundledBinaries,
Expand Down
27 changes: 15 additions & 12 deletions src/telemetry.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,10 @@
* Licensed under the MIT License. See LICENSE file in the project root for license information.
*-----------------------------------------------------------------------------------------------*/

import { getTelemetryService, TelemetryEvent, TelemetryService } from '@redhat-developer/vscode-redhat-telemetry';
import { ExtenisonID } from './util/constants';
import { getRedHatService, TelemetryEvent, TelemetryService } from '@redhat-developer/vscode-redhat-telemetry';
import { ExtensionContext } from 'vscode';

const telemetryService: Promise<TelemetryService> = getTelemetryService(ExtenisonID);

export async function getTelemetryServiceInstance(): Promise<TelemetryService> {
return telemetryService;
}
let telemetryService: TelemetryService;

export function createTrackingEvent(name: string, properties: any = {}): TelemetryEvent {
return {
Expand All @@ -20,12 +16,19 @@ export function createTrackingEvent(name: string, properties: any = {}): Telemet
}
}

export default async function sendTelemetry(actionName: string, properties?: any): Promise<void> {
const service = await getTelemetryServiceInstance();
if (actionName === 'activation') {
return service?.sendStartupEvent();
export async function startTelemetry(context: ExtensionContext): Promise<void> {
try {
const redHatService = await getRedHatService(context);
telemetryService = await redHatService.getTelemetryService();
} catch(error) {
// eslint-disable-next-line no-console
console.log(`${error}`);
}
return service?.send(createTrackingEvent(actionName, properties));
return telemetryService?.sendStartupEvent();
}

export default async function sendTelemetry(actionName: string, properties?: any): Promise<void> {
return telemetryService?.send(createTrackingEvent(actionName, properties));
}

export interface CommonCommandProps {
Expand Down
⚡