feat: run gc

License: MIT
Signed-off-by: Henrique Dias <[email protected]>

Author: hacdias

assets/locales/en.json

@@ -49,6 +49,7 @@
   "takeScreenshot": "Take Screenshot",
   "downloadHash": "Download Hash",
   "moveRepositoryLocation": "Move Repository Location",
+  "runGarbageCollector": "Run Garbage Collector",
   "polkitDialog": {
     "title": "Polkit not found",
     "message": "IPFS can't be added to /usr/local/bin/ without polkit agent."
@@ -116,5 +117,14 @@
   "itemsFailedNotification": {
     "title": "Failed to add items",
     "message": "Could not add your items to your node."
+  },
+  "runGarbageCollectorWarning": {
+    "title": "Garbage collector",
+    "message": "Running the garbage collector will remove all the objects that are not pinned or on your MFS from your repository. This action might take a while. Do you want to run the Garbage Collector?",
+    "action": "Run GC"
+  },
+  "runGarbageCollectorDone": {
+    "title": "Garbage collector",
+    "message": "Garbage collector run was successful."
   }
 }

src/run-gc.js

@@ -0,0 +1,48 @@
+import i18n from 'i18next'
+import logger from './common/logger'
+import { showDialog, recoverableErrorDialog } from './dialogs'
+import dock from './dock'
+
+export default function runGarbageCollector ({ getIpfsd }) {
+  dock.run(async () => {
+    logger.info('[run gc] alerting user for effects')
+
+    const opt = showDialog({
+      title: i18n.t('runGarbageCollectorWarning.title'),
+      message: i18n.t('runGarbageCollectorWarning.message'),
+      type: 'warning',
+      buttons: [
+        i18n.t('runGarbageCollectorWarning.action'),
+        i18n.t('cancel')
+      ],
+      showDock: false
+    })
+
+    if (opt !== 0) {
+      logger.info('[run gc] user canceled')
+      return
+    }
+
+    const ipfsd = await getIpfsd()
+
+    if (!ipfsd) {
+      return
+    }
+
+    try {
+      ipfsd.api.repo.gc()
+      showDialog({
+        title: i18n.t('runGarbageCollectorDone.title'),
+        message: i18n.t('runGarbageCollectorDone.message'),
+        type: 'info',
+        buttons: [
+          i18n.t('ok')
+        ],
+        showDock: false
+      })
+    } catch (err) {
+      logger.error(`[run gc] ${err.toString()}`)
+      return recoverableErrorDialog(err)
+    }
+  })
+}

src/tray.js

@@ -9,6 +9,7 @@ import logger from './common/logger'
 import store from './common/store'
 import { IS_MAC, IS_WIN, VERSION, GO_IPFS_VERSION } from './common/consts'
 import moveRepositoryLocation from './move-repository-location'
+import runGarbageCollector from './run-gc'
 
 // Notes on this: we are only supporting accelerators on macOS for now because
 // they natively work as soon as the menu opens. They don't work like that on Windows
@@ -95,6 +96,12 @@ function buildMenu (ctx) {
         {
           label: i18n.t('moveRepositoryLocation'),
           click: () => { moveRepositoryLocation(ctx) }
+        },
+        {
+          id: 'runGarbageCollector',
+          label: i18n.t('runGarbageCollector'),
+          click: () => { runGarbageCollector(ctx) },
+          enabled: false
         }
       ]
     },
@@ -193,6 +200,7 @@ export default function (ctx) {
 
     menu.getMenuItemById('takeScreenshot').enabled = menu.getMenuItemById('ipfsIsRunning').visible
     menu.getMenuItemById('downloadHash').enabled = menu.getMenuItemById('ipfsIsRunning').visible
+    menu.getMenuItemById('runGarbageCollector').enabled = menu.getMenuItemById('ipfsIsRunning').visible
 
     if (status === STATUS.STARTING_FINISHED) {
       tray.setImage(icon(on))