Add Block Content revision UI

I really like this idea, but I think this has to be a feature request. Could be a cool contrib module? :)

This is certainly not in scope for 8.0.x ... views had an issue for revisions for itself since quite a while,
but this got pushed back in badcamp 2012 already.

@dawehner, can you please provide the steps to proceed with this issue so that everyone can understand better?

Block revisions in Drupal 8 do not exist as far as I can tell.

Right now, in core, you can create block content revisions only programatically see BlockContentRevisionsTest for reference.

Custom block UI after #2669802: Add a content entity form which allows to set revisions .

Create block

Edit block

This is not postpone anymore.

Yeah - kinda need a UI of some kind for this, otherwise doesn't seem much point to making blocks revisionable.

Revisionable. Is that even a word? :)

In fact it has already been nicely implemented in Entity API module, so one should simply consider merging the respective part to the core and updating the entities definitions.

(See https://gist.github.com/alex-bukach/75c13b674ea1a22bae43788d51326265 for a quick and dirty solution.)

There is 100% an issue for bringing the generic functionality from entity module into core.

@dawehner if you mean my patch, I realize that it's unacceptable to do it that way, and I made it temporary until the solution in the core appears, since it was a major issue for me not to have it working.

Otherwise, if you mean merging Entity API code to core, as the module page of Entity API states:

The Drupal 8 version of the Entity API module is used for improvements to Drupal 8's Entity API which will be moved to Drupal core one day

I believe it's the case when we should move this piece into the core.

There is #2350939: Implement a generic revision UI but it doesn't yet contain the version from entity API.

Right, I didn't see that issue. I wonder how happened that the work had been duplicated between the core and Entity API.

Well the entity API started with the core patch but then slowly improved it over time.

Created a project for adding revisions UI to Block Content making use of patches in #2350939: Implement a generic revision UI: https://www.drupal.org/project/block_content_revision_ui

Rather than integrate the UI into block content in that issue, should we do it here?

In line with similar issues for Media and other projects/initiatives, postponing this in favour of the issue referenced above in #23

I've also created "Config entity revisions", doing a similar thing for webforms. I've only come across this now because I made it generic and was planning on applying it to blocks, views and other config entities too. I'll take a look at the code in #23. Perhaps we can work together...

On further checking, it looks like blocks aren't config entities (as I had previously been led to believe), so this is a different problem.

Hi All,

Block is content entity, it not a config entity. It has it's own fields definitions. So we need to implement the re-visioning that already implemented in the node module.

Thanks

"Custom block" aka \Drupal\block_content\Entity\BlockContent is a content entity.
That's what's being discussed here, not block plugins, not block entities (Block UI placements), not custom block types (the config entities that are equivalent to bundles for custom blocks).

Hi @tim.plunkett,

Thanks for the great explanation. I am willing to contribute in this feature. Any guidance for me? Thanks

Hi @30iyyappan.govind

We postponed this issue (and similar issues for other core modules) in favour of #2350939: Implement a generic revision UI which aims to address this for all Content Entity Types, so if you want to contribute I’d recommend doing it over on that issue.

Thanks
-Aaron

#2350939: Implement a generic revision UI is merged, unblocking this issue.

Matching the issue title at #2936995: Add taxonomy term revision UI

MR adds the UI + tests for block content adapted from tests introduced by #2350939: Implement a generic revision UI.

There are three tests from 2350939 relevant to this issue, each revision revert, delete revision, and version history. Adapted surface level of tests, but not the small details as they are still covered and don't differ from the generic tests.

Couple of fixes to existing tests required: JSON API endpoints accessible by administer permission, and needed a relation type plugin definition.

Some differences between Block Content Revision UI contrib:

• Block content doesn't have a view route. So it doesn't make sense to add a revision view route.
• Permissions have different naming, more in line with core permissions.

So initial testing

Install hook applied cleanly
Verified Revisions tab is appearing on the block_content form
Created several different revisions of the block and verified I saw all the revisions being stored
Reverted back and forth between revisions verifying they were switching correctly.
Tested the deleting of revisions and that worked too.

Great work!

I think we need an Issue Summary update and Change Record.

Created change record at https://www.drupal.org/node/3319245

Updated summary.

"Rerolled"

May be NW based on allowedIfHasPermissions change but it's used elsewhere so maybe there's a reason not to use it

I made a small change to the CR. The title of the CR is a bit cryptic and doesn't mention the UI, should it?

I opted for listing each new UI available rather than a "UI" umbrella. Feel free to rearrange the title.

Oh, I see what you mean now. Can it be "Revision history, revert, and delete forms added to Block Content"?

Revision history is not a form.

Maybe "Revision history, and revert and delete forms, added to Block Content"

How about "Block Content now provides a UI for viewing, reverting and deleting revisions"?

Seems a little cleaner to me, keeping the module name near the start is also probably a good idea.

Updated title. I'm not invested in CR details, feel free to update further as it's wiki-like.

Moving to NW for those changes.

I've addressed feedback from @larowlan in a local branch, however I'm unable to push new work to this repo due to a Gitlab bug. Requested assistance in Slack#gitlab. If there is no resolution I'll create a new MR soon enough.

Until then, new work/commits can be viewed at https://github.com/dpi/drupal/compare/10.1.x...dpi:drupal:1984588-block-...

Edit: updated and resolved less than 24 hours later. Thanks to @hestenet for stepping in.

Feedback for @larowlan pushed and is green.

Tested this out and confirmed the feedback was addressed.

Need this for 9.4.x. is there any patch available for version 9.4.x ?

Need this for 9.4.x. is there any patch available for version 9.4.x ?

@shree.yesare for 9.4, 9.5 and 10.0 you should use the Block Content Revision UI contrib module, as the work in this issue is simply implementing the work done in #2350939: Implement a generic revision UI which was only committed to 10.1.

@ #66

BlockContentAccessControlHandler seems to already prevent access for delete and revert when the entity is not reusable out of the box, under certain circumstances (dependency checks).

Created new MR:

• The same Git commit lineage as the formerly merged PR.
• Always check if non re-usable for revert/delete revision operations. Disallow even before dependency checks.
• Reworked test to allow asserting access result messages.
• Rearranged dataprovider arguments by non optional.
• Switch out access strings for class object instance checks: removes a bunch of switch lines and easier to read.

Back for review.

Retested the MR very quickly and see that block revisions are working still.

Have we thought about the IA for this in terms of the block IA reorganization, which has one issue committed already and a second issue close?
#3318110: [meta] Reorganize Block items in the administration menu.

This issue tackles tasks around individual entities, rather than collection/index routes. So I'd say we're not affected unless paths of Block Content entities themselves are changing.

• Menu's are not added/changed.
• New paths (routes) are added, inherit whatever treatment canonical receives.
• New local tasks (tasks are unrelated to IA changes?)
• No new/changed actions

Breadcrumbs for individual Block Content entities, which typically include a collection link, are being tackled in #2317981: Move block content edit and delete routes under admin/content/block to improve IA for editors and fix breadcrumbs. This is new ground so is unlikely subjected to the re-org.

Based on my understanding of what this issue does, and @dpi's explanation in #76, and the fact I'm close to what's going on in #3318110: [meta] Reorganize Block items in the administration menu, I'm happy to second @dpi's comment.

It looks likely that this issue will be done prior to #2317981: Move block content edit and delete routes under admin/content/block to improve IA for editors and fix breadcrumbs being done, if so that issue will just need to account for the new paths this issue is introducing.

Thanks @dpi and @AaronMcHale for the quick feedback!

The one thing we could do with then I think is screenshots showing the change. I think this is basically "before, there is no tab; after, there is a new tab" as in #57. Could we put screenshots of that and other parts of the new user interface in the IS? Thanks!

Added screens for the three UIs to IS + CR

Sorry another question; what is up with the fact that there are two merge requests open and which is canonical? And why does one say "merged"? Did @larowlan actually use the GitLab merge feature? Or what is that about?

One MR is marked as merged, later reverted. I don’t think I can push to merged MRs.

Moved on with a new MR with the same commits.

Here's a version of #83 for anyone who needs this on Drupal 10.0.

Note it also depends on #2350939-314: Implement a generic revision UI and #2809291-192: Add "edit block $type" permissions

Not sure if I should be posting here or not, but I have tested a few sites, and I can't actually see any option to VIEW any revision. That is, I can use the action buttons to either revert to or delete any revision listed, but I can't actually see the revision content itself. The 'view' link that is on the date listed in the node revision interface is not appearing for blocks (although the link to the user is).

@Andrew.Macpherson block content doesn't have a view route so therefore doesn't have a view revision operation either.