Emit an event after items are manually sorted 💯

[infomiho]

This PR tries to address this discussion #10888

The idea is to add a new action called sort_update which can be an extension point for e.g. clearing cache on external CDN.

I've tested this locally with a test collection and it works as expected.

module.exports = function registerHook({ action }, { logger }) {
	action('test.items.sort_updated', () => {
		logger.info('test.items.sort_updated');
	});

	action('items.sort_updated', () => {
		logger.info('items.sort_updated');
	});
};

[rijkvanzanten]

Thanks @infomiho!

@benhaynes Thoughts on the event name? sort_update is the only one so far with two words. It could just be sort? 🤔

[benhaynes]

Thoughts on the event name? sort_update is the only one so far with two words. It could just be sort? 🤔

Yeah, sort makes sense, because (AFAICT) there would never be any other sort operations (eg: Delete, Create). If you agree with that, then let's stay consistent with the single word. 👍

[infomiho]

Makes sense, I'll update it today to be only sort 👍

[nickrum]

I'm wondering if we should rather emit items.update events for the items affected by the sort order change, as manually sorting items simply causes the sort fields to update 🤔

[rijkvanzanten]

@nickrum Hmm that's an interesting one. Technically speaking, the sort operation functions differently from a regular update, so there is a case to be made to treat it as a separate event as well 🤔

[benhaynes]

I worry about repurposing items.update` if that will save revisions for every sort change. Maybe good to decouple these? 🤔

[infomiho]

One extra argument for decoupling items.update and items.sort. To me those two events feel semantically different:

• sort is more "collection level" hook
  • "hey collection sort was updated",
• and update is more "single items" level hook
  • "hey these items got updated".

[rijkvanzanten]

One extra argument for decoupling items.update and items.sort. To me those two events feel semantically different:

• sort is more "collection level" hook

  • "hey collection sort was updated",

• and update is more "single items" level hook

  • "hey these items got updated".

Agreed, I see it the same way. That being said, what Nicola said is also true: Doing the "collection sort was updated" in practice means that the sort field of the individual items was updated 🤔

@benhaynes this is unrelated to revisions or revisions tracking, so that doesn't matter 👍🏻