Infrastructure/verdaccio
0
Fork 0
mirror of https://github.com/verdaccio/verdaccio.git synced 2025-01-06 22:40:26 -05:00
Code Issues Activity

chore: request header constants (#4920)

Browse source
This commit is contained in:
Marc Bernard 2024-10-28 02:22:15 -04:00 committed by GitHub
parent 027057c686
commit 48aa89f651
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
6 changed files with 22 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
.changeset/blue-paws-cheer.md Normal file
View file

@ -0,0 +1,7 @@
---
'@verdaccio/server': patch
'@verdaccio/middleware': patch
'@verdaccio/core': patch
---
chore: request header constants

4
packages/core/core/src/constants.ts
View file

@ -46,6 +46,10 @@ export const HEADERS = {
CSP: 'Content-Security-Policy', CSP: 'Content-Security-Policy',
CTO: 'X-Content-Type-Options', CTO: 'X-Content-Type-Options',
XSS: 'X-XSS-Protection', XSS: 'X-XSS-Protection',
CLIENT: 'X-Client',
POWERED_BY: 'X-Powered-By',
RATELIMIT_LIMIT: 'X-RateLimit-Limit',
RATELIMIT_REMAINING: 'X-RateLimit-Remaining',
NONE_MATCH: 'If-None-Match', NONE_MATCH: 'If-None-Match',
ETAG: 'ETag', ETAG: 'ETag',
JSON_CHARSET: 'application/json; charset=utf-8', JSON_CHARSET: 'application/json; charset=utf-8',

2
packages/core/core/src/error-utils.ts
View file

@ -3,7 +3,7 @@ import createError, { HttpError } from 'http-errors';
import { HTTP_STATUS } from './constants'; import { HTTP_STATUS } from './constants';
export const API_ERROR = { export const API_ERROR = {
PASSWORD_SHORT: `The provided password does not pass the validation`, PASSWORD_SHORT: 'The provided password does not pass the validation',
MUST_BE_LOGGED: 'You must be logged in to publish packages.', MUST_BE_LOGGED: 'You must be logged in to publish packages.',
PLUGIN_ERROR: 'bug in the auth plugin system', PLUGIN_ERROR: 'bug in the auth plugin system',
CONFIG_BAD_FORMAT: 'config file must be an object', CONFIG_BAD_FORMAT: 'config file must be an object',

4
packages/middleware/src/middlewares/log.ts
View file

@ -1,5 +1,7 @@
import _ from 'lodash'; import _ from 'lodash';
import { HEADERS } from '@verdaccio/core';
import { $NextFunctionVer, $RequestExtend, $ResponseExtend } from '../types'; import { $NextFunctionVer, $RequestExtend, $ResponseExtend } from '../types';
// FIXME: deprecated, moved to @verdaccio/dev-commons // FIXME: deprecated, moved to @verdaccio/dev-commons
@ -52,7 +54,7 @@ export const log = (logger) => {
}; };
const log = function (): void { const log = function (): void {
const forwardedFor = req.get('x-forwarded-for'); const forwardedFor = req.get(HEADERS.FORWARDED_FOR);
const remoteAddress = req.connection.remoteAddress; const remoteAddress = req.connection.remoteAddress;
const remoteIP = forwardedFor ? `${forwardedFor} via ${remoteAddress}` : remoteAddress; const remoteIP = forwardedFor ? `${forwardedFor} via ${remoteAddress}` : remoteAddress;
let message; let message;

3
packages/middleware/src/middlewares/user-agent.ts
View file

@ -1,10 +1,11 @@
import { getUserAgent } from '@verdaccio/config'; import { getUserAgent } from '@verdaccio/config';
import { HEADERS } from '@verdaccio/core';
import { $NextFunctionVer, $RequestExtend, $ResponseExtend } from '../types'; import { $NextFunctionVer, $RequestExtend, $ResponseExtend } from '../types';
export function userAgent(config) { export function userAgent(config) {
return function (_req: $RequestExtend, res: $ResponseExtend, next: $NextFunctionVer): void { return function (_req: $RequestExtend, res: $ResponseExtend, next: $NextFunctionVer): void {
res.setHeader('x-powered-by', getUserAgent(config?.user_agent)); res.setHeader(HEADERS.POWERED_BY, getUserAgent(config?.user_agent));
next(); next();
}; };
} }

10
packages/server/express/test/server.spec.ts
View file

@ -40,8 +40,8 @@ describe('server api', () => {
await supertest(app) await supertest(app)
.get('/') .get('/')
.expect(HEADER_TYPE.CONTENT_TYPE, HEADERS.TEXT_HTML_UTF8) .expect(HEADER_TYPE.CONTENT_TYPE, HEADERS.TEXT_HTML_UTF8)
.expect('x-ratelimit-limit', '10000') .expect(HEADERS.RATELIMIT_LIMIT, '10000')
.expect('x-ratelimit-remaining', '9999') .expect(HEADERS.RATELIMIT_REMAINING, '9999')
.expect(HTTP_STATUS.OK); .expect(HTTP_STATUS.OK);
}); });
@ -66,7 +66,7 @@ describe('server api', () => {
.get('/') .get('/')
.expect(HEADER_TYPE.CONTENT_TYPE, HEADERS.TEXT_HTML_UTF8) .expect(HEADER_TYPE.CONTENT_TYPE, HEADERS.TEXT_HTML_UTF8)
.expect(HTTP_STATUS.OK); .expect(HTTP_STATUS.OK);
const powered = response.get('x-powered-by'); const powered = response.get(HEADERS.POWERED_BY);
expect(powered).toMatch('hidden'); expect(powered).toMatch('hidden');
}, 40000); }, 40000);
@ -76,7 +76,7 @@ describe('server api', () => {
.get('/') .get('/')
.expect(HEADER_TYPE.CONTENT_TYPE, HEADERS.TEXT_HTML_UTF8) .expect(HEADER_TYPE.CONTENT_TYPE, HEADERS.TEXT_HTML_UTF8)
.expect(HTTP_STATUS.OK); .expect(HTTP_STATUS.OK);
const powered = response.get('x-powered-by'); const powered = response.get(HEADERS.POWERED_BY);
expect(powered).toEqual('hidden'); expect(powered).toEqual('hidden');
}); });
@ -86,7 +86,7 @@ describe('server api', () => {
.get('/') .get('/')
.expect(HEADER_TYPE.CONTENT_TYPE, HEADERS.TEXT_HTML_UTF8) .expect(HEADER_TYPE.CONTENT_TYPE, HEADERS.TEXT_HTML_UTF8)
.expect(HTTP_STATUS.OK); .expect(HTTP_STATUS.OK);
const powered = response.get('x-powered-by'); const powered = response.get(HEADERS.POWERED_BY);
expect(powered).toEqual('custom user agent'); expect(powered).toEqual('custom user agent');
}); });