Skip to content

Commit

Permalink
Remove dependency on webContents.history
Browse files Browse the repository at this point in the history 
The history field of Electron's webContents module is no longer present
beyond Electron 10, so we have to stop using it in order to upgrade.

webContents.history is used to manage a subset of browsing history
within the app. My observation is that the global history (which
includes itch:// URLs) is a superset of the webContents.history, so the
theory is that we could rely entirely on the global history and
back-forward navigation would work just as well.

Closes #2598
  • Loading branch information
@aycyang
aycyang committed Jul 28, 2022
1 parent bbd0a47 commit be6c332
Showing 1 changed file with 8 additions and 219 deletions.
227 changes: 8 additions & 219 deletions src/main/reactors/web-contents.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,7 @@ const logger = mainLogger.child(__filename);

const SHOW_DEVTOOLS = parseInt(process.env.DEVTOOLS, 10) > 1;

export type ExtendedWebContents = Electron.WebContents & {
history: string[];
currentIndex: number;
pendingIndex: number;
inPageIndex: number;
};

type WebContentsCallback<T> = (wc: ExtendedWebContents) => T;
type WebContentsCallback<T> = (wc: Electron.WebContents) => T;

function withWebContents<T>(
store: Store,
Expand All @@ -36,7 +29,7 @@ function withWebContents<T>(
): T | null {
const wc = getWebContents(wind, tab);
if (wc && !wc.isDestroyed()) {
return cb(wc as ExtendedWebContents);
return cb(wc);
}
return null;
}
Expand Down Expand Up @@ -66,7 +59,7 @@ export default function (watcher: Watcher) {
storeWebContents(wind, tab, wc);

logger.debug(`Loading url '${initialURL}'`);
await hookWebContents(store, wind, tab, wc as ExtendedWebContents);
await hookWebContents(store, wind, tab, wc);
loadURL(wc, initialURL);
});

Expand Down Expand Up @@ -237,40 +230,8 @@ export default function (watcher: Watcher) {
}

withWebContents(store, wind, tab, (wc) => {
let offset = index - oldIndex;
const url = rs.winds[wind].tabInstances[tab].history[index].url;
if (
wc.canGoToOffset(offset) &&
wc.history[wc.currentIndex + offset] === url
) {
logger.debug(`\n`);
logger.debug(`~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~`);
logger.debug(
`For index ${oldIndex} => ${index}, applying offset ${offset}`
);
logger.debug(`~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n`);
wc.goToOffset(offset);
} else {
const url = Space.fromState(rs, wind, tab).url();
logger.debug(`\n`);
logger.debug(`~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~`);
logger.debug(
`For index ${oldIndex} => ${index}, clearing history and loading ${url}`
);
logger.debug(`(could go to offset? ${wc.canGoToOffset(offset)})`);
logger.debug(`(wcl = ${wc.history[wc.currentIndex + offset]})`);
logger.debug(`(url = ${url})`);

if (offset == 1) {
logger.debug(
`Wait, no, we're just going forward one, we don't need to clear history`
);
} else {
wc.clearHistory();
}
logger.debug(`~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n`);
loadURL(wc, url);
}
const url = Space.fromState(rs, wind, tab).url();
loadURL(wc, url);
});
});

Expand All @@ -281,7 +242,7 @@ export default function (watcher: Watcher) {
}

