Fix misleading tk-multi-publish2 "items added" message

j0yu · March 9, 2021, 1:10pm

Anyone else run into the odd standalone publisher message where there’s no tasks added but it says “items were added”?

I’ve submitted a PR for it but basically it’s just a quick 1 line fix:

shotgunsoftware/tk-multi-publish2/blob/eeb872f068115ed74d9ea3d72cff23946f71c784/python/tk_multi_publish2/dialog.py#L883


try:
    self.ui.main_stack.setCurrentIndex(self.PUBLISH_SCREEN)
    # ensure the progress details are parented here in case we get
    # stuck here.
    self._progress_handler.progress_details.set_parent(self.ui.main_frame)
    self._overlay.show_loading()
    self.ui.button_container.hide()
    new_items = self._publish_manager.collect_files(str_files)
    num_items_created = len([item for item in new_items if item.tasks])
    num_errors = self._progress_handler.pop()
    if num_errors == 0 and num_items_created == 0:
        self._progress_handler.logger.info("Nothing was added.")
    elif num_errors == 0 and num_items_created == 1:
        self._progress_handler.logger.info("One item was added.")
    elif num_errors == 0 and num_items_created > 1:
        self._progress_handler.logger.info(
            "%d items were added." % num_items_created
        )

mmoshev · March 9, 2021, 1:23pm

Sounds to me like there may have been an error thrown during collection. Check the DCC’s output/console.

j0yu · March 9, 2021, 1:43pm

It’s not necessarily to do with errors during collection, but rather, whether the PublishTask plugins actually accept the PublishItem fed in during the “acceptance phase”

Collectors pick up PublishItems, so if any are discovered, great, but otherwise, they shouldn’t care about what PublishTasks will do
Then, it is up to each PublishTask plugin to choose whether they will accept publishing that PublishItem found by the collector. They can absolutely refuse to accept a PublishItem without error if they deem it not suitable
Finally, the GUI logic will take the collected published items passed through all the publish tasks and build the publish item tree

The fix just focuses on the GUI part, where previously it was just checking if any items are collected, rather than if any tasks accepted any of the items that are collected

mmoshev · March 9, 2021, 1:53pm

I see, so this was an item that did not have any publish plugins to accept it? I agree this looks like a bug, that the log says “One item”.

j0yu · March 9, 2021, 2:14pm

Indeed! The wording “One Item” in the screenshot is correct technically when it comes debugging, but as a artist user experience, it’s misleading because there’s nothing in the items tree when the message sets the expectation for there to be something in the items tree

mmoshev · March 9, 2021, 2:18pm

Yeah, I get what you’re saying. There are a few possibilities, e.g. it might say “One item added with 0 tasks” or something along those lines.
Ultimately the Shotgun guys should decide on the proper wording.