msw@next

[dajinchu]

🎯 Changes

This makes msw-trpc work with the breaking changes in MSW 2, currently released under msw@next. I needed this because my project is on Node 18, which is not supported in msw v1, so I was forced to upgrade msw, and thus this package too.

API Change

MSW 2 changes the API a bit: https://github.com/mswjs/msw/blob/feat/standard-api/MIGRATING.md

With no context object, and response construction being done with HttpResponse.json I wasn't sure what the best design for this library would be. I have implemented a data()and getInput() function that just gets passed in the params object.

So this:

  trpcMsw.userById.query((req, res, ctx) => {
    return res(ctx.status(200), ctx.data({ id: '1', name: 'Uncle bob' }))
  }),

becomes

  trpcMsw.userById.query(({data}) => {
    return data({ id: '1', name: 'Uncle bob' })
  }),

Can also use HttpResponse from msw and type-safety still works:

  trpcMsw.userById.query(({data}) => {
    return HttpResponse.json({results: {data: { id: '1', name: 'Uncle bob' }}})
  }),

Other API proposals:

  // Extend the HttpResponse prototype (but now how will we apply superjson? clone the response and rewrite it?:
  trpcMsw.userById.query(({data}) => {
    return HttpResponse.trpc({ id: '1', name: 'Uncle bob' })
  })

  // do raw data (how will you return an error):
  trpcMsw.userById.query(({data}) => {
    return { id: '1', name: 'Uncle bob' }
  })

Would love some feedback on the API! Thanks.

[danilofuchs]

Is the API for returning 404, to throw a NOT_FOUND TRPCError?

[maloguertin]

Hey thanks for this! I'll try to review this tomorrow. Sorry I have been pretty busy lately.

[dajinchu]

No worries. Latest commit actually changes it to the "raw data" option and catches TRPCError. Been in use at my company since without issue

[danilofuchs]

I believe the PR must be updated to depend on MSW@2.0

[maloguertin]

What would you think of creating an helper for this to clean up the code a bit:

const httpMethodByProcedureKey = {
  query: http.get,
  post: http.post
}

const getInputByProcedureKey = {
  query: getQueryInput,
  mutation: getMutationInput
}

const createHandler(procedureKey: 'query' | 'mutation') => {
  const httpMethod = httpMethodByProcedureKey[procedureKey]
  const getInput = getInputByProcedureKey[procedureKey]
   
   return handler => (httpMethod)(
              buildUrlFromPathParts(pathParts),
              async (params): Promise<any> => {
                try {
                  const body = await handler(await getInput(params.request, transformer))
                  return HttpResponse.json({ result: { data: transformer.input.serialize(body) } })
                } catch (e) {
                  if (e instanceof TRPCError) {
                    const status = getHTTPStatusCodeFromError(e)
                    return HttpResponse.json(
                      {
                        error: {
                          message: e.message,
                          code: TRPC_ERROR_CODES_BY_KEY[e.code],
                          data: { code: e.code, httpStatus: status },
                        },
                      },
                      { status }
                    )
                  } else {
                    throw e
                  }
                }
              }
            )
}

[maloguertin]

I believe the PR must be updated to depend on MSW@2.0

Do you mean the PR in itself or the package dependencies?

[maloguertin]

This PR seems to adress this feature request: #13

[danilofuchs]

I believe the PR must be updated to depend on MSW@2.0

Do you mean the PR in itself or the package dependencies?

The package dependencies must be changed from msw@^1.0.1 to msw@^2.0.10. This PR currently sets it to msw@next.

Of course, that would be a breaking change. (Also for dropping support for Node <18)

[maloguertin]

I believe the PR must be updated to depend on MSW@2.0

Do you mean the PR in itself or the package dependencies?

The package dependencies must be changed from msw@^1.0.1 to msw@^2.0.10. This PR currently sets it to msw@next.

Of course, that would be a breaking change. (Also for dropping support for Node <18)

Oh you're right, I thought I had seen msw@next on their website

[maloguertin]

Set dependency to ^2.0.0

[maloguertin]

We also need to update the doc

[madi-tracksuit]

Anything I can do to help unblock and get this shipped? Our team also has a prerequisite for msw v2.

If it's just documentation or a breaking change hesitation could it be shipped as a pre-release version?

[maloguertin]

Anything I can do to help unblock and get this shipped? Our team also has a prerequisite for msw v2.

If it's just documentation or a breaking change hesitation could it be shipped as a pre-release version?

I wouldn't mind that, I'm not sure I'll have the time this week but I'm open to review the PR for that!

[madi-tracksuit]

For publishing a pre-release version? Would need access to npm for that, but I'll happily bump the package.json

[maloguertin]

For publishing a pre-release version? Would need access to npm for that, but I'll happily bump the package.json

yes sorry that is what I was referring to!

[madi-tracksuit]

@maloguertin #31