App Provided Non Model View -View Without an associated API #3736

timizuoebideri1 · 2023-05-11T18:56:34Z

Closes: #3712

What's Changed

Added a View Component to the 'example_plugin' plugin.
Updated the 'build_ui.py' file to retrieve all Apps routes (urlspatterns) and create a react router representation of these routes, which will then be registered in nautobot-ui.

Limitation

It is currently not able to convert nested App urls.

TODO

Explanation of Change(s)
Added change log fragment(s) (for more information see the documentation)
Attached Screenshots, Payload Example
Unit, Integration Tests
Documentation Updates (when adding/changing features)
Example Plugin Updates (when adding/changing features)
Outline Remaining Work, Constraints from Design

examples/example_plugin/example_plugin/ui/NonModelView.jsx

examples/example_plugin/example_plugin/ui/index.js

examples/example_plugin_with_view_override/example_plugin_with_view_override/ui/CustomView.jsx

nautobot/ui/src/components/Apps.js

nautobot/ui/src/utils/nav.js

nautobot/ui/src/utils/string.js

nautobot/ui/src/utils/utils.js

nautobot/ui/src/views/generic/ObjectList.js

nautobot/core/management/commands/build_ui.py

nautobot/ui/src/utils/api.js

…ithub.com/nautobot/nautobot into u/timizuoebideri1-3712-app-non-model-view

examples/example_plugin/example_plugin/ui/ModelRetrieveView.jsx

examples/example_plugin/example_plugin/ui/index.js

...les/example_plugin_with_view_override/example_plugin_with_view_override/ui/FullWidthPage.jsx

nautobot/core/management/commands/build_ui.py

Co-authored-by: Glenn Matthews <glenn.matthews@networktocode.com>

nautobot/ui/src/utils/navigation.js

nautobot/core/management/commands/build_ui.py

nautobot/ui/src/utils/app-import.js

Co-authored-by: Glenn Matthews <glenn.matthews@networktocode.com>

…ithub.com/nautobot/nautobot into u/timizuoebideri1-3712-app-non-model-view

bryanculver

I think this is almost perfect but I think we should at least seed an empty app_routes for the tests instead of a try-catch.

.github/workflows/ci_pullrequest.yml

examples/example_plugin/example_plugin/ui/index.js

Co-authored-by: Bryan Culver <31187+bryanculver@users.noreply.github.com>

bryanculver

as soon as tests pass

glennmatthews · 2023-05-26T12:45:31Z

.github/workflows/ci_pullrequest.yml

      - name: "Setup base app_imports for mock"
        working-directory: ./nautobot/ui
        run: "echo 'export const NautobotApps = {}; export default NautobotApps;' > src/app_imports.js"
+      - name: "Setup base app_routes.json for test"
+        working-directory: ./nautobot/ui
+        run: "echo '{}' > src/app_routes.json"


Are these steps that a developer needs to do before running invoke unittest-ui locally? If so let's make sure we have that well documented.

Are these steps that a user needs to do when installing Nautobot from pypi? Same concern.

@glennmatthews What if instead we added said file in the repo bit .gitignore and ignored all changes?

So:

echo "{}" > nautobot/ui/src/app_routes.json git add -f nautobot/ui/src/app_routes.json

That's probably fine, I think?

Womp womp...

Editing .gitignore will only ignore files so they will not be added to the git repository. However files that are tracked already will not be ignored.

Testing locally it still picked up future changes to the file. I'll update the PR to create the file if it doesn't exist.

https://github.com/nautobot/nautobot/pull/3736/files#diff-5c50d475237a0b724fe8d90c7862d19b2a48d8cf8f0c334b8e7d8d336db219f8R6-R9

How about this instead @glennmatthews?

I don't have a strong opinion about how we do this, just want to make sure that if it's something a developer needs to do, they are informed about it. :-)

They shouldn't have to do that anymore. Exception handling FTW!

bryanculver · 2023-05-26T19:02:41Z

nautobot/ui/src/utils/navigation.js

+let app_routes = {};
+try {
+    app_routes = require("../app_routes.json");
+} catch {}


Because JavaScript I can't do:

try { const app_routes = require("../app_routes.json"); } catch { const app_routes = {}; }

timizuoebideri1 added 5 commits May 10, 2023 20:34

Stage One: Add custom plugin route to nautobot ui route

d068938

Non Model Component Views

d61a56a

Remove example app with override

7ee6d51

non model view complete

73da06b

revert changes made to object list

fa21aea

glennmatthews requested changes May 15, 2023

View reviewed changes

bryanculver linked an issue May 15, 2023 that may be closed by this pull request

UI 2.0: App Provided Non-Model View #3712

Closed

timizuoebideri1 added 4 commits May 15, 2023 20:22

🤗

e4de781

❄️

683f11c

Pretty

5ff219b

revert changes i made to staggeredBaseQue

9994526

