Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: update macOS asset matching #169

Merged
merged 16 commits into from
Jan 3, 2025
Merged

feat: update macOS asset matching #169

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
0476c06
fix: support latest electron builder default macOS release names
setchy Oct 7, 2024
ff43355
fix: support latest electron builder default macOS release names
setchy Oct 7, 2024
ef38952
fix: update regex to match end of line
setchy Oct 7, 2024
f22e472
fix: update regex to match end of line
setchy Oct 7, 2024
2bdcea8
fix: support latest electron builder default macOS release names
setchy Oct 7, 2024
f2fd8d8
fix: support latest electron builder default macOS release names
setchy Oct 7, 2024
c924e0d
feat: add log statement
setchy Oct 7, 2024
7ab3f84
feat: change where logic guard is for latest universal substitution
setchy Oct 8, 2024
08d4032
feat: change where logic guard is for latest universal substitution
setchy Oct 8, 2024
f08728a
feat: change where logic guard is for latest universal substitution
setchy Oct 8, 2024
8224ad2
test: add unit tests for universal upgrade
setchy Oct 8, 2024
1216fb1
test: add unit tests for universal upgrade
setchy Oct 8, 2024
b2c09c9
incorporate PR feedback on asset matching
setchy Nov 2, 2024
e313059
Merge branch 'fix/electron-builder-default-naming' of https://github.…
setchy Nov 2, 2024
cb7cc68
incorporate PR feedback on asset matching
setchy Nov 2, 2024
cd8e924
incorporate PR feedback on asset matching
setchy Nov 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 3 additions & 4 deletions src/asset-platform.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
const { PLATFORM_ARCH } = require("./constants");

