Infrastructure/astro
0
Fork 0
mirror of https://github.com/withastro/astro.git synced 2025-03-31 23:31:30 -05:00
Code Issues Activity

feat: prefer using x-forwarded-for as clientAddress (#11101)

Browse source 
* feat: change node clientAddress use x-forwarded-for

when

```
adapter: node({
    mode: 'standalone',
  })
```

* feat: prefer using x-forwarded-for as clientAddress

* Update .changeset/healthy-planets-dream.md

Co-authored-by: Emanuele Stoppa <my.burning@gmail.com>

* Update .changeset/healthy-planets-dream.md

Co-authored-by: Emanuele Stoppa <my.burning@gmail.com>

* Apply suggestions from code review

---------

Co-authored-by: Emanuele Stoppa <my.burning@gmail.com>
This commit is contained in:
Guofeng Lin 2024-05-22 20:10:56 +09:00 • committed by GitHub
parent 2d4c8faa56
commit a6916e4402
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
8 changed files with 86 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
.changeset/healthy-planets-dream.md Normal file
View file

@ -0,0 +1,7 @@
---
"astro": minor
---
Updates Astro's code for adapters to use the header `x-forwarded-for` to initialize the `clientAddress`.
To take advantage of the new change, integration authors must upgrade the version of Astro in their adapter `peerDependencies` to `4.9.0`.

6
packages/astro/src/core/app/node.ts
View file

@ -81,7 +81,11 @@ export class NodeApp extends App {
Object.assign(options, makeRequestBody(req));
}
const request = new Request(url, options);
if (req.socket?.remoteAddress) {
const clientIp = req.headers['x-forwarded-for'];
if (clientIp) {
Reflect.set(request, clientAddressSymbol, clientIp);
} else if (req.socket?.remoteAddress) {
Reflect.set(request, clientAddressSymbol, req.socket.remoteAddress);
}
return request;

27
packages/astro/test/client-address-node.test.js Normal file
View file

@ -0,0 +1,27 @@
import * as assert from 'node:assert/strict';
import { describe, it } from 'node:test';
import * as cheerio from 'cheerio';
import { loadFixture } from './test-utils.js';
import { createRequestAndResponse } from './units/test-utils.js';
describe('NodeClientAddress', () => {
it('clientAddress is 1.1.1.1', async () => {
const fixture = await loadFixture({
root: './fixtures/client-address-node/',
});
await fixture.build();
const handle = await fixture.loadNodeAdapterHandler();
const { req, res, text } = createRequestAndResponse({
method: 'GET',
url: '/',
headers: {
'x-forwarded-for': '1.1.1.1',
},
});
handle(req, res);
const html = await text();
const $ = cheerio.load(html);
assert.equal(res.statusCode, 200);
assert.equal($('#address').text(), '1.1.1.1');
});
});

8
packages/astro/test/fixtures/client-address-node/astro.config.mjs vendored Normal file
View file

@ -0,0 +1,8 @@
import node from '@astrojs/node';
import { defineConfig } from 'astro/config';
// https://astro.build/config
export default defineConfig({
output: 'server',
adapter: node({ mode: 'middleware' }),
});

9
packages/astro/test/fixtures/client-address-node/package.json vendored Normal file
View file

@ -0,0 +1,9 @@
{
"name": "@test/client-address-node",
"version": "0.0.0",
"private": true,
"dependencies": {
"@astrojs/node": "workspace:*",
"astro": "workspace:*"
}
}

13
packages/astro/test/fixtures/client-address-node/src/pages/index.astro vendored Normal file
View file

@ -0,0 +1,13 @@
---
export const prerender = false;
const address = Astro.clientAddress;
---
<html>
<head>
<title>Astro.clientAddress</title>
</head>
<body>
<h1>Astro.clientAddress</h1>
<div id="address">{ address }</div>
</body>
</html>

8
packages/astro/test/test-utils.js
View file

@ -25,6 +25,8 @@ process.env.ASTRO_TELEMETRY_DISABLED = true;
* @typedef {import('../src/core/app/index').App} App
* @typedef {import('../src/cli/check/index').AstroChecker} AstroChecker
* @typedef {import('../src/cli/check/index').CheckPayload} CheckPayload
* @typedef {import('http').IncomingMessage} NodeRequest
* @typedef {import('http').ServerResponse} NodeResponse
*
*
* @typedef {Object} Fixture
@ -40,6 +42,7 @@ process.env.ASTRO_TELEMETRY_DISABLED = true;
* @property {typeof preview} preview
* @property {() => Promise<void>} clean
* @property {() => Promise<App>} loadTestAdapterApp
* @property {() => Promise<(req: NodeRequest, res: NodeResponse) => void>} loadNodeAdapterHandler
* @property {() => Promise<void>} onNextChange
* @property {typeof check} check
* @property {typeof sync} sync
@ -213,6 +216,11 @@ export async function loadFixture(inlineConfig) {
});
}
},
loadNodeAdapterHandler: async () => {
const url = new URL(`./server/entry.mjs?id=${fixtureId}`, config.outDir);
const { handler } = await import(url);
return handler;
},
loadTestAdapterApp: async (streaming) => {
const url = new URL(`./server/entry.mjs?id=${fixtureId}`, config.outDir);
const { createApp, manifest } = await import(url);

9
pnpm-lock.yaml generated
View file

@ -2381,6 +2381,15 @@ importers:
specifier: workspace:*
version: link:../../..
packages/astro/test/fixtures/client-address-node:
dependencies:
'@astrojs/node':
specifier: workspace:*
version: link:../../../../integrations/node
astro:
specifier: workspace:*
version: link:../../..
packages/astro/test/fixtures/code-component:
dependencies:
astro: