feat: expose GC to http api

Author: dirkmc

src/http/api/resources/repo.js

@@ -1,9 +1,22 @@
 'use strict'
 
-exports.gc = async (request, h) => {
-  const { ipfs } = request.server.app
-  await ipfs.repo.gc()
-  return h.response()
+const Joi = require('joi')
+
+exports.gc = {
+  validate: {
+    query: Joi.object().keys({
+      quiet: Joi.boolean().default(false),
+      'stream-errors': Joi.boolean().default(false)
+    }).unknown()
+  },
+
+  async handler (request, h) {
+    const quiet = request.query.quiet
+    const streamErrors = request.query['stream-errors']
+    const { ipfs } = request.server.app
+    const res = await ipfs.repo.gc({ quiet, streamErrors })
+    return h.response(res.map(r => ({ Err: r.err, Key: { '/': r.cid } })))
+  }
 }
 
 exports.version = async (request, h) => {

src/http/api/routes/repo.js

@@ -12,6 +12,14 @@ module.exports = [
     method: '*',
     path: '/api/v0/repo/stat',
     handler: resources.repo.stat
+  },
+  {
+    method: '*',
+    path: '/api/v0/repo/gc',
+    options: {
+      validate: resources.repo.gc.validate
+    },
+    handler: resources.repo.gc.handler
   }
   // TODO: implement the missing spec https://github.com/ipfs/interface-ipfs-core/blob/master/SPEC/REPO.md
 ]

test/cli/repo.js

@@ -2,7 +2,12 @@
 'use strict'
 
 const expect = require('chai').expect
+const fs = require('fs')
+const os = require('os')
+const path = require('path')
 const repoVersion = require('ipfs-repo').repoVersion
+const hat = require('hat')
+const clean = require('../utils/clean')
 
 const runOnAndOff = require('../utils/on-and-off')
 
@@ -18,4 +23,34 @@ describe('repo', () => runOnAndOff((thing) => {
       expect(out).to.eql(`${repoVersion}\n`)
     })
   })
+
+  // Note: There are more comprehensive GC tests in interface-js-ipfs-core
+  it('should run garbage collection', async () => {
+    // Create and add a file to IPFS
+    const filePath = path.join(os.tmpdir(), hat())
+    const content = String(Math.random())
+    fs.writeFileSync(filePath, content)
+    const cid = (await ipfs(`add -Q ${filePath}`)).trim()
+
+    // File hash should be in refs local
+    const localRefs = await ipfs('refs local')
+    expect(localRefs.split('\n')).includes(cid)
+
+    // Run GC, file should not have been removed because it's pinned
+    const gcOut = await ipfs('repo gc')
+    expect(gcOut.split('\n')).not.includes('Removed ' + cid)
+
+    // Unpin file
+    await ipfs('pin rm ' + cid)
+
+    // Run GC, file should now be removed
+    const gcOutAfterUnpin = await ipfs('repo gc')
+    expect(gcOutAfterUnpin.split('\n')).to.includes('Removed ' + cid)
+
+    const localRefsAfterGc = await ipfs('refs local')
+    expect(localRefsAfterGc.split('\n')).not.includes(cid)
+
+    // Clean up file
+    await clean(filePath)
+  })
 }))