Common add as() function #920
Conversation
…n value to a pre-defined key in state while preserving any values in the `data` key
|
@josephjclark What do you think about this? |
|
@PiusKariuki That's actually really nice - This has been sitting at the back of my mind for a while and I didn't think it would work well. But seeing it here I love it! Let me circulate for some feedback within the team. Thank you! |
|
|
||
|
|
||
| /** | ||
| * Runs an operation and saves the return value to a pre-defined key in state |
There was a problem hiding this comment.
Well, almost!
The ask here is to save what would have been saved to state.data onto state.<key>
I'll pick this up in comments on the test
|
|
||
| const { foo: {data: fooData} } = await as('foo', mockOperation('https://localhost:1/as'))(state); | ||
|
|
||
| expect(fooData).to.eql('this data object has been changed'); |
There was a problem hiding this comment.
I actually expect this to be more like:
const result = await as('foo', () => ({ data: 'bar' }))(state);
expect(result).to.eql({ foo: 'bar' });
| * @public | ||
| * @function | ||
| * @example | ||
| * as('lookup_table.option_set', get('fixture/?fixture_type=option_set_mapping')); |
There was a problem hiding this comment.
This example is interesting. If the key has dot notation, should it be a path? This would be easy to implement with lodash.set. But I also don't know the use-case
| * @function | ||
| * @example | ||
| * as('lookup_table.option_set', get('fixture/?fixture_type=option_set_mapping')); | ||
| * @param {string} key - The key used to store the return value in the state object |
There was a problem hiding this comment.
Note for me: Perhaps as well as the string, we can accept an object which maps stuff. So "key" and { data: "key" } would be equivalent.
This would bypass the problems of a) only state.data gets mapped and state.data is kind of arbitrary, and b) what if I want to map multiple state keys, like http data AND response?
Please don't implement this yet, it might be too complicated
Summary
Performs and operation and saves the result in a pre-defined key while preserving any values in the
datakey.Fixes #800
Details
I save the initial state
datavalue in a variable then after I perform the operation I return that value bak in thedatakey in state.AI Usage
Please disclose how you've used AI in this work (it's cool, we just want to know!):
You can read more details in our Responsible AI Policy
Review Checklist
Before merging, the reviewer should check the following items:
dev only changes don't need a changeset.