Skip to content

A fully open source & end-to-end encrypted note taking alternative to Evernote.

desktop: enable asar

Abdullah Attae1b46d33f49d
diff --git a/apps/desktop/__tests__/utils.ts b/apps/desktop/__tests__/utils.ts
index b4ecaf155..bdc17d38a 100644
--- a/apps/desktop/__tests__/utils.ts
+++ b/apps/desktop/__tests__/utils.ts
@@ -18,7 +18,7 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
import { execSync } from "child_process";
-import { cp, readFile, writeFile } from "fs/promises";
+import { cp } from "fs/promises";
import { fileURLToPath } from "node:url";
import path, { join, resolve } from "path";
import { _electron as electron } from "playwright";
@@ -59,7 +59,8 @@ export async function buildAndLaunchApp(
});
const { app, page, configPath, userDataDir } = await launchApp(
executablePath,
- productName
+ productName,
+ options?.version
);
const ctx: AppContext = {
app,
@@ -70,7 +71,8 @@ export async function buildAndLaunchApp(
relaunch: async () => {
const { app, page, configPath, userDataDir } = await launchApp(
executablePath,
- productName
+ productName,
+ options?.version
);
ctx.app = app;
ctx.page = page;
@@ -81,7 +83,11 @@ export async function buildAndLaunchApp(
return ctx;
}
-async function launchApp(executablePath: string, packageName: string) {
+async function launchApp(
+ executablePath: string,
+ packageName: string,
+ version?: string
+) {
const userDataDir = resolve(
__dirname,
"..",
@@ -99,7 +105,12 @@ async function launchApp(executablePath: string, packageName: string) {
APPIMAGE: "true"
}
: (process.env as Record<string, string>)),
- CUSTOM_USER_DATA_DIR: userDataDir
+ CUSTOM_USER_DATA_DIR: userDataDir,
+ ...(version
+ ? {
+ CUSTOM_APP_VERSION: version
+ }
+ : {})
}
});
@@ -147,33 +158,18 @@ export async function buildApp(version?: string) {
}
}
-async function copyBuild({
- version,
- outputDir
-}: {
- version?: string;
- outputDir: string;
-}) {
+async function copyBuild({ outputDir }: { outputDir: string }) {
return process.platform === "win32"
- ? await makeBuildCopyWindows(outputDir, productName, version)
+ ? await makeBuildCopyWindows(outputDir, productName)
: process.platform === "darwin"
- ? await makeBuildCopyMacOS(outputDir, productName, version)
- : await makeBuildCopyLinux(outputDir, productName, version);
+ ? await makeBuildCopyMacOS(outputDir, productName)
+ : await makeBuildCopyLinux(outputDir, productName);
}
-async function makeBuildCopyLinux(
- outputDir: string,
- productName: string,
- version?: string
-) {
+async function makeBuildCopyLinux(outputDir: string, productName: string) {
const platformDir =
process.arch === "arm64" ? "linux-arm64-unpacked" : "linux-unpacked";
- const appDir = await makeBuildCopy(
- outputDir,
- platformDir,
- "resources",
- version
- );
+ const appDir = await makeBuildCopy(outputDir, platformDir);
return resolve(
__dirname,
"..",
@@ -182,34 +178,16 @@ async function makeBuildCopyLinux(
);
}
-async function makeBuildCopyWindows(
- outputDir: string,
- productName: string,
- version?: string
-) {
+async function makeBuildCopyWindows(outputDir: string, productName: string) {
const platformDir =
process.arch === "arm64" ? "win-arm64-unpacked" : "win-unpacked";
- const appDir = await makeBuildCopy(
- outputDir,
- platformDir,
- "resources",
- version
- );
+ const appDir = await makeBuildCopy(outputDir, platformDir);
return resolve(__dirname, "..", appDir, `${productName}.exe`);
}
-async function makeBuildCopyMacOS(
- outputDir: string,
- productName: string,
- version?: string
-) {
+async function makeBuildCopyMacOS(outputDir: string, productName: string) {
const platformDir = process.arch === "arm64" ? "mac-arm64" : "mac";
- const appDir = await makeBuildCopy(
- outputDir,
- platformDir,
- join(`${productName}.app`, "Contents", "Resources"),
- version
- );
+ const appDir = await makeBuildCopy(outputDir, platformDir);
return resolve(
__dirname,
"..",
@@ -221,12 +199,7 @@ async function makeBuildCopyMacOS(
);
}
-async function makeBuildCopy(
- outputDir: string,
- platformDir: string,
- resourcesDir: string,
- version?: string
-) {
+async function makeBuildCopy(outputDir: string, platformDir: string) {
const appDir = outputDir;
await cp(join(SOURCE_DIR, platformDir), outputDir, {
recursive: true,
@@ -236,14 +209,6 @@ async function makeBuildCopy(
force: true
});
- const packageJsonPath = join(appDir, resourcesDir, "app", "package.json");
-
- const packageJson = JSON.parse(await readFile(packageJsonPath, "utf-8"));
- if (version) {
- packageJson.version = version;
- await writeFile(packageJsonPath, JSON.stringify(packageJson, null, 2));
- }
-
return appDir;
}
diff --git a/apps/desktop/electron-builder.config.js b/apps/desktop/electron-builder.config.js
index 04b3b3ceb..e633a4e1c 100644
--- a/apps/desktop/electron-builder.config.js
+++ b/apps/desktop/electron-builder.config.js
@@ -47,7 +47,11 @@ module.exports = {
copyright: `Copyright © ${year} Streetwriters (Private) Limited`,
artifactName: "notesnook_${os}_${arch}.${ext}",
generateUpdatesFilesForAllChannels: true,
- asar: false,
+ asar: true,
+ asarUnpack: [
+ "node_modules/sqlite-better-trigram-@(linux|darwin|windows)-${arch}/**/*",
+ "node_modules/sqlite3-fts5-html-@(linux|darwin|windows)-${arch}/**/*"
+ ],
files: [
"!*.chunk.js.map",
"!*.chunk.js.LICENSE.txt",
diff --git a/apps/desktop/scripts/build.mjs b/apps/desktop/scripts/build.mjs
index 205d0e137..870641870 100644
--- a/apps/desktop/scripts/build.mjs
+++ b/apps/desktop/scripts/build.mjs
@@ -51,7 +51,7 @@ console.log("removed build folder");
if (args.rebuild || !existsSync(path.join(webAppPath, "build"))) {
console.log("rebuilding...");
await exec(
- "npx nx build:desktop @notesnook/web",
+ "node scripts/execute.mjs @notesnook/web:build:desktop",
path.join(__dirname, "..", "..", "..")
);
}
diff --git a/apps/desktop/src/api/sqlite-kysely.ts b/apps/desktop/src/api/sqlite-kysely.ts
index 1b7af2105..7a6269e5f 100644
--- a/apps/desktop/src/api/sqlite-kysely.ts
+++ b/apps/desktop/src/api/sqlite-kysely.ts
@@ -123,15 +123,21 @@ export class SQLite {
// fts5 API, we must wait decrypt the database before we can load
// the extensions.
if (!this.extensionsLoaded && (await this.isDatabaseReady())) {
- const betterTrigram = require("sqlite-better-trigram");
- const fts5Html = require("sqlite3-fts5-html");
- betterTrigram.load(this.sqlite);
- fts5Html.load(this.sqlite);
- this.extensionsLoaded = true;
+ this.loadExtensions();
}
}
}
+ private loadExtensions() {
+ this.sqlite?.loadExtension(
+ getExtensionPath("sqlite-better-trigram", "better-trigram")
+ );
+ this.sqlite?.loadExtension(
+ getExtensionPath("sqlite3-fts5-html", "fts5-html")
+ );
+ this.extensionsLoaded = true;
+ }
+
async run<R>(
sql: string,
parameters?: SQLiteCompatibleType[]
@@ -175,3 +181,34 @@ export class SQLite {
}
}
}
+
+function getExtensionPath(extensionName: string, entryPoint: string) {
+ const path = require("path");
+ const { statSync } = require("fs");
+
+ const os = process.platform === "win32" ? "windows" : process.platform;
+ const packageName = `${extensionName}-${os}-${process.arch}`;
+ const extensionSuffix =
+ process.platform === "win32"
+ ? "dll"
+ : process.platform === "darwin"
+ ? "dylib"
+ : "so";
+ let loadablePath = path.join(
+ __dirname,
+ "..",
+ "node_modules",
+ packageName,
+ `${entryPoint}.${extensionSuffix}`
+ );
+
+ if (loadablePath.includes(".asar"))
+ loadablePath = loadablePath
+ .replace("electron.asar", "app.asar")
+ .replace(".asar", ".asar.unpacked");
+
+ if (!statSync(loadablePath, { throwIfNoEntry: false })) {
+ throw new Error(`${extensionName} not found at ${loadablePath}.`);
+ }
+ return loadablePath;
+}
diff --git a/apps/desktop/src/overrides.ts b/apps/desktop/src/overrides.ts
index 721dbfb43..6ed9b66dc 100644
--- a/apps/desktop/src/overrides.ts
+++ b/apps/desktop/src/overrides.ts
@@ -19,6 +19,12 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
import { app } from "electron";
import path from "path";
+const customVersion = process.env.CUSTOM_APP_VERSION;
+if (customVersion) {
+ app.getVersion = () => customVersion;
+ console.log("setting custom version:", customVersion);
+}
+
if (process.env.CUSTOM_USER_DATA_DIR) {
app.setPath(
"appData",