single upsert and bulk Upsert accept divergent document types

[agorischek]

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

Describe the bug
The Upsert bulk operation accepts fewer input types than the upsert non-bulk method. The bulk approach requires a JSONObject, while the single upsert approach accepts unknown. This seems to prevent submitting documents that are instances of custom classes in bulk. Is this intentional?

To Reproduce

1. Create a JavaScript object from a custom class
2. Attempt to write it to Cosmos using Upsert operation via bulk method

Expected behavior
Object is written as document, just like as if upsert were called directly.

Additional context
Code sample:

  // Case 1: Plain object
  const document1 = { id: "1" };
  // TypeScript is fine with this and the operation succeeds
  await container.items.upsert(document1);

  // Case 2: Class
  class Document {
    constructor(public id: string) {}
  }
  const document2 = new Document("2");
  // TypeScript complains:
  //   Type 'Document' is not assignable to type 'JSONObject'.
  //     Index signature for type 'string' is missing in type 'Document'.ts(2322)
  await container.items.batch([
    {
      operationType: "Upsert",
      resourceBody: document2,
    },
  ]);

  // Case 3: Class with type casting
  const document3 = new Document("3");
  // Operation succeeds
  await container.items.bulk([
    {
      operationType: "Upsert",
      resourceBody: document3 as unknown as JSONObject,
    },
  ]);

[cjshelton]

Hi @xirzec - I see you've been somewhat active on this issue, so I'm just reaching out to see if you know any further details on this? I see it has been added to the "2022-08 milestone" - does this mean the issue has been acknowledged and planned to be fixed for then?

I'm seeing this exact issue when trying to save an object which has a Date type on it. Date does not seem to satisfy the JSONValue type.

Any help / comments on this would be appreciated to help us know whether we're going about this in the right way. Should we be manually converting the object to satisfy the JSONValue constraint by explicitly stringifying dates?

[agorischek]

Should we be manually converting the object to satisfy the JSONValue constraint by explicitly stringifying dates?

Hey @cjshelton, I'm far from a Cosmos expert but my understanding is that in your case, yes, you'll want to convert your Date object to a string first. The JavaScript Date object has a bunch of methods on it (e.g. getMonth, getDay) and those can't be represented in JSON. In particular I'd encourage you to try .toISOString() on your date before storing.

[cjshelton]

Yep that's what I've been thinking. Thanks for taking the time to respond @agorischek

[xirzec]

I'm also not a cosmos expert, but if it works with type casting it seems we might just need to fix our typings here?

I'll let @sajeetharan and @jay-most comment as to when this work will be able to be completed

[ghost]

Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc @bkolant-MSFT, @sajeetharan, @pjohari-ms.

Issue Details

---

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

Describe the bug
The Upsert bulk operation accepts fewer input types than the upsert non-bulk method. The bulk approach requires a JSONObject, while the single upsert approach accepts unknown. This seems to prevent submitting documents that are instances of custom classes in bulk. Is this intentional?

To Reproduce

1. Create a JavaScript object from a custom class
2. Attempt to write it to Cosmos using Upsert operation via bulk method

Expected behavior
Object is written as document, just like as if upsert were called directly.

Additional context
Code sample:

  // Case 1: Plain object
  const document1 = { id: "1" };
  // TypeScript is fine with this and the operation succeeds
  await container.items.upsert(document1);

  // Case 2: Class
  class Document {
    constructor(public id: string) {}
  }
  const document2 = new Document("2");
  // TypeScript complains:
  //   Type 'Document' is not assignable to type 'JSONObject'.
  //     Index signature for type 'string' is missing in type 'Document'.ts(2322)
  await container.items.batch([
    {
      operationType: "Upsert",
      resourceBody: document2,
    },
  ]);

  // Case 3: Class with type casting
  const document3 = new Document("3");
  // Operation succeeds
  await container.items.bulk([
    {
      operationType: "Upsert",
      resourceBody: document3 as unknown as JSONObject,
    },
  ]);

Author:	agorischek
Assignees:	sajeetharan
Labels:	bug, customer-reported, Client, Cosmos, Service Attention
Milestone:	azure-cosmos jan release

[github-actions]

Hi @agorischek, we deeply appreciate your input into this project. Regrettably, this issue has remained unresolved for over 2 years and inactive for 30 days, leading us to the decision to close it. We've implemented this policy to maintain the relevance of our issue queue and facilitate easier navigation for new contributors. If you still believe this topic requires attention, please feel free to create a new issue, referencing this one. Thank you for your understanding and ongoing support.