ActivityId is always undefined in FeedResponse

[victor-meng]

• Package Name: @azure/cosmos
• Package Version: 3.16.2
• Operating system: Windows
• nodejs
  • version:
• browser
  • name/version:
• typescript
  • version:
• Is the bug related to documentation in
  • README.md
  • source code documentation
  • SDK API docs on https://docs.microsoft.com

Describe the bug
ActivityId property is always undefined in FeedResponse.

To Reproduce
Steps to reproduce the behavior:

1. Log into ms.azure.portal.com
2. Open any Cosmos DB account
3. Navigate to data explorer
4. Run any query on a container
5. Notice that the activityId is undefined in the response but is available in the response header

Expected behavior
A clear and concise description of what you expected to happen.
The correct activityId should be included in the FeedResponse.

Screenshots
If applicable, add screenshots to help explain your problem.

Additional context
Add any other context about the problem here.
Doc reference for FeedResponse: https://learn.microsoft.com/en-us/javascript/api/@azure/cosmos/feedresponse?view=azure-node-latest

[topshot99]

@victor-meng can you please share entire headers object. I don't see x-ms-activity-id field in the header which you shared.

[topshot99]

@victor-meng we found it bit difficult to reproduce the object (shared in screen shot) by following the steps mentioned. Can you please describe your steps to reproduce more?

[victor-meng]

@topshot99 Here's the HAR file: ActivityId missing in FeedResponse.zip

The x-ms-activity-id is in the response header section:

[victor-meng]

@victor-meng we found it bit difficult to reproduce the object (shared in screen shot) by following the steps mentioned. Can you please describe your steps to reproduce more?

You can only get the FeedResponse in the screenshot by setting break-points in our data explorer code. We get the FeedResponse after calling QueryIterator.fetchNext. Here's what we do in data explorer:

1. We call client().database(databaseId).container(containerId).items.query(query, options) to get the query iterator.
2. We call fetchNext on the query iterator to get the query response.

I imagine you should be able to reproduce this issue by making the same calls on any database and container.

[victor-meng]

Another thing to add is that the ErrorResponse does contain the ActivityId:

[topshot99]

Hey @victor-meng,

tried these configurations:
Package Name: @azure/cosmos
Package Version: 3.16.2
Operating system: Windows

over my system and ran this basic query mentioned in our readme document.

await container.items
        .query("SELECT * from c WHERE c.isCapitol = false")
        .fetchNext();

And I was getting activity id in the response also it was present inside header(check ss). Attaching screenshot here:

so, from this we can surely say that activity id is not undefined for all the query responses.
I guess it might be failing for some of the cases, but you need supply us more data in order to figure out those cases.
cc: @sajeetharan @v1k1

[victor-meng]

Thanks @topshot99 for investigating. I see that the basic query that you ran didn't include an options parameter, so I suspect the issue is with the FeedOptions that we are using. Here's the exact options object that we are passing to the SDK:
{
"enableCrossPartitionQuery": true,
"populateQueryMetrics": true,
"enableScanInQuery": true,
"forceQueryPlan": true,
"maxItemCount": 100,
"maxDegreeOfParallelism": 6
}

I checked the documentation for FeedOptions but it didn't mention anything about ActivityId: https://learn.microsoft.com/en-us/javascript/api/@azure/cosmos/feedoptions?view=azure-node-latest

[topshot99]

Hey @victor-meng ,
You are correct feed options is causing this issue. Also, I have figured out that these options ("forceQueryPlan": true and "maxDegreeOfParallelism": 6) is causing this issue. With these 2 options set sdk is not getting x-ms-activity-id header hence the value of activity id is undefined.
cc: @sajeetharan

[victor-meng]

Awesome, thank you for confirming @topshot99 !

[sajeetharan]

Check with Backend team to pass the activityid