withWebContents(store, wind, tab, async (wc) => {
const webUrl = wc.history[wc.currentIndex];
const webUrl = wc.getURL();
if (webUrl !== url) {
logger.debug(
`WebContents has\n--> ${webUrl}\ntab evolved to\n--> ${url}\nlet's load`
Expand All @@ -300,7 +261,7 @@ async function hookWebContents(
store: Store,
wind: string,
tab: string,
wc: ExtendedWebContents
wc: Electron.WebContents
) {
let setLoading = (loading: boolean) => {
store.dispatch(actions.tabLoadingStateChanged({ wind, tab, loading }));
Expand Down Expand Up @@ -410,21 +371,6 @@ async function hookWebContents(
);
};

let printWebContentsHistory = (previousIndex: number) => {
if (wc.history.length === 0) {
logger.debug(`(The webcontents history are empty for some reason)`);
} else {
logger.debug("WebContents history:");
for (let i = 0; i < wc.history.length; i++) {
let prevMark = i === previousIndex ? "<" : " ";
let pendMark = i === wc.pendingIndex ? "P" : " ";
let currMark = i === wc.currentIndex ? ">" : " ";

logger.debug(`W|${prevMark}${pendMark}${currMark} ${wc.history[i]}`);
}
}
};

let printStateHistory = () => {
const space = Space.fromStore(store, wind, tab);
logger.debug(`---------------------------------`);
Expand All @@ -435,32 +381,13 @@ async function hookWebContents(
}
};

let previousState = {
previousIndex: 0,
previousHistorySize: 1,
};

const commit = (
reason: "will-navigate" | "did-navigate" | "did-navigate-in-page",
event: any,
url: string, // latest URL
inPage: boolean, // in-page navigation (HTML5 pushState/popState/replaceState)
replaceEntry: boolean // previous history entry was replaced
) => {
if (wc.currentIndex < 0) {
// We get those spurious events after a "clear history & loadURL()"
// at this point `wc.history.length` is 0 anyway, so it's not like we
// can figure out much. They're followed by a meaningful event shortly after.
logger.debug(`Ignoring commit with negative currentIndex`);
return;
}

let { previousIndex, previousHistorySize } = previousState;
previousState = {
previousIndex: wc.currentIndex,
previousHistorySize: wc.history.length,
};

const space = Space.fromStore(store, wind, tab);
const stateHistory = space.history();
const getStateURL = (index: number) => {
Expand All @@ -477,14 +404,6 @@ async function hookWebContents(
const stateIndex = space.currentIndex();
const stateURL = getStateURL(stateIndex);

logger.debug("\n");
logger.debug(`=================================`);
logger.debug(`commit ${url}, reason ${reason}`);
logger.debug(
`currentIndex ${wc.currentIndex} pendingIndex ${wc.pendingIndex} inPageIndex ${wc.inPageIndex} inPage ${inPage}`
);

printWebContentsHistory(previousIndex);
printStateHistory();

const wcTitle = wc.getTitle();
Expand All @@ -504,137 +423,7 @@ async function hookWebContents(
});
}

let offset = wc.currentIndex - previousIndex;
let sizeOffset = wc.history.length - previousHistorySize;

if (sizeOffset === 1) {
logger.debug(`History grew one, offset is ${offset}`);

if (stateURL === url) {
logger.debug(`web and state point to same URL, doing nothing`);
}

if (offset === 0) {
logger.debug(`Replacing because offset is 0`);
didNavigate(url, NavMode.Replace);
printStateHistory();
return;
}

let currentURL = space.url();
let previousWebURL = wc.history[wc.currentIndex - 1];
if (currentURL && previousWebURL !== currentURL) {
logger.debug(
`Replacing because previous web url \n${previousWebURL}\n is not current state url \n${currentURL}`
);
didNavigate(url, NavMode.Replace);
printStateHistory();
return;
}

logger.debug(`Assuming regular navigation happened`);
didNavigate(url, NavMode.Append);
printStateHistory();
return;
}

if (sizeOffset === 0) {
logger.debug(`History stayed the same size, offset is ${offset}`);
if (offset === 1) {
if (stateURL === url) {
logger.debug(`web and state point to same URL, doing nothing`);
return;
}

if (getStateURL(stateIndex + offset) === url) {
logger.debug(`If we apply the history offset, the URLs match!`);
// fallthrough to in-history navigation
} else {
logger.debug(`Assuming normal navigation happened`);
didNavigate(url, NavMode.Append);
printStateHistory();
return;
}
} else if (offset === 0) {
if (replaceEntry) {
const index = space.currentIndex();
if (inPage) {
if (getStateURL(index - 1) === url) {
logger.debug(
`replaceEntry is true, but inPage & previous is a dupe, ignoring`
);
return;
}

if (getStateURL(index + 1) === url) {
logger.debug(
`replaceEntry is true, but inPage & next is a dupe, ignoring`
);
return;
}
}

logger.debug(`Handling it like a replace`);
didNavigate(url, NavMode.Replace);
printStateHistory();
return;
} else {
const index = space.currentIndex();
let prevURL = getStateURL(index - 1);
let webURL = wc.history[wc.currentIndex];
logger.debug(`prevURL = ${prevURL}`);
logger.debug(` webURL = ${webURL}`);
if (prevURL === webURL) {
logger.debug(
`looks like a forward navigation, but previous is a dupe`
);
didNavigate(url, NavMode.Replace);
return;
} else {
logger.debug(`Not a replace, doing nothing.`);
return;
}
}
}

if (stateURL === url) {
logger.debug(`web and state point to same URL, doing nothing`);
return;
}

let oldIndex = stateIndex;
let index = oldIndex + offset;
if (getStateURL(index) === url) {
logger.debug(
`Assuming in-history navigation (${oldIndex} => ${index})`
);
store.dispatch(
actions.tabWentToIndex({
wind,
tab,
oldIndex,
index,
fromWebContents: true,
})
);
printStateHistory();
return;
} else {
logger.debug(`We're not sure what happened, doing nothing`);
return;
}
}

logger.debug(`History shrunk ; usually means normal navigation.`);

if (stateURL === url) {
logger.debug(`Except the url is already good, nvm!`);
} else {
logger.debug(`Assuming normal navigation happened`);
didNavigate(url, NavMode.Append);
printStateHistory();
}
return;
didNavigate(url, NavMode.Append);
};
wc.on("did-navigate", (event, url) => {
commit("did-navigate", event, url, false, false);
Expand Down

0 comments on commit be6c332

Please sign in to comment.