Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

增强 response 函数:允许定制返回状态码和返回头,支持返回非JSON序列化类型 #140

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -183,6 +183,36 @@ export default [
},
},
},
// Custom status code and response
{
url: '/api/query',
method: 'get',
response: ({ query, res }) => {
// res.setHeader('X-Hello', 'World')
if (query.name === 'vite') {
res.statusCode = 200
return { message: 'OK' }
} else {
res.statusCode = 404
return { message: 'Not Found' }
}
},
},
{
url: '/api/plaintext',
method: 'get',
response: () => {
return '200 OK'
},
},
// 204 No Content
{
url: '/api/204',
method: 'get',
response: () => {
return
},
},
{
url: '/api/text',
method: 'post',
Expand Down
48 changes: 43 additions & 5 deletions packages/vite-plugin-mock/src/createMockServer.ts
Original file line number Diff line number Diff line change
Expand Up @@ -87,16 +87,41 @@ export async function requestMiddleware(opt: ViteMockOptions) {
await rawResponse.bind(self)(req, res)
} else {
const body = await parseJson(req)
res.setHeader('Content-Type', 'application/json')
if (opt) {
res.setHeader('Access-Control-Allow-Credentials', true)
res.setHeader('Access-Control-Allow-Origin', req.headers.origin || '*')
}
res.statusCode = statusCode || 200
const mockResponse = isFunction(response)
? response.bind(self)({ url: req.url as any, body, query, headers: req.headers })
: response
res.end(JSON.stringify(Mock.mock(mockResponse)))
let mockResponse = Mock.mock(
isFunction(response)
? response.bind(self)({
url: req.url as any,
body,
query,
headers: req.headers,
req,
res,
})
: response,
)
if (typeof mockResponse === 'undefined') {
res.statusCode = 204
res.end()
return
}
if (!res.statusCode) {
res.statusCode = statusCode || 200
}
if (!res.getHeader('Content-Type')) {
res.setHeader('Content-Type', guessContentType(mockResponse))
}
if (
res.getHeader('Content-Type') === 'application/json' &&
typeof mockResponse !== 'string'
) {
mockResponse = JSON.stringify(mockResponse)
}
res.end(mockResponse)
}

logger && loggerOutput('request invoke', req.url!)
Expand All @@ -107,6 +132,19 @@ export async function requestMiddleware(opt: ViteMockOptions) {
return middleware
}

function guessContentType(body: any) {
if (body instanceof Buffer || body instanceof Uint8Array) {
return 'application/octet-stream'
}
switch (typeof body) {
case 'string':
return 'text/plain'
case 'undefined':
default:
return 'application/json'
}
}

// create watch mock
function createWatch(opt: ViteMockOptions, config: ResolvedConfig) {
const { configPath, logger, watchFiles } = opt
Expand Down
2 changes: 1 addition & 1 deletion packages/vite-plugin-mock/src/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ export declare interface MockMethod {
response?:
| ((
this: RespThisType,
opt: { url: Recordable; body: Recordable; query: Recordable; headers: Recordable },
opt: { url: Recordable; body: Recordable; query: Recordable; headers: Recordable, req: IncomingMessage, res: ServerResponse },
) => any)
| any
rawResponse?: (this: RespThisType, req: IncomingMessage, res: ServerResponse) => void
Expand Down