const assetPlatform = (fileName) => {
if (/.*(mac|darwin|osx).*(-arm).*\.zip/i.test(fileName)) {
return PLATFORM_ARCH.DARWIN_ARM64;
}
if (/.*-(mac|darwin|osx).*\.zip$/i.test(fileName)) {
if (/-arm64/.test(fileName)) return PLATFORM_ARCH.DARWIN_ARM64;
if (/-universal/.test(fileName)) return PLATFORM_ARCH.DARWIN_UNIVERSAL;

if (/.*(mac|darwin|osx).*\.zip/i.test(fileName) && !/arm64/.test(fileName)) {
return PLATFORM_ARCH.DARWIN_X64;
}

Expand Down
1 change: 1 addition & 0 deletions src/constants.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ const PLATFORM = {
const PLATFORM_ARCH = {
DARWIN_X64: "darwin-x64",
DARWIN_ARM64: "darwin-arm64",
DARWIN_UNIVERSAL: "darwin-universal",
WIN_X64: "win32-x64",
WIN_IA32: "win32-ia32",
WIN_ARM64: "win32-arm64",
Expand Down
21 changes: 19 additions & 2 deletions src/updates.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,16 +95,33 @@ class Updates {
}

async handleUpdate(res, account, repository, platform, version) {
const latest = await this.cachedGetLatest(
let latest = await this.cachedGetLatest(
account,
repository,
platform,
version
);

if (platform.includes(PLATFORM.DARWIN)) {
const latestUniversal = await this.cachedGetLatest(
account,
repository,
PLATFORM_ARCH.DARWIN_UNIVERSAL,
version
);

if (
latestUniversal &&
semver.gt(latestUniversal.version, latest.version)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@MarshallOfSound - moved the semver check here to be part of the universal replacement logic

) {
log.info("Falling back to universal build for darwin");
latest = latestUniversal;
}
}

if (!latest) {
const message = platform.includes(PLATFORM.DARWIN)
? "No updates found (needs asset matching *(mac|darwin|osx).*(-arm).*.zip in public repository)"
? "No updates found (needs asset matching .*-(mac|darwin|osx).*.zip in public repository)"
: "No updates found (needs asset containing win32-{x64,ia32,arm64} or .exe in public repository)";
notFound(res, message);
} else if (semver.lte(latest.version, version)) {
Expand Down
28 changes: 28 additions & 0 deletions test/asset-platform.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,34 @@ test("assetPlatform() matches the right platform", (t) => {
name: "Electron.Fiddle-darwin-x64-0.27.3.zip",
platform: PLATFORM_ARCH.DARWIN_X64,
},
{
name: "Electron-Builder-1.2.3-mac.zip",
platform: PLATFORM_ARCH.DARWIN_X64,
},
{
name: "Electron-Builder-1.2.3-universal-mac.zip",
platform: PLATFORM_ARCH.DARWIN_UNIVERSAL,
},
{
name: "Electron-Builder-1.2.3-arm64-mac.zip",
platform: PLATFORM_ARCH.DARWIN_ARM64,
},
{
name: "Electron.Builder-1.2.3-mac.zip.blockmap",
platform: false,
},
{
name: "mac.zip",
platform: false,
},
{
name: "darwin.zip",
platform: false,
},
{
name: "osx.zip",
platform: false,
},
];

for (const release of releases) {
Expand Down
141 changes: 110 additions & 31 deletions test/update.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,16 @@ nock("https://api.github.com")
body: "notes",
assets: [
{
name: "mac.zip",
browser_download_url: "mac.zip",
name: "app-mac.zip",
browser_download_url: "app-mac.zip",
},
{
name: "mac-arm64.zip",
browser_download_url: "mac-arm64.zip",
name: "app-mac-arm64.zip",
browser_download_url: "app-mac-arm64.zip",
},
{
name: "app-universal-mac.zip",
browser_download_url: "app-universal-mac.zip",
},
{
name: "electron-fiddle-1.0.0-win32-x64-setup.exe",
Expand All @@ -48,12 +52,12 @@ nock("https://api.github.com")
body: "notes",
assets: [
{
name: "mac.zip",
browser_download_url: "mac.zip",
name: "app-mac.zip",
browser_download_url: "app-mac.zip",
},
{
name: "mac-arm64.zip",
browser_download_url: "mac-arm64.zip",
name: "app-mac-arm64.zip",
browser_download_url: "app-mac-arm64.zip",
},
],
},
Expand All @@ -70,12 +74,49 @@ nock("https://api.github.com")
body: "notes",
assets: [
{
name: "darwin.zip",
browser_download_url: "darwin.zip",
name: "app-darwin.zip",
browser_download_url: "app-darwin.zip",
},
{
name: "app-darwin-arm64.zip",
browser_download_url: "app-darwin-arm64.zip",
},
{
name: "darwin-arm64.zip",
browser_download_url: "darwin-arm64.zip",
name: "app-universal-mac.zip",
browser_download_url: "app-universal-mac.zip",
},
],
},
])
.get("/repos/owner/repo-universal/releases?per_page=100")
.reply(200, [
{
name: "name",
tag_name: "v2.0.0",
body: "notes",
assets: [
{
name: "app-universal-mac.zip",
browser_download_url: "app-universal-mac.zip",
},
{
name: "app-arm64-mac.zip",
browser_download_url: "app-arm64-mac.zip",
},
],
},
{
name: "name",
tag_name: "v1.0.0",
body: "notes",
assets: [
{
name: "app-mac.zip",
browser_download_url: "app-mac.zip",
},
{
name: "app-arm64-mac.zip",
browser_download_url: "app-arm64-mac.zip",
},
],
},
Expand Down Expand Up @@ -154,12 +195,12 @@ nock("https://api.github.com")
body: "notes",
assets: [
{
name: "mac.zip",
browser_download_url: "mac.zip",
name: "app-mac.zip",
browser_download_url: "app-mac.zip",
},
{
name: "mac-arm64.zip",
browser_download_url: "mac-arm64.zip",
name: "app-mac-arm64.zip",
browser_download_url: "app-mac-arm64.zip",
},
{
name: "electron-fiddle-0.36.0-win32-x64-setup.exe",
Expand All @@ -184,12 +225,12 @@ nock("https://api.github.com")
body: "notes",
assets: [
{
name: "mac.zip",
browser_download_url: "mac.zip",
name: "app-mac.zip",
browser_download_url: "app-mac.zip",
},
{
name: "mac-arm64.zip",
browser_download_url: "mac-arm64.zip",
name: "app-mac-arm64.zip",
browser_download_url: "app-mac-arm64.zip",
},
{
name: "electron-fiddle-1.0.0-win32-x64-setup.exe",
Expand Down Expand Up @@ -243,7 +284,7 @@ test("Updates", async (t) => {
const body = await res.json();
t.same(body, {
name: "name",
url: "mac.zip",
url: "app-mac.zip",
notes: "notes",
});
}
Expand Down Expand Up @@ -309,32 +350,44 @@ test("Updates", async (t) => {
let res = await fetch(`${address}/owner/repo/darwin-x64/0.0.0`);
t.equal(res.status, 200);
let body = await res.json();
t.equal(body.url, "mac.zip");
t.equal(body.url, "app-mac.zip");

res = await fetch(`${address}/owner/repo/darwin-arm64/0.0.0`);
t.equal(res.status, 200);
body = await res.json();
t.equal(body.url, "mac-arm64.zip");
t.equal(body.url, "app-mac-arm64.zip");

res = await fetch(`${address}/owner/repo/darwin/0.0.0`);
t.equal(res.status, 200);
body = await res.json();
t.equal(body.url, "mac.zip");
t.equal(body.url, "app-mac.zip");

res = await fetch(`${address}/owner/repo/darwin-universal/0.0.0`);
t.equal(res.status, 200);
body = await res.json();
t.equal(body.url, "app-universal-mac.zip");

res = await fetch(`${address}/owner/repo-darwin/darwin-x64/0.0.0`);
t.equal(res.status, 200);
body = await res.json();
t.match(body.url, "darwin.zip");
t.match(body.url, "app-darwin.zip");

res = await fetch(`${address}/owner/repo-darwin/darwin-arm64/0.0.0`);
t.equal(res.status, 200);
body = await res.json();
t.match(body.url, "darwin-arm64.zip");
t.match(body.url, "app-darwin-arm64.zip");

res = await fetch(`${address}/owner/repo-darwin/darwin/0.0.0`);
t.equal(res.status, 200);
body = await res.json();
t.match(body.url, "darwin.zip");
t.match(body.url, "app-darwin.zip");

res = await fetch(
`${address}/owner/repo-darwin/darwin-universal/0.0.0`
);
t.equal(res.status, 200);
body = await res.json();
t.match(body.url, "app-universal-mac.zip");
}
});

Expand All @@ -346,15 +399,41 @@ test("Updates", async (t) => {
let body = await res.text();
t.equal(
body,
"No updates found (needs asset matching *(mac|darwin|osx).*(-arm).*.zip in public repository)"
"No updates found (needs asset matching .*-(mac|darwin|osx).*.zip in public repository)"
);

res = await fetch(`${address}/owner/repo-win32-zip/darwin/0.0.0`);
t.equal(res.status, 404);
body = await res.text();
t.equal(
body,
"No updates found (needs asset matching *(mac|darwin|osx).*(-arm).*.zip in public repository)"
"No updates found (needs asset matching .*-(mac|darwin|osx).*.zip in public repository)"
);
});

await t.test("darwin universal assets", async (t) => {
await t.test(
"use universal asset if platform-specific asset not available",
async (t) => {
let res = await fetch(
`${address}/owner/repo-universal/darwin-x64/0.0.0`
);
t.equal(res.status, 200);
let body = await res.json();
t.match(body.url, "app-universal-mac.zip");
}
);

await t.test(
"skip universal asset if platform-specific asset available",
async (t) => {
let res = await fetch(
`${address}/owner/repo-universal/darwin-arm64/0.0.0`
);
t.equal(res.status, 200);
let body = await res.json();
t.match(body.url, "app-arm64-mac.zip");
}
);
});
});
Expand Down Expand Up @@ -491,7 +570,7 @@ test("Updates", async (t) => {
const body = await res.text();
t.equal(
body,
'Unsupported platform: "linux". Supported: darwin-x64, darwin-arm64, win32-x64, win32-ia32, win32-arm64.'
'Unsupported platform: "linux". Supported: darwin-x64, darwin-arm64, darwin-universal, win32-x64, win32-ia32, win32-arm64.'
);
});
});
Expand All @@ -503,7 +582,7 @@ test("Updates", async (t) => {
const body = await res.text();
t.equal(
body,
'Unsupported platform: "os". Supported: darwin-x64, darwin-arm64, win32-x64, win32-ia32, win32-arm64.'
'Unsupported platform: "os". Supported: darwin-x64, darwin-arm64, darwin-universal, win32-x64, win32-ia32, win32-arm64.'
);
});
});
Expand Down