mirrors/TiddlyWiki5
1
0
Fork 0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2025-01-07 16:00:28 +00:00
Code Issues Releases Wiki Activity

Expose the connection status in the UI

Browse Source
This commit is contained in:
Jeremy Ruston 2024-03-25 17:07:36 +00:00
parent b58cfe6324
commit d1bb7159b8
2 changed files with 25 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
plugins/tiddlywiki/multiwikiclient/multiwikiclientadaptor.js
View File

@ -15,12 +15,13 @@ A sync adaptor module for synchronising with MultiWikiServer-compatible servers
var CONFIG_HOST_TIDDLER = "$:/config/multiwikiclient/host", var CONFIG_HOST_TIDDLER = "$:/config/multiwikiclient/host",
DEFAULT_HOST_TIDDLER = "$protocol$//$host$/", DEFAULT_HOST_TIDDLER = "$protocol$//$host$/",
BAG_STATE_TIDDLER = "$:/state/multiwikiclient/tiddlers/bag", BAG_STATE_TIDDLER = "$:/state/multiwikiclient/tiddlers/bag",
REVISION_STATE_TIDDLER = "$:/state/multiwikiclient/tiddlers/revision"; REVISION_STATE_TIDDLER = "$:/state/multiwikiclient/tiddlers/revision",
CONNECTION_STATE_TIDDLER = "$:/state/multiwikiclient/connection";
var SERVER_NOT_CONNECTED = 0, var SERVER_NOT_CONNECTED = "NOT CONNECTED",
SERVER_CONNECTING_SSE = 1, SERVER_CONNECTING_SSE = "CONNECTING SSE",
SERVER_CONNECTED_SSE = 2, SERVER_CONNECTED_SSE = "CONNECTED SSE",
SERVER_POLLING = 3; SERVER_POLLING = "SERVER POLLING";
function MultiWikiClientAdaptor(options) { function MultiWikiClientAdaptor(options) {
this.wiki = options.wiki; this.wiki = options.wiki;
@ -31,9 +32,17 @@ function MultiWikiClientAdaptor(options) {
this.isLoggedIn = false; this.isLoggedIn = false;
this.isReadOnly = false; this.isReadOnly = false;
this.logoutIsAvailable = true; this.logoutIsAvailable = true;
this.serverUpdatesConnection = SERVER_NOT_CONNECTED; this.setUpdateConnectionStatus(SERVER_NOT_CONNECTED);
} }
MultiWikiClientAdaptor.prototype.setUpdateConnectionStatus = function(status) {
this.serverUpdateConnectionStatus = status;
this.wiki.addTiddler({
title: CONNECTION_STATE_TIDDLER,
text: status
});
};
MultiWikiClientAdaptor.prototype.name = "multiwikiclient"; MultiWikiClientAdaptor.prototype.name = "multiwikiclient";
MultiWikiClientAdaptor.prototype.supportsLazyLoading = true; MultiWikiClientAdaptor.prototype.supportsLazyLoading = true;
@ -115,29 +124,29 @@ Get details of changed tiddlers from the server
MultiWikiClientAdaptor.prototype.getUpdatedTiddlers = function(syncer,callback) { MultiWikiClientAdaptor.prototype.getUpdatedTiddlers = function(syncer,callback) {
var self = this; var self = this;
// Do nothing if there's already a connection in progress. // Do nothing if there's already a connection in progress.
if(this.serverUpdatesConnection !== SERVER_NOT_CONNECTED) { if(this.serverUpdateConnectionStatus !== SERVER_NOT_CONNECTED) {
return callback(null,{ return callback(null,{
modifications: [], modifications: [],
deletions: [] deletions: []
}); });
} }
// Try to connect a server stream // Try to connect a server stream
this.serverUpdatesConnection = SERVER_CONNECTING_SSE; this.setUpdateConnectionStatus(SERVER_CONNECTING_SSE);
this.connectServerStream({ this.connectServerStream({
syncer: syncer, syncer: syncer,
onerror: function(err) { onerror: function(err) {
self.logger.log("Error connecting SSE stream",err); self.logger.log("Error connecting SSE stream",err);
// If the stream didn't work, try polling // If the stream didn't work, try polling
self.serverUpdatesConnection = SERVER_POLLING; self.setUpdateConnectionStatus(SERVER_POLLING);
self.pollServer({ self.pollServer({
callback: function(err,changes) { callback: function(err,changes) {
self.serverUpdatesConnection = SERVER_NOT_CONNECTED; self.setUpdateConnectionStatus(SERVER_NOT_CONNECTED);
callback(null,changes); callback(null,changes);
} }
}); });
}, },
onopen: function() { onopen: function() {
self.serverUpdatesConnection = SERVER_CONNECTED_SSE; self.setUpdateConnectionStatus(SERVER_CONNECTED_SSE);
// The syncer is expecting a callback but we don't have any data to send // The syncer is expecting a callback but we don't have any data to send
callback(null,{ callback(null,{
modifications: [], modifications: [],

5
plugins/tiddlywiki/multiwikiclient/sidebarsegment.tid Normal file
View File

@ -0,0 +1,5 @@
title: $:/plugins/multiwikiclient/SideBarSegment
tags: $:/tags/SideBarSegment
list-before: $:/core/ui/SideBarSegments/page-controls
MWS Connection Status: {{$:/state/multiwikiclient/connection}}