salesforce Add support for asyncMode in bulk operation

[mtuchi]

Summary

Add asyncMode option in bulk operation. If you don't provided this extra asyncMode option, we return all record info to state.data as we currently do.

Fixes #286

Details

• If asyncMode is true we return batchInfo
• Formatted the results to { success: true, batches: [], errors: []} if asyncMode: true
• Add docs for state.data.batches
• Add integration test when asyncMode: true

AI Usage

Please disclose how you've used AI in this work (it's cool, we just want to know!):

• Code generation (copilot but not intellisense)
• Learning or fact checking
• Strategy / design
• Optimisation / refactoring
• Translation / spellchecking / doc gen
• Other
• I have not used AI

You can read more details in our Responsible AI Policy

Review Checklist

Before merging, the reviewer should check the following items:

• Does the PR do what it claims to do?
• If this is a new adaptor, added the adaptor on marketing website ?
• Are there any unit tests?
• Is there a changeset associated with this PR? Should there be? Note that
  dev only changes don't need a changeset.
• Have you ticked a box under AI Usage?

[josephjclark]

A promise can only resolve once. If there are multiple queue events, for multiple chunks, then they'll never report back to user code. In other words, we'll only ever report back the first batch here.

[mtuchi]

🤔 I have tried running the test with a batch size of 1 and i got the expected results.
Can you tell me more about this ?

[mtuchi]

I have tested multiple batches by reducing the batch size to 1 and run integration test that insert two records with the option asynMode: true, I can see that i am getting two batches records after the bulk operation is done.

[josephjclark]

Typo

[josephjclark]

@mtuchi where are we on this? I'm still not comfortable with this promise that returns multiple times.

When you call resolve(), you are saying to the Javascript: "I have finished with my promise, please continue executing". Until then, the runtime is patiently waiting for the promise to end.

In your code, every time the queue event is called, you're trying to resolve the promise again.

There are two really important things here:

1. A promise can only return once. If you do promise.then() twice, you'll get the same value back twice. Your code is sort of working because it returns the same array twice - it's just that the array itself has changed
2. Each Operation is a Promise, and our Runtime waits for each Operation to resolve before executing the next one (or moving on to the next workflow step). Your adaptor code is "exiting" the operation after the first queue call, and so our runtime carries on. What happens when the promise resolves a second time? I actually don't know - but we can't trust the order of events that follows next.

I can't merge this as-is, it's too unsafe.

What we actually want to do is resolve the promise after the last queue event has triggered. But we have no way of knowing that, right? jsforce gives us no "queue finished event.

See the issue for a possible solution, although I'm not totally sure I trust that either 🤔

[josephjclark]

promises demo

[mtuchi]

Hiya @josephjclark i have forgotten to close this PR, from our last conversation we don't want this implementation and we agreed to put more effort on updating jsforce instead.