[nodejs] Clean up inputs/outputs for InvokeAgent spans based on new OTel format by fpfp100 · Pull Request #137 · microsoft/Agent365-nodejs

PengF (fpfp100) · 2026-01-07T19:28:05Z

Clean up inputs/outputs for InvokeAgent spans based on new OTel format
Before:

After:

Copilot

Pull request overview

This pull request refactors the handling of input messages for InvokeAgent spans to align with a new OpenTelemetry format. Instead of storing the complete input structure and extracting attributes separately, the code now intelligently processes input arrays to extract user text content when available, falling back to the full array JSON when no user messages are present.

Key Changes:

Introduced a new buildInputMessages method that extracts text content from user role messages or returns the full array
Removed the previous logic that called Utils.getAttributesFromInput and set additional attributes from input
Added comprehensive test coverage for both extraction scenarios (user messages present and assistant-only messages)

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.

File	Description
`packages/agents-a365-observability-extensions-openai/src/OpenAIAgentsTraceProcessor.ts`	Implements new `buildInputMessages` method to extract user text content from input arrays, replacing previous attribute extraction logic
`tests/observability/extension/openai/OpenAIAgentsTraceProcessor.test.ts`	Adds two test cases validating the new input message processing behavior for both user and assistant-only scenarios

Copilot

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

Copilot

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

Nikhil Navakiran (nikhilNava)

Can you post the before and after for the input / output values?

PengF (fpfp100) · 2026-01-12T20:32:19Z

Can you post the before and after for the input / output values?

added

Copilot

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 9 comments.

Copilot · 2026-01-13T19:02:02Z

+        spanData: {
+          type: 'response' as const,
+          name: 'ResponseArray',
+          _input:  inputArray,         


Extra whitespace before 'inputArray'. There should be only one space after the colon.

Suggested change

_input: inputArray,

_input: inputArray,

Copilot · 2026-01-13T19:02:02Z

+      }
+    }
+  }



The new private method 'buildInputMessages' is missing JSDoc documentation. Other private methods in this file have JSDoc comments explaining their purpose. Add a JSDoc comment describing what this method does, its parameters, and return value.

Suggested change

/**

* Builds a JSON-encoded representation of input messages for tracing.

* Extracts the text content of user-role messages when available, otherwise

* falls back to serializing the full input array.

*

* @param arr - Array of message objects containing a role and string content.

* @returns A JSON string of user message contents, or the original array if no valid user content is found.

*/

Copilot · 2026-01-13T19:02:03Z