timizuoebideri1 requested a review from glennmatthews May 15, 2023 18:31

timizuoebideri1 commented May 16, 2023

View reviewed changes

timizuoebideri1 and others added 5 commits May 16, 2023 05:25

Apply suggestions from code review

ee6046e

update to ExamplePluginModelRetrieveView

e156deb

Merge branch 'u/timizuoebideri1-3712-app-non-model-view' of https://g…

179ca0d

…ithub.com/nautobot/nautobot into u/timizuoebideri1-3712-app-non-model-view

add change log

79bb0c2

flake8

7b36497

timizuoebideri1 marked this pull request as ready for review May 16, 2023 12:44

timizuoebideri1 added 3 commits May 16, 2023 15:23

ExampleApp

68c7c28

fix build failure

5c28682

prettier

356244b

glennmatthews mentioned this pull request May 16, 2023

Re-introduce app provided model view override #3721

Merged

7 tasks

timizuoebideri1 requested review from bryanculver, jathanism, HanlinMiao and a team May 17, 2023 10:25

bryanculver mentioned this pull request May 17, 2023

UI Session Improvements #3744

Merged

11 tasks

glennmatthews reviewed May 18, 2023

View reviewed changes

Apply suggestions from code review

230bd97

Co-authored-by: Glenn Matthews <glenn.matthews@networktocode.com>

timizuoebideri1 requested a review from glennmatthews May 19, 2023 11:13

timizuoebideri1 commented May 19, 2023

View reviewed changes

nautobot/ui/src/utils/navigation.js Outdated Show resolved Hide resolved

glennmatthews reviewed May 19, 2023

View reviewed changes

timizuoebideri1 and others added 4 commits May 19, 2023 08:21

Update nautobot/core/management/commands/build_ui.py

afad505

Co-authored-by: Glenn Matthews <glenn.matthews@networktocode.com>

resolve comment

af1f007

Merge branch 'u/timizuoebideri1-3712-app-non-model-view' of https://g…

6415c73

…ithub.com/nautobot/nautobot into u/timizuoebideri1-3712-app-non-model-view

fix git merge fragment

2b0a123

timizuoebideri1 requested a review from glennmatthews May 19, 2023 15:55

timizuoebideri1 and others added 3 commits May 19, 2023 17:57

prettier

785f480

Merge branch 'next' into u/timizuoebideri1-3712-app-non-model-view

42c40d7

fix test failure

e4a7aa3

bryanculver reviewed May 22, 2023

View reviewed changes

timizuoebideri1 and others added 3 commits May 22, 2023 19:26

Merge branch 'next' into u/timizuoebideri1-3712-app-non-model-view

03b9dba

remove try catch

b7b9062

Add workflow

9e84722

bryanculver self-requested a review May 24, 2023 15:06

bryanculver reviewed May 24, 2023

View reviewed changes

.github/workflows/ci_pullrequest.yml Outdated Show resolved Hide resolved

bryanculver reviewed May 24, 2023

View reviewed changes

examples/example_plugin/example_plugin/ui/index.js Outdated Show resolved Hide resolved

timizuoebideri1 and others added 3 commits May 24, 2023 19:30

Update .github/workflows/ci_pullrequest.yml

3cd5576

Co-authored-by: Bryan Culver <31187+bryanculver@users.noreply.github.com>

use app_name:url_name

207db71

use app base name

77e86a5

timizuoebideri1 requested a review from bryanculver May 25, 2023 06:38

bryanculver approved these changes May 25, 2023

View reviewed changes

fix black

0bc2ce6

glennmatthews approved these changes May 26, 2023

View reviewed changes

Allow exception handling for app routes missing

78a275f

bryanculver reviewed May 26, 2023

View reviewed changes

glennmatthews merged commit a47f9f6 into next May 30, 2023
19 checks passed

glennmatthews deleted the u/timizuoebideri1-3712-app-non-model-view branch May 30, 2023 12:53

bryanculver mentioned this pull request May 30, 2023

UI 2.0: App Provided Non-Model View #3712

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

App Provided Non Model View -View Without an associated API #3736

App Provided Non Model View -View Without an associated API #3736

timizuoebideri1 commented May 11, 2023 •

edited

Loading

bryanculver left a comment

bryanculver left a comment

glennmatthews May 26, 2023

bryanculver May 26, 2023

glennmatthews May 26, 2023

bryanculver May 26, 2023

bryanculver May 26, 2023

glennmatthews May 26, 2023

bryanculver May 26, 2023

bryanculver May 26, 2023

App Provided Non Model View -View Without an associated API #3736

App Provided Non Model View -View Without an associated API #3736

Conversation

timizuoebideri1 commented May 11, 2023 • edited Loading

Closes: #3712

What's Changed

Limitation

TODO

bryanculver left a comment

Choose a reason for hiding this comment

bryanculver left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

timizuoebideri1 commented May 11, 2023 •

edited

Loading