Skip to content

NIFI-14319: Create initial project structure for new NiFi Registry UI #9855

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 15 commits into
base: main
Choose a base branch
from

Conversation

sardell
Copy link
Contributor

@sardell sardell commented Apr 7, 2025

Summary

NIFI-14319

Description

This PR establishes the initial project setup for the new NiFi Registry UI and includes the new explorer view.

Testing

Build and start the old registry project with maven using the existing instructions. Next, run npm ci at nifi-frontend/src/main/frontend and start the app by running npx nx run nifi-registry:serve. Visit http://localhost:4204/nifi-registry/ to see the new explorer page. Compare the old explorer view with the new one, ensuring feature parity between the two views. Run unit tests with npx nx run nifi-registry:test.

NOTE: buckets cannot be created through the new UI yet, so in order to test the functionality of the new explorer view you must first create a bucket through the old UI.

Screenshot 2025-04-07 at 4 55 29 PM

Screenshot 2025-04-07 at 4 57 31 PM

Considerations

Styling - The old logo was created with a much darker background color in mind. It may be time for a refreshed logo, but for now I simply added the old one to the header along with a heading containing the application's name.

Tracking

Please complete the following tracking steps prior to pull request creation.

Issue Tracking

Pull Request Tracking

  • Pull Request title starts with Apache NiFi Jira issue number, such as NIFI-00000
  • Pull Request commit message starts with Apache NiFi Jira issue number, as such NIFI-00000

Pull Request Formatting

  • Pull Request based on current revision of the main branch
  • Pull Request refers to a feature branch with one commit containing changes

Verification

Please indicate the verification steps performed prior to pull request creation.

Build

  • Build completed using mvn clean install -P contrib-check
    • JDK 21

Licensing

  • New dependencies are compatible with the Apache License 2.0 according to the License Policy
  • New dependencies are documented in applicable LICENSE and NOTICE files

Documentation

  • Documentation formatting appears as expected in rendered files

Copy link
Contributor

@exceptionfactory exceptionfactory left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for this work on NiFi Registry @sardell!

The standard ci-workflow builds are failing, does this build locally for you, or is this still a work in progress that should be marked as draft?

@sardell
Copy link
Contributor Author

sardell commented Apr 8, 2025

@exceptionfactory Thanks for raising the failing CI to my attention. It looks like the failure was due to the favicon missing from the old registry ui directory. I accidentally deleted it when copying over images to the new project. I noticed the missing file while working on this PR and added the file back, but it seems that file was accidentally added to the .gitignore (I think intention of that .gitignore line was to ignore the generated favicon, not all instances of that file). I believe this is why I could successfully build locally and also see the CI failures you pointed out.

Fingers crossed the CI passes this time. I'll keep an eye on it.

UPDATE: Looks like the CI build is now failing on a build step that runs fine locally. Will need to investigate a little further.

Copy link
Contributor

@exceptionfactory exceptionfactory left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the update @sardell, although the build completes on macOS, it is failing on Linux and Windows.

On Linux, there appears to be something platform-dependent:

[INFO] ::group::❌ > nx run shared:build:production
[INFO] 
[INFO] Building Angular Package
[INFO] 
[INFO] ------------------------------------------------------------------------------
[INFO] Building entry point '@nifi/shared'
[INFO] ------------------------------------------------------------------------------
[INFO] - Compiling with Angular sources in Ivy full compilation mode.
[INFO] ✖ Compiling with Angular sources in Ivy full compilation mode.
[INFO] 
[INFO]  NX   The package "@esbuild/linux-x64" could not be found, and is needed by esbuild.

@sardell sardell requested a review from exceptionfactory April 9, 2025 19:51
@mcgilman mcgilman added the new ui Pull requests for work relating to the new user interface being developed. label Apr 24, 2025
Copy link
Contributor

@elcsiga elcsiga left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good for the 1st glance, I post my first comments, will continue the review soon

styleUrl: './header.component.scss'
})
export class HeaderComponent implements OnInit {
currentUser: Signal<CurrentUser>;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is it used or planned to use next time?

Copy link
Contributor Author

@sardell sardell Apr 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I plan on using it much more in the next part I'm working on. I originally intended for it to be included in this PR but once I saw how big this PR became, I decided to make it auth/login/logout its own task. If it helps to review or you'd just prefer, I can remove the user-related code from this PR.

from(this.dropletsService.uploadFlow(href, request.file)).pipe(
map((res) => DropletsActions.importNewFlowSuccess({ response: res })),
catchError((errorResponse: HttpErrorResponse) => {
this.dialog.closeAll();
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

importNewFlowSuccess reducer has draftState.saving = false, in case of an error draftState.saving remains true. Same question for any ...Success reducer. If there is no ...Error reducer defined, how to recover from the loading state?

Copy link
Contributor

@scottyaslan scottyaslan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@sardell thanks for the PR! I have left several comments on things that need to be addressed. Apologies that there are so many comments as I know this is a big undertaking and your effort here is appreciated. I am sure I will have more comments after you make the requested changes.

Also, I didn't have a great place to leave the following comments so placing them here:

Please run prettier and lint:fix. There are several strange formatting issues.

Please delete nifi-registry/public directory and the favicon.ico.

"maximumError": "4kb"
}
],
"outputHashing": "all"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"outputHashing": "all"
"outputHashing": "all",
"optimization": true

-->

<h2 mat-dialog-title>
<div class="flex justify-between items-baseline">
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The spacing of this dialog header is incorrect.

sardell added 2 commits May 8, 2025 15:23
* fix multiple namings
* template cleanup
* configuration changes to align better with NiFi
* style fixes
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
new ui Pull requests for work relating to the new user interface being developed.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants