feat(readMetadata): add support for macOS target apps

src/readmetadata.js

@@ -1,12 +1,23 @@
 'use strict'
 
+const { promisify } = require('util')
+
 const asar = require('asar')
 const fs = require('fs-extra')
+const glob = promisify(require('glob'))
 const path = require('path')
 const { wrapError } = require('./error')
 
-async function readPackageJSONFromUnpackedApp (options) {
-  const appPackageJSONPath = path.join(options.src, 'resources', 'app', 'package.json')
+async function determineResourcesDir (src) {
+  if (await fs.pathExists(path.join(src, 'resources'))) {
+    return 'resources'
+  }
+
+  return (await glob('*.app/Contents/Resources', { cwd: src }))[0]
+}
+
+async function readPackageJSONFromUnpackedApp (resourcesDir, options) {
+  const appPackageJSONPath = path.join(options.src, resourcesDir, 'app', 'package.json')
   options.logger(`Reading package metadata from ${appPackageJSONPath}`)
 
   return fs.readJson(appPackageJSONPath)
@@ -16,8 +27,9 @@ async function readPackageJSONFromUnpackedApp (options) {
 }
 
 /**
- * Read `package.json` either from `resources/app.asar` (if the app is packaged)
- * or from `resources/app/package.json` (if it is not).
+ * Read `package.json` either from `$RESOURCES_DIR/app.asar` (if the app is packaged)
+ * or from `$RESOURCES_DIR/app/package.json` (if it is not). `$RESOURCES_DIR` is either
+ * `AppName.app/Contents/Resources` on macOS, or `resources` on other platforms.
  *
  * Options used:
  *
@@ -26,14 +38,18 @@ async function readPackageJSONFromUnpackedApp (options) {
  *             `debug('electron-installer-something:some-module')`
  */
 module.exports = async function readMetadata (options) {
-  const appAsarPath = path.join(options.src, 'resources/app.asar')
-
   return wrapError('reading package metadata', async () => {
+    const resourcesDir = await determineResourcesDir(options.src)
+    if (!resourcesDir) {
+      throw new Error('Could not determine resources directory in Electron app')
+    }
+    const appAsarPath = path.join(options.src, resourcesDir, 'app.asar')
+
     if (await fs.pathExists(appAsarPath)) {
       options.logger(`Reading package metadata from ${appAsarPath}`)
       return JSON.parse(asar.extractFile(appAsarPath, 'package.json'))
     } else {
-      return readPackageJSONFromUnpackedApp(options)
+      return readPackageJSONFromUnpackedApp(resourcesDir, options)
     }
   })
 }

test/fixtures/app-with-bad-package-json/resources/app/package.json

@@ -0,0 +1 @@
+{

test/fixtures/macOS-app-without-asar/Test.app/Contents/Resources/app/package.json

@@ -0,0 +1,19 @@
+{
+  "name": "bartest",
+  "description": "Bar test (without asar).",
+  "version": "0.0.1",
+  "license": "MIT",
+
+  "private": true,
+  "main": "index.js",
+
+  "copyright": "Copyright 2015 Daniel Perez Alvarez",
+  "projectId": "org.electron-userland.Bar",
+  "projectName": "Bar",
+  "productName": "Bar",
+  "productUrl": "https://github.com/electron-userland/",
+  "companyName": "Daniel Perez Alvarez",
+  "companyUrl": "https://github.com/electron-userland/",
+
+  "author": "Daniel Perez Alvarez <[email protected]> (https://unindented.org/)"
+}

test/readmetadata.js

@@ -14,6 +14,20 @@ test('readMetadata for app without asar', async t => {
   t.regex(packageJSON.description, /without asar/)
 })
 
-test('readMetadata for invalid app', t => {
-  return t.throwsAsync(readMetadata({ src: path.join(__dirname, 'fixtures'), logger: log => log }), { message: /Could not find, read, or parse/ })
+test('readMetadata for macOS app with asar', async t => {
+  const packageJSON = await readMetadata({ src: path.join(__dirname, 'fixtures', 'macOS-app-with-asar'), logger: log => log })
+  t.regex(packageJSON.description, /with asar/)
+})
+
+test('readMetadata for macOS app without asar', async t => {
+  const packageJSON = await readMetadata({ src: path.join(__dirname, 'fixtures', 'macOS-app-without-asar'), logger: log => log })
+  t.regex(packageJSON.description, /without asar/)
+})
+
+test('readMetadata for app without a resources directory', t => {
+  return t.throwsAsync(readMetadata({ src: path.join(__dirname, 'fixtures'), logger: log => log }), { message: /Could not determine resources directory/ })
+})
+
+test('readMetadata for app with a bad package.json', t => {
+  return t.throwsAsync(readMetadata({ src: path.join(__dirname, 'fixtures', 'app-with-bad-package-json'), logger: log => log }), { message: /Could not find, read, or parse/ })
 })