feat: DSAPP-106 CMS Plugin for User Guide Link

[wesleyboar]

Overview

Add plugin to render User Guide link on CMS app overview page.

Status

Warning

• Prevent false positives.

Related

• DSAPP-106

Changes

• added CMS plugin and its model and admin form
• added function to derive app from URL path
• added function to know whether context is editing Text

Testing & UI

1. Create/Find an App Listing Entry with an href value.
   ^{E.g. Ground-Motion Portal app. Scroll to "CMS Display Options:".}

   

2. Create/Open page at a path that matches one of an App Listing Entry.
   ^{E.g. /use-designsafe/tools-applications/hazard-apps/ground-motion-portal/.}

   

3. On page, add "User Guide Link" plugin; do not choose app.

4. Verify link is rendered that opens page at correct path for User Guide.
   ^{E.g. /user-guide/tools/hazard/#scec.}

   3-4.mov

   ✅ Link opens correct page. Video did not capture it.

5. Change page path to one that does not match an app.

6. Verify:

   • link is not rendered
   • text "User guide not found." is rendered
   • server does not crash
   5-6.mov

   ✅ App can not be guessed at wrong path, so no button.

7. Change "User Guide Link" plugin; choose app.

8. Verify button URL is for the app chosen.

   7-8.mov

   ✅ Link opens correct page. Video did not capture it.

Notes

The new function get_instance_from_url could be used by existing plugins, RelatedApps and AppVariants, so that their models, AppVariantsPlugin and RelatedAppsPlugin, need not be used.

[rstijerina]

Are you able to find by the href here, i.e. AppListingEntry.objects.get(href=url)?

[wesleyboar]

I think not reliably.

Using exact match would require:

• data entry be exact (include trailing slash)
• user be on page with URL that does not have hash nor query params

Details

The url passed is context.get("request").path, which can include:

• trailing slashes (e.g. /use-designsafe/…/adcirc/)
• query parameters (e.g. ?tab=overview, ?edit, ?toolbar_off)
• hash (e.g. #specific-element)

[rstijerina]

Could you parse the url to conform to just the path?

[wesleyboar]

Yes, like this?

    from urllib.parse import __
    path = ... # logic via `urllib` taht gets path from url
    app_listing_entries = AppListingEntry.objects.get(href=path)

And —

        help_texts = {
            "href": (
                "Use absolute path. Include trailing slash."
            ),
        }

— yeah?

[rstijerina]

Yeah exactly 👍

[wesleyboar]

Okay.

@wesleyboar, prevent false positives e.g. what/ considered a match of whatever/, i/am/good/ considered a match of i/am/good--test/ — solution.