feat: app lazy-loads app-context

src/add-to-ipfs.js

@@ -7,6 +7,7 @@ const fs = require('fs-extra')
 const logger = require('./common/logger')
 const { notify, notifyError } = require('./common/notify')
 const { analyticsKeys } = require('./analytics/keys')
+const getCtx = require('./context')
 
 async function copyFileToMfs (ipfs, cid, filename) {
   let i = 0
@@ -76,6 +77,7 @@ function sendNotification (launchWebUI, hasFailures, successCount, filename) {
     body = i18n.t('itemsFailedNotification.message')
   }
 
+  // @ts-expect-error
   fn({ title, body }, () => {
     // force refresh for Files screen to pick up newly added items
     // https://github.com/ipfs/ipfs-desktop/issues/1763
@@ -102,7 +104,9 @@ async function addFileOrDirectory (ipfs, filepath) {
   return { cid, filename }
 }
 
-module.exports = async function ({ getIpfsd, launchWebUI }, files) {
+module.exports = async function (files) {
+  const ctx = getCtx()
+  const getIpfsd = await ctx.getProp('getIpfsd')
   const ipfsd = await getIpfsd()
   if (!ipfsd) {
     return
@@ -129,6 +133,7 @@ module.exports = async function ({ getIpfsd, launchWebUI }, files) {
   }
 
   const { cid, filename } = await getShareableCid(ipfsd.api, successes)
+  const launchWebUI = ctx.getFn('launchWebUI')
   sendNotification(launchWebUI, failures.length !== 0, successes.length, filename)
 
   const query = filename ? `?filename=${encodeURIComponent(filename)}` : ''

src/analytics/index.js

@@ -6,14 +6,18 @@ const { join } = require('path')
 const { app } = require('electron')
 const { existsSync, mkdirSync } = require('fs')
 const ipcMainEvents = require('../common/ipc-main-events')
+const logger = require('../common/logger')
+const getCtx = require('../context')
 
-module.exports = async function (ctx) {
+module.exports = async function () {
+  logger.info('[analytics] init...')
   // workaround: recursive mkdir https://github.com/Countly/countly-sdk-nodejs/pull/14
   const countlyDataDir = join(app.getPath('userData'), 'countly-data')
   if (!existsSync(countlyDataDir)) {
     mkdirSync(countlyDataDir, { recursive: true })
   }
 
+  // @ts-expect-error
   Countly.init({
     url: 'https://countly.ipfs.io',
     app_key: COUNTLY_KEY,
@@ -23,7 +27,8 @@ module.exports = async function (ctx) {
     storage_path: countlyDataDir
   })
 
-  ctx.countlyDeviceId = Countly.device_id
+  // @ts-expect-error
+  getCtx().setProp('countlyDeviceId', Countly.device_id)
 
   ipcMain.on(ipcMainEvents.COUNTLY_ADD_CONSENT, (_, consent) => {
     Countly.add_consent(consent)
@@ -32,4 +37,5 @@ module.exports = async function (ctx) {
   ipcMain.on(ipcMainEvents.COUNTLY_REMOVE_CONSENT, (_, consent) => {
     Countly.remove_consent(consent)
   })
+  logger.info('[analytics] init done')
 }

src/app-menu.js

@@ -1,4 +1,5 @@
 const { app, Menu, shell } = require('electron')
+const logger = require('./common/logger')
 
 const template = [
   {
@@ -88,6 +89,8 @@ if (process.platform === 'darwin') {
 }
 
 module.exports = function () {
+  logger.info('[appMenu] init...')
   const menu = Menu.buildFromTemplate(template)
   Menu.setApplicationMenu(menu)
+  logger.info('[appMenu] init done...')
 }

src/argv-files-handler.js

@@ -1,7 +1,7 @@
 const fs = require('fs-extra')
 const addToIpfs = require('./add-to-ipfs')
 
-async function argvHandler (argv, ctx) {
+async function argvHandler (argv) {
   let handled = false
 
   const files = []
@@ -18,16 +18,16 @@ async function argvHandler (argv, ctx) {
   }
 
   if (files.length > 0) {
-    await addToIpfs(ctx, files)
+    await addToIpfs(files)
     handled = true
   }
 
   return handled
 }
 
-module.exports = async function (ctx) {
+module.exports = async function () {
   // Checks current proccess
-  await argvHandler(process.argv, ctx)
+  await argvHandler(process.argv)
 }
 
 module.exports.argvHandler = argvHandler

src/auto-launch.js

@@ -1,3 +1,4 @@
+// @ts-check
 const { app } = require('electron')
 const i18n = require('i18next')
 const os = require('os')

src/auto-updater/index.js

@@ -6,6 +6,7 @@ const logger = require('../common/logger')
 const { showDialog } = require('../dialogs')
 const { IS_MAC, IS_WIN, IS_APPIMAGE } = require('../common/consts')
 const ipcMainEvents = require('../common/ipc-main-events')
+const getCtx = require('../context')
 
 function isAutoUpdateSupported () {
   // atm only macOS, windows and AppImage builds support autoupdate mechanism,
@@ -16,7 +17,8 @@ function isAutoUpdateSupported () {
 let updateNotification = null // must be a global to avoid gc
 let feedback = false
 
-function setup (ctx) {
+function setup () {
+  const ctx = getCtx()
   // we download manually in 'update-available'
   autoUpdater.autoDownload = false
   autoUpdater.autoInstallOnAppQuit = true
@@ -122,14 +124,15 @@ function setup (ctx) {
       updateNotification.show()
     }
   })
+  const stopIpfs = ctx.getFn('stopIpfs')
 
   // In some cases before-quit event is not emitted before all windows are closed,
   // and we need to do cleanup here
   const beforeQuitCleanup = async () => {
     BrowserWindow.getAllWindows().forEach(w => w.removeAllListeners('close'))
     app.removeAllListeners('window-all-closed')
     try {
-      const s = await ctx.stopIpfs()
+      const s = await stopIpfs()
       logger.info(`[beforeQuitCleanup] stopIpfs had finished with status: ${s}`)
     } catch (err) {
       logger.error('[beforeQuitCleanup] stopIpfs had an error', err)
@@ -150,33 +153,34 @@ async function checkForUpdates () {
   ipcMain.emit(ipcMainEvents.UPDATING_ENDED)
 }
 
-module.exports = async function (ctx) {
+module.exports = async function () {
+  console.log(getCtx()._properties)
   if (['test', 'development'].includes(process.env.NODE_ENV)) {
-    ctx.manualCheckForUpdates = () => {
+    getCtx().setProp('manualCheckForUpdates', () => {
       showDialog({
         title: 'Not available in development',
         message: 'Yes, you called this function successfully.',
         buttons: [i18n.t('close')]
       })
-    }
+    })
     return
   }
   if (!isAutoUpdateSupported()) {
-    ctx.manualCheckForUpdates = () => {
+    getCtx().setProp('manualCheckForUpdates', () => {
       shell.openExternal('https://github.com/ipfs-shipyard/ipfs-desktop/releases/latest')
-    }
+    })
     return
   }
 
-  setup(ctx)
+  setup()
 
   checkForUpdates() // background check
 
   setInterval(checkForUpdates, 43200000) // every 12 hours
 
   // enable on-demand check via About submenu
-  ctx.manualCheckForUpdates = () => {
+  getCtx().setProp('manualCheckForUpdates', () => {
     feedback = true
     checkForUpdates()
-  }
+  })
 }

src/common/config-keys.js

@@ -1,7 +1,7 @@
 /**
  * Configuration key constants for the features in IPFS Desktop.
  *
- * @type {Object.<string, string>}
+ * @type {Record<import('../types').CONFIG_KEYS, string>}
  */
 const CONFIG_KEYS = {
   AUTO_LAUNCH: 'autoLaunch',

src/common/logger.js

@@ -22,7 +22,7 @@ const { analyticsKeys } = require('../analytics/keys')
  * @property {(err: Error) => void} fail
  */
 
-const { combine, splat, timestamp, printf } = format
+const { combine, splat, timestamp, printf, errors } = format
 const logsPath = app.getPath('userData')
 
 const errorFile = new transports.File({
@@ -36,6 +36,7 @@ errorFile.on('finish', () => {
 
 const logger = createLogger({
   format: combine(
+    errors({ stack: true }),
     timestamp(),
     splat(),
     printf(info => `${info.timestamp} ${info.level}: ${info.message}`)
@@ -57,7 +58,7 @@ logger.info(`[meta] logs can be found on ${logsPath}`)
 
 /**
  *
- * @param {AnalyticsTimeOptions & import('countly-sdk-nodejs').CountlyAddEventOptions}
+ * @param {AnalyticsTimeOptions & import('countly-sdk-nodejs').CountlyAddEventOptions} args
  *
  * @returns {void} void
  */