Delete component that's used in a unit

[bradenmacdonald]

This is different from:

• deleting a component from within a unit (Delete component within unit #1623)
• removing a component from a unit (Remove component from unit #1622)

When a component is used in a unit, it can also be viewed independently in the library or added to other units. When a user views it "elsewhere" (e.g. in the "Components" tab of the library or in another unit) and deletes it, it will be deleted from the unit as well.

Spec

When a component is used in a unit and the author browses to view it outside of the unit (e.g. in the "Components" tab or in a different unit) and deletes it:

1. The user will see a confirmation dialog with a message like: "Warning: By deleting this component, you will also be deleting it from Unit XYZ".

   • List all units containing the component. If we're currently in a unit, the current unit doesn't have to be listed.

2. A toast shows that the component was deleted, and allows the user to undo

3. The library will show as having unpublished changes

4. The unit will show as having unpublished changes

5. The deleted component can no longer be seen in the Components tab nor in any units in the same library that used it.

6. Courses using either the component or the unit are not immediately affected because the deletion hasn't been published.

7. Then, when any of the following have happened:

   • The library is published ("publish all changes"),
   • The unit is published ("publish unit" -> affects all components in the unit),
   • Any other unit that contained the same component (if any) is published, or
   • The deletion of the component is published from the "Components" tab (this is theoretical; we have no UI for it but it could be implemented in the future)

8. ... the unit will no longer show as having unpublished changes.

9. Courses using either the component or the unit will see that an update is available, and when they sync the changes that component will disappear.

[bradenmacdonald]

@sdaitzman CC @edschema @jmakowski1123 The workflow in #1623 makes sense to me for deleting a component from a unit. The separate #1622 workflow for removing a component from a unit also makes sense.

But I believe there is a third scenario: if you find the component separately from the unit (like on the "Components" tab), and delete it there. What do you then see when you go view the unit? Could you please review this story?

If we don't want to bother with the placeholder / ghost component for now, then there are no UX changes associated with this story (everything else is covered by #1623), so it's mostly about making sure the publishing workflow on the backend matches expectations.

[jmakowski1123]

Rather than a ghost placeholder within the unit, is it easier to have a message/warning pop up when a seemingly standalone component is being deleted but it actually exists in units? "Warning: By deleting this component, you will also be deleting it from Unit XYZ". ?

[bradenmacdonald]

@jmakowski1123 Yes, that should be doable and it's definitely easier on the frontend side. I'm looking into the backend part now. I was kind of thinking the same thing so that's what I was trying to say for the point number 1 in the specs above.

I have updated it now with that wording.

[sdaitzman]

Added some potential dialogs here in Figma.

Component in 1 unit	Component in >1 unit

[bradenmacdonald]

@sdaitzman those dialogs look good from my perspective. I would maybe emphasize the second part ("By deleting this component...") a bit more though.

[sdaitzman]

Agreed. Here's an option to emphasize it more, and a variant with a shorter course reuse warning to give the library level notice more room:

The general conditional warning "if this component has been used..." is taking a lot of emphasis here, and I think it's worth only showing that one for objects that are used in a course if possible. Tracking that as #1691

[pomegranited]

@sdaitzman These shortened variant modals look great :)

Could you update the "Confirmation" part of #1623 to show the preferred wording for this modal? Then this ticket can be backend-only as designed. Thank you!

[bradenmacdonald]

I have updated the "Spec" above to remove the mention of placeholders/ghosts. Please double-check that the publishing behavior in point 7 matches your expectations.

[pomegranited]

Thanks @bradenmacdonald !

Please double-check that the publishing behavior in point 7 matches your expectations.

Yep, looks good. I hadn't considered publishing where components are used in multiple units, but your spec sounds like the simplest implementation path through that.

[bradenmacdonald]

@ChrisChV Do you know if this is working as specified, or is there more work to be done here?

[ChrisChV]

@bradenmacdonald Yes, there are some changes still to be made, we get issues confused, sorry about that.

• Is missing the new confirmation dialog.
• The sync button in units does not appear when publishing the unit with the component removed.
• There is no way to sync a component added to a course unit that has been deleted from the library. @bradenmacdonald I'm not sure if this is in scope.

CC @pomegranited