Skip to content

Commit

Permalink
Refine backupData
Browse files Browse the repository at this point in the history
  • Loading branch information
@OKendigelyan
OKendigelyan committed Dec 17, 2024
1 parent c64e2cf commit 3969823
Show file tree
Hide file tree
Showing 4 changed files with 86 additions and 87 deletions.
102 changes: 60 additions & 42 deletions apps/desktop/public/electron.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,10 @@ const fs = require("fs");

const APP_PROTOCOL = "app";
const APP_HOST = "assets";
// create in memory store of the leveldb database of previous version which had file:// protocol

// backupData is used to store the backup data from the previous version of the app
let backupData;

const appURL = app.isPackaged
? url.format({
pathname: `${APP_HOST}/index.html`,
Expand All @@ -35,17 +36,20 @@ protocol.registerSchemesAsPrivileged([
// Configure electron-log
log.transports.file.file = path.join(app.getPath("userData"), "Local Storage", "umami-desktop.log");

async function readAndCopyValues() {
// Path to the LevelDB database
async function createBackupFromPrevDB() {
const dbPath = path.join(app.getPath("userData"), "Local Storage", "leveldb");
const backupPath = path.join(app.getPath("userData"), "Local Storage", "backup_leveldb.json");

if (fs.existsSync(backupPath)) {
console.log("Backup file already exists. Skipping migration.");
return;
}

// Check if the LevelDB database exists
if (!fs.existsSync(dbPath)) {
log.info("LevelDB database not found at path. Code:EM01", dbPath);
return;
}

// Open the LevelDB database
const db = new Level(dbPath);
await db.open();

Expand All @@ -54,62 +58,77 @@ async function readAndCopyValues() {

// Function to clean up the string (removing non-printable chars)
function cleanString(str) {
// Remove non-printable characters like \x00 and \x01
str = str.replace(/[\x00\x01\x17\x10\x0f]/g, ""); // Removing some common control chars
str = str.replace(/[\x00\x01\x17\x10\x0f]/g, "");

// Optionally, you could try Base64 decoding here if you're suspecting such encoding
// Example: if(str.includes("base64")) { str = Buffer.from(str, 'base64').toString(); }
return str;
}

// Function to check if a string is valid JSON
function isValidJSON(str) {
try {
JSON.parse(str);
return true;
} catch (e) {
return false;
const KEYS_TO_MIGRATE = ["_file://\x00\x01persist:accounts", "_file://\x00\x01persist:root"];
const ROOT_KEYS_TO_MIGRATE = [
"batches",
"beacon",
"networks",
"contacts",
"errors",
"protocolSettings",
"_persist",
];

const extractKeys = json => {
const regexp = /"([^"]+)":("[^"\\]*(?:\\.[^"\\]*)*"|{[^}]+})/g;

const result = {};
const matches = json.matchAll(regexp);

for (const [_, key, value] of matches) {
if (ROOT_KEYS_TO_MIGRATE.includes(key)) {
try {
// Try to parse the value if it's a valid JSON
result[key] = JSON.parse(value);
} catch {
// If parsing fails, store as raw string
result[key] = value.replace(/^"|"$/g, "");
}
}
}
}

for await (const [key, value] of db.iterator()) {
if (
!key.includes("_file://\x00\x01persist:accounts") ||
!key.includes("_file://\x00\x01persist:root")
) {
continue;
}
return result;
};

// Clean the value string before storing
let cleanedValue = cleanString(value);
for await (const [_key, value] of db.iterator()) {
if (KEYS_TO_MIGRATE.includes(_key)) {
let cleanedValue = cleanString(value);

const key = _key.includes("_file://\x00\x01persist:root")
? "persist:root"
: "persist:accounts";

// Try parsing the cleaned string as JSON
if (isValidJSON(cleanedValue)) {
try {
storage[key.includes("accounts") ? "persist:accounts" : "persist:root"] =
JSON.parse(cleanedValue);
} catch (error) {
console.error(`Error parsing JSON for key: ${key}, value: ${cleanedValue}`);
storage[key] = cleanedValue; // Store as raw value if JSON parsing fails
storage[key] = JSON.parse(cleanedValue);
} catch (_) {
// Store as raw value if JSON parsing fails
storage[key] = cleanedValue;
}
} else {
// If not valid JSON, store the raw cleaned string
storage[key] = cleanedValue;
}
}

const preparedStorage = {
...storage,
"persist:root": extractKeys(storage["persist:root"]),
};

backupData = preparedStorage;

// Write storage object to JSON file
const backupPath = path.join(app.getPath("userData"), "Local Storage", "backup_leveldb.json");
try {
fs.writeFileSync(backupPath, JSON.stringify(storage, null, 2), "utf-8");
fs.writeFileSync(backupPath, JSON.stringify(preparedStorage, null, 2), "utf-8");
log.info("Backup successfully created at:", backupPath);
} catch (err) {
log.error("Error during LevelDB backup creation. Code:EM2.", err);
}
} catch (err) {
log.error("Error during key migration. Code:EM4.", err);
} finally {
// Close the database
db.close().catch(err => {
log.error("Error closing the database. Code:EM5", err);
});
Expand Down Expand Up @@ -264,7 +283,6 @@ function start() {
app.quit();
return;
}
let waitForMigration = true;

// Check for app updates, download and notify UI if update is available to be installed.
try {
Expand Down Expand Up @@ -320,8 +338,8 @@ function start() {
// is ready to create the browser windows.
// Some APIs can only be used after this event occurs.
app.whenReady().then(async () => {
// Execute readAndCopyValues at the beginning
await readAndCopyValues();
// Execute createBackupFromPrevDB at the beginning
await createBackupFromPrevDB();
createWindow();
});

Expand Down
9 changes: 9 additions & 0 deletions packages/state/src/global.d.ts
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
export {};

declare global {
interface Window {
electronAPI?: {
onBackupData: (fn: (event: any, data?: Record<string, string>) => void) => void;
};
}
}
14 changes: 0 additions & 14 deletions packages/state/src/migrations.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,6 @@ import { fromPairs, identity } from "lodash";

import { announcementInitialState as announcementsInitialState } from "./slices/announcement";

function handleBackupData(callback: (data: any) => void) {
// @ts-ignore
// window.electronAPI.triggerBackupData();
// @ts-ignore
localStorage.setItem("test", "true");
// @ts-ignore
window.electronAPI.onBackupData(backupData => {
console.log(backupData);
localStorage.setItem("backup-received", "true");
localStorage.setItem("backupData", backupData);
callback(backupData);
});
}

export const VERSION = 9;

export const mainStoreMigrations = {
Expand Down
48 changes: 17 additions & 31 deletions packages/state/src/reducer.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,32 +41,23 @@ const getTestStorage = () => {
export const processMigrationData = (backupData: any) => {
try {
const processedData: { accounts: any; root: any } = {
accounts: null,
root: null,
accounts: {},
root: {},
};

console.log(backupData, "backupData");
if (backupData["persist:accounts"]) {
const accounts = backupData["persist:accounts"];

if (backupData["persist:accounts"]?.accountsValue) {
const accountsValue = backupData["persist:accounts"].accountsValue.slice(1);
processedData.accounts = JSON.parse(accountsValue);

for (const item in processedData.accounts) {
processedData.accounts[item] = JSON.parse(processedData.accounts[item]);
for (const item in accounts) {
processedData.accounts[item] = JSON.parse(accounts[item]);
}
}

if (backupData["persist:root"]?.rootValue) {
const sanitizedRootValue = backupData["persist:root"].rootValue.replaceAll(
// eslint-disable-next-line no-control-regex
/[\u0000-\u001F\u007F-\u009F]/g,
""
);

processedData.root = JSON.parse(sanitizedRootValue);
if (backupData["persist:root"]) {
const root = backupData["persist:root"];

for (const item in processedData.root) {
processedData.root[item] = JSON.parse(processedData.root[item]);
for (const item in root) {
processedData.root[item] = JSON.parse(root[item]);
}
}

Expand All @@ -80,29 +71,24 @@ export const processMigrationData = (backupData: any) => {
export const makeReducer = (storage_: Storage | undefined) => {
const storage = storage_ || getTestStorage() || createWebStorage("local");

// Custom getStoredState function to handle migration
// Custom getStoredState function to handle migration from desktop v2.3.3 to v2.3.4
const customGetStoredState = async (config: PersistConfig<any>): Promise<PersistedState> => {
try {
// First try to get state from current storage
const state = (await getStoredState(config)) as PersistedState;
console.log(state, "state");

if (state) {
return state;
}

// If no state, check if we have backup data
// @ts-ignore
// If no state, check if we have backup data and migrate it to the new state
if (window.electronAPI) {
return new Promise(resolve => {
// @ts-ignore
window.electronAPI.onBackupData((_, data) => {
window.electronAPI?.onBackupData((_, data) => {
if (data) {
const processed = processMigrationData(data);
console.log(processed, "processed");

if (processed) {
// Return the processed state based on config key
// @ts-ignore
return resolve(config.key === "root" ? processed.root : processed.accounts);
return resolve(processed[config.key as keyof typeof processed]);
}
}
resolve(undefined);
Expand All @@ -111,7 +97,7 @@ export const makeReducer = (storage_: Storage | undefined) => {
}
} catch (err) {
console.error("Error getting stored state:", err);
return undefined;
return;
}
};

Expand Down

0 comments on commit 3969823

Please sign in to comment.