Skip to content

Lazy serve: fix untracked tab bug on backwards navigation #1522

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

Merged
wxwxwxwx9 merged 6 commits into from
Apr 2, 2021
Merged

Lazy serve: fix untracked tab bug on backwards navigation #1522

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
1924843
Move active tab entry addition to socket establishment phase
ryoarmanda Mar 28, 2021
ec521da
Add extra guard for opened pages sync on fs events
ryoarmanda Mar 28, 2021
ab9662e
Correctly process incomplete active urls to refer to index files
ryoarmanda Mar 31, 2021
083d869
Revert "Correctly process incomplete active urls to refer to index fi…
ryoarmanda Apr 1, 2021
fd9a1a9
Address reviews
ryoarmanda Apr 1, 2021
0eccf8b
Revert "Add extra guard for opened pages sync on fs events"
ryoarmanda Apr 1, 2021
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
43 changes: 14 additions & 29 deletions packages/cli/src/lib/live-server/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
* clients list is stored internally.
*
* This patch allows us to gain access to the information that can be gathered with the client
* websockets, which in turn can enables the support for multiple-tab development.
* websockets, which in turn enables the support for multiple-tab development.
*
* Patch is written against live-server v1.2.1
* The **only** changes are prefaced with a CHANGED comment
Expand Down Expand Up @@ -88,23 +88,6 @@ function staticServer(root) {
}
}

// CHANGED: Added line to create new entry on non-include and non-live-reload requests
const reqUrl = req.originalUrl;
if (!reqUrl.endsWith('._include_.html') && !LiveServer.isLiveReloadRequest(reqUrl)) {
/*
* TODO: Find a way to handle the edge case of a tab that is immediately closed before socket
* establishment happens. Current behaviour is that the tab will remain forever in the list.
* Context: https://github.com/MarkBind/markbind/pull/1513#issuecomment-803025676
*/
const tabEntry = {
url: reqUrl,
client: undefined,
prevClient: undefined,
isReloading: false,
}
LiveServer.activeTabs.unshift(tabEntry);
}

if (injectTag === null && LiveServer.logLevel >= 3) {
console.warn("Failed to inject refresh script!".yellow,
"Couldn't find any of the tags ", injectCandidates, "from", filepath);
Expand Down Expand Up @@ -382,11 +365,18 @@ LiveServer.start = function(options) {
LiveServer.activeTabs = LiveServer.activeTabs.filter(tab => tab.client !== ws);
};

// CHANGED: Added line to record tab client socket on creation
// CHANGED: Enhanced client websocket addition process to record the client as an active tab entry
const reqUrl = path.dirname(request.url);
const tab = LiveServer.activeTabs.find(tab => tab.url === reqUrl && !tab.client);
tab.client = ws;
tab.isReloading = false;

// If an entry with empty client is present, reuse existing entry to maintain order from pre-reload
const existingTab = LiveServer.activeTabs.find(tab => tab.url === reqUrl && !tab.client);
if (existingTab) {
existingTab.client = ws;
return;
}

// Insert new entry to the active tabs list
LiveServer.activeTabs.unshift({ url: reqUrl, client: ws });
});

var ignored = [
Expand Down Expand Up @@ -416,10 +406,9 @@ LiveServer.start = function(options) {
// CHANGED: Prepare tab entry data before issuing reload
LiveServer.activeTabs.forEach(tab => {
if (tab.client) {
// Clear the client from the entry to be refilled in the socket establishment phase after reload
const client = tab.client;
tab.client = undefined;
tab.prevClient = client;
tab.isReloading = true;
client.send(cssChange ? 'refreshcss' : 'reload');
}
});
Expand Down Expand Up @@ -452,10 +441,6 @@ LiveServer.shutdown = function() {
};

// CHANGED: Added method to retrieve current active urls
LiveServer.getActiveUrls = () => LiveServer.activeTabs.filter(tab => !tab.isReloading).map(tab => tab.url);

// CHANGED: Added method to check whether a request is a product of the live reload mechanism
LiveServer.isLiveReloadRequest = (reqUrl) =>
LiveServer.activeTabs.some(tab => tab.url === reqUrl && tab.isReloading);
LiveServer.getActiveUrls = () => LiveServer.activeTabs.filter(tab => tab.client).map(tab => tab.url);

module.exports = LiveServer;