Skip to content

Fix TypeScript compatibility issue with ITelemetryPlugin interface #2597

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
MSNev merged 3 commits into from
Jul 3, 2025
Merged

Fix TypeScript compatibility issue with ITelemetryPlugin interface #2597

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
34336cf
Initial plan
Copilot Jul 2, 2025
34e1d71
Fix ITelemetryPlugin interface: make setNextPlugin optional and add d…
Copilot Jul 2, 2025
41b9575
Add full comment from interface to BaseTelemetryPlugin setNextPlugin …
Copilot Jul 2, 2025
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
15 changes: 10 additions & 5 deletions shared/AppInsightsCore/Tests/Unit/src/ApplicationInsightsCore.Tests.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1928,7 +1928,8 @@ class TestSamplingPlugin implements ITelemetryPlugin {
public processTelemetry: (env: ITelemetryItem) => void;
public initialize: (config: IConfiguration) => void;
public identifier: string = "AzureSamplingPlugin";
public setNextPlugin: (next: ITelemetryPlugin) => void;
/** @deprecated - Use processNext() function of the passed IProcessTelemetryContext instead */
public setNextPlugin?: (next: ITelemetryPlugin) => void;
public priority: number = 5;
public version = "1.0.31-Beta";
public nexttPlugin: ITelemetryPlugin;
Expand Down Expand Up @@ -2013,7 +2014,8 @@ class ChannelPlugin implements IChannelControls {
this.isUnloadInvoked = true;
}

setNextPlugin(next: ITelemetryPlugin) {
/** @deprecated - Use processNext() function of the passed IProcessTelemetryContext instead */
setNextPlugin?(next: ITelemetryPlugin) {
this._nextPlugin = next;
}

Expand Down Expand Up @@ -2052,7 +2054,8 @@ class TrackPlugin implements IPlugin {

}

public setNextPlugin(next: ITelemetryPlugin) {
/** @deprecated - Use processNext() function of the passed IProcessTelemetryContext instead */
public setNextPlugin?(next: ITelemetryPlugin) {
this._nextPlugin = next;
}

Expand Down Expand Up @@ -2106,7 +2109,8 @@ class TestOfflineChannelPlugin implements IChannelControls {
this.isUnloadInvoked = true;
}

setNextPlugin(next: ITelemetryPlugin) {
/** @deprecated - Use processNext() function of the passed IProcessTelemetryContext instead */
setNextPlugin?(next: ITelemetryPlugin) {
this._nextPlugin = next;
}

Expand Down Expand Up @@ -2176,7 +2180,8 @@ class TestChannelPlugin implements IChannelControls {
this.isUnloadInvoked = true;
}

setNextPlugin(next: ITelemetryPlugin) {
/** @deprecated - Use processNext() function of the passed IProcessTelemetryContext instead */
setNextPlugin?(next: ITelemetryPlugin) {
this._nextPlugin = next;
}

Expand Down
3 changes: 2 additions & 1 deletion shared/AppInsightsCore/Tests/Unit/src/Dynamic.Tests.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1145,7 +1145,8 @@ class TestSamplingPlugin implements ITelemetryPlugin {
public processTelemetry: (env: ITelemetryItem) => void;
public initialize: (config: IConfiguration) => void;
public identifier: string = "AzureSamplingPlugin";
public setNextPlugin: (next: ITelemetryPlugin) => void;
/** @deprecated - Use processNext() function of the passed IProcessTelemetryContext instead */
public setNextPlugin?: (next: ITelemetryPlugin) => void;
public priority: number = 5;
public version = "1.0.31-Beta";
public nextPlugin: ITelemetryPlugin;
Expand Down
3 changes: 2 additions & 1 deletion shared/AppInsightsCore/Tests/Unit/src/TestPlugins.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,8 @@ export class TestSamplingPlugin implements ITelemetryPlugin {
public processTelemetry: (env: ITelemetryItem) => void;
public initialize: (config: IConfiguration) => void;
public identifier: string = "AzureSamplingPlugin";
public setNextPlugin: (next: ITelemetryPlugin) => void;
/** @deprecated - Use processNext() function of the passed IProcessTelemetryContext instead */
public setNextPlugin?: (next: ITelemetryPlugin) => void;
public priority: number = 5;
public version = "1.0.31-Beta";
public nextPlugin: ITelemetryPlugin;
Expand Down
3 changes: 2 additions & 1 deletion shared/AppInsightsCore/src/JavaScriptSDK.Interfaces/ITelemetryPlugin.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,10 @@ export interface ITelemetryProcessor {
*/
export interface ITelemetryPlugin extends ITelemetryProcessor, IPlugin {
/**
* Set next extension for telemetry processing, this is not optional as plugins should use the
* Set next extension for telemetry processing, this is now optional as plugins should use the
* processNext() function of the passed IProcessTelemetryContext instead. It is being kept for
* now for backward compatibility only.
* @deprecated - Use processNext() function of the passed IProcessTelemetryContext instead
*/
setNextPlugin?: (next: ITelemetryPlugin | ITelemetryPluginChain) => void;

Expand Down
7 changes: 5 additions & 2 deletions shared/AppInsightsCore/src/JavaScriptSDK/BaseTelemetryPlugin.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,9 +63,12 @@ export abstract class BaseTelemetryPlugin implements ITelemetryPlugin {
public processNext: (env: ITelemetryItem, itemCtx: IProcessTelemetryContext) => void;

/**
* Set next extension for telemetry processing
* Set next extension for telemetry processing, this is now optional as plugins should use the
* processNext() function of the passed IProcessTelemetryContext instead. It is being kept for
* now for backward compatibility only.
* @deprecated - Use processNext() function of the passed IProcessTelemetryContext instead
*/
public setNextPlugin: (next: ITelemetryPlugin | ITelemetryPluginChain) => void;
public setNextPlugin?: (next: ITelemetryPlugin | ITelemetryPluginChain) => void;

/**
* Returns the current diagnostic logger that can be used to log issues, if no logger is currently
Expand Down