+      if (!Array.isArray(content)) {
+        continue;


Missing test coverage for the edge case where elements in the output array have non-array content properties. The code handles this case with a check on line 291-292, but there's no test verifying this behavior works correctly.

Copilot · 2026-01-13T19:02:03Z

+  }
+
+  private buildOutputMessages(arr: Array<{ role: string; content: Array<{ type: string; text: string }> }>): string {
+    const userTexts: string[] = [];


The variable name 'userTexts' is misleading in the context of 'buildOutputMessages'. This variable collects output texts (type 'output_text'), not user texts. Consider renaming to 'outputTexts' for clarity.

Copilot · 2026-01-13T19:02:03Z

-          otelSpan.setAttribute(OpenTelemetryConstants.GEN_AI_OUTPUT_MESSAGES_KEY, JSON.stringify(resp.output));
+          otelSpan.setAttribute(
+            OpenTelemetryConstants.GEN_AI_OUTPUT_MESSAGES_KEY,
+            this.buildOutputMessages(resp.output  as Array<{ role: string; content: Array<{ type: string; text: string }> }>)


Extra whitespace before 'as' keyword. There should be only one space between 'output' and 'as'.

Suggested change

this.buildOutputMessages(resp.output as Array<{ role: string; content: Array<{ type: string; text: string }> }>)

this.buildOutputMessages(resp.output as Array<{ role: string; content: Array<{ type: string; text: string }> }>)

Copilot · 2026-01-13T19:02:03Z

+    for (const { content } of arr) {
+      if (!Array.isArray(content)) {
+        continue;
+      }
+
+      for (const { type, text } of content) {


The destructuring pattern 'for (const { content } of arr)' on line 290 will throw a runtime error if any element in the array is null, undefined, or doesn't have a 'content' property. Add a null check before destructuring to prevent potential runtime errors.

Suggested change

for (const { content } of arr) {

if (!Array.isArray(content)) {

continue;

}

for (const { type, text } of content) {

for (const message of arr) {

if (!message || !Array.isArray(message.content)) {

continue;

}

for (const part of message.content) {

if (!part) {

continue;

}

const { type, text } = part;

Copilot · 2026-01-13T19:02:04Z

+        continue;
+      }
+
+      for (const { type, text } of content) {


The destructuring pattern 'for (const { type, text } of content)' on line 295 will throw a runtime error if any element in the content array is null, undefined, or doesn't have 'type' or 'text' properties. Add a null check before destructuring to prevent potential runtime errors.

Suggested change

for (const { type, text } of content) {

for (const item of content) {

if (!item) {

continue;

}

const { type, text } = item;

Copilot · 2026-01-13T19:02:04Z

        otelSpan.setAttribute(OpenTelemetryConstants.GEN_AI_INPUT_MESSAGES_KEY, inputObj);
      } else if (Array.isArray(inputObj)) {
-        // Store the complete _input structure as JSON
+        // build the input messages from array


Comment should start with an uppercase letter for consistency with the codebase style. Change 'build' to 'Build'.

Suggested change

// build the input messages from array

// Build the input messages from array

Copilot · 2026-01-13T19:02:04Z

+
+    return JSON.stringify(userTexts.length ? userTexts : arr);
+  }
+


The new private method 'buildOutputMessages' is missing JSDoc documentation. Other private methods in this file have JSDoc comments explaining their purpose. Add a JSDoc comment describing what this method does, its parameters, and return value.

Suggested change

/**

* Builds a serialized representation of output messages from the agent response.

*

* Extracts text from message content parts where the part type is `output_text`

* and returns a JSON string of those texts. If no such texts are found, the

* original message array is serialized instead.

*

* @param arr - Array of response messages, each containing a role and a content

* array of typed text parts.

* @returns JSON string containing the extracted output texts or the original

* message array as a fallback.

*/

update input message

b4a7717

Copilot AI review requested due to automatic review settings January 7, 2026 19:28

PengF (fpfp100) requested a review from a team as a code owner January 7, 2026 19:28

Copilot started reviewing on behalf of PengF (fpfp100) January 7, 2026 19:28 View session

Copilot AI reviewed Jan 7, 2026

View reviewed changes

comments

aa10faf

Julio Carlos Menendez (juliomenendez) requested changes Jan 7, 2026

View reviewed changes

Comment thread packages/agents-a365-observability-extensions-openai/src/OpenAIAgentsTraceProcessor.ts

comment

aa0f134

Copilot AI review requested due to automatic review settings January 7, 2026 20:27

Copilot started reviewing on behalf of PengF (fpfp100) January 7, 2026 20:28 View session

Copilot AI reviewed Jan 7, 2026

View reviewed changes

Comment thread packages/agents-a365-observability-extensions-openai/src/OpenAIAgentsTraceProcessor.ts

Comment thread packages/agents-a365-observability-extensions-openai/src/OpenAIAgentsTraceProcessor.ts Outdated

comment

9ecfd83

Julio Carlos Menendez (juliomenendez) requested changes Jan 7, 2026

View reviewed changes

Comment thread packages/agents-a365-observability-extensions-openai/src/OpenAIAgentsTraceProcessor.ts Outdated

add test to cover handling non standard input.

a20c19a

Copilot AI review requested due to automatic review settings January 7, 2026 23:26

Copilot started reviewing on behalf of PengF (fpfp100) January 7, 2026 23:27 View session

Copilot AI reviewed Jan 7, 2026

View reviewed changes

Comment thread tests/observability/extension/openai/OpenAIAgentsTraceProcessor.test.ts

Comment thread tests/observability/extension/openai/OpenAIAgentsTraceProcessor.test.ts

Julio Carlos Menendez (juliomenendez) previously approved these changes Jan 7, 2026

View reviewed changes

threddy reviewed Jan 8, 2026

View reviewed changes

Comment thread tests/observability/extension/openai/OpenAIAgentsTraceProcessor.test.ts

threddy previously approved these changes Jan 8, 2026

View reviewed changes

Nikhil Navakiran (nikhilNava) requested changes Jan 8, 2026

View reviewed changes

fix the message process to match open ai agent

7e9dc62

PengF (fpfp100) dismissed stale reviews from threddy and Julio Carlos Menendez (juliomenendez) via 7e9dc62 January 12, 2026 19:52

Nikhil Navakiran (nikhilNava) approved these changes Jan 13, 2026

View reviewed changes

Julio Carlos Menendez (juliomenendez) approved these changes Jan 13, 2026

View reviewed changes

Merge branch 'main' into users/pefan/input

e99a70d

Copilot AI review requested due to automatic review settings January 13, 2026 18:57

Copilot started reviewing on behalf of PengF (fpfp100) January 13, 2026 18:57 View session

PengF (fpfp100) merged commit 02e673f into main Jan 13, 2026
11 checks passed

PengF (fpfp100) deleted the users/pefan/input branch January 13, 2026 19:00

Copilot AI reviewed Jan 13, 2026

View reviewed changes

+  /**
+   * Builds a JSON-encoded representation of input messages for tracing.
+   * Extracts the text content of user-role messages when available, otherwise
+   * falls back to serializing the full input array.
+   *
+   * @param arr - Array of message objects containing a role and string content.
+   * @returns A JSON string of user message contents, or the original array if no valid user content is found.
+   */

	this.buildOutputMessages(resp.output as Array<{ role: string; content: Array<{ type: string; text: string }> }>)
	this.buildOutputMessages(resp.output as Array<{ role: string; content: Array<{ type: string; text: string }> }>)

-      for (const { type, text } of content) {
+      for (const item of content) {
+        if (!item) {
+          continue;
+        }
+        const { type, text } = item;

	// build the input messages from array
	// Build the input messages from array

+  /**
+   * Builds a serialized representation of output messages from the agent response.
+   *
+   * Extracts text from message content parts where the part type is `output_text`
+   * and returns a JSON string of those texts. If no such texts are found, the
+   * original message array is serialized instead.
+   *
+   * @param arr - Array of response messages, each containing a role and a content
+   *   array of typed text parts.
+   * @returns JSON string containing the extracted output texts or the original
+   *   message array as a fallback.
+   */

Uh oh!

Conversation

PengF (fpfp100) commented Jan 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Nikhil Navakiran (nikhilNava) left a comment

Choose a reason for hiding this comment

Uh oh!

PengF (fpfp100) commented Jan 12, 2026

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Jan 13, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 13, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 13, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 13, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 13, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 13, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 13, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 13, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 13, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

PengF (fpfp100) commented Jan 7, 2026 •

edited

Loading