[#716][#719] feat(UI): Initial frontend framework and Metalake page by ch3yne · Pull Request #788 · apache/gravitino

ch3yne · 2023-11-21T14:12:33Z

What changes were proposed in this pull request?

Initial frontend and add Metalakes page Create Metalake Metalake Details with mock data.

Run below commands:

./gradlew compileDistribution -x test
./dirstribution/package/bin/gravitino.sh start

You can access the Gravitino WEB UI by typing http://localhost:8090/ in your browser.

Previews:

Metalakes page

Create Metalake

Metalake Details

Why are the changes needed?

Fix: #716
Fix: #719

Does this PR introduce any user-facing change?

No

How was this patch tested?

No

…r and view Details

…ify the docker section in README.md

…ve unused docker commands

(cherry picked from commit de76957227ef01c79c304f6a05e6fcc32b3f5f89)

github-actions · 2023-11-21T14:37:55Z

Code Coverage Report

Overall Project	65.52% `-0.41%`	🟢
Files changed	7.28%	🔴

Module	Coverage
server	88.04%	🟢
catalog-lakehouse-iceberg	82.46% `-0.14%`	🔴
server-common	71.42% `-12.21%`	🔴

Files

Module	File	Coverage
server	GravitinoServer.java	53.05%	🟢
catalog-lakehouse-iceberg	IcebergRESTService.java	0% `-4.32%`	🔴
server-common	JettyServer.java	59.17% `-29.51%`	🔴

xunliu · 2023-11-21T14:51:57Z

web/.gitignore


 # See https://help.github.com/articles/ignoring-files/ for more about ignoring files.

-# dependencies


I have modified the .gitignor file, Cloud you please review it?
Do we really need to include icons-bundle-react.js in the source code? It's very huge. Perhaps we should consider ignore it?

It is necessary to retain these ignored rules that have been removed, because some development environments may generate unnecessary submitted files or folders, such as using other package managers, error files generated by build failures, local environments, etc.
The .vscode folder needs to be kept in the repository, as it provides all the extensions and settings required for the project to run smoothly. Similarly, in the future, editor development environment files or folders like .idea will also be created as needed.

The file icons-bundle-react.js is generated using yarn build:icons and utilizes the iconify third-party dependency to provide the SVG icons used in the project.
Once generated, it does not require any further modification, making it convenient to locate the corresponding icons.
This also resolves issues related to icon loading due to network reasons, eliminating the dependency on third-party services.
The required icons can be found at https://icon-sets.iconify.design/.

If necessary, I will modify the configuration to only generate the icons that are already in use.

Ok, you can improve it.

jerryshao · 2023-11-22T01:50:33Z

@xunliu please help to review this PR and get it merged this week.

xunliu · 2023-11-22T02:16:31Z

Because we changed JettyServer code, So I manually completed this test.

curl http://localhost:8090/api/metalakes
curl http://127.0.0.1:9001/iceberg/application.wadl

This test case needs to be added to the next PR.

conf/gravitino.conf.template

build.gradle.kts

server-common/src/main/java/com/datastrato/gravitino/server/web/JettyServer.java

server-common/src/main/java/com/datastrato/gravitino/server/web/JettyServerConfig.java

server-common/src/main/java/com/datastrato/gravitino/server/web/JettyServer.java

xunliu · 2023-11-22T14:49:05Z

@jerryshao I fixed all the problems in the comments. Please help me review it again. Thanks!

jerryshao · 2023-11-23T02:07:25Z

build.gradle.kts

+        from(projectDir.dir("conf")) {
+          into("package/conf")
+          filter { line ->
+            line.replace("{version}", "${version}")


What is the usage of this code?

I think it is not used anymore.

I removed it.

jerryshao · 2023-11-23T02:09:00Z

server-common/src/main/java/com/datastrato/gravitino/server/web/JettyServer.java


-  public synchronized void initialize(JettyServerConfig serverConfig, String serverName) {
+  public synchronized void initialize(
+      JettyServerConfig serverConfig, String serverName, boolean isWebApp) {


isWebApp -> shouldEnableUI

jerryshao · 2023-11-23T02:15:55Z

web/package.json

@@ -0,0 +1,68 @@
+{
+  "name": "gravitino-web",
+  "version": "0.1.0",


I think the version should be aligned with Gravitino, like "0.3.0-SNAPSHOT"

I removed "version" in package.json.

jerryshao · 2023-11-23T02:20:16Z

web/build.gradle.kts

+    from("dist") {
+      into("")
+    }
+    this.archiveFileName.set("${rootProject.name}-web.war")


Do we need a version number for war package?

Modified to ${rootProject.name}-web-${version}.war

jerryshao · 2023-11-23T02:21:23Z

web/next.config.js

+    // config.watchOptions = {
+    //   poll: 1000,
+    //   aggregateTimeout: 300
+    // }


You should remove any unwanted code here.

I will remember.

jerryshao · 2023-11-23T02:26:14Z

...erg/src/main/java/com/datastrato/gravitino/catalog/lakehouse/iceberg/IcebergRESTService.java

    JettyServerConfig serverConfig = JettyServerConfig.fromConfig(icebergConfig);
    server = new JettyServer();
-    server.initialize(serverConfig, SERVICE_NAME);
+    server.initialize(serverConfig, SERVICE_NAME, false);


Can you please change to this style: false /* shouldEnableUI */

jerryshao · 2023-11-23T02:26:31Z

server/src/main/java/com/datastrato/gravitino/server/GravitinoServer.java

    JettyServerConfig jettyServerConfig =
        JettyServerConfig.fromConfig(serverConfig, WEBSERVER_CONF_PREFIX);
-    server.initialize(jettyServerConfig, SERVER_NAME);
+    server.initialize(jettyServerConfig, SERVER_NAME, true);


Can you please change to this style: true /* shouldEnableUI */

xunliu · 2023-11-23T04:12:33Z

@jerryshao , I and @ch3yne fixed all the problems in the comments. Please help me review it again. Thanks!

ch3yne and others added 8 commits November 21, 2023 21:56

[#716] initial frontend

dbe21b7

improvement(frontend): Add docker runtime enviroment in the frontend

17bfbc0

[#719] feat(frontend): Add Metalakes page with Create metalake, Filte…

4d059ca

…r and view Details

[MINOR] improvement(frontend): changed the output directory and simpl…

0c3a1e8

…ify the docker section in README.md

[MINOR] improvement(frontend): add lint command descriptions and remo…

d7a6f32

…ve unused docker commands

[MINOR] Add license information at the top of the file in web directory

349f4a5

[MINOR] Add descriptions for lint commands in README.md

f5a2089

Add web server

102e5d2

(cherry picked from commit de76957227ef01c79c304f6a05e6fcc32b3f5f89)

ch3yne requested review from jerryshao and xunliu November 21, 2023 14:12

ch3yne self-assigned this Nov 21, 2023

xunliu added this to the Gravitino 0.3.0 milestone Nov 21, 2023

xunliu reviewed Nov 21, 2023

View reviewed changes

[MINOR] Add .gitignore rules and limit icons bundle

3c74b3d

jerryshao reviewed Nov 22, 2023

View reviewed changes

xunliu force-pushed the issue-719 branch 5 times, most recently from 9ae6589 to 2400e0b Compare November 22, 2023 13:09

xunliu changed the title ~~[#716][#719] feat(UI): Initial frontend and add Metalakes page with mock data~~ [#716][#719] feat(UI): Initial frontend framework and Metalake page Nov 22, 2023

xunliu force-pushed the issue-719 branch from 2400e0b to 4d35257 Compare November 22, 2023 14:25

fix

c28e15a

xunliu force-pushed the issue-719 branch from 4d35257 to c28e15a Compare November 22, 2023 14:28

jerryshao reviewed Nov 23, 2023

View reviewed changes

remove unused lines

59fa172

generating gravition-web-{version}.war file

65923c6

jerryshao approved these changes Nov 23, 2023

View reviewed changes

jerryshao merged commit 5b2bcab into apache:main Nov 23, 2023


		# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.

		# dependencies

Conversation

ch3yne commented Nov 21, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What changes were proposed in this pull request?

Why are the changes needed?

Does this PR introduce any user-facing change?

How was this patch tested?

Uh oh!

github-actions bot commented Nov 21, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Code Coverage Report

Uh oh!

xunliu Nov 21, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jerryshao commented Nov 22, 2023

Uh oh!

xunliu commented Nov 22, 2023

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

xunliu commented Nov 22, 2023

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jerryshao Nov 23, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

xunliu commented Nov 23, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

ch3yne commented Nov 21, 2023 •

edited

Loading

github-actions bot commented Nov 21, 2023 •

edited

Loading

xunliu Nov 21, 2023 •

edited

Loading

jerryshao Nov 23, 2023 •

edited

Loading

xunliu commented Nov 23, 2023 •

edited

Loading