refactor: use separate ipc-renderer-internal / ipc-main-internal APIs for Electron internals (#13940)
This commit is contained in:
		
					parent
					
						
							
								f7122610cc
							
						
					
				
			
			
				commit
				
					
						b50f86ef43
					
				
			
		
					 49 changed files with 322 additions and 133 deletions
				
			
		| 
						 | 
				
			
			@ -1,117 +0,0 @@
 | 
			
		|||
'use strict'
 | 
			
		||||
 | 
			
		||||
const electron = require('electron')
 | 
			
		||||
const binding = process.atomBinding('crash_reporter')
 | 
			
		||||
 | 
			
		||||
const sendSync = function (channel, ...args) {
 | 
			
		||||
  if (process.type === 'browser') {
 | 
			
		||||
    const event = {}
 | 
			
		||||
    electron.ipcMain.emit(channel, event, ...args)
 | 
			
		||||
    return event.returnValue
 | 
			
		||||
  } else {
 | 
			
		||||
    return electron.ipcRenderer.sendSync(channel, ...args)
 | 
			
		||||
  }
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
class CrashReporter {
 | 
			
		||||
  contructor () {
 | 
			
		||||
    this.productName = null
 | 
			
		||||
    this.crashesDirectory = null
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  start (options) {
 | 
			
		||||
    if (options == null) options = {}
 | 
			
		||||
 | 
			
		||||
    let {
 | 
			
		||||
      productName,
 | 
			
		||||
      companyName,
 | 
			
		||||
      extra,
 | 
			
		||||
      ignoreSystemCrashHandler,
 | 
			
		||||
      submitURL,
 | 
			
		||||
      uploadToServer
 | 
			
		||||
    } = options
 | 
			
		||||
 | 
			
		||||
    if (uploadToServer == null) {
 | 
			
		||||
      uploadToServer = true
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    if (ignoreSystemCrashHandler == null) {
 | 
			
		||||
      ignoreSystemCrashHandler = false
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    if (companyName == null) {
 | 
			
		||||
      throw new Error('companyName is a required option to crashReporter.start')
 | 
			
		||||
    }
 | 
			
		||||
    if (submitURL == null) {
 | 
			
		||||
      throw new Error('submitURL is a required option to crashReporter.start')
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    const ret = sendSync('ELECTRON_CRASH_REPORTER_INIT', {
 | 
			
		||||
      submitURL,
 | 
			
		||||
      productName
 | 
			
		||||
    })
 | 
			
		||||
 | 
			
		||||
    this.productName = ret.productName
 | 
			
		||||
    this.crashesDirectory = ret.crashesDirectory
 | 
			
		||||
 | 
			
		||||
    if (extra == null) extra = {}
 | 
			
		||||
    if (extra._productName == null) extra._productName = ret.productName
 | 
			
		||||
    if (extra._companyName == null) extra._companyName = companyName
 | 
			
		||||
    if (extra._version == null) extra._version = ret.appVersion
 | 
			
		||||
 | 
			
		||||
    binding.start(ret.productName, companyName, submitURL, ret.crashesDirectory, uploadToServer, ignoreSystemCrashHandler, extra)
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  getLastCrashReport () {
 | 
			
		||||
    const reports = this.getUploadedReports()
 | 
			
		||||
      .sort((a, b) => {
 | 
			
		||||
        const ats = (a && a.date) ? new Date(a.date).getTime() : 0
 | 
			
		||||
        const bts = (b && b.date) ? new Date(b.date).getTime() : 0
 | 
			
		||||
        return bts - ats
 | 
			
		||||
      })
 | 
			
		||||
 | 
			
		||||
    return (reports.length > 0) ? reports[0] : null
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  getUploadedReports () {
 | 
			
		||||
    return binding.getUploadedReports(this.getCrashesDirectory())
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  getCrashesDirectory () {
 | 
			
		||||
    return this.crashesDirectory
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  getProductName () {
 | 
			
		||||
    return this.productName
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  getUploadToServer () {
 | 
			
		||||
    if (process.type === 'browser') {
 | 
			
		||||
      return binding.getUploadToServer()
 | 
			
		||||
    } else {
 | 
			
		||||
      throw new Error('getUploadToServer can only be called from the main process')
 | 
			
		||||
    }
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  setUploadToServer (uploadToServer) {
 | 
			
		||||
    if (process.type === 'browser') {
 | 
			
		||||
      return binding.setUploadToServer(uploadToServer)
 | 
			
		||||
    } else {
 | 
			
		||||
      throw new Error('setUploadToServer can only be called from the main process')
 | 
			
		||||
    }
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  addExtraParameter (key, value) {
 | 
			
		||||
    binding.addExtraParameter(key, value)
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  removeExtraParameter (key) {
 | 
			
		||||
    binding.removeExtraParameter(key)
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  getParameters (key, value) {
 | 
			
		||||
    return binding.getParameters()
 | 
			
		||||
  }
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
module.exports = new CrashReporter()
 | 
			
		||||
| 
						 | 
				
			
			@ -3,7 +3,6 @@
 | 
			
		|||
// Common modules, please sort alphabetically
 | 
			
		||||
module.exports = [
 | 
			
		||||
  { name: 'clipboard', file: 'clipboard' },
 | 
			
		||||
  { name: 'crashReporter', file: 'crash-reporter' },
 | 
			
		||||
  { name: 'nativeImage', file: 'native-image' },
 | 
			
		||||
  { name: 'shell', file: 'shell' },
 | 
			
		||||
  // The internal modules, invisible unless you know their names.
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue