XWiki Platform
  1. XWiki Platform
  2. XWIKI-11504

Extension Manager / Distribution wizard should create a downloadable file with all the decisions taken/changes made during the execution

    Details

    • Tests:
      Unit
    • Development Priority:
      High
    • Difficulty:
      Hard
    • Similar issues:

      Description

      While running an upgrade with distribution wizard / extension manager, there can be questions asked to the user about conflicts on documents where user has to make decisions.
      As well, the distribution wizard will propose to delete useless documents and also will modify some documents on its own.

      All these changes on the pages of the wiki should be presented to the user in the form of a structured file that they could download at the end of the execution, in order to keep track of what happened and also reproduce the same decisions on another wiki or compare it.

        Issue Links

          Activity

          Hide
          Marius Dumitru Florea added a comment -

          I'm implementing an extension history that should support the following use cases:

          • (UC1) Replay extensions actions from one wiki to another
            • Perform some actions from the Extension Manager's administration (e.g. install, uninstall, upgrade, downgrade)
              • Answer the questions (merge conflicts, delete pages, etc.)
            • Go to the "Extension History" section
            • Select some of the history records
            • Click on Export and download the XML file
            • On a different wiki (from the same or a different XWiki instance) go the the "Extension History" administration section
            • Expand the list of history sources
            • Import the XML file
            • Select some of the history records from that file
            • Click on Replay
            • Fill in the replay options
            • Confirm the replay
            • View the replay progress log
              • The questions for which there is a provided answer will be handled automatically
            • Done. The extension actions from one wiki have been replayed in another wiki
          Show
          Marius Dumitru Florea added a comment - I'm implementing an extension history that should support the following use cases: (UC1) Replay extensions actions from one wiki to another Perform some actions from the Extension Manager's administration (e.g. install, uninstall, upgrade, downgrade) Answer the questions (merge conflicts, delete pages, etc.) Go to the "Extension History" section Select some of the history records Click on Export and download the XML file On a different wiki (from the same or a different XWiki instance) go the the "Extension History" administration section Expand the list of history sources Import the XML file Select some of the history records from that file Click on Replay Fill in the replay options Confirm the replay View the replay progress log The questions for which there is a provided answer will be handled automatically Done. The extension actions from one wiki have been replayed in another wiki
          Hide
          Anca Luca added a comment -

          In the history screens, shouldn't we also have an information about the namespace on which the history element was executed? So that when we go on main wiki, we are able to select stuff for a subwiki or for the main wiki? Or how will that be handled? The history will only show the current namespace?

          Show
          Anca Luca added a comment - In the history screens, shouldn't we also have an information about the namespace on which the history element was executed? So that when we go on main wiki, we are able to select stuff for a subwiki or for the main wiki? Or how will that be handled? The history will only show the current namespace?
          Hide
          Marius Dumitru Florea added a comment -

          The namespaces were a history record was executed is displayed if

          • the action was performed globally (root namespace)
          • the action was performed on multiple namespaces (e.g. multiple wikis)
          • the action was performed on a single namespace, different than the current one (e.g. a different wiki)

          So the namepace is not displayed if the action was performed on the current namepace (wiki).

          The "local history" shows at the moment only records from the current wiki (because it's called "local"). But if you upload a history file with records that have been executed on a different wiki, you'll see that wiki displayed after each record.

          Show
          Marius Dumitru Florea added a comment - The namespaces were a history record was executed is displayed if the action was performed globally (root namespace) the action was performed on multiple namespaces (e.g. multiple wikis) the action was performed on a single namespace, different than the current one (e.g. a different wiki) So the namepace is not displayed if the action was performed on the current namepace (wiki). The "local history" shows at the moment only records from the current wiki (because it's called "local"). But if you upload a history file with records that have been executed on a different wiki, you'll see that wiki displayed after each record.
          Hide
          Marius Dumitru Florea added a comment - - edited

          Remaining work after 7.1RC1:

          • Auto scroll the replay log while the replay is in progress so that the user sees the last log entries. It's not a big issue because the replay log is collapsed by default.
          • Add a "Back to Extension History" link on the "Replay Status" view. Currently you have to select again the Extension History administration section in order to go back.
          • Mark XWiki.ExtensionHistoryUploads as hidden when the first history file is uploaded.
          • Generate valid XML when the history records are exported (i.e. wrap the records in <list>) to prevent a Tika error when a history file is indexed by Solr. The history file is now an XML fragment.
          • (XWIKI-12164) Move the Extension History code to a template that can be accessed with an empty database. Moreover, when upgrading the wiki, we need to be able to use the Extension History because the default UI is upgraded/installed (thus the Extension History must be provided by the war and not by the default UI).
          Show
          Marius Dumitru Florea added a comment - - edited Remaining work after 7.1RC1: Auto scroll the replay log while the replay is in progress so that the user sees the last log entries. It's not a big issue because the replay log is collapsed by default. Add a "Back to Extension History" link on the "Replay Status" view. Currently you have to select again the Extension History administration section in order to go back. Mark XWiki.ExtensionHistoryUploads as hidden when the first history file is uploaded. Generate valid XML when the history records are exported (i.e. wrap the records in <list>) to prevent a Tika error when a history file is indexed by Solr. The history file is now an XML fragment. ( XWIKI-12164 ) Move the Extension History code to a template that can be accessed with an empty database. Moreover, when upgrading the wiki, we need to be able to use the Extension History because the default UI is upgraded/installed (thus the Extension History must be provided by the war and not by the default UI).

            People

            • Assignee:
              Marius Dumitru Florea
              Reporter:
              Anca Luca
            • Votes:
              3 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:
                Date of First Response: