Skip to content

The Unified and Autonomous Development Platform

feat: Online code editor — request for unsaved changes protection on connection loss / page refresh (OD-2721)

Robin Shen6fe7a367814b
diff --git a/server-core/src/main/java/io/onedev/server/web/component/markdown/JavascriptTranslations.java b/server-core/src/main/java/io/onedev/server/web/component/markdown/JavascriptTranslations.java
index e11f5dabee..ef94c567e2 100644
--- a/server-core/src/main/java/io/onedev/server/web/component/markdown/JavascriptTranslations.java
+++ b/server-core/src/main/java/io/onedev/server/web/component/markdown/JavascriptTranslations.java
@@ -34,6 +34,7 @@ public class JavascriptTranslations {
map.put("commit-not-exist-or-access-denied", _T("Commit not exist or access denied"));
map.put("workspace-not-exist-or-access-denied", _T("Dev session not exist or access denied"));
map.put("enter-description-here", _T("Enter description here"));
+ map.put("discard-unsaved-change", _T("Discard unsaved change and revert to original content"));
return OneDev.getInstance(ObjectMapper.class).writeValueAsString(map);
} catch (JsonProcessingException e) {
diff --git a/server-core/src/main/java/io/onedev/server/web/component/markdown/MarkdownEditor.html b/server-core/src/main/java/io/onedev/server/web/component/markdown/MarkdownEditor.html
index 38e3745444..8b9e67daf8 100644
--- a/server-core/src/main/java/io/onedev/server/web/component/markdown/MarkdownEditor.html
+++ b/server-core/src/main/java/io/onedev/server/web/component/markdown/MarkdownEditor.html
@@ -37,7 +37,7 @@
</div>
<div class="warning alert alert-notice alert-light-warning">
<a class="close" data-dismiss="alert"><span><wicket:svg href="times" class="icon"/></span></a>
- <div class="message"><wicket:t>Below content is restored from an unsaved change. <a class="clear-unsaved-change">Clear</a> to discard</wicket:t></div>
+ <div class="message"><wicket:t>Below content is restored from an unsaved change. <a class="discard-unsaved-change">Discard</a></wicket:t></div>
</div>
<div class="emojis"></div>
<div class="help text-muted font-size-sm">
diff --git a/server-core/src/main/java/io/onedev/server/web/component/markdown/MarkdownEditor.java b/server-core/src/main/java/io/onedev/server/web/component/markdown/MarkdownEditor.java
index b913ecadda..7a85111530 100644
--- a/server-core/src/main/java/io/onedev/server/web/component/markdown/MarkdownEditor.java
+++ b/server-core/src/main/java/io/onedev/server/web/component/markdown/MarkdownEditor.java
@@ -129,7 +129,7 @@ public class MarkdownEditor extends FormComponentPanel<String> {
protected void onModelChanged() {
super.onModelChanged();
input.setModelObject(getModelObject());
- if (getAutosaveKey() != null)
+ if (getAutosaveKey() != null && !getAutosaveKey().contains(":markdown-file:"))
((BasePage) getPage()).removeAutosaveKey(getAutosaveKey());
}
diff --git a/server-core/src/main/java/io/onedev/server/web/component/markdown/markdown.js b/server-core/src/main/java/io/onedev/server/web/component/markdown/markdown.js
index af5e9b0422..1a308c8fab 100644
--- a/server-core/src/main/java/io/onedev/server/web/component/markdown/markdown.js
+++ b/server-core/src/main/java/io/onedev/server/web/component/markdown/markdown.js
@@ -81,6 +81,7 @@ onedev.server.markdown = {
var $previewLink = $head.find(".preview");
var $splitLink = $head.find(".split");
var $edit = $body.children(".edit");
+ var $warning = $head.children(".warning");
var $input = $edit.children("textarea");
var $preview = $body.children(".preview");
var $rendered = $preview.children(".markdown-rendered");
@@ -114,6 +115,17 @@ onedev.server.markdown = {
});
}
+ var discardTip = onedev.server.markdown.translations["discard-unsaved-change"];
+ if (discardTip) {
+ $warning.find(".discard-unsaved-change").each(function() {
+ $(this).attr("data-tippy-content", discardTip);
+ tippy(this, {
+ delay: [500, 0],
+ placement: "auto"
+ });
+ });
+ }
+
$editLink.click(function() {
$container.removeClass("preview-mode").removeClass("split-mode").addClass("edit-mode");
$input.focus();
@@ -177,13 +189,8 @@ onedev.server.markdown = {
var previewTimeout = 500;
$input.doneEvents("input inserted.atwho", function() {
- if (autosaveKey) {
- var content = $input.val();
- if (content.trim().length != 0)
- localStorage.setItem(autosaveKey, content);
- else
- localStorage.removeItem(autosaveKey);
- }
+ if (autosaveKey)
+ localStorage.setItem(autosaveKey, $input.val());
preview();
}, previewTimeout);
@@ -953,9 +960,9 @@ onedev.server.markdown = {
var $edit = $body.children(".edit");
var $preview = $body.children(".preview");
var $input = $edit.children("textarea");
- $warning.find(".clear-unsaved-change").click(function() {
+ $warning.find(".discard-unsaved-change").click(function() {
$warning.hide();
- $input.val("");
+ $input.val($input.data("initialValue"));
$preview.children(".markdown-rendered").html("");
localStorage.removeItem(autosaveKey);
onedev.server.form.markClean($input.closest("form"));
@@ -986,6 +993,7 @@ onedev.server.markdown = {
if (autosaveKey) {
var autosaveValue = localStorage.getItem(autosaveKey);
if (autosaveValue && $input.val() != autosaveValue) {
+ $input.data("initialValue", $input.val());
$input.val(autosaveValue);
$warning.show();
onedev.server.markdown.fireInputEvent($input);
diff --git a/server-core/src/main/java/io/onedev/server/web/page/base/base.css b/server-core/src/main/java/io/onedev/server/web/page/base/base.css
index 50f6b43982..a41a4dad4f 100644
--- a/server-core/src/main/java/io/onedev/server/web/page/base/base.css
+++ b/server-core/src/main/java/io/onedev/server/web/page/base/base.css
@@ -876,4 +876,8 @@ span.keycap {
}
.tippy-box a:hover, .tippy-box a:focus {
color: rgb(127, 196, 255) !important;
+}
+
+.warning>.close {
+ font-size: 1.3rem;
}
\ No newline at end of file
diff --git a/server-core/src/main/java/io/onedev/server/web/page/project/blob/render/renderers/markdown/MarkdownBlobEditor.java b/server-core/src/main/java/io/onedev/server/web/page/project/blob/render/renderers/markdown/MarkdownBlobEditor.java
index 0a27c46aab..b5feb04796 100644
--- a/server-core/src/main/java/io/onedev/server/web/page/project/blob/render/renderers/markdown/MarkdownBlobEditor.java
+++ b/server-core/src/main/java/io/onedev/server/web/page/project/blob/render/renderers/markdown/MarkdownBlobEditor.java
@@ -71,7 +71,12 @@ class MarkdownBlobEditor extends FormComponentPanel<byte[]> {
@Nullable
@Override
protected String getAutosaveKey() {
- return "project:" + getBlobRenderContext().getProject().getId() + ":markdown-file";
+ String path = context.getNewPath();
+ if (path == null)
+ path = context.getBlobIdent().path;
+ if (path == null)
+ return null;
+ return "project:" + context.getProject().getId() + ":" + path;
}
@Override
diff --git a/server-core/src/main/java/io/onedev/server/web/page/project/blob/render/source/SourceEditPanel.java b/server-core/src/main/java/io/onedev/server/web/page/project/blob/render/source/SourceEditPanel.java
index 764e8c8301..b1d650856f 100644
--- a/server-core/src/main/java/io/onedev/server/web/page/project/blob/render/source/SourceEditPanel.java
+++ b/server-core/src/main/java/io/onedev/server/web/page/project/blob/render/source/SourceEditPanel.java
@@ -45,6 +45,16 @@ public class SourceEditPanel extends BlobEditPanel implements Positionable {
protected SourceFormatPanel getSourceFormat() {
return sourceFormat;
}
+
+ @Override
+ protected String getAutosaveKey() {
+ String path = context.getNewPath();
+ if (path == null)
+ path = context.getBlobIdent().path;
+ if (path == null)
+ return null;
+ return "project:" + context.getProject().getId() + ":" + path;
+ }
};
}
diff --git a/server-core/src/main/java/io/onedev/server/web/page/project/blob/render/source/SourceFormComponent.html b/server-core/src/main/java/io/onedev/server/web/page/project/blob/render/source/SourceFormComponent.html
index 2b3203dcee..9137c90ed5 100644
--- a/server-core/src/main/java/io/onedev/server/web/page/project/blob/render/source/SourceFormComponent.html
+++ b/server-core/src/main/java/io/onedev/server/web/page/project/blob/render/source/SourceFormComponent.html
@@ -2,9 +2,11 @@
<!-- Make it no-autofocus as we will do focus with CodeMirror. Also this is necessary to fix the issue that
file name input loses focus when add file via firefox in Linux -->
<div class="source-edit blob-submit-aware no-autofocus d-flex flex-grow-1 flex-column">
- <div class="m-3 warning alert-notice alert alert-light-warning d-shrink-0">
+ <div class="warning m-2 alert-notice alert alert-light-warning d-shrink-0">
<button class="close" data-dismiss="alert"><span><wicket:svg href="times" class="icon"/></span></button>
- <div class="message"><wicket:t>Below content is restored from an unsaved change. Clear to discard</wicket:t></div>
+ <div class="message">
+ <wicket:t>Below content is restored from an unsaved change. <a class="discard-unsaved-change">Discard</a></wicket:t>
+ </div>
</div>
<div class="code flex-grow-1 autofit overflow-hidden resize-aware"></div>
<textarea wicket:id="input" class="input d-none"></textarea>
diff --git a/server-core/src/main/java/io/onedev/server/web/page/project/blob/render/source/SourceFormComponent.java b/server-core/src/main/java/io/onedev/server/web/page/project/blob/render/source/SourceFormComponent.java
index 9a8a8e8832..983ab83bf1 100644
--- a/server-core/src/main/java/io/onedev/server/web/page/project/blob/render/source/SourceFormComponent.java
+++ b/server-core/src/main/java/io/onedev/server/web/page/project/blob/render/source/SourceFormComponent.java
@@ -1,5 +1,7 @@
package io.onedev.server.web.page.project.blob.render.source;
+import static io.onedev.server.web.translation.Translation._T;
+
import java.nio.charset.Charset;
import java.nio.charset.StandardCharsets;
@@ -79,20 +81,32 @@ abstract class SourceFormComponent extends FormComponentPanel<byte[]> {
} else {
jsonOfMark = "undefined";
}
+ String autosaveKey = getAutosaveKey();
+ String escapedAutosaveKey;
+ if (autosaveKey != null)
+ escapedAutosaveKey = "'" + JavaScriptEscape.escapeJavaScript(autosaveKey) + "'";
+ else
+ escapedAutosaveKey = "undefined";
String script = String.format("onedev.server.sourceEdit.onDomReady("
- + "'%s', '%s', %s, '%s', %s, '%s', %b);",
+ + "'%s', '%s', %s, '%s', %s, '%s', %b, %s, '%s');",
getMarkupId(),
JavaScriptEscape.escapeJavaScript(getContext().getNewPath()),
jsonOfMark,
getSourceFormat().getIndentType(),
getSourceFormat().getTabSize(),
getSourceFormat().getLineWrapMode(),
- getContext().getMode() == Mode.EDIT || getContext().getInitialNewPath() != null);
+ getContext().getMode() == Mode.EDIT || getContext().getInitialNewPath() != null,
+ escapedAutosaveKey,
+ JavaScriptEscape.escapeJavaScript(_T("Discard unsaved change and revert to original content")));
response.render(OnDomReadyHeaderItem.forScript(script));
}
protected abstract BlobRenderContext getContext();
protected abstract SourceFormatPanel getSourceFormat();
+
+ protected String getAutosaveKey() {
+ return null;
+ }
}
diff --git a/server-core/src/main/java/io/onedev/server/web/page/project/blob/render/source/source-edit.js b/server-core/src/main/java/io/onedev/server/web/page/project/blob/render/source/source-edit.js
index 8e42edaee2..dd6a1d1a4d 100644
--- a/server-core/src/main/java/io/onedev/server/web/page/project/blob/render/source/source-edit.js
+++ b/server-core/src/main/java/io/onedev/server/web/page/project/blob/render/source/source-edit.js
@@ -1,11 +1,12 @@
onedev.server.sourceEdit = {
- onDomReady: function(containerId, filePath, mark, indentType, tabSize, lineWrapMode, autoFocus) {
+ onDomReady: function(containerId, filePath, mark, indentType, tabSize, lineWrapMode, autoFocus, autosaveKey, discardUnsavedTooltip) {
var $container = $("#" + containerId);
var $sourceEdit = $container.children(".source-edit");
var $warning = $sourceEdit.children(".warning");
var $code = $sourceEdit.children(".code");
+ var initialValue = $sourceEdit.children(".input").val();
var cm = CodeMirror($code[0], {
- value: $sourceEdit.children(".input").val(),
+ value: initialValue,
autofocus: autoFocus,
theme: "eclipse",
indentWithTabs: indentType == "Tabs",
@@ -23,6 +24,9 @@ onedev.server.sourceEdit = {
highlightIdentifiers: {delay: 500}
});
+ $sourceEdit.data("autosaveKey", autosaveKey);
+ $sourceEdit.data("initialValue", initialValue);
+
onedev.server.codemirror.setModeByFileName(cm, filePath);
/*
@@ -40,8 +44,35 @@ onedev.server.sourceEdit = {
onedev.server.codemirror.bindShortcuts(cm);
+ var autosaveTimeout;
cm.on("change", function() {
$sourceEdit.closest("form").addClass("dirty");
+ if (autosaveKey) {
+ if (autosaveTimeout)
+ clearTimeout(autosaveTimeout);
+ autosaveTimeout = setTimeout(function() {
+ localStorage.setItem(autosaveKey, cm.getValue());
+ }, 500);
+ }
+ });
+
+ if (discardUnsavedTooltip) {
+ $warning.find(".discard-unsaved-change").each(function() {
+ $(this).attr("data-tippy-content", discardUnsavedTooltip);
+ tippy(this, {
+ delay: [500, 0],
+ placement: "auto"
+ });
+ });
+ }
+
+ $warning.find(".discard-unsaved-change").click(function() {
+ $warning.hide();
+ if (autosaveKey)
+ localStorage.removeItem(autosaveKey);
+ cm.setValue($sourceEdit.data("initialValue"));
+ onedev.server.form.markClean($sourceEdit.closest("form"));
+ $(window).resize();
});
$code.on("getViewState", function(e) {
@@ -69,8 +100,20 @@ onedev.server.sourceEdit = {
},
onWindowLoad: function(containerId, mark) {
var $container = $("#" + containerId);
- var $warning = $container.find(">.source-edit>.warning");
- var cm = $(".source-edit>.code>.CodeMirror")[0].CodeMirror;
+ var $sourceEdit = $container.find(">.source-edit");
+ var $warning = $sourceEdit.children(".warning");
+ var cm = $sourceEdit.find(">.code>.CodeMirror")[0].CodeMirror;
+
+ var autosaveKey = $sourceEdit.data("autosaveKey");
+ if (autosaveKey) {
+ var autosaveValue = localStorage.getItem(autosaveKey);
+ if (autosaveValue && cm.getValue() != autosaveValue) {
+ cm.setValue(autosaveValue);
+ cm.oldDocValue = autosaveValue;
+ $warning.show();
+ $sourceEdit.closest("form").addClass("dirty");
+ }
+ }
if (mark && onedev.server.viewState.getFromHistory() === undefined
&& onedev.server.viewState.carryOver === undefined) {