Uploaded image for project: 'Nuxeo Platform'
  1. Nuxeo Platform
  2. NXP-29050

Allow proper hiding of runtime distribution from API

    XMLWordPrintable

    Details

    • Type: Improvement
    • Status: Resolved
    • Priority: Critical
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: explorer-20.0.0
    • Component/s: Explorer
    • Epic Link:
    • Impact type:
      API change
    • Upgrade notes:
      Hide

      User changes: even when not in site mode, only administrators can now see the live distribution (see also NXP-29219).
      When no distribution key is provided, a 404 page is returned instead of showing current live distribution.

      Removed Configuration:

      • nuxeo.conf property "org.nuxeo.apidoc.hide.current.distribution" included in existing "org.nuxeo.site.mode" property

      Removed API:

      • SnapshotManagerComponent#RUNTIME (moved to interface SnapshotManager#DISTRIBUTION_ALIAS_CURRENT)
      • SnapshotManagerComponent#ADM (moved to interface SnapshotManager#DISTRIBUTION_ALIAS_ADM)
      • Distribution#getRuntimeDistributionName (unused)

      Changed API:

      • stop defaulting to current live distribution when given key is null or empty, in UI logics as well as SnapshotManager#getSnapshot
      • renamed Distribution#showCurrentDistribution into Distribution#showRuntimeSnapshot
      Show
      User changes: even when not in site mode, only administrators can now see the live distribution (see also NXP-29219 ). When no distribution key is provided, a 404 page is returned instead of showing current live distribution. Removed Configuration: nuxeo.conf property "org.nuxeo.apidoc.hide.current.distribution" included in existing "org.nuxeo.site.mode" property Removed API: SnapshotManagerComponent#RUNTIME (moved to interface SnapshotManager#DISTRIBUTION_ALIAS_CURRENT) SnapshotManagerComponent#ADM (moved to interface SnapshotManager#DISTRIBUTION_ALIAS_ADM) Distribution#getRuntimeDistributionName (unused) Changed API: stop defaulting to current live distribution when given key is null or empty, in UI logics as well as SnapshotManager#getSnapshot renamed Distribution#showCurrentDistribution into Distribution#showRuntimeSnapshot
    • Team:
      AT
    • Sprint:
      nxAT 11.1.17, nxAT 11.1.18, nxAT 11.1.19, nxAT 11.1.20
    • Story Points:
      2

      Description

      The nuxeo.conf property "org.nuxeo.apidoc.hide.current.distribution" is currently checked only for display in the UI.

      This should also have an effect on all API showing the live distrib.

      Also commit at https://github.com/nuxeo/nuxeo/commit/77634a1aa8bd4d348a5505fd376f1cdb836c1c82#diff-144ea7d86861e98df9c9cca568a9234fL555, done for NXP-28839, introduced a regression on this property check in the UI.

      While we're at it, with documentation removal, it seems the "site mode" does not do much on top of hiding the current distribution: it also allows to hide the "upload your distribution" button on the main distribution page (on top of hiding the "/nuxeo/site/distribution/_admin" page that holds the same import form).
      It is also checked to hide the Seam components listing on the production instance.

      --> make this easier to manage by using only the "org.nuxeo.apidoc.site.mode" property, and by checking usual Nuxeo permissions on the distributions parent folder to hide or show the upload form and admin page.

      + add ftests on site mode...

        Attachments

          Issue Links

          depends on

          Improvement - An improvement or enhancement to an existing feature or task. NXP-28839 Reorganize explorer packages, make service pluggable

          • Major - Major loss of function.
          • Resolved

          Improvement - An improvement or enhancement to an existing feature or task. NXP-29219 Rework Explorer security model

          • Major - Major loss of function.
          • Resolved
          is related to

          Improvement - An improvement or enhancement to an existing feature or task. NXP-29299 Make JX build archive html files on ftest failure

          • Minor - Minor loss of function, or other problem where easy workaround is present.
          • Resolved
          is required by

          New Feature - A new feature of the product, which has yet to be developed. NXP-28838 Provide pluggable export of the runtime exploration

          • Critical - Crashes, loss of data, severe memory leak.
          • Resolved
          Is referenced in

          [Captain Hook] PR for master: #44 PR for master: #44

          [Captain Hook] PR for master: #68 PR for master: #68

          [Captain Hook] PR for master: #4133 PR for master: #4133

          [Captain Hook] PR for master: #4179 PR for master: #4179

            Activity

              People

              • Votes:
                0 Vote for this issue
                Watchers:
                2 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved:

                  Time Tracking

                  Estimated:
                  Original Estimate - Not Specified
                  Not Specified
                  Remaining:
                  Remaining Estimate - 0 minutes
                  0m
                  Logged:
                  Time Spent - 1 week, 4 hours, 30 minutes
                  1w 4h 30m