Diff for Flarum

Kylo

DursunCan yeah, just don't forget to run php flarum migrate

rob006

Are you sure you want to rollback to this revision? Edit's contents after this revision will be deleted permanently.

Wait, what? Why rollback removes history? It should be treated as new edit and add new revision to history.

Kylo

rob006 ohh, i did it while thinking from sensitive data perspective 🙈 i'll keep it in this way for now. Let's see what others think about this feature

rob006

Kylo These are separate concerns. And ability to remove edits history kinda defeats purpose of this plugin.

Another nitpicks: content columns seems to be too small. Revision uses text for content while posts have mediumtext, so revision may not be able to store the whole post. blob may be also too small for multiple revisions, even after compression.

jordanjay29

Kylo this does make sense, but destructive rollbacks might be better as an option than as default. Especially since it seems revision history can be deleted manually regardless. I agree with rob006 that removing the edit history (excepting in extreme cases like sensitive data) defeats the purpose.

Also, was it your intention to make it possible only to rollback to a revision older than the most recent?

Kylo

rob006 And ability to remove edits history kinda defeats purpose of this plugin.

I personally think it is a must. Thanks for the advice about columns, i'll change them in the next release.

jordanjay29 destructive rollbacks might be better as an option than as default

Okay, i'll see what i can do about it. I think the "rollback" is a multiple-meaning word and i just followed one of them.

jordanjay29 Also, was it your intention to make it possible only to rollback to a revision older than the most recent?

Yes, because it's not rolling back to old content but the revision itself.

Rollback to this revision

I couldn't find any examples about rolling back to revisions so it's like inventing a wheel for me.

Should it be "revert" or "rollback"? If i go with revert than the post's content should be replaced with the revision's old content. If it is rollback than it sounds more reasonable to jump between revisions (so post's content will be replaced with the revision's new content).

Kylo

rob006 okay now i need some help to decide a column type for compressed revisions. Since flarum uses MEDIUMTEXT for a post, i'm not sure if LONGBLOB will be enough to hold compressed data.

rob006

Kylo I personally think it is a must.

I'm not against removing history, but this should not be related to reverting feature. For example on Stack Overflow everyone can revert post to any revision, but this is treated as another edit. And only mods can remove/edit revision from history - user needs to ask moderator to remove sensitive data from history. In this way users have convenient tool for reverting some destructive changes, but they cannot exploit it hide their activity.

jordanjay29

rob006 That's similar to the MediaWiki (e.g. Wikipedia) approach as well, and I think that'd be familiar to most people.

Kylo jordanjay29 Also, was it your intention to make it possible only to rollback to a revision older than the most recent?

Yes, because it's not rolling back to old content but the revision itself.

Gotcha. That may cause some user confusion, for those less technical.

rob006

Kylo Should it be "revert" or "rollback"? If i go with revert than the post's content should be replaced with the revision's old content. If it is rollback than it sounds more reasonable to jump between revisions (so post's content will be replaced with the revision's new content).

I would call it rollback, since it does not revert particular edit, but uses old version of post (so it reverts all further edits). But IMO neither "revert" nor "rollback" should alter history - git revert and "rollback" from Stack Overflow work in similar way - they add new revision with changes without altering history.

Kylo

rob006 That was my intention to do so. I think there is no point to show the original post in the dropdown list because well, just look at the first revision for the original post?

rob006 And when I click it, there is no "revert" option available (it seems to be a bug).

this is the same question which @jordanjay29 asked before. See my answer Kylo

rob006

Kylo LONGBLOB can store 4GB of data - you won't be able to work with such volumes way before you hit the column size limit. Even MEDIUMBLOB may be enough - it can store over 16MB of data which should be about 300 MB of text after decompression. I didn't check how do you handle decompression, but if you store the whole decompressed text in PHP variable, 300MB may be already too much for most environments.

Kylo

rob006 i am using PHP's \gzcompress('', -1) and \gzuncompress() functions fyi.

rob006

After few tests I must say that dropdown with list of revisions is really confusing. If I create a post, and then edit it once, I have 2 revisions: original posts and version after edit. On GitHub in dropdown you have two entries, where first is labeled as "created" and displays diff between nothing and original post:

In your plugin there is only one entry:

And when I click it, there is no "revert" option available (it seems to be a bug). Since you switched from "diff approach" to "revisions approach", wouldn't be better to display revisions in similar way as GitHub? Then it should be more clear what is the target of "revert/rollback" and "delete revision" features.

rob006

Kylo That was my intention to do so. I think there is no point to show the original post in the dropdown list because well, just look at the first revision for the original post?

How can I look at first revision? In my example (post with 1 edit) there are 2 revisions, but you're displaying 1 entry. It's clear that this is not a list of revisions, but a list of diffs between revisions. And if it is a diff, it is no longer clear which revision will be used for "rollback" or "delete" action - will it be revision before or after the change?

Kylo this is the same question which @jordanjay29 asked before. See my answer Kylo

Sorry, I don't get your answer. Why I can't revert last edit and restore original content of post? It seems to be valid use case for me.

Kylo

rob006 And if it is a diff, it is no longer clear which revision will be used for "rollback" or "delete" action - will it be revision before or after the change?

That is the real question that we need to find answers.

Kylo Should it be "revert" or "rollback"? If i go with revert than the post's content should be replaced with the revision's old content. If it is rollback than it sounds more reasonable to jump between revisions (so post's content will be replaced with the revision's new content).

Kylo

rob006 Okay your points makes sense. Dropdown list should include all revisions and rollback should change one revision to another. I'll call the original post as revision 1 so when one rollbacks to revision 1, it'll revert the changes all the way to the original post then it'll be treated as new edit. Sounds good?

rob006

Kylo Yeah, sounds good.

Kylo

Next version will be tagged as stable and i'll drop it in 2-3 weeks because i have another priorities for now. Sadly, it'll delete previous revisions for the last time, because i did some modifications on the DB side among other things. I also noticed some bugs on renderers (especially with long diffs), so sorry if you encounter one of them. It's up to you to wait for the stable one. Thanks for your patience & comprehension.

Littlegolden

Can we change the box size? just like Windows Form? Right now the view box is too small... can only see a few contents...

Kylo

Littlegolden i'm planning to drop tabular view on v2 and implement a new layout like Notion's version history so it'll be looking like this:

https://www.notion.so/Version-history-eec3af1f5bc64ba0a712ee5794e12a9c

Until that, i think you can force the modal to be large with using .Modal--large class

« Previous Page Next Page »