-
-
Notifications
You must be signed in to change notification settings - Fork 2.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Fix endpoint response with immutable header (#9876)
* add test * added runtime endpoint test for `new Response` * added `try..catch` for reroute directive handling Fixes #9871 * added changeset * replaced `try..catch` with HTTP status code check based on the suggestion of @lilnasy * updated changeset description * added more tests for the endpoint reroute header * fixed grammar in `renderEndpoint` comment * updated endpoint tests to check for the reroute directive header in lower-case * updated changeset description
- Loading branch information
1 parent
3a50cbf
commit e9027f1
Showing
3 changed files
with
103 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
--- | ||
"astro": patch | ||
--- | ||
|
||
Fixes an issue where using `Response.redirect` in an endpoint led to an error. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,91 @@ | ||
import { | ||
createBasicSettings, | ||
createFs, | ||
createRequestAndResponse, | ||
defaultLogger, | ||
} from '../test-utils.js'; | ||
import { fileURLToPath } from 'node:url'; | ||
import { expect } from 'chai'; | ||
import { createContainer } from '../../../dist/core/dev/container.js'; | ||
import testAdapter from '../../test-adapter.js'; | ||
|
||
const root = new URL('../../fixtures/api-routes/', import.meta.url); | ||
const fileSystem = { | ||
'/src/pages/response-redirect.ts': `export const GET = ({ url }) => Response.redirect("https://example.com/destination", 307)`, | ||
'/src/pages/response.ts': `export const GET = ({ url }) => new Response(null, { headers: { Location: "https://example.com/destination" }, status: 307 })`, | ||
'/src/pages/not-found.ts': `export const GET = ({ url }) => new Response('empty', { headers: { "Content-Type": "text/plain" }, status: 404 })`, | ||
'/src/pages/internal-error.ts': `export const GET = ({ url }) => new Response('something went wrong', { headers: { "Content-Type": "text/plain" }, status: 500 })`, | ||
}; | ||
|
||
describe('endpoints', () => { | ||
let container; | ||
let settings; | ||
|
||
before(async () => { | ||
const fs = createFs(fileSystem, root); | ||
settings = await createBasicSettings({ | ||
root: fileURLToPath(root), | ||
output: 'server', | ||
adapter: testAdapter(), | ||
}); | ||
container = await createContainer({ | ||
fs, | ||
settings, | ||
logger: defaultLogger, | ||
}); | ||
}); | ||
|
||
after(async () => { | ||
await container.close(); | ||
}); | ||
|
||
it('should return a redirect response with location header', async () => { | ||
const { req, res, done } = createRequestAndResponse({ | ||
method: 'GET', | ||
url: '/response-redirect', | ||
}); | ||
container.handle(req, res); | ||
await done; | ||
const headers = res.getHeaders(); | ||
expect(headers).to.deep.include({ location: 'https://example.com/destination' }); | ||
expect(headers).not.to.deep.include({ 'x-astro-reroute': 'no' }); | ||
expect(res.statusCode).to.equal(307); | ||
}); | ||
|
||
it('should return a response with location header', async () => { | ||
const { req, res, done } = createRequestAndResponse({ | ||
method: 'GET', | ||
url: '/response', | ||
}); | ||
container.handle(req, res); | ||
await done; | ||
const headers = res.getHeaders(); | ||
expect(headers).to.deep.include({ location: 'https://example.com/destination' }); | ||
expect(headers).not.to.deep.include({ 'x-astro-reroute': 'no' }); | ||
expect(res.statusCode).to.equal(307); | ||
}); | ||
|
||
it('should append reroute header for HTTP status 404', async () => { | ||
const { req, res, done } = createRequestAndResponse({ | ||
method: 'GET', | ||
url: '/not-found', | ||
}); | ||
container.handle(req, res); | ||
await done; | ||
const headers = res.getHeaders(); | ||
expect(headers).to.deep.include({ 'x-astro-reroute': 'no' }); | ||
expect(res.statusCode).to.equal(404); | ||
}); | ||
|
||
it('should append reroute header for HTTP status 500', async () => { | ||
const { req, res, done } = createRequestAndResponse({ | ||
method: 'GET', | ||
url: '/internal-error', | ||
}); | ||
container.handle(req, res); | ||
await done; | ||
const headers = res.getHeaders(); | ||
expect(headers).to.deep.include({ 'x-astro-reroute': 'no' }); | ||
expect(res.statusCode).to.equal(500); | ||
}); | ||
}); |