NIFI-8899 - Add NiFi Registry version information to the Registry under an "about" button. #5743

ohnoitsyou · 2022-02-03T22:49:16Z

Add a new endpoint to the registry API that serves up the project version.
Add a new "about" button to the Registry layout that shows a dialog with
version information.
Closes #NIFI-8899

For all changes:

Is there a JIRA ticket associated with this PR? Is it referenced
in the commit message?
Does your PR title start with NIFI-XXXX where XXXX is the JIRA number you are trying to resolve? Pay particular attention to the hyphen "-" character.
Has your PR been rebased against the latest commit within the target branch (typically main)?
Is your initial contribution a single, squashed commit? Additional commits in response to PR reviewer feedback should be made on this branch and pushed to allow change tracking. Do not squash or use --force when pushing to allow for clean monitoring of changes.

For code changes:

Have you ensured that the full suite of tests is executed via mvn -Pcontrib-check clean install at the root nifi folder?
Have you written or updated unit tests to verify your changes?
No similar bits of code have tests
Have you verified that the full build is successful on JDK 8?
Have you verified that the full build is successful on JDK 11?
If adding new dependencies to the code, are these dependencies licensed in a way that is compatible for inclusion under ASF 2.0?
If applicable, have you updated the LICENSE file, including the main LICENSE file under nifi-assembly?
If applicable, have you updated the NOTICE file, including the main NOTICE file found under nifi-assembly?
If adding new Properties, have you added .displayName in addition to .name (programmatic access) for each of the new properties?

For documentation related changes:

Have you ensured that format looks appropriate for the output in which it is rendered?

.../nifi-registry-core/nifi-registry-resources/src/main/resources/conf/nifi-registry.properties

ohnoitsyou · 2022-02-10T21:38:50Z

I think this is all ready to go. I've had it successfully build all three flows on my fork.

bbende · 2022-02-14T18:01:13Z

...re/nifi-registry-web-api/src/main/java/org/apache/nifi/registry/web/api/VersionResource.java

