feat: forward non-get requests to the registry, fixes #58

Author: achingbrain

.gitignore

@@ -30,3 +30,5 @@ build/Release
 # https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git
 node_modules
 package-lock.json
+
+docs

package.json

@@ -36,6 +36,7 @@
     "debug": "^3.1.0",
     "dnscache": "^1.0.1",
     "express": "^4.16.3",
+    "express-http-proxy": "^1.4.0",
     "follow-registry": "achingbrain/follow-registry",
     "ipfs-blob-store": "^2.0.0",
     "once": "^1.4.0",

src/cli/bin.js

@@ -31,9 +31,13 @@ yargs.command('$0', 'Starts a registry server that uses IPFS to fetch js depende
       default: 'http'
     })
     .option('mirror-registry', {
-      describe: 'Where to download missing files from',
+      describe: 'Where to download missing files from/proxy for non-get requests',
       default: 'https://registry.npmjs.com'
     })
+    .option('mirror-upload-size-limit', {
+      describe: 'How large a file upload to allow when proxying for the registry',
+      default: '1024mb'
+    })
     .option('ipfs-port', {
       describe: 'Which port the daemon is listening on',
       default: null

src/core/config.js

@@ -32,7 +32,8 @@ module.exports = (overrides = {}) => {
       host: option(process.env.MIRROR_HOST, overrides.mirrorHost),
       port: option(process.env.MIRROR_PORT, overrides.mirrorPort),
       protocol: option(process.env.MIRROR_PROTOCOL, overrides.mirrorProtocol),
-      registry: option(process.env.MIRROR_REGISTRY, overrides.mirrorRegistry)
+      registry: option(process.env.MIRROR_REGISTRY, overrides.mirrorRegistry),
+      uploadSizeLimit: option(process.env.MIRROR_UPLOAD_SIZE_LIMIT, overrides.mirrorUploadSizeLimit)
     },
     external: {
       host: option(process.env.EXTERNAL_HOST, overrides.externalHost),

src/core/mirror/index.js

@@ -11,6 +11,7 @@ const clone = require('../clone')
 const store = require('./store')
 const ipfsBlobStore = require('ipfs-blob-store')
 const getExternalUrl = require('../utils/get-external-url')
+const proxy = require('express-http-proxy')
 
 module.exports = async (options) => {
   options = config(options)
@@ -35,9 +36,19 @@ module.exports = async (options) => {
     next()
   })
 
+  // intercept requests for tarballs and manifests
   app.get('/**/*.tgz', tarball)
   app.get('/*', json)
 
+  // everything else should just proxy for the registry
+  const registry = proxy(options.mirror.registry, {
+    limit: options.mirror.uploadSizeLimit
+  })
+  app.put('/*', registry)
+  app.post('/*', registry)
+  app.patch('/*', registry)
+  app.delete('/*', registry)
+
   app.use(function (error, request, response, next) {
     console.error(`💀 ${request.method} ${request.url} ${response.statusCode} - ${error.stack}`)
 

test/mirror.spec.js

@@ -38,7 +38,8 @@ describe('mirror', () => {
     app = await mirror({
       mirrorProtocol: 'http',
       mirrorPort: 0,
-      mirrorHost: '127.0.0.1'
+      mirrorHost: '127.0.0.1',
+      mirrorRegistry: 'http://127.0.0.1:1234'
     })
 
     const content = 'manifest content'
@@ -54,7 +55,8 @@ describe('mirror', () => {
     app = await mirror({
       mirrorProtocol: 'http',
       mirrorPort: 0,
-      mirrorHost: '127.0.0.1'
+      mirrorHost: '127.0.0.1',
+      mirrorRegistry: 'http://127.0.0.1:1234'
     })
 
     const content = 'tarball content'
@@ -140,4 +142,25 @@ describe('mirror', () => {
 
     expect(result.trim()).to.equal(data.trim())
   })
+
+  it('should proxy all other requests to the registry', async () => {
+    let data = 'hello world'
+
+    const server = await createTestServer((server) => {
+      return {
+        '/-/user/org.couchdb.user:dave': data
+      }
+    })
+
+    app = await mirror({
+      mirrorProtocol: 'http',
+      mirrorPort: 0,
+      mirrorHost: '127.0.0.1',
+      mirrorRegistry: `http://127.0.0.1:${server.address().port}`
+    })
+
+    const result = await request.put(`http://127.0.0.1:${app.address().port}/-/user/org.couchdb.user:dave`)
+
+    expect(result.trim()).to.equal(data.trim())
+  })
 })