feat: add constructor options to configure max sizes (#586)

* test: use the recommended sink constructor option * feat: add constructor options to configure max sizes * test: add test for max package size * fix: update eik/core
eik-lib · Aug 8, 2024 · 37a60a0 · 37a60a0
1 parent fa309aa
commit 37a60a0
Show file tree

Hide file tree

Showing 16 changed files with 94 additions and 34 deletions.
diff --git a/lib/main.js b/lib/main.js
@@ -18,6 +18,8 @@ import * as utils from './utils.js';
  * @property {import('@eik/sink').default} [customSink] [Deprecated] Use sink instead
  * @property {string} [aliasCacheControl]
  * @property {string} [notFoundCacheControl="public, max-age=5"]
+ * @property {number} [pkgMaxFileSize=10000000] The limit in bytes before PUT /pkg/ starts returning 413 Content Too Large
+ * @property {number} [mapMaxFileSize=1000000] The limit in bytes before PUT /map/ starts returning 413 Content Too Large
  */
 
 const EikService = class EikService {
@@ -26,7 +28,13 @@ const EikService = class EikService {
      */
     constructor(options = {}) {
         let { sink, logger } = options;
-        const { customSink, notFoundCacheControl, aliasCacheControl } = options;
+        const {
+            customSink,
+            notFoundCacheControl,
+            aliasCacheControl,
+            pkgMaxFileSize,
+            mapMaxFileSize,
+        } = options;
         this._notFoundCacheControl =
             notFoundCacheControl || 'public, max-age=5';
 
@@ -90,9 +98,19 @@ const EikService = class EikService {
         });
         this._pkgLog = new eik.http.PkgLog({ organizations, sink, logger });
         this._pkgGet = new eik.http.PkgGet({ organizations, sink, logger });
-        this._pkgPut = new eik.http.PkgPut({ organizations, sink, logger });
+        this._pkgPut = new eik.http.PkgPut({
+            organizations,
+            sink,
+            logger,
+            pkgMaxFileSize,
+        });
         this._mapGet = new eik.http.MapGet({ organizations, sink, logger });
-        this._mapPut = new eik.http.MapPut({ organizations, sink, logger });
+        this._mapPut = new eik.http.MapPut({
+            organizations,
+            sink,
+            logger,
+            mapMaxFileSize,
+        });
 
         const mergeStreams = (...streams) => {
             const str = new PassThrough({ objectMode: true });

diff --git a/package.json b/package.json
@@ -38,7 +38,7 @@
   },
   "homepage": "https://github.com/eik-lib/service#readme",
   "dependencies": {
-    "@eik/core": "1.3.53",
+    "@eik/core": "1.3.56",
     "@eik/sink": "1.2.5",
     "@eik/sink-file-system": "1.0.1",
     "@eik/sink-memory": "1.1.1",

diff --git a/test/400.test.js b/test/400.test.js
@@ -15,7 +15,7 @@ const FIXTURE_PKG = path.resolve(__dirname, '../fixtures/archive.tgz');
 
 tap.test('400 - GET request with non-existing hostname', async (t) => {
     const sink = new Sink();
-    const service = new Server({ customSink: sink });
+    const service = new Server({ sink });
 
     const app = Fastify({
         ignoreTrailingSlash: true,

diff --git a/test/404.test.js b/test/404.test.js
@@ -8,7 +8,7 @@ import Server from '../lib/main.js';
 
 tap.test('404 - POST request to non existing pathname', async (t) => {
     const sink = new Sink();
-    const service = new Server({ customSink: sink });
+    const service = new Server({ sink });
 
     const app = Fastify({
         ignoreTrailingSlash: true,
@@ -38,7 +38,7 @@ tap.test('404 - POST request to non existing pathname', async (t) => {
 
 tap.test('404 - GET request to non existing pathname', async (t) => {
     const sink = new Sink();
-    const service = new Server({ customSink: sink });
+    const service = new Server({ sink });
 
     const app = Fastify({
         ignoreTrailingSlash: true,

diff --git a/test/alias.map.test.js b/test/alias.map.test.js
@@ -16,7 +16,7 @@ const FIXTURE_MAP_B = path.resolve(__dirname, '../fixtures/import-map-b.json');
 
 tap.beforeEach(async (t) => {
     const sink = new Sink();
-    const service = new Server({ customSink: sink });
+    const service = new Server({ sink });
 
     const app = Fastify({
         ignoreTrailingSlash: true,

diff --git a/test/alias.npm.test.js b/test/alias.npm.test.js
@@ -21,7 +21,7 @@ tap.cleanSnapshot = (s) => {
 
 tap.beforeEach(async (t) => {
     const sink = new Sink();
-    const service = new Server({ customSink: sink });
+    const service = new Server({ sink });
 
     const app = Fastify({
         ignoreTrailingSlash: true,

diff --git a/test/alias.pkg.test.js b/test/alias.pkg.test.js
@@ -21,7 +21,7 @@ tap.cleanSnapshot = (s) => {
 
 tap.beforeEach(async (t) => {
     const sink = new Sink();
-    const service = new Server({ customSink: sink });
+    const service = new Server({ sink });
 
     const app = Fastify({
         ignoreTrailingSlash: true,

diff --git a/test/auth.test.js b/test/auth.test.js
@@ -8,7 +8,7 @@ import Server from '../lib/main.js';
 
 tap.test('auth - authenticate - legal "key" value', async (t) => {
     const sink = new Sink();
-    const service = new Server({ customSink: sink });
+    const service = new Server({ sink });
 
     const app = Fastify({
         ignoreTrailingSlash: true,
@@ -43,7 +43,7 @@ tap.test('auth - authenticate - legal "key" value', async (t) => {
 
 tap.test('auth - authenticate - illegal "key" value', async (t) => {
     const sink = new Sink();
-    const service = new Server({ customSink: sink });
+    const service = new Server({ sink });
 
     const app = Fastify({
         ignoreTrailingSlash: true,

diff --git a/test/http.cache.control.test.js b/test/http.cache.control.test.js
@@ -22,7 +22,7 @@ tap.cleanSnapshot = (s) => {
 
 tap.beforeEach(async (t) => {
     const sink = new Sink();
-    const service = new Server({ customSink: sink });
+    const service = new Server({ sink });
 
     const app = Fastify({
         ignoreTrailingSlash: true,

diff --git a/test/http.etag.test.js b/test/http.etag.test.js
@@ -11,7 +11,7 @@ import Server from '../lib/main.js';
 
 tap.test('ETag - pkg:get - ETag and "If-None-Match" is matching', async (t) => {
     const sink = new Sink();
-    const service = new Server({ customSink: sink });
+    const service = new Server({ sink });
 
     const app = Fastify({
         ignoreTrailingSlash: true,
@@ -64,7 +64,7 @@ tap.test(
     async (t) => {
         const sink = new Sink();
         const service = new Server({
-            customSink: sink,
+            sink,
         });
 
         const app = Fastify({
@@ -123,7 +123,7 @@ tap.test(
     async (t) => {
         const sink = new Sink();
         const service = new Server({
-            customSink: sink,
+            sink,
         });
 
         const app = Fastify({
@@ -176,7 +176,7 @@ tap.test(
 /*
 tap.test('ETag - pkg:get - ETags is configured to not be set', async t => {
     const sink = new Sink();
-    const service = new Server({ customSink: sink, port: 0, config: { etag: false }, logger: false });
+    const service = new Server({ sink, port: 0, config: { etag: false }, logger: false });
     const address = await service.start();
 
     const url = `${address}/pkg/fuzz/8.4.1/main/index.js`;
@@ -213,7 +213,7 @@ tap.test('ETag - pkg:get - ETags is configured to not be set', async t => {
 
 tap.test('ETag - pkg:log - ETag and "If-None-Match" is matching', async (t) => {
     const sink = new Sink();
-    const service = new Server({ customSink: sink });
+    const service = new Server({ sink });
 
     const app = Fastify({
         ignoreTrailingSlash: true,
@@ -266,7 +266,7 @@ tap.test(
     async (t) => {
         const sink = new Sink();
         const service = new Server({
-            customSink: sink,
+            sink,
         });
 
         const app = Fastify({
@@ -325,7 +325,7 @@ tap.test(
     async (t) => {
         const sink = new Sink();
         const service = new Server({
-            customSink: sink,
+            sink,
         });
 
         const app = Fastify({
@@ -378,7 +378,7 @@ tap.test(
 /*
 tap.test('ETag - pkg:log - ETags is configured to not be set', async t => {
     const sink = new Sink();
-    const service = new Server({ customSink: sink, port: 0, config: { etag: false }, logger: false });
+    const service = new Server({ sink, port: 0, config: { etag: false }, logger: false });
     const address = await service.start();
 
     const url = `${address}/pkg/fuzz/8.4.1`;
@@ -415,7 +415,7 @@ tap.test('ETag - pkg:log - ETags is configured to not be set', async t => {
 
 tap.test('ETag - map:get - ETag and "If-None-Match" is matching', async (t) => {
     const sink = new Sink();
-    const service = new Server({ customSink: sink });
+    const service = new Server({ sink });
 
     const app = Fastify({
         ignoreTrailingSlash: true,
@@ -468,7 +468,7 @@ tap.test(
     async (t) => {
         const sink = new Sink();
         const service = new Server({
-            customSink: sink,
+            sink,
         });
 
         const app = Fastify({
@@ -527,7 +527,7 @@ tap.test(
     async (t) => {
         const sink = new Sink();
         const service = new Server({
-            customSink: sink,
+            sink,
         });
 
         const app = Fastify({
@@ -580,7 +580,7 @@ tap.test(
 /*
 tap.test('ETag - map:get - ETags is configured to not be set', async t => {
     const sink = new Sink();
-    const service = new Server({ customSink: sink, port: 0, config: { etag: false }, logger: false });
+    const service = new Server({ sink, port: 0, config: { etag: false }, logger: false });
     const address = await service.start();
 
     const url = `${address}/map/buzz/4.2.2`;

diff --git a/test/http.override.cache.control.test.js b/test/http.override.cache.control.test.js
@@ -22,7 +22,7 @@ tap.cleanSnapshot = (s) => {
 tap.beforeEach(async (t) => {
     const sink = new Sink();
     const service = new Server({
-        customSink: sink,
+        sink,
         aliasCacheControl: 'public, max-age=600',
     });
 

diff --git a/test/http.query.params.test.js b/test/http.query.params.test.js
@@ -22,7 +22,7 @@ tap.cleanSnapshot = (s) => {
 
 tap.beforeEach(async (t) => {
     const sink = new Sink();
-    const service = new Server({ customSink: sink });
+    const service = new Server({ sink });
 
     const app = Fastify({
         ignoreTrailingSlash: true,

diff --git a/test/map.test.js b/test/map.test.js
@@ -15,7 +15,7 @@ const FIXTURE_MAP = path.resolve(__dirname, '../fixtures/import-map.json');
 
 tap.beforeEach(async (t) => {
     const sink = new Sink();
-    const service = new Server({ customSink: sink });
+    const service = new Server({ sink });
 
     const app = Fastify({
         ignoreTrailingSlash: true,

diff --git a/test/npm.test.js b/test/npm.test.js
@@ -21,7 +21,7 @@ tap.cleanSnapshot = (s) => {
 
 tap.beforeEach(async (t) => {
     const sink = new Sink();
-    const service = new Server({ customSink: sink });
+    const service = new Server({ sink });
 
     const app = Fastify({
         ignoreTrailingSlash: true,

diff --git a/test/pkg-put-write-integrity.test.js b/test/pkg-put-write-integrity.test.js
@@ -46,7 +46,7 @@ tap.test(
             return Math.floor(Math.random() * max) + min;
         };
 
-        const service = new Server({ customSink: sink });
+        const service = new Server({ sink });
 
         const app = Fastify({
             ignoreTrailingSlash: true,
@@ -96,7 +96,7 @@ tap.test(
             return Math.floor(Math.random() * max) + min;
         };
 
-        const service = new Server({ customSink: sink });
+        const service = new Server({ sink });
 
         const app = Fastify({
             ignoreTrailingSlash: true,
@@ -146,7 +146,7 @@ tap.test(
             return Math.floor(Math.random() * max) + min;
         };
 
-        const service = new Server({ customSink: sink });
+        const service = new Server({ sink });
 
         const app = Fastify({
             ignoreTrailingSlash: true,
@@ -196,7 +196,7 @@ tap.test(
             return Math.floor(Math.random() * max) + min;
         };
 
-        const service = new Server({ customSink: sink });
+        const service = new Server({ sink });
 
         const app = Fastify({
             ignoreTrailingSlash: true,

diff --git a/test/pkg.test.js b/test/pkg.test.js
@@ -21,7 +21,7 @@ tap.cleanSnapshot = (s) => {
 
 tap.beforeEach(async (t) => {
     const sink = new Sink();
-    const service = new Server({ customSink: sink });
+    const service = new Server({ sink });
 
     const app = Fastify({
         ignoreTrailingSlash: true,
@@ -372,3 +372,45 @@ tap.test('packages - get package versions - non scoped', async (t) => {
         'on GET, response should match snapshot',
     );
 });
+
+tap.test('packages - configure max size', async (t) => {
+    const sink = new Sink();
+    const service = new Server({ sink, pkgMaxFileSize: 10 });
+
+    const app = Fastify({
+        ignoreTrailingSlash: true,
+    });
+    t.after(() => app.close());
+
+    app.register(service.api());
+
+    const address = await app.listen({ port: 0, host: '127.0.0.1' });
+
+    const loginFormData = new FormData();
+    loginFormData.append('key', 'change_me');
+    const res = await fetch(`${address}/auth/login`, {
+        method: 'POST',
+        body: loginFormData,
+        headers: loginFormData.getHeaders(),
+    });
+
+    const { token } = /** @type {{ token: string }} */ (await res.json());
+    const headers = { Authorization: `Bearer ${token}` };
+
+    const formData = new FormData();
+    formData.append('package', fs.createReadStream(FIXTURE_PKG));
+
+    // PUT files on server
+    const uploaded = await fetch(`${address}/pkg/fuzz/8.4.1/`, {
+        method: 'PUT',
+        body: formData,
+        headers: { ...headers, ...formData.getHeaders() },
+        redirect: 'manual',
+    });
+
+    t.equal(
+        uploaded.status,
+        413,
+        'Expected to be told that the content is too large',
+    );
+});