Skip to content

feat: create O11yReporter with getOrgConnection function when event has target org username @W-21306700 #835

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

Open
shetzel wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: create O11yReporter with getOrgConnection function when event has target org username @W-21306700 #835

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
17 changes: 9 additions & 8 deletions src/commandExecution.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@ export class CommandExecution extends AsyncCreatable {
private enableO11y?: boolean;
private o11yUploadEndpoint?: string;
private productFeatureId?: string;
private targetOrgUsername?: string | null;

public constructor(options: CommandExecutionOptions) {
super(options);
Expand Down Expand Up @@ -115,6 +116,7 @@ export class CommandExecution extends AsyncCreatable {

// Salesforce Information
orgId: this.orgId,
targetOrgUsername: this.targetOrgUsername,
devhubId: this.devhubId,
orgApiVersion: this.orgApiVersion,
devhubApiVersion: this.devhubApiVersion,
Expand Down Expand Up @@ -176,15 +178,14 @@ export class CommandExecution extends AsyncCreatable {
} catch (error) {
debug('Error parsing flags');
}
const targetOrg = flags['target-org'] ? (flags['target-org'] as unknown as Org) : null;
const targetDevHub = flags['target-dev-hub'] ? (flags['target-dev-hub'] as unknown as Org) : null;

this.orgId = flags['target-org'] ? (flags['target-org'] as unknown as Org).getOrgId() : null;
this.devhubId = flags['target-dev-hub'] ? (flags['target-dev-hub'] as unknown as Org).getOrgId() : null;
this.orgApiVersion = flags['target-org']
? (flags['target-org'] as unknown as Org).getConnection().getApiVersion()
: null;
this.devhubApiVersion = flags['target-dev-hub']
? (flags['target-dev-hub'] as unknown as Org).getConnection().getApiVersion()
: null;
this.orgId = targetOrg ? targetOrg.getOrgId() : null;
this.targetOrgUsername = targetOrg ? targetOrg.getUsername() : null;
this.devhubId = targetDevHub ? targetDevHub.getOrgId() : null;
this.orgApiVersion = targetOrg ? targetOrg.getConnection().getApiVersion() : null;
this.devhubApiVersion = targetDevHub ? targetDevHub.getConnection().getApiVersion() : null;
this.determineSpecifiedFlags(argv, flags, flagDefinitions);

// Read o11y configuration from the plugin's package.json (plugin that owns the command)
Expand Down
63 changes: 43 additions & 20 deletions src/uploader.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,9 @@
*/

import { SfError } from '@salesforce/core/sfError';
import type { Attributes, PdpEvent } from '@salesforce/telemetry';
import type { Attributes, PdpEvent, TelemetryOptions } from '@salesforce/telemetry';
import { asBoolean, asString, Dictionary } from '@salesforce/ts-types';
import { Connection, Org } from '@salesforce/core';
import Telemetry from './telemetry.js';
import { debug } from './debugger.js';
import { TelemetryGlobal } from './telemetryGlobal.js';
Expand All @@ -27,6 +28,7 @@ const PROJECT = 'salesforce-cli';
const APP_INSIGHTS_KEY =
'InstrumentationKey=2ca64abb-6123-4c7b-bd9e-4fe73e71fe9c;IngestionEndpoint=https://eastus-1.in.applicationinsights.azure.com/;LiveEndpoint=https://eastus.livediagnostics.monitor.azure.com/;ApplicationId=ecd8fa7a-0e0d-4109-94db-4d7878ada862';

export type PdpEventWithUsername = PdpEvent & { targetOrgUsername?: string };
export class Uploader {
private o11yUploadEndpoint: string = '';

Expand All @@ -47,7 +49,7 @@ export class Uploader {
private async sendToTelemetry(): Promise<void> {
const { TelemetryReporter } = await import('@salesforce/telemetry');
let appInsightsReporter: InstanceType<typeof TelemetryReporter>;
let o11yReporter: InstanceType<typeof TelemetryReporter> | undefined;
const o11yReporterMap: Map<string, InstanceType<typeof TelemetryReporter>> = new Map();

try {
appInsightsReporter = await TelemetryReporter.create({
Expand Down Expand Up @@ -98,21 +100,37 @@ export class Uploader {

// Send PDP events via O11y
if (o11yEvents.length > 0) {
try {
o11yReporter = await TelemetryReporter.create({
project: PROJECT,
key: 'not-used',
userId: this.telemetry.getCLIId(),
waitForConnection: true,
enableO11y: true,
enableAppInsights: false,
o11yUploadEndpoint: this.o11yUploadEndpoint,
});
} catch (err) {
const error = SfError.wrap(err);
debug(`Error creating o11y reporter: ${error.message}`);
for (const event of o11yEvents) {
let o11yReporter: InstanceType<typeof TelemetryReporter> | undefined;
const o11yReporterKey = event.targetOrgUsername ?? 'default';
if (!o11yReporterMap.has(o11yReporterKey)) {
try {
const telemetryReporterOptions: TelemetryOptions = {
project: PROJECT,
key: 'not-used',
userId: this.telemetry.getCLIId(),
waitForConnection: true,
enableO11y: true,
enableAppInsights: false,
o11yUploadEndpoint: this.o11yUploadEndpoint,
};
if (event.targetOrgUsername) {
telemetryReporterOptions.getConnectionFn = async (): Promise<Connection> =>
(await Org.create({ aliasOrUsername: event.targetOrgUsername! })).getConnection();
}
// eslint-disable-next-line no-await-in-loop
o11yReporter = await TelemetryReporter.create(telemetryReporterOptions);
o11yReporterMap.set(o11yReporterKey, o11yReporter);
} catch (err) {
const error = SfError.wrap(err);
debug(`Error creating o11y reporter for PDP event: ${error.message}`);
}
} else {
o11yReporter = o11yReporterMap.get(o11yReporterKey);
}
delete event.targetOrgUsername;
o11yReporter?.sendPdpEvent(event);
}
o11yEvents.forEach((event) => o11yReporter?.sendPdpEvent(event));
}
} catch (err) {
const error = SfError.wrap(err);
Expand All @@ -121,8 +139,10 @@ export class Uploader {
try {
// We are done sending events
appInsightsReporter.stop();
if (o11yReporter) {
o11yReporter.stop();
if (o11yReporterMap.size > 0) {
for (const reporter of o11yReporterMap.values()) {
reporter.stop();
}
}
} catch (err) {
const error = SfError.wrap(err);
Expand All @@ -137,22 +157,24 @@ export class Uploader {
private parseEvents(events: Attributes[]): {
appInsightsEvents: Attributes[];
appInsightsErrors: Attributes[];
o11yEvents: PdpEvent[];
o11yEvents: PdpEventWithUsername[];
} {
const appInsightsEvents: Attributes[] = [];
const appInsightsErrors: Attributes[] = [];
const o11yEvents: PdpEvent[] = [];
const o11yEvents: PdpEventWithUsername[] = [];
for (const event of events) {
event.telemetryVersion = this.version;
const eventType = asString(event.type) ?? Telemetry.EVENT;
const eventName = asString(event.eventName) ?? 'UNKNOWN';
const enableO11y = asBoolean(event.enableO11y) ?? false;
const productFeatureId = asString(event.productFeatureId) ?? 'aJCEE0000000mHP4AY';
const targetOrgUsername = asString(event.targetOrgUsername) ?? undefined;
this.o11yUploadEndpoint = asString(event.o11yUploadEndpoint) ?? '';
delete event.type;
delete event.enableO11y;
delete event.o11yUploadEndpoint;
delete event.productFeatureId;
delete event.targetOrgUsername;

if (eventType === Telemetry.EVENT) {
appInsightsEvents.push(event);
Expand All @@ -161,6 +183,7 @@ export class Uploader {
const commandName = `${asString(event.command) ?? 'unknownCommand'}`;
o11yEvents.push({
eventName: 'salesforceCli.executed',
targetOrgUsername,
productFeatureId: productFeatureId as `aJC${string}`,
componentId: `${pluginName}.${commandName}`,
contextName: 'orgId::devhubId', // Delimited string of keys
Expand Down
22 changes: 22 additions & 0 deletions test/uploader.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,4 +180,26 @@ describe('uploader', () => {
expect(sendPdpEventStub.called).to.equal(false);
expect(clearStub.called).to.equal(true);
});

it('when COMMAND_EXECUTION has targetOrgUsername and enableO11y, creates O11y reporter with getConnectionFn in options', async () => {
readStub.resolves([
{
eventName: 'COMMAND_EXECUTION',
type: Telemetry.EVENT,
enableO11y: true,
o11yUploadEndpoint: 'https://o11y.example.com',
productFeatureId: 'aJCEE0000000mHP4AY',
plugin: 'myPlugin',
command: 'myCommand',
orgId: 'org1',
devhubId: 'hub1',
targetOrgUsername: 'user@example.com',
},
]);

await Uploader.upload('test', 'test', '1.0.0');

expect(createStub.calledTwice).to.equal(true);
expect(createStub.secondCall.args[0].getConnectionFn).to.be.a('function');
});
});
Loading
Loading