Compare commits
27 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
b6f0c88db4 | ||
|
|
bb304ce10b | ||
|
|
8e2842b4a3 | ||
|
|
02119d5a83 | ||
|
|
1948f1caa9 | ||
|
|
52fa9a2a78 | ||
|
|
4e631b7ca2 | ||
|
|
fe1a0e06b0 | ||
|
|
9a808beecc | ||
|
|
381ca1a748 | ||
|
|
0d2b974dcc | ||
|
|
0cfaddcc77 | ||
|
|
fddff57c15 | ||
|
|
b02ce7697f | ||
|
|
85b1f90f2c | ||
|
|
3ecbbd5710 | ||
|
|
8bff0b7579 | ||
|
|
283773eb45 | ||
|
|
a99ae94fc2 | ||
|
|
0d70c1c39f | ||
|
|
ba587f0a08 | ||
|
|
580002844b | ||
|
|
365775311f | ||
|
|
1fc0005ae8 | ||
|
|
64cbc83faf | ||
|
|
691e4ef31d | ||
|
|
d902197267 |
@@ -1,46 +1,35 @@
|
|||||||
step-restore-cache: &step-restore-cache
|
|
||||||
restore_cache:
|
|
||||||
keys:
|
|
||||||
- v1-dependencies-{{ arch }}-{{ checksum "yarn.lock" }}
|
|
||||||
- v1-dependencies-{{ arch }}
|
|
||||||
|
|
||||||
steps-test: &steps-test
|
|
||||||
steps:
|
|
||||||
- checkout
|
|
||||||
- *step-restore-cache
|
|
||||||
- run: yarn --frozen-lockfile
|
|
||||||
- save_cache:
|
|
||||||
paths:
|
|
||||||
- node_modules
|
|
||||||
key: v1-dependencies-{{ arch }}-{{ checksum "yarn.lock" }}
|
|
||||||
- run: yarn build
|
|
||||||
- run: yarn test
|
|
||||||
|
|
||||||
version: 2.1
|
version: 2.1
|
||||||
jobs:
|
|
||||||
test:
|
|
||||||
macos:
|
|
||||||
xcode: "13.4.1"
|
|
||||||
<<: *steps-test
|
|
||||||
|
|
||||||
release:
|
orbs:
|
||||||
docker:
|
cfa: continuousauth/npm@2.0.0
|
||||||
- image: circleci/node:14.15
|
node: electronjs/node@2.1.0
|
||||||
steps:
|
|
||||||
- checkout
|
|
||||||
- *step-restore-cache
|
|
||||||
- run: yarn --frozen-lockfile
|
|
||||||
- run: npx semantic-release
|
|
||||||
workflows:
|
workflows:
|
||||||
version: 2
|
|
||||||
test_and_release:
|
test_and_release:
|
||||||
|
# Run the test jobs first, then the release only when all the test jobs are successful
|
||||||
jobs:
|
jobs:
|
||||||
- test
|
- node/test:
|
||||||
- release:
|
executor: node/macos
|
||||||
|
name: test-mac-<< matrix.node-version >>
|
||||||
|
override-ci-command: yarn install --frozen-lockfile --ignore-engines
|
||||||
|
test-steps:
|
||||||
|
- node/install-rosetta
|
||||||
|
- run: yarn build
|
||||||
|
- run: yarn lint
|
||||||
|
- run: yarn test
|
||||||
|
use-test-steps: true
|
||||||
|
matrix:
|
||||||
|
alias: test
|
||||||
|
parameters:
|
||||||
|
node-version:
|
||||||
|
- 20.5.0
|
||||||
|
- 18.17.0
|
||||||
|
- 16.20.1
|
||||||
|
- cfa/release:
|
||||||
requires:
|
requires:
|
||||||
- test
|
- test
|
||||||
filters:
|
filters:
|
||||||
branches:
|
branches:
|
||||||
only:
|
only:
|
||||||
- master
|
- main
|
||||||
|
context: cfa-release
|
||||||
|
|||||||
1
.github/CODEOWNERS
vendored
Normal file
1
.github/CODEOWNERS
vendored
Normal file
@@ -0,0 +1 @@
|
|||||||
|
* @electron/wg-ecosystem
|
||||||
29
.github/workflows/add-to-project.yml
vendored
Normal file
29
.github/workflows/add-to-project.yml
vendored
Normal file
@@ -0,0 +1,29 @@
|
|||||||
|
name: Add to Ecosystem WG Project
|
||||||
|
|
||||||
|
on:
|
||||||
|
issues:
|
||||||
|
types:
|
||||||
|
- opened
|
||||||
|
pull_request_target:
|
||||||
|
types:
|
||||||
|
- opened
|
||||||
|
|
||||||
|
permissions: {}
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
add-to-project:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- name: Generate GitHub App token
|
||||||
|
uses: electron/github-app-auth-action@384fd19694fe7b6dcc9a684746c6976ad78228ae # v1.1.1
|
||||||
|
id: generate-token
|
||||||
|
with:
|
||||||
|
creds: ${{ secrets.ECOSYSTEM_ISSUE_TRIAGE_GH_APP_CREDS }}
|
||||||
|
org: electron
|
||||||
|
- name: Add to Project
|
||||||
|
uses: dsanders11/project-actions/add-item@3a81985616963f32fae17d1d1b406c631f3201a1 # v1.1.0
|
||||||
|
with:
|
||||||
|
field: Opened
|
||||||
|
field-value: ${{ github.event.pull_request.created_at || github.event.issue.created_at }}
|
||||||
|
project-number: 89
|
||||||
|
token: ${{ steps.generate-token.outputs.token }}
|
||||||
26
.github/workflows/semantic.yml
vendored
Normal file
26
.github/workflows/semantic.yml
vendored
Normal file
@@ -0,0 +1,26 @@
|
|||||||
|
name: "Check Semantic Commit"
|
||||||
|
|
||||||
|
on:
|
||||||
|
pull_request:
|
||||||
|
types:
|
||||||
|
- opened
|
||||||
|
- edited
|
||||||
|
- synchronize
|
||||||
|
|
||||||
|
permissions:
|
||||||
|
contents: read
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
main:
|
||||||
|
permissions:
|
||||||
|
pull-requests: read # for amannn/action-semantic-pull-request to analyze PRs
|
||||||
|
statuses: write # for amannn/action-semantic-pull-request to mark status of analyzed PR
|
||||||
|
name: Validate PR Title
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- name: semantic-pull-request
|
||||||
|
uses: amannn/action-semantic-pull-request@c3cd5d1ea3580753008872425915e343e351ab54 # v5.2.0
|
||||||
|
env:
|
||||||
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
with:
|
||||||
|
validateSingleCommit: false
|
||||||
4
.gitignore
vendored
4
.gitignore
vendored
@@ -1,3 +1,7 @@
|
|||||||
node_modules
|
node_modules
|
||||||
dist
|
dist
|
||||||
|
entry-asar/*.js*
|
||||||
|
entry-asar/*.ts
|
||||||
*.app
|
*.app
|
||||||
|
test/fixtures/apps
|
||||||
|
coverage
|
||||||
4
.husky/pre-commit
Executable file
4
.husky/pre-commit
Executable file
@@ -0,0 +1,4 @@
|
|||||||
|
#!/usr/bin/env sh
|
||||||
|
. "$(dirname -- "$0")/_/husky.sh"
|
||||||
|
|
||||||
|
yarn lint-staged
|
||||||
@@ -4,6 +4,7 @@
|
|||||||
"@semantic-release/release-notes-generator",
|
"@semantic-release/release-notes-generator",
|
||||||
"@continuous-auth/semantic-release-npm",
|
"@continuous-auth/semantic-release-npm",
|
||||||
"@semantic-release/github"
|
"@semantic-release/github"
|
||||||
]
|
],
|
||||||
|
"branches": [ "main" ]
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
21
LICENSE
Normal file
21
LICENSE
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
MIT License
|
||||||
|
|
||||||
|
Copyright (c) Contributors to the Electron project
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
in the Software without restriction, including without limitation the rights
|
||||||
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
copies of the Software, and to permit persons to whom the Software is
|
||||||
|
furnished to do so, subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all
|
||||||
|
copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||||
|
SOFTWARE.
|
||||||
@@ -2,7 +2,8 @@
|
|||||||
|
|
||||||
> Create universal macOS Electron applications
|
> Create universal macOS Electron applications
|
||||||
|
|
||||||
[](https://circleci.com/gh/electron/universal)
|
[](https://circleci.com/gh/electron/universal)
|
||||||
|
[](https://npm.im/@electron/universal)
|
||||||
|
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|||||||
19
entry-asar/ambient.d.ts
vendored
Normal file
19
entry-asar/ambient.d.ts
vendored
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
declare namespace NodeJS {
|
||||||
|
interface Process extends EventEmitter {
|
||||||
|
// This is an undocumented private API. It exists.
|
||||||
|
_archPath: string;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
declare module 'electron' {
|
||||||
|
const app: Electron.App;
|
||||||
|
|
||||||
|
namespace Electron {
|
||||||
|
interface App {
|
||||||
|
getAppPath: () => string;
|
||||||
|
setAppPath: (p: string) => void;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export { app };
|
||||||
|
}
|
||||||
@@ -1,7 +0,0 @@
|
|||||||
if (process.arch === 'arm64') {
|
|
||||||
process._archPath = require.resolve('../app-arm64.asar');
|
|
||||||
} else {
|
|
||||||
process._archPath = require.resolve('../app-x64.asar');
|
|
||||||
}
|
|
||||||
|
|
||||||
require(process._archPath);
|
|
||||||
27
entry-asar/has-asar.ts
Normal file
27
entry-asar/has-asar.ts
Normal file
@@ -0,0 +1,27 @@
|
|||||||
|
import { app } from 'electron';
|
||||||
|
import path from 'path';
|
||||||
|
|
||||||
|
if (process.arch === 'arm64') {
|
||||||
|
setPaths('arm64');
|
||||||
|
} else {
|
||||||
|
setPaths('x64');
|
||||||
|
}
|
||||||
|
|
||||||
|
function setPaths(platform: string) {
|
||||||
|
// This should return the full path, ending in something like
|
||||||
|
// Notion.app/Contents/Resources/app.asar
|
||||||
|
const appPath = app.getAppPath();
|
||||||
|
const asarFile = `app-${platform}.asar`;
|
||||||
|
|
||||||
|
// Maybe we'll handle this in Electron one day
|
||||||
|
if (path.basename(appPath) === 'app.asar') {
|
||||||
|
const platformAppPath = path.join(path.dirname(appPath), asarFile);
|
||||||
|
|
||||||
|
// This is an undocumented API. It exists.
|
||||||
|
app.setAppPath(platformAppPath);
|
||||||
|
}
|
||||||
|
|
||||||
|
process._archPath = require.resolve(`../${asarFile}`);
|
||||||
|
}
|
||||||
|
|
||||||
|
require(process._archPath);
|
||||||
@@ -1,7 +0,0 @@
|
|||||||
if (process.arch === 'arm64') {
|
|
||||||
process._archPath = require.resolve('../app-arm64');
|
|
||||||
} else {
|
|
||||||
process._archPath = require.resolve('../app-x64');
|
|
||||||
}
|
|
||||||
|
|
||||||
require(process._archPath);
|
|
||||||
27
entry-asar/no-asar.ts
Normal file
27
entry-asar/no-asar.ts
Normal file
@@ -0,0 +1,27 @@
|
|||||||
|
import { app } from 'electron';
|
||||||
|
import path from 'path';
|
||||||
|
|
||||||
|
if (process.arch === 'arm64') {
|
||||||
|
setPaths('arm64');
|
||||||
|
} else {
|
||||||
|
setPaths('x64');
|
||||||
|
}
|
||||||
|
|
||||||
|
function setPaths(platform: string) {
|
||||||
|
// This should return the full path, ending in something like
|
||||||
|
// Notion.app/Contents/Resources/app
|
||||||
|
const appPath = app.getAppPath();
|
||||||
|
const appFolder = `app-${platform}`;
|
||||||
|
|
||||||
|
// Maybe we'll handle this in Electron one day
|
||||||
|
if (path.basename(appPath) === 'app') {
|
||||||
|
const platformAppPath = path.join(path.dirname(appPath), appFolder);
|
||||||
|
|
||||||
|
// This is an undocumented private API. It exists.
|
||||||
|
app.setAppPath(platformAppPath);
|
||||||
|
}
|
||||||
|
|
||||||
|
process._archPath = require.resolve(`../${appFolder}`);
|
||||||
|
}
|
||||||
|
|
||||||
|
require(process._archPath);
|
||||||
14
jest.config.js
Normal file
14
jest.config.js
Normal file
@@ -0,0 +1,14 @@
|
|||||||
|
/** @type {import('ts-jest').JestConfigWithTsJest} */
|
||||||
|
module.exports = {
|
||||||
|
preset: 'ts-jest',
|
||||||
|
testEnvironment: 'node',
|
||||||
|
transform: {
|
||||||
|
'.': [
|
||||||
|
'ts-jest',
|
||||||
|
{
|
||||||
|
tsconfig: 'tsconfig.jest.json'
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
globalSetup: './jest.setup.ts'
|
||||||
|
};
|
||||||
57
jest.setup.ts
Normal file
57
jest.setup.ts
Normal file
@@ -0,0 +1,57 @@
|
|||||||
|
import { downloadArtifact } from '@electron/get';
|
||||||
|
import * as zip from 'cross-zip';
|
||||||
|
import * as fs from 'fs-extra';
|
||||||
|
import * as path from 'path';
|
||||||
|
|
||||||
|
const asarsDir = path.resolve(__dirname, 'test', 'fixtures', 'asars');
|
||||||
|
const appsDir = path.resolve(__dirname, 'test', 'fixtures', 'apps');
|
||||||
|
|
||||||
|
const templateApp = async (
|
||||||
|
name: string,
|
||||||
|
arch: string,
|
||||||
|
modify: (appPath: string) => Promise<void>,
|
||||||
|
) => {
|
||||||
|
const electronZip = await downloadArtifact({
|
||||||
|
artifactName: 'electron',
|
||||||
|
version: '27.0.0',
|
||||||
|
platform: 'darwin',
|
||||||
|
arch,
|
||||||
|
});
|
||||||
|
const appPath = path.resolve(appsDir, name);
|
||||||
|
zip.unzipSync(electronZip, appsDir);
|
||||||
|
await fs.rename(path.resolve(appsDir, 'Electron.app'), appPath);
|
||||||
|
await fs.remove(path.resolve(appPath, 'Contents', 'Resources', 'default_app.asar'));
|
||||||
|
await modify(appPath);
|
||||||
|
};
|
||||||
|
|
||||||
|
export default async () => {
|
||||||
|
await fs.remove(appsDir);
|
||||||
|
await fs.mkdirp(appsDir);
|
||||||
|
await templateApp('Asar.app', 'arm64', async (appPath) => {
|
||||||
|
await fs.copy(
|
||||||
|
path.resolve(asarsDir, 'app.asar'),
|
||||||
|
path.resolve(appPath, 'Contents', 'Resources', 'app.asar'),
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
await templateApp('X64Asar.app', 'x64', async (appPath) => {
|
||||||
|
await fs.copy(
|
||||||
|
path.resolve(asarsDir, 'app.asar'),
|
||||||
|
path.resolve(appPath, 'Contents', 'Resources', 'app.asar'),
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
await templateApp('NoAsar.app', 'arm64', async (appPath) => {
|
||||||
|
await fs.copy(
|
||||||
|
path.resolve(asarsDir, 'app'),
|
||||||
|
path.resolve(appPath, 'Contents', 'Resources', 'app'),
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
await templateApp('X64NoAsar.app', 'x64', async (appPath) => {
|
||||||
|
await fs.copy(
|
||||||
|
path.resolve(asarsDir, 'app'),
|
||||||
|
path.resolve(appPath, 'Contents', 'Resources', 'app'),
|
||||||
|
);
|
||||||
|
});
|
||||||
|
};
|
||||||
58
package.json
58
package.json
@@ -15,50 +15,56 @@
|
|||||||
"url": "https://github.com/electron/universal.git"
|
"url": "https://github.com/electron/universal.git"
|
||||||
},
|
},
|
||||||
"engines": {
|
"engines": {
|
||||||
"node": ">=8.6"
|
"node": ">=16.4"
|
||||||
},
|
},
|
||||||
"files": [
|
"files": [
|
||||||
"dist/*",
|
"dist/*",
|
||||||
"entry-asar/*",
|
"entry-asar/*",
|
||||||
|
"!entry-asar/**/*.ts",
|
||||||
"README.md"
|
"README.md"
|
||||||
],
|
],
|
||||||
"author": "Samuel Attard",
|
"author": "Samuel Attard",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"build": "tsc && tsc -p tsconfig.esm.json",
|
"build": "tsc -p tsconfig.cjs.json && tsc -p tsconfig.esm.json && tsc -p tsconfig.entry-asar.json",
|
||||||
"lint": "prettier --check \"src/**/*.ts\"",
|
"lint": "prettier --check \"{src,entry-asar,test}/**/*.ts\" \"*.ts\"",
|
||||||
|
"prettier:write": "prettier --write \"{src,entry-asar,test}/**/*.ts\" \"*.ts\"",
|
||||||
"prepublishOnly": "npm run build",
|
"prepublishOnly": "npm run build",
|
||||||
"test": "exit 0"
|
"test": "jest",
|
||||||
|
"prepare": "husky install"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@continuous-auth/semantic-release-npm": "^2.0.0",
|
"@continuous-auth/semantic-release-npm": "^4.0.0",
|
||||||
"@types/debug": "^4.1.5",
|
"@electron/get": "^3.0.0",
|
||||||
"@types/fs-extra": "^9.0.4",
|
"@types/cross-zip": "^4.0.1",
|
||||||
"@types/minimatch": "^3.0.5",
|
"@types/debug": "^4.1.10",
|
||||||
"@types/node": "^14.14.7",
|
"@types/fs-extra": "^11.0.3",
|
||||||
"@types/plist": "^3.0.2",
|
"@types/jest": "^29.5.7",
|
||||||
"husky": "^4.3.0",
|
"@types/minimatch": "^5.1.2",
|
||||||
"lint-staged": "^10.5.1",
|
"@types/node": "^20.8.10",
|
||||||
"prettier": "^2.1.2",
|
"@types/plist": "^3.0.4",
|
||||||
"semantic-release": "^17.2.2",
|
"cross-zip": "^4.0.0",
|
||||||
"typescript": "^4.0.5"
|
"husky": "^8.0.3",
|
||||||
|
"jest": "^29.7.0",
|
||||||
|
"lint-staged": "^15.0.2",
|
||||||
|
"prettier": "^3.0.3",
|
||||||
|
"ts-jest": "^29.1.1",
|
||||||
|
"typescript": "^5.2.2"
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@malept/cross-spawn-promise": "^1.1.0",
|
"@electron/asar": "^3.2.7",
|
||||||
"asar": "^3.1.0",
|
"@malept/cross-spawn-promise": "^2.0.0",
|
||||||
"debug": "^4.3.1",
|
"debug": "^4.3.1",
|
||||||
"dir-compare": "^2.4.0",
|
"dir-compare": "^4.2.0",
|
||||||
"fs-extra": "^9.0.1",
|
"fs-extra": "^11.1.1",
|
||||||
"minimatch": "^3.0.4",
|
"minimatch": "^9.0.3",
|
||||||
"plist": "^3.0.4"
|
"plist": "^3.1.0"
|
||||||
},
|
|
||||||
"husky": {
|
|
||||||
"hooks": {
|
|
||||||
"pre-commit": "lint-staged"
|
|
||||||
}
|
|
||||||
},
|
},
|
||||||
"lint-staged": {
|
"lint-staged": {
|
||||||
"*.ts": [
|
"*.ts": [
|
||||||
"prettier --write"
|
"prettier --write"
|
||||||
]
|
]
|
||||||
|
},
|
||||||
|
"resolutions": {
|
||||||
|
"jackspeak": "2.1.1"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,10 +1,10 @@
|
|||||||
import * as asar from 'asar';
|
import asar from '@electron/asar';
|
||||||
import { execFileSync } from 'child_process';
|
import { execFileSync } from 'child_process';
|
||||||
import * as crypto from 'crypto';
|
import crypto from 'crypto';
|
||||||
import * as fs from 'fs-extra';
|
import fs from 'fs-extra';
|
||||||
import * as path from 'path';
|
import path from 'path';
|
||||||
import * as minimatch from 'minimatch';
|
import { minimatch } from 'minimatch';
|
||||||
import * as os from 'os';
|
import os from 'os';
|
||||||
import { d } from './debug';
|
import { d } from './debug';
|
||||||
|
|
||||||
const LIPO = 'lipo';
|
const LIPO = 'lipo';
|
||||||
@@ -25,12 +25,15 @@ export type MergeASARsOptions = {
|
|||||||
// See: https://github.com/apple-opensource-mirror/llvmCore/blob/0c60489d96c87140db9a6a14c6e82b15f5e5d252/include/llvm/Object/MachOFormat.h#L108-L112
|
// See: https://github.com/apple-opensource-mirror/llvmCore/blob/0c60489d96c87140db9a6a14c6e82b15f5e5d252/include/llvm/Object/MachOFormat.h#L108-L112
|
||||||
const MACHO_MAGIC = new Set([
|
const MACHO_MAGIC = new Set([
|
||||||
// 32-bit Mach-O
|
// 32-bit Mach-O
|
||||||
0xfeedface,
|
0xfeedface, 0xcefaedfe,
|
||||||
0xcefaedfe,
|
|
||||||
|
|
||||||
// 64-bit Mach-O
|
// 64-bit Mach-O
|
||||||
0xfeedfacf,
|
0xfeedfacf, 0xcffaedfe,
|
||||||
0xcffaedfe,
|
]);
|
||||||
|
|
||||||
|
const MACHO_UNIVERSAL_MAGIC = new Set([
|
||||||
|
// universal
|
||||||
|
0xcafebabe, 0xbebafeca,
|
||||||
]);
|
]);
|
||||||
|
|
||||||
export const detectAsarMode = async (appPath: string) => {
|
export const detectAsarMode = async (appPath: string) => {
|
||||||
@@ -147,6 +150,13 @@ export const mergeASARs = async ({
|
|||||||
continue;
|
continue;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if (
|
||||||
|
MACHO_UNIVERSAL_MAGIC.has(x64Content.readUInt32LE(0)) &&
|
||||||
|
MACHO_UNIVERSAL_MAGIC.has(arm64Content.readUInt32LE(0))
|
||||||
|
) {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
if (!MACHO_MAGIC.has(x64Content.readUInt32LE(0))) {
|
if (!MACHO_MAGIC.has(x64Content.readUInt32LE(0))) {
|
||||||
throw new Error(`Can't reconcile two non-macho files ${file}`);
|
throw new Error(`Can't reconcile two non-macho files ${file}`);
|
||||||
}
|
}
|
||||||
@@ -195,8 +205,15 @@ export const mergeASARs = async ({
|
|||||||
|
|
||||||
const resolvedUnpack = Array.from(unpackedFiles).map((file) => path.join(x64Dir, file));
|
const resolvedUnpack = Array.from(unpackedFiles).map((file) => path.join(x64Dir, file));
|
||||||
|
|
||||||
|
let unpack: string | undefined;
|
||||||
|
if (resolvedUnpack.length > 1) {
|
||||||
|
unpack = `{${resolvedUnpack.join(',')}}`;
|
||||||
|
} else if (resolvedUnpack.length === 1) {
|
||||||
|
unpack = resolvedUnpack[0];
|
||||||
|
}
|
||||||
|
|
||||||
await asar.createPackageWithOptions(x64Dir, outputAsarPath, {
|
await asar.createPackageWithOptions(x64Dir, outputAsarPath, {
|
||||||
unpack: `{${resolvedUnpack.join(',')}}`,
|
unpack,
|
||||||
});
|
});
|
||||||
|
|
||||||
d('done merging');
|
d('done merging');
|
||||||
|
|||||||
@@ -1,3 +1,3 @@
|
|||||||
import * as debug from 'debug';
|
import debug from 'debug';
|
||||||
|
|
||||||
export const d = debug('electron-universal');
|
export const d = debug('electron-universal');
|
||||||
|
|||||||
18
src/index.ts
18
src/index.ts
@@ -1,8 +1,7 @@
|
|||||||
import { spawn } from '@malept/cross-spawn-promise';
|
import { spawn } from '@malept/cross-spawn-promise';
|
||||||
import * as asar from 'asar';
|
import * as asar from '@electron/asar';
|
||||||
import * as crypto from 'crypto';
|
|
||||||
import * as fs from 'fs-extra';
|
import * as fs from 'fs-extra';
|
||||||
import * as minimatch from 'minimatch';
|
import { minimatch } from 'minimatch';
|
||||||
import * as os from 'os';
|
import * as os from 'os';
|
||||||
import * as path from 'path';
|
import * as path from 'path';
|
||||||
import * as plist from 'plist';
|
import * as plist from 'plist';
|
||||||
@@ -31,7 +30,7 @@ export type MakeUniversalOpts = {
|
|||||||
/**
|
/**
|
||||||
* Forcefully overwrite any existing files that are in the way of generating the universal application
|
* Forcefully overwrite any existing files that are in the way of generating the universal application
|
||||||
*/
|
*/
|
||||||
force: boolean;
|
force?: boolean;
|
||||||
/**
|
/**
|
||||||
* Merge x64 and arm64 ASARs into one.
|
* Merge x64 and arm64 ASARs into one.
|
||||||
*/
|
*/
|
||||||
@@ -44,6 +43,10 @@ export type MakeUniversalOpts = {
|
|||||||
* Minimatch pattern of binaries that are expected to be the same x64 binary in both of the ASAR files.
|
* Minimatch pattern of binaries that are expected to be the same x64 binary in both of the ASAR files.
|
||||||
*/
|
*/
|
||||||
x64ArchFiles?: string;
|
x64ArchFiles?: string;
|
||||||
|
/**
|
||||||
|
* Minimatch pattern of paths that should not receive an injected ElectronAsarIntegrity value
|
||||||
|
*/
|
||||||
|
infoPlistsToIgnore?: string;
|
||||||
};
|
};
|
||||||
|
|
||||||
const dupedFiles = (files: AppFile[]) =>
|
const dupedFiles = (files: AppFile[]) =>
|
||||||
@@ -321,7 +324,12 @@ export const makeUniversalApp = async (opts: MakeUniversalOpts): Promise<void> =
|
|||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
const mergedPlist = { ...x64Plist, ElectronAsarIntegrity: generatedIntegrity };
|
const injectAsarIntegrity =
|
||||||
|
!opts.infoPlistsToIgnore ||
|
||||||
|
minimatch(plistFile.relativePath, opts.infoPlistsToIgnore, { matchBase: true });
|
||||||
|
const mergedPlist = injectAsarIntegrity
|
||||||
|
? { ...x64Plist, ElectronAsarIntegrity: generatedIntegrity }
|
||||||
|
: { ...x64Plist };
|
||||||
|
|
||||||
await fs.writeFile(path.resolve(tmpApp, plistFile.relativePath), plist.build(mergedPlist));
|
await fs.writeFile(path.resolve(tmpApp, plistFile.relativePath), plist.build(mergedPlist));
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,16 +1,13 @@
|
|||||||
import * as fs from 'fs-extra';
|
import * as fs from 'fs-extra';
|
||||||
import * as crypto from 'crypto';
|
import * as crypto from 'crypto';
|
||||||
|
import { pipeline } from 'stream/promises';
|
||||||
|
|
||||||
import { d } from './debug';
|
import { d } from './debug';
|
||||||
|
|
||||||
export const sha = async (filePath: string) => {
|
export const sha = async (filePath: string) => {
|
||||||
d('hashing', filePath);
|
d('hashing', filePath);
|
||||||
const hash = crypto.createHash('sha256');
|
const hash = crypto.createHash('sha256');
|
||||||
hash.setEncoding('hex');
|
hash.setEncoding('hex');
|
||||||
const fileStream = fs.createReadStream(filePath);
|
await pipeline(fs.createReadStream(filePath), hash);
|
||||||
fileStream.pipe(hash);
|
|
||||||
await new Promise((resolve, reject) => {
|
|
||||||
fileStream.on('end', () => resolve());
|
|
||||||
fileStream.on('error', (err) => reject(err));
|
|
||||||
});
|
|
||||||
return hash.read();
|
return hash.read();
|
||||||
};
|
};
|
||||||
|
|||||||
26
test/asar-utils.spec.ts
Normal file
26
test/asar-utils.spec.ts
Normal file
@@ -0,0 +1,26 @@
|
|||||||
|
import * as path from 'path';
|
||||||
|
|
||||||
|
import { AsarMode, detectAsarMode, generateAsarIntegrity } from '../src/asar-utils';
|
||||||
|
|
||||||
|
const asarsPath = path.resolve(__dirname, 'fixtures', 'asars');
|
||||||
|
const appsPath = path.resolve(__dirname, 'fixtures', 'apps');
|
||||||
|
|
||||||
|
describe('asar-utils', () => {
|
||||||
|
describe('detectAsarMode', () => {
|
||||||
|
it('should correctly detect an asar enabled app', async () => {
|
||||||
|
expect(await detectAsarMode(path.resolve(appsPath, 'Asar.app'))).toBe(AsarMode.HAS_ASAR);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('should correctly detect an app without an asar', async () => {
|
||||||
|
expect(await detectAsarMode(path.resolve(appsPath, 'NoAsar.app'))).toBe(AsarMode.NO_ASAR);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe('generateAsarIntegrity', () => {
|
||||||
|
it('should deterministically hash an asar header', async () => {
|
||||||
|
expect(generateAsarIntegrity(path.resolve(asarsPath, 'app.asar')).hash).toEqual(
|
||||||
|
'85fff474383bd8df11cd9c5784e8fcd1525af71ff140a8a882e1dc9d5b39fcbf',
|
||||||
|
);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
});
|
||||||
61
test/file-utils.spec.ts
Normal file
61
test/file-utils.spec.ts
Normal file
@@ -0,0 +1,61 @@
|
|||||||
|
import * as path from 'path';
|
||||||
|
|
||||||
|
import { AppFile, AppFileType, getAllAppFiles } from '../src/file-utils';
|
||||||
|
|
||||||
|
const appsPath = path.resolve(__dirname, 'fixtures', 'apps');
|
||||||
|
|
||||||
|
describe('file-utils', () => {
|
||||||
|
describe('getAllAppFiles', () => {
|
||||||
|
let asarFiles: AppFile[];
|
||||||
|
let noAsarFiles: AppFile[];
|
||||||
|
|
||||||
|
beforeAll(async () => {
|
||||||
|
asarFiles = await getAllAppFiles(path.resolve(appsPath, 'Asar.app'));
|
||||||
|
noAsarFiles = await getAllAppFiles(path.resolve(appsPath, 'NoAsar.app'));
|
||||||
|
});
|
||||||
|
|
||||||
|
it('should correctly identify plist files', async () => {
|
||||||
|
expect(asarFiles.find((f) => f.relativePath === 'Contents/Info.plist')?.type).toBe(
|
||||||
|
AppFileType.INFO_PLIST,
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('should correctly identify asar files as app code', async () => {
|
||||||
|
expect(asarFiles.find((f) => f.relativePath === 'Contents/Resources/app.asar')?.type).toBe(
|
||||||
|
AppFileType.APP_CODE,
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('should correctly identify non-asar code files as plain text', async () => {
|
||||||
|
expect(
|
||||||
|
noAsarFiles.find((f) => f.relativePath === 'Contents/Resources/app/index.js')?.type,
|
||||||
|
).toBe(AppFileType.PLAIN);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('should correctly identify the Electron binary as Mach-O', async () => {
|
||||||
|
expect(noAsarFiles.find((f) => f.relativePath === 'Contents/MacOS/Electron')?.type).toBe(
|
||||||
|
AppFileType.MACHO,
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('should correctly identify the Electron Framework as Mach-O', async () => {
|
||||||
|
expect(
|
||||||
|
noAsarFiles.find(
|
||||||
|
(f) =>
|
||||||
|
f.relativePath ===
|
||||||
|
'Contents/Frameworks/Electron Framework.framework/Versions/A/Electron Framework',
|
||||||
|
)?.type,
|
||||||
|
).toBe(AppFileType.MACHO);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('should correctly identify the v8 context snapshot', async () => {
|
||||||
|
expect(
|
||||||
|
noAsarFiles.find(
|
||||||
|
(f) =>
|
||||||
|
f.relativePath ===
|
||||||
|
'Contents/Frameworks/Electron Framework.framework/Versions/A/Resources/v8_context_snapshot.arm64.bin',
|
||||||
|
)?.type,
|
||||||
|
).toBe(AppFileType.SNAPSHOT);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
});
|
||||||
BIN
test/fixtures/asars/app.asar
vendored
Normal file
BIN
test/fixtures/asars/app.asar
vendored
Normal file
Binary file not shown.
2
test/fixtures/asars/app/index.js
vendored
Normal file
2
test/fixtures/asars/app/index.js
vendored
Normal file
@@ -0,0 +1,2 @@
|
|||||||
|
console.log('I am an app folder', process.arch);
|
||||||
|
process.exit(0);
|
||||||
4
test/fixtures/asars/app/package.json
vendored
Normal file
4
test/fixtures/asars/app/package.json
vendored
Normal file
@@ -0,0 +1,4 @@
|
|||||||
|
{
|
||||||
|
"name": "app",
|
||||||
|
"main": "index.js"
|
||||||
|
}
|
||||||
1
test/fixtures/tohash
vendored
Normal file
1
test/fixtures/tohash
vendored
Normal file
@@ -0,0 +1 @@
|
|||||||
|
hello there
|
||||||
40
test/index.spec.ts
Normal file
40
test/index.spec.ts
Normal file
@@ -0,0 +1,40 @@
|
|||||||
|
import { spawn } from '@malept/cross-spawn-promise';
|
||||||
|
import * as fs from 'fs-extra';
|
||||||
|
import * as path from 'path';
|
||||||
|
|
||||||
|
import { makeUniversalApp } from '../src/index';
|
||||||
|
|
||||||
|
const appsPath = path.resolve(__dirname, 'fixtures', 'apps');
|
||||||
|
|
||||||
|
async function ensureUniversal(app: string) {
|
||||||
|
const exe = path.resolve(app, 'Contents', 'MacOS', 'Electron');
|
||||||
|
const result = await spawn(exe);
|
||||||
|
expect(result).toContain('arm64');
|
||||||
|
const result2 = await spawn('arch', ['-x86_64', exe]);
|
||||||
|
expect(result2).toContain('x64');
|
||||||
|
}
|
||||||
|
|
||||||
|
describe('makeUniversalApp', () => {
|
||||||
|
it('should correctly merge two identical asars', async () => {
|
||||||
|
const out = path.resolve(appsPath, 'MergedAsar.app');
|
||||||
|
await makeUniversalApp({
|
||||||
|
x64AppPath: path.resolve(appsPath, 'X64Asar.app'),
|
||||||
|
arm64AppPath: path.resolve(appsPath, 'Asar.app'),
|
||||||
|
outAppPath: out,
|
||||||
|
});
|
||||||
|
await ensureUniversal(out);
|
||||||
|
// Only a single asar as they were identical
|
||||||
|
expect(
|
||||||
|
(await fs.readdir(path.resolve(out, 'Contents', 'Resources'))).filter((p) =>
|
||||||
|
p.endsWith('asar'),
|
||||||
|
),
|
||||||
|
).toEqual(['app.asar']);
|
||||||
|
}, 60000);
|
||||||
|
|
||||||
|
// TODO: Add tests for
|
||||||
|
// * different asar files
|
||||||
|
// * identical app dirs
|
||||||
|
// * different app dirs
|
||||||
|
// * different app dirs with different macho files
|
||||||
|
// * identical app dirs with universal macho files
|
||||||
|
});
|
||||||
11
test/sha.spec.ts
Normal file
11
test/sha.spec.ts
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
import * as path from 'path';
|
||||||
|
|
||||||
|
import { sha } from '../src/sha';
|
||||||
|
|
||||||
|
describe('sha', () => {
|
||||||
|
it('should correctly hash a file', async () => {
|
||||||
|
expect(await sha(path.resolve(__dirname, 'fixtures', 'tohash'))).toEqual(
|
||||||
|
'12998c017066eb0d2a70b94e6ed3192985855ce390f321bbdb832022888bd251',
|
||||||
|
);
|
||||||
|
});
|
||||||
|
});
|
||||||
4
tsconfig.cjs.json
Normal file
4
tsconfig.cjs.json
Normal file
@@ -0,0 +1,4 @@
|
|||||||
|
{
|
||||||
|
"extends": "./tsconfig.json",
|
||||||
|
"include": ["src"]
|
||||||
|
}
|
||||||
10
tsconfig.entry-asar.json
Normal file
10
tsconfig.entry-asar.json
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
{
|
||||||
|
"extends": "./tsconfig.json",
|
||||||
|
"compilerOptions": {
|
||||||
|
"outDir": "entry-asar",
|
||||||
|
},
|
||||||
|
"include": [
|
||||||
|
"entry-asar"
|
||||||
|
],
|
||||||
|
"exclude": []
|
||||||
|
}
|
||||||
@@ -3,5 +3,6 @@
|
|||||||
"compilerOptions": {
|
"compilerOptions": {
|
||||||
"module": "esnext",
|
"module": "esnext",
|
||||||
"outDir": "dist/esm"
|
"outDir": "dist/esm"
|
||||||
}
|
},
|
||||||
|
"include": ["src"]
|
||||||
}
|
}
|
||||||
11
tsconfig.jest.json
Normal file
11
tsconfig.jest.json
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
{
|
||||||
|
"extends": "./tsconfig.json",
|
||||||
|
"compilerOptions": {
|
||||||
|
"module": "esnext",
|
||||||
|
"outDir": "dist/esm",
|
||||||
|
"types": [
|
||||||
|
"jest"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"include": ["src"]
|
||||||
|
}
|
||||||
@@ -13,9 +13,11 @@
|
|||||||
],
|
],
|
||||||
"allowSyntheticDefaultImports": true,
|
"allowSyntheticDefaultImports": true,
|
||||||
"moduleResolution": "node",
|
"moduleResolution": "node",
|
||||||
|
"esModuleInterop": true,
|
||||||
"declaration": true
|
"declaration": true
|
||||||
},
|
},
|
||||||
"include": [
|
"include": [
|
||||||
"src"
|
"src",
|
||||||
|
"entry-asar"
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
|
|||||||
Reference in New Issue
Block a user