Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion addons/wiki/static/wikiPage.js
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ var defaultOptions = {
menuVisible: true,
canEdit: true,
viewVersion: 'current',
compareVersion: 'previous',
compareVersion: 'current',
urls: {
content: '',
draft: '',
Expand Down
59 changes: 42 additions & 17 deletions addons/wiki/static/wikiPageMilkdown.js
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,18 @@ const wikiId = (wikiCtx.wiki.wikiName === 'home') ? wikiCtx.node.id : window.con
const wsPrefix = (window.location.protocol === 'https:') ? 'wss://' : 'ws://';
const wsUrl = wsPrefix + window.contextVars.wiki.urls.y_websocket;

function getEditorMarkdown() {
var content = '';
if (mEdit && typeof mEdit.action === 'function') {

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

この関数は、エディタが予期しない状態であったときも、実際に空の内容であった場合も、同様に空文字列を返すため、何かトラブルが起きたときに調査しづらいコードに見えます。if (mEdit && typeof mEdit.action === 'function') { が成立しない場合に、エラーとまではしなくても、consoleにwarning等は出力できると良いかもしれません。ご検討ください。

mEdit.action((ctx) => {
const view = ctx.get(mCore.editorViewCtx);
const serializer = ctx.get(mCore.serializerCtx);
content = serializer(view.state.doc);
});
}
return content;
}

import { underlineSchema, underlineInputRule, remarkUnderlineToMarkdown, remarkUnderlineFromMarkdown, toggleUnderlineCommand } from './underline.js';
import { colortextSchema, colortextInputRule, remarkColortextToMarkdown, remarkColortextFromMarkdown, toggleColortextCommand } from './colortext.js';
import { extendedImageSchemaPlugin, extendedInsertImageCommand, extendedUpdateImageCommand, updatedInsertImageInputRule } from './image.js';
Expand Down Expand Up @@ -131,13 +143,7 @@ async function createMEditor(editor, vm, template) {
uploader,
enableHtmlFileUploader,
}));
const debouncedMarkdownUpdated = $osf.debounce(async (ctx, markdown, prevMarkdown) => {
const compareWidgetElement = document.getElementById("compareWidget");

if (compareWidgetElement && compareWidgetElement.style.display !== 'none') {
vm.viewVM.displaySource(markdown);
}

const debouncedUndoButtonUpdate = $osf.debounce(async (ctx) => {
const view = ctx.get(mCore.editorViewCtx);
const state = view.state;
const undoElement = document.getElementById("undoWiki");
Expand All @@ -148,7 +154,10 @@ async function createMEditor(editor, vm, template) {
}
}, 300);
ctx.get(mListener.listenerCtx).markdownUpdated((ctx, markdown, prevMarkdown) => {
debouncedMarkdownUpdated(ctx, markdown, prevMarkdown);
// Keep the live editor body in displaySource even while Compare is
// closed, so opening Compare after edits diffs against the edits.
vm.viewVM.displaySource(markdown);
debouncedUndoButtonUpdate(ctx);
});
ctx.update(mCore.editorViewOptionsCtx, (prev) => ({
...prev,
Expand Down Expand Up @@ -334,7 +343,7 @@ var defaultOptions = {
menuVisible: true,
canEdit: true,
viewVersion: 'current',
compareVersion: 'previous',
compareVersion: 'current',
urls: {
content: '',
draft: '',
Expand All @@ -343,6 +352,27 @@ var defaultOptions = {
metadata: {}
};

// Normalize compare target to a dropdown option value.
// Default / empty -> current (edit vs latest saved). Explicit previous -> prior version number.
function resolveCompareVersion(compareVersion) {
if (!compareVersion) {
return 'current';
}
if (compareVersion !== 'previous') {
return String(compareVersion);
}
var select = document.getElementById('compareVersionSelect');

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

previous を指定しても、対応する選択肢を取得できなかった場合は、黙って current に切り替わる点が気になりました。過去版が存在しない場合の扱いと、DOMを取得できない等の想定外の状態を区別し、後者はwarning等で確認できるとよいかもしれません。ご検討ください。

if (select) {
for (var i = 0; i < select.options.length; i++) {
var val = select.options[i].value;
if (val && val !== 'current') {
return val;
}
}
}
return 'current';
}

function ViewModel(options){
var self = this;
// enabled?
Expand Down Expand Up @@ -372,7 +402,7 @@ function ViewModel(options){
self.status = ko.observable('connecting');
self.throttledStatus = ko.observable(self.status());

self.compareVersion = ko.observable(options.compareVersion);
self.compareVersion = ko.observable(resolveCompareVersion(options.compareVersion));
self.viewVersion = ko.observable(options.viewVersion);
self.draftURL = options.urls.draft;
self.contentURL = options.urls.content;
Expand Down Expand Up @@ -545,13 +575,8 @@ function ViewModel(options){
if (panel === 'compare') {
if(display && self.compareVis()){
self.viewVersion('preview');
var toMarkdown = '';
mEdit.action((ctx) => {
const view = ctx.get(mCore.editorViewCtx);
const serializer = ctx.get(mCore.serializerCtx);
toMarkdown = serializer(view.state.doc);
});
self.viewVM.displaySource(toMarkdown);
// Always use the live editor body as the "after" side of the diff.
self.viewVM.displaySource(getEditorMarkdown());
}
}

Expand Down
20 changes: 20 additions & 0 deletions addons/wiki/tests/test_wiki.py
Original file line number Diff line number Diff line change
Expand Up @@ -295,6 +295,26 @@ def test_project_wiki_compare_scope(self):
res = self.app.get(url, auth=self.user.auth, expect_errors=True)
assert_equal(res.status_code, 400)

def test_project_wiki_compare_defaults_to_current(self):
# Bare ?compare and omitted compare both default to editing vs latest saved.
for url in (
self.project.web_url_for('project_wiki_view', wname='home') + '?compare',
self.project.web_url_for('project_wiki_view', wname='home'),
):
res = self.app.get(url, auth=self.user.auth)
assert_equal(res.status_code, 200)
assert_in('"compare": "current"', res.text)
assert_not_in('"compare": "previous"', res.text)

def test_project_wiki_compare_previous_maps_to_version_number(self):
# home has versions 1 and 2; compare=1 collapses to 'previous' in
# format_wiki_version, then views remaps it to the dropdown option value.
url = self.project.web_url_for('project_wiki_view', wname='home', compare=1)
res = self.app.get(url, auth=self.user.auth)
assert_equal(res.status_code, 200)
assert_in('"compare": 1', res.text)
assert_not_in('"compare": "previous"', res.text)

def test_wiki_page_creation_strips_whitespace(self):
# Regression test for:
# https://github.com/CenterForOpenScience/openscienceframework.org/issues/1080
Expand Down
12 changes: 10 additions & 2 deletions addons/wiki/views.py
Original file line number Diff line number Diff line change
Expand Up @@ -340,11 +340,19 @@ def project_wiki_view(auth, wname, path=None, **kwargs):
raise HTTPError(http_status.HTTP_403_FORBIDDEN)
sharejs_uuid = None

# Default versions for view and compare
# Default versions for view and compare.
# Default compare to current so editing vs latest saved matches the dropdown.
version_settings = {
'view': view or 'current',
'compare': compare or 'previous',
'compare': compare or 'current',
}
# format_wiki_version may collapse the prior version number to 'previous'.
# Map that back to the dropdown option value.
if version_settings['compare'] == 'previous':
if len(versions) > 1:
version_settings['compare'] = versions[1]['version']
else:
version_settings['compare'] = 'current'
import_dirs = _get_import_folder(node)
alive_task_id = WikiImportTask.objects.values_list('task_id').filter(status=WikiImportTask.STATUS_RUNNING, node=node)
sortable_pages_ctn = node.wikis.filter(deleted__isnull=True).exclude(page_name='home').count()
Expand Down
3 changes: 2 additions & 1 deletion website/static/js/pages/wiki-edit-page.js
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,8 @@ var comparable = (ctx.panelsUsed.indexOf('compare') !== -1);
var menuVisible = (ctx.panelsUsed.indexOf('menu') !== -1);

var viewVersion = ctx.versionSettings.view || (editable ? 'preview' : 'current');
var compareVersion = ctx.versionSettings.compare || 'previous';
// Default Current = editing body vs latest saved. Explicit previous is remapped server-side.
var compareVersion = ctx.versionSettings.compare || 'current';

var wikiPageOptions = {
editVisible: editable,
Expand Down
Loading