add new config to batch properties calls

[gyDBD]

Feature

Add a new config propertyBatchKey so that we are able to batch “properties” call.
Only a specific kind of endpoint would benefit from this:
input parameters format:

ids: str[] (should be the batchKey)
properties: str[] (should be the propertyBatchKey)

response:

properties is not returned in a nested object, but spread at top level. (see getFilmsV2 in example/swapi)
e.g.: { id: 'id_1', property_1: 'foo', property_2: 'boo' }

Status Quo

run node build/swapi-server.js under example/swapi, the getFilmsV2 function will be called three times in a roll.

after this change

run node build/swapi-server.js under example/swapi, the getFilmsV2 function will be only be called once.
And the flow type of response

Manual testing enforce optional properties

https://fluffy.yelpcorp.com/i/18BHFxFfJg0TgsWjWDwngS2c6D4WS8zS.html#L1,L7,L12,L15,L29,L35,L57

Note

I realized it's hard to build something perfect that works for different kinds of use cases. And it adds complexity for both reviewers and me. Given we don't have much time left for this project, I think we should only focus on to support the use case of batching SBP services calls and maybe in the future we can improve this more.

(Previous pr: #261)

[gyDBD]

Only reponseKey (they key in the response that correspond to batchKey, usually id) can be marked as required in the swagger definition. The implementation is undersrc/index.ts and manually tested https://fluffy.yelpcorp.com/i/18BHFxFfJg0TgsWjWDwngS2c6D4WS8zS.html#L1,L7,L12,L15,L29,L35,L57

[magicmark]

As discussed, since this is quite Yelpy and relies on checking swagger stuff specifically (which this tool is currently opinionated about), I'd suggest keeping this logic but moving it to a seperate script that runs in our build, outside of this tool.

added benefit: we can remove the swaggerPath / httpMethod keys etc since we'll know how to map to it.

[gyDBD]

Hmm, you mean move the script to ggs? But the propertyBatchKey needs to be in dataloader-codegen, if anyone else uses propertyBatchKey they won't have correct flow type.

[gyDBD]

nvm, saw your other command!

[gyDBD]

script to enforce the swagger contract will be moved to Yelp-land. The review comments on those lines will be addressed there.

[magicmark]

fix n ship, awesome stuff! 🎉🎉🎉

[magicmark]

fix n ship, awesome stuff! 🎉🎉🎉

[gyDBD]

@magicmark Hey Mark, thanks so much for the review!! I've addressed all your comments,do you want to take a final look?

[magicmark]

🥳 🎉