feat(msw): possible to overwrite value when creating an object with msw mock

[soartec-lab]

Status

READY

Description

I responded to part of #822

If there is only one response case and the type is object, the returned value can be overwritten externally by specifying overrideResponse as an argument.
In order to handle the case where it is an array of object such as Pets, after calculating the return value, we determine whether overwriting is possible based on whether overrideResponse is included in it.

Todos

• Tests
• Documentation
• Changelog Entry (unreleased)

Steps to Test or Reproduce

1. Specify basic pet schema as input
2. execute orval

orval

3. generated mock function bellow:

export const getListPetsMock = (overrideResponse?: any) => (Array.from({
  length: faker.number.int({ min: 1, max: 10 }) }, (_, i) => i + 1).map(() => ({
    id: faker.number.int({min: undefined, max: undefined}),
    name: faker.word.sample(),
    tag: faker.helpers.arrayElement([faker.word.sample(), undefined]),
    ...overrideResponse
  }))
)

export const getShowPetByIdMock = (overrideResponse?: any) => ({
  id: faker.number.int({min: undefined, max: undefined}),
  name: faker.word.sample(),
  tag: faker.helpers.arrayElement([faker.word.sample(), undefined]), ...overrideResponse
})

4. usage

import { getListPetsMock, getShowPetByIdMock } from 'gen/pets.msw'

const pets = getListPetsMock({name: 'orverride'})
console.log(pets)
// => [{ id: 645061935104000, name: "orverride", tag: undefined }, { id: 83169910980608, name: "orverride", tag: undefined }]
​​
const pet = getShowPetByIdMock({name: 'orverride'})
console.log(pet)
// => { id: 7272122785202176, ​name: "orverride", tag: undefined }

[melloware]

@Will-Mann-16 can you review since you recently did a lot of work in Mock?

[soartec-lab]

@Will-Mann-16
Hi, could you review this as well?

[melloware]

It looks good to me if @Will-Mann-16 has an issue we can re-open.

[Will-Mann-16]

This was the only thing I saw - if it's tested and works I'm happy. Otherwise might need a separate issue but would be an easy fix.

[Will-Mann-16]

Some ESLint config setups would throw errors if you try to spread an undefined value, is it worth setting this to a default param of {}, empty object?

[soartec-lab]

@Will-Mann-16

Thank you for your comment. That's good. I didn't have that perspective. I'll fix it in another PR.