major: ACNA-2584 - add Adobe App Builder State Store

[shazron]

This is a breaking change. The CosmosDB State Store has been removed, and we will be using our own State Store.
Note for put, the new restriction is we can only push strings, not any other types like objects.

The change has been designed to be "drop in" for existing users, so they won't need to change their code except if they have been pushing non-string data to the state store, they will have to stringify their values now.

How Has This Been Tested?

Note that the e2e tests will only run in node-16, for node-18+ you will need this update in @adobe/aio-lib-core-networking: adobe/aio-lib-core-networking@87a2e7f

• npm test
• e2e tests (using the adp-state-storage local server)

MERGING NOTES (DO NOT MERGE UNTIL COMPLETED)

• The prod and stage endpoints have not been finalized, there are placeholder urls in lib/constants.js
• The Adobe AB State Store has been released to production

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

• I have signed the Adobe Open Source CLA.
• My code follows the code style of this project.
• My change requires a change to the documentation.
• I have updated the documentation accordingly.
• I have read the CONTRIBUTING document.
• I have added tests to cover my changes.
• All new and existing tests passed.

[moritzraho]

Nice!
I've added a few inline comments already.

There is a lot of cp/paste from StateStore.js into AdobeStateStore.js but it would also be unnecessary work to support the StateStore.js interface for the App Builder Storage State service as the CosmosDB implementation differs in the API, input validation, limits,..
Maybe we are better off ditching the CosmosDB support + generic interface altogether and focusing on supporting one implementation.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (04027cf) 100.00% compared to head (2f12dbd) 100.00%.

Additional details and impacted files

@@            Coverage Diff            @@
##            master      #134   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            6         6           
  Lines          173       166    -7     
  Branches        36        29    -7     
=========================================
- Hits           173       166    -7     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[moritzraho]

lgtm!

Few esthetics nitpicks

[sandeep-paliwal]

Maybe we are better off ditching the CosmosDB support + generic interface altogether and focusing on supporting one implementation.

@moritzraho @shazron What will be impact on support of BYO creds by not sticking to generic interface? Will it mean that the new state lib will not support BYO creds now?

[shazron]

Maybe we are better off ditching the CosmosDB support + generic interface altogether and focusing on supporting one implementation.

@moritzraho @shazron What will be impact on support of BYO creds by not sticking to generic interface? Will it mean that the new state lib will not support BYO creds now?

Moritz and I discussed this: since this is a major version update, we won't break existing users since if they want to do BYO creds for CosmosDB, they can use the previous major version. We can have a 2.x branch there if we need to patch for security updates but going forward we will only develop for 3.x (this update).

[evgeniykapelko]

@shazron Please tell me, is it possible to specify search criteria as get parameters? I haven't found any documentation on the state of the Adobe App Builder Store.

[evgeniykapelko]

Hey @shazron Please tell me where I can look at the documentation for Adobe State Store?

I see that all requests go to the https://storage-state-amer.app-builder.adp.adobe.io domain or http://storage-state-amer.stg.app-builder.corp.adp.adobe.io, but I didn’t find any documentation about what other endpoints are provided?

Regards,
Eugene

[moritzraho]

Hi @evgeniykapelko, thanks for your interest!
The Adobe State storage service is still a work in progress and there is no documentation for it as of now. This PR is not going to be released yet.
We will eventually support listing keys, but this may not be part of the first State service release.

[shazron]

this PR was merged, but reverted. New PR with the same changes at #135