+            response = RegistryVersion.class
+    )
+    public Response getVersion() {
+        final String implVersion = NiFiRegistryApiApplication.class.getPackage().getImplementationVersion();


What version is actually being returned here?

We would need the Maven version like 1.16.0-SNAPSHOT. Was expecting that Maven would have to filter the version into some file that registry core can read from.

It ultimately returns the project.version from the nifi-registry-web-api pom

I tried it that was initially, with the filtering, but Mark (up above) recommended against that as it allowed it to be modified at runtime

bbende · 2022-02-14T18:03:41Z

...re/nifi-registry-web-api/src/main/java/org/apache/nifi/registry/web/api/VersionResource.java

+        description = "Retrieves the version information for this NiFi Registry.",
+        authorizations = { @Authorization("Authorization") }
+)
+public class VersionResource extends ApplicationResource {


What do you think about calling this AboutResource? and the object being returned could be AboutInfo (or something)?

My thought was the using the word "version" could be a little confusing since registry is all about version control, but this doesn't have anything to do with that aspect.

I'm open to this. Thinking about it, makes perfect sense.

I've updated these classes, let me know what you think

nifi-registry/nifi-registry-core/nifi-registry-web-ui/src/main/package.json

markobean · 2022-02-15T15:48:16Z

I installed Registry to see how the UI reports the version. This is a good start. I'd like to recommend the UI dialog mimic the "About" dialog for Apache NiFi for a consistent look across related applications. For example, "About NiFi Registry" placed on a colored background, inclusion of NiFi Registry logo, and a short description of Registry. Perhaps the description can be that of the Registry website: "Registry—a subproject of Apache NiFi—is a complementary application that provides a central location for storage and management of shared resources across one or more instances of NiFi and/or MiNiFi."

ohnoitsyou · 2022-02-21T20:14:43Z

@markobean I've created the new about page, take a look and let me know what you think

markobean · 2022-02-25T15:19:26Z

@ohnoitsyou - UI dialog looks better. Thanks for the improvement.
I tested the UI out, and it reports the correct version. Hope we can get this into 1.16.0 release.
+1

mtien-apache

Thanks for the updates! Works well and overall looks good. Just a few minor fixes and it should be good to go.

...istry-web-ui/src/main/webapp/components/explorer/dialogs/about/nf-registry-explorer-about.ts

nifi-registry/nifi-registry-core/nifi-registry-web-ui/src/main/webapp/nf-registry.html

...istry-web-ui/src/main/webapp/components/explorer/dialogs/about/nf-registry-explorer-about.ts

ohnoitsyou · 2022-03-01T18:22:15Z

Thanks for the updates! Works well and overall looks good. Just a few minor fixes and it should be good to go.

@mtien-apache
I've addressed these and pushed the changes.
If you or someone else could trigger the new build actions that would be appreciated.

mtien-apache · 2022-03-04T21:09:59Z

@ohnoitsyou Thanks for the updates! Unfortunately I found a few other things.

When I click on the info icon, the circle is off-center from the icon. It should look more like the wrench settings icon when clicked.
In the dialog, the different states of the Close button style looks different than other buttons in the app. NiFi Registry follows the NiFi Flow Design System (FDS) for all of its style conventions. Specifically it has a FdsDialogService component you can leverage. An example of a similar button can be seen in the New Bucket dialog's Cancel button.

Button state when it's clicked on:
The info icon vertical alignment looks off from the question mark and wrench icons.

…er an "about" button. Add a new endpoint to the registry API that serves up the project version. Add a new "about" button to the Registry layout that shows a dialog with version information.

Change from pulling the version information from the POM itself, set by having maven filter the properties file at build time, to getting it from the `NiFiRegistryApiApplication` class's `getImplementationVersion` method.

Left in an extra import

Rebased on top of main, merged new dependencies Updated and locking Sass to 1.49.7

Updated typescript to something more modern. (latest)

Changed plain 'Version' to be more explicit about whose version: Registry Changed the url endpoint from 'version' to 'about' to make it more clear it's not a versioned resource but information about the registry itself

API changes are now reflected in the UI Bring the look-and-feel more inline with the Nifi about page. It's not perfect, but it looks much better than before. Update the build-and-run script for the registry to not actually run the registry if the build didn't complete

Removed unused import Fixed param name in javadoc Fixed spacing in HTML

Changed close button to use raised accent styling Moved dialog showing into nf-registry.api.js Changed click call to show dialog using the api method Showing the dialog now makes the api call before rendering.

ohnoitsyou · 2022-03-11T19:06:48Z

@mtien-apache : I think I've captured what you are looking for. If you could take a look when you get a chance and let me know. I'd love to have this included in the 1.16 release if possible.

mtien-apache

@ohnoitsyou Thanks for addressing my previous comments! Most of it looks good now. However, I've made several suggestions that I think would provide better functionality. Specifically, the showAboutDialog is not being called now. Pls see my comments below.

...try-web-ui/src/main/webapp/components/explorer/dialogs/about/nf-registry-explorer-about.html

nifi-registry/nifi-registry-core/nifi-registry-web-ui/src/main/webapp/nf-registry.js

nifi-registry/nifi-registry-core/nifi-registry-web-ui/src/main/webapp/nf-registry.html

...registry/nifi-registry-core/nifi-registry-web-ui/src/main/webapp/services/nf-registry.api.js

nifi-registry/nifi-registry-core/nifi-registry-web-ui/src/main/webapp/nf-registry.js

ohnoitsyou · 2022-03-11T20:12:09Z

I had a bad feeling I forgot to address some things. Thanks for catching this. I'll work on it post haste

Changed close button to use raised primary style Changed click call to use nf-regisry.js to call the api method Removed the extra call to show the dialog. Removed some comments and outdated references

mtien-apache

@ohnoitsyou +1 Looks good! Thanks for all the fixes and useful addition!

…er an "about" button. (apache#5743) * NIFI-8899 - Add NiFi Registry version information to the Registry under an "about" button. Add a new endpoint to the registry API that serves up the project version. Add a new "about" button to the Registry layout that shows a dialog with version information. * NIFI-8899 - Change where the version information is retrieved from Change from pulling the version information from the POM itself, set by having maven filter the properties file at build time, to getting it from the `NiFiRegistryApiApplication` class's `getImplementationVersion` method. * NIFI-8899 - Remove unused dependency Left in an extra import * NIFI-8899 - Rebase and update npm dependencies Rebased on top of main, merged new dependencies Updated and locking Sass to 1.49.7 * NIFI-8899 - Update typescript Updated typescript to something more modern. (latest) * NIFI-8899 - Change Version to RegistryVersion Changed plain 'Version' to be more explicit about whose version: Registry Changed the url endpoint from 'version' to 'about' to make it more clear it's not a versioned resource but information about the registry itself * NIFI-8899 - Reflect new API in UI, look-and-feel, build-and-run script API changes are now reflected in the UI Bring the look-and-feel more inline with the Nifi about page. It's not perfect, but it looks much better than before. Update the build-and-run script for the registry to not actually run the registry if the build didn't complete * NIFI-8899 - Fix spacing, documentation Removed unused import Fixed param name in javadoc Fixed spacing in HTML * NIFI-8899 - Change to dialogService, fix styling Changed close button to use raised accent styling Moved dialog showing into nf-registry.api.js Changed click call to show dialog using the api method Showing the dialog now makes the api call before rendering. * NIFI-8899 - Fixed styling, refactored the about dialog codepath Changed close button to use raised primary style Changed click call to use nf-regisry.js to call the api method Removed the extra call to show the dialog. Removed some comments and outdated references Merged apache#5743 into main.

markobean reviewed Feb 7, 2022

View reviewed changes

.../nifi-registry-core/nifi-registry-resources/src/main/resources/conf/nifi-registry.properties Outdated Show resolved Hide resolved

ohnoitsyou force-pushed the NIFI-8899 branch 2 times, most recently from 0abb2ce to 53ec8e2 Compare February 10, 2022 17:34

bbende reviewed Feb 14, 2022

View reviewed changes

mtien-apache reviewed Feb 14, 2022

View reviewed changes

nifi-registry/nifi-registry-core/nifi-registry-web-ui/src/main/package.json Outdated Show resolved Hide resolved

ohnoitsyou force-pushed the NIFI-8899 branch 2 times, most recently from 41928c2 to 199e664 Compare February 17, 2022 20:03

mtien-apache reviewed Feb 25, 2022

View reviewed changes

ohnoitsyou added 9 commits March 11, 2022 16:23

NIFI-8899 - Add NiFi Registry version information to the Registry und…

f38aa23

…er an "about" button. Add a new endpoint to the registry API that serves up the project version. Add a new "about" button to the Registry layout that shows a dialog with version information.

NIFI-8899 - Remove unused dependency

7c334f6

Left in an extra import

NIFI-8899 - Rebase and update npm dependencies

1ff64cf

Rebased on top of main, merged new dependencies Updated and locking Sass to 1.49.7

NIFI-8899 - Update typescript

096d424

Updated typescript to something more modern. (latest)

NIFI-8899 - Change Version to RegistryVersion

154fff5

Changed plain 'Version' to be more explicit about whose version: Registry Changed the url endpoint from 'version' to 'about' to make it more clear it's not a versioned resource but information about the registry itself

NIFI-8899 - Fix spacing, documentation

9f06252

Removed unused import Fixed param name in javadoc Fixed spacing in HTML

NIFI-8899 - Change to dialogService, fix styling

dca8e8c

Changed close button to use raised accent styling Moved dialog showing into nf-registry.api.js Changed click call to show dialog using the api method Showing the dialog now makes the api call before rendering.

ohnoitsyou force-pushed the NIFI-8899 branch from b233dff to dca8e8c Compare March 11, 2022 16:23

mtien-apache reviewed Mar 11, 2022

View reviewed changes

NIFI-8899 - Fixed styling, refactored the about dialog codepath

88b44a0

Changed close button to use raised primary style Changed click call to use nf-regisry.js to call the api method Removed the extra call to show the dialog. Removed some comments and outdated references

mtien-apache approved these changes Mar 12, 2022

View reviewed changes

mtien-apache merged commit d424537 into apache:main Mar 12, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

NIFI-8899 - Add NiFi Registry version information to the Registry under an "about" button. #5743

NIFI-8899 - Add NiFi Registry version information to the Registry under an "about" button. #5743

ohnoitsyou commented Feb 3, 2022

ohnoitsyou commented Feb 10, 2022

bbende Feb 14, 2022

ohnoitsyou Feb 14, 2022

ohnoitsyou Feb 14, 2022

bbende Feb 14, 2022

ohnoitsyou Feb 14, 2022

ohnoitsyou Feb 21, 2022

markobean commented Feb 15, 2022

ohnoitsyou commented Feb 21, 2022

markobean commented Feb 25, 2022

mtien-apache left a comment

ohnoitsyou commented Mar 1, 2022 •

edited

mtien-apache commented Mar 4, 2022

ohnoitsyou commented Mar 11, 2022

mtien-apache left a comment

ohnoitsyou commented Mar 11, 2022

mtien-apache left a comment

NIFI-8899 - Add NiFi Registry version information to the Registry under an "about" button. #5743

NIFI-8899 - Add NiFi Registry version information to the Registry under an "about" button. #5743

Conversation

ohnoitsyou commented Feb 3, 2022

For all changes:

For code changes:

For documentation related changes:

ohnoitsyou commented Feb 10, 2022

bbende Feb 14, 2022

Choose a reason for hiding this comment

ohnoitsyou Feb 14, 2022

Choose a reason for hiding this comment

ohnoitsyou Feb 14, 2022

Choose a reason for hiding this comment

bbende Feb 14, 2022

Choose a reason for hiding this comment

ohnoitsyou Feb 14, 2022

Choose a reason for hiding this comment

ohnoitsyou Feb 21, 2022

Choose a reason for hiding this comment

markobean commented Feb 15, 2022

ohnoitsyou commented Feb 21, 2022

markobean commented Feb 25, 2022

mtien-apache left a comment

Choose a reason for hiding this comment

ohnoitsyou commented Mar 1, 2022 • edited

mtien-apache commented Mar 4, 2022

ohnoitsyou commented Mar 11, 2022

mtien-apache left a comment

Choose a reason for hiding this comment

ohnoitsyou commented Mar 11, 2022

mtien-apache left a comment

Choose a reason for hiding this comment

ohnoitsyou commented Mar 1, 2022 •

edited