Rename portal-ui to web-app (#3178)

Signed-off-by: Daniel Valdivia <18384552+dvaldivia@users.noreply.github.com>

.dockerignore

@@ -3,5 +3,5 @@ dist/
 target/
 console
 !console/
-portal-ui/node_modules/
+web-app/node_modules/
 .git/

.github/workflows/jobs.yaml

@@ -58,7 +58,7 @@ jobs:
           # https://github.com/actions/checkout/issues/334
           sudo apt install -y python3-pip || apt install -y python3-pip
           pip3 install semgrep
-          semgrep --config semgrep.yaml $(pwd)/portal-ui --error
+          semgrep --config semgrep.yaml $(pwd)/web-app --error
 
   ui-assets:
     name: "React Code Has No Warnings & Prettified"
@@ -77,31 +77,31 @@ jobs:
         with:
           node-version: ${{ env.NVMRC }}
           cache: "yarn"
-          cache-dependency-path: portal-ui/yarn.lock
+          cache-dependency-path: web-app/yarn.lock
       - uses: actions/cache@v3
         id: assets-cache
         name: Assets Cache
         with:
           path: |
-            ./portal-ui/build/
+            ./web-app/build/
           key: ${{ runner.os }}-assets-${{ github.run_id }}
       - name: Install Dependencies
-        working-directory: ./portal-ui
+        working-directory: ./web-app
         continue-on-error: false
         run: |
           yarn install --frozen-lockfile --immutable
       - name: Check for Warnings in build output
-        working-directory: ./portal-ui
+        working-directory: ./web-app
         continue-on-error: false
         run: |
           ./check-warnings.sh
       - name: Check if Files are Prettified
-        working-directory: ./portal-ui
+        working-directory: ./web-app
         continue-on-error: false
         run: |
           ./check-prettier.sh
       - name: Check for dead code
-        working-directory: ./portal-ui
+        working-directory: ./web-app
         continue-on-error: false
         run: |
           ./check-deadcode.sh
@@ -191,7 +191,7 @@ jobs:
         name: Assets Cache
         with:
           path: |
-            ./portal-ui/build/
+            ./web-app/build/
           key: ${{ runner.os }}-assets-${{ github.run_id }}
       - name: Build on ${{ matrix.os }}
         env:
@@ -242,7 +242,7 @@ jobs:
         run: npm install testcafe@3.0.0
 
       - name: Run TestCafe Tests
-        run: npx testcafe "chrome:headless" portal-ui/tests/subpath-nginx/ -q --skip-js-errors -c 3
+        run: npx testcafe "chrome:headless" web-app/tests/subpath-nginx/ -q --skip-js-errors -c 3
 
       - name: Clean up docker
         if: always()
@@ -291,7 +291,7 @@ jobs:
         run: npm install testcafe@3.0.0
 
       - name: Run TestCafe Tests
-        run: npx testcafe "chrome:headless" portal-ui/tests/permissions-1/ -q --skip-js-errors -c 3
+        run: npx testcafe "chrome:headless" web-app/tests/permissions-1/ -q --skip-js-errors -c 3
 
       - name: Clean up users & policies
         run: |
@@ -338,7 +338,7 @@ jobs:
         run: npm install testcafe@3.0.0
 
       - name: Run TestCafe Tests
-        run: npx testcafe "chrome:headless" portal-ui/tests/permissions-2/ -q --skip-js-errors -c 3
+        run: npx testcafe "chrome:headless" web-app/tests/permissions-2/ -q --skip-js-errors -c 3
 
       - name: Clean up users & policies
         run: |
@@ -385,7 +385,7 @@ jobs:
         run: npm install testcafe@3.0.0
 
       - name: Run TestCafe Tests
-        run: npx testcafe "chrome:headless" portal-ui/tests/permissions-3/ -q --skip-js-errors -c 3
+        run: npx testcafe "chrome:headless" web-app/tests/permissions-3/ -q --skip-js-errors -c 3
 
       - name: Clean up users & policies
         run: |
@@ -433,7 +433,7 @@ jobs:
 
       - name: Run TestCafe Tests
         timeout-minutes: 10
-        run: npx testcafe "chrome:headless" portal-ui/tests/permissions-4/ --skip-js-errors
+        run: npx testcafe "chrome:headless" web-app/tests/permissions-4/ --skip-js-errors
 
   all-permissions-5:
     name: Permissions Tests Part 5
@@ -476,7 +476,7 @@ jobs:
 
       - name: Run TestCafe Tests
         timeout-minutes: 5
-        run: npx testcafe "chrome:headless" portal-ui/tests/permissions-5/ --skip-js-errors
+        run: npx testcafe "chrome:headless" web-app/tests/permissions-5/ --skip-js-errors
 
   all-permissions-6:
     name: Permissions Tests Part 6
@@ -519,7 +519,7 @@ jobs:
 
       - name: Run TestCafe Tests
         timeout-minutes: 5
-        run: npx testcafe "chrome:headless" portal-ui/tests/permissions-6/ --skip-js-errors
+        run: npx testcafe "chrome:headless" web-app/tests/permissions-6/ --skip-js-errors
 
   all-permissions-7:
     name: Permissions Tests Part 7
@@ -561,7 +561,7 @@ jobs:
 
       - name: Run TestCafe Tests
         timeout-minutes: 5
-        run: npx testcafe "chrome:headless" portal-ui/tests/permissions-7/ --skip-js-errors
+        run: npx testcafe "chrome:headless" web-app/tests/permissions-7/ --skip-js-errors
 
   all-permissions-8:
     name: Permissions Tests Part 8
@@ -604,7 +604,7 @@ jobs:
 
       - name: Run TestCafe Tests
         timeout-minutes: 5
-        run: npx testcafe "chrome:headless" portal-ui/tests/permissions-8/ --skip-js-errors
+        run: npx testcafe "chrome:headless" web-app/tests/permissions-8/ --skip-js-errors
 
   all-permissions-9:
     name: Permissions Tests Part 9
@@ -646,7 +646,7 @@ jobs:
         run: npm install testcafe@3.0.0
 
       - name: Run TestCafe Tests
-        run: npx testcafe "chrome:headless" portal-ui/tests/permissions-9/ --skip-js-errors -c 3
+        run: npx testcafe "chrome:headless" web-app/tests/permissions-9/ --skip-js-errors -c 3
 
       - name: Clean up users & policies
         run: |
@@ -692,7 +692,7 @@ jobs:
         run: npm install testcafe@3.0.0
 
       - name: Run TestCafe Tests
-        run: npx testcafe "chrome:headless" portal-ui/tests/permissions-A/ --skip-js-errors -c 3
+        run: npx testcafe "chrome:headless" web-app/tests/permissions-A/ --skip-js-errors -c 3
 
       - name: Clean up users & policies
         run: |
@@ -738,7 +738,7 @@ jobs:
         run: npm install testcafe@3.0.0
 
       - name: Run TestCafe Tests
-        run: npx testcafe "chrome:headless" portal-ui/tests/permissions-B/ --skip-js-errors -c 3
+        run: npx testcafe "chrome:headless" web-app/tests/permissions-B/ --skip-js-errors -c 3
 
       - name: Clean up users & policies
         run: |
@@ -902,10 +902,10 @@ jobs:
     steps:
       - uses: actions/checkout@v3
       - name: Install modules
-        working-directory: ./portal-ui
+        working-directory: ./web-app
         run: yarn
       - name: Run tests
-        working-directory: ./portal-ui
+        working-directory: ./web-app
         run: yarn test
   replication:
     name: Site Replication Test
@@ -1223,21 +1223,21 @@ jobs:
         with:
           node-version: ${{ env.NVMRC }}
           cache: "yarn"
-          cache-dependency-path: portal-ui/yarn.lock
+          cache-dependency-path: web-app/yarn.lock
       - uses: actions/cache@v3
         id: assets-cache-istanbul-coverage
         name: Assets Cache Istanbul Coverage
         with:
           path: |
-            ./portal-ui/build/
+            ./web-app/build/
           key: ${{ runner.os }}-assets-istanbul-coverage-${{ github.run_id }}
       - name: Install Dependencies
-        working-directory: ./portal-ui
+        working-directory: ./web-app
         continue-on-error: false
         run: |
           yarn install --frozen-lockfile --immutable
       - name: Check for Warnings in build output
-        working-directory: ./portal-ui
+        working-directory: ./web-app
         continue-on-error: false
         run: |
           ./check-warnings-istanbul-coverage.sh
@@ -1275,7 +1275,7 @@ jobs:
         name: Assets Cache Istanbul Coverage
         with:
           path: |
-            ./portal-ui/build/
+            ./web-app/build/
           key: ${{ runner.os }}-assets-istanbul-coverage-${{ github.run_id }}
       - name: Build on ${{ matrix.os }}
         env:
@@ -1298,7 +1298,7 @@ jobs:
       - name: Install dependencies
         run: |
           echo "Install dependencies"
-          cd $GITHUB_WORKSPACE/portal-ui
+          cd $GITHUB_WORKSPACE/web-app
           yarn add -D playwright
           yarn add -D babel-plugin-istanbul
           yarn add -D nyc
@@ -1326,7 +1326,7 @@ jobs:
       - name: Run Playwright tests
         run: |
           echo "Run tests under playwright folder only"
-          cd $GITHUB_WORKSPACE/portal-ui
+          cd $GITHUB_WORKSPACE/web-app
           yarn remove playwright
           yarn add --dev @playwright/test
           echo "npx playwright test"

.github/workflows/vulncheck.yaml

@@ -45,9 +45,9 @@ jobs:
         with:
           node-version: ${{ env.NVMRC }}
           cache: "yarn"
-          cache-dependency-path: portal-ui/yarn.lock
+          cache-dependency-path: web-app/yarn.lock
       - name: Checks for known security issues with the installed packages
-        working-directory: ./portal-ui
+        working-directory: ./web-app
         continue-on-error: false
         run: |
           yarn audit --groups dependencies

.gitignore

@@ -1,12 +1,12 @@
 # Playwright Data
-portal-ui/storage/
+web-app/storage/
-portal-ui/playwright/.auth/admin.json
+web-app/playwright/.auth/admin.json
 
 # Report from Playwright
-portal-ui/playwright-report/
+web-app/playwright-report/
 
 # Coverage from Playwright
-portal-ui/.nyc_output/
+web-app/.nyc_output/
 
 # Binaries for programs and plugins
 *.exe
@@ -37,7 +37,7 @@ dist/
 
 # Ignore node_modules
 
-portal-ui/node_modules/
+web-app/node_modules/
 
 # Ignore tls cert and key
 private.key

.semgrepignore

@@ -5,7 +5,7 @@
 
 # Common large paths
 node_modules/
-portal-ui/node_modules/
+web-app/node_modules/
 build/
 dist/
 .idea/

DEVELOPMENT.md

@@ -1,15 +1,20 @@
 # Developing MinIO Console
 
-The MinIO Console requires the [MinIO Server](https://github.com/minio/minio). For development purposes, you also need to run both the MinIO Console web app and the MinIO Console server.
+The MinIO Console requires the [MinIO Server](https://github.com/minio/minio). For development purposes, you also need
+to run both the MinIO Console web app and the MinIO Console server.
 
 ## Running MinIO Console server
 
 Build the server in the main folder by running:
+
 ```
 make
 ```
-> Note: If it's the first time running the server, you might need to run `go mod tidy` to ensure you have all modules required.
+
-To start the server run:
+> Note: If it's the first time running the server, you might need to run `go mod tidy` to ensure you have all modules
+> required.
+> To start the server run:
+
 ```
 CONSOLE_ACCESS_KEY=<your-access-key>
 CONSOLE_SECRET_KEY=<your-secret-key>
@@ -19,8 +24,8 @@ CONSOLE_DEV_MODE=on
 ```
 
 ## Running MinIO Console web app
-Refer to `/portal-ui` [instructions](/portal-ui/README.md) to run the web app locally.
 
+Refer to `/web-app` [instructions](/web-app/README.md) to run the web app locally.
 
 # Building with MinIO
 

Dockerfile

@@ -3,11 +3,11 @@ FROM node:$NODE_VERSION as uilayer
 
 WORKDIR /app
 
-COPY ./portal-ui/package.json ./
+COPY ./web-app/package.json ./
-COPY ./portal-ui/yarn.lock ./
+COPY ./web-app/yarn.lock ./
 RUN yarn install
 
-COPY ./portal-ui .
+COPY ./web-app .
 
 RUN make build-static
 
@@ -29,7 +29,7 @@ WORKDIR /go/src/github.com/minio/console/
 
 ENV CGO_ENABLED=0
 
-COPY --from=uilayer /app/build /go/src/github.com/minio/console/portal-ui/build
+COPY --from=uilayer /app/build /go/src/github.com/minio/console/web-app/build
 RUN go build --tags=kqueue,operator -ldflags "-w -s" -a -o console ./cmd/console
 
 FROM registry.access.redhat.com/ubi8/ubi-minimal:8.7

Dockerfile.assets

@@ -3,11 +3,11 @@ FROM node:$NODE_VERSION as uilayer
 
 WORKDIR /app
 
-COPY ./portal-ui/package.json ./
+COPY ./web-app/package.json ./
-COPY ./portal-ui/yarn.lock ./
+COPY ./web-app/yarn.lock ./
 RUN yarn install
 
-COPY ./portal-ui .
+COPY ./web-app .
 
 RUN yarn install && make build-static
 

Makefile

@@ -54,13 +54,13 @@ swagger-console:
 	@echo "Generating swagger server code from yaml"
 	@swagger generate server -A console --main-package=management --server-package=api --exclude-main -P models.Principal -f ./swagger.yml -r NOTICE
 	@echo "Generating typescript api"
-	@npx swagger-typescript-api -p ./swagger.yml -o ./portal-ui/src/api -n consoleApi.ts
+	@npx swagger-typescript-api -p ./swagger.yml -o ./web-app/src/api -n consoleApi.ts
 	@git restore api/server.go
 
 
 assets:
 	@(if [ -f "${NVM_DIR}/nvm.sh" ]; then \. "${NVM_DIR}/nvm.sh" && nvm install && nvm use && npm install -g yarn ; fi &&\
-	  cd portal-ui; yarn install --prefer-offline; make build-static; yarn prettier --write . --loglevel warn; cd ..)
+	  cd web-app; yarn install --prefer-offline; make build-static; yarn prettier --write . --loglevel warn; cd ..)
 
 test-integration:
 	@(docker stop pgsqlcontainer || true)
@@ -184,41 +184,41 @@ test-sso-integration:
 
 test-permissions-1:
 	@(docker run -v /data1 -v /data2 -v /data3 -v /data4 -d --name minio --rm -p 9000:9000 quay.io/minio/minio:latest server /data{1...4})
-	@(env bash $(PWD)/portal-ui/tests/scripts/permissions.sh "portal-ui/tests/permissions-1/")
+	@(env bash $(PWD)/web-app/tests/scripts/permissions.sh "web-app/tests/permissions-1/")
 	@(docker stop minio)
 
 test-permissions-2:
 	@(docker run -v /data1 -v /data2 -v /data3 -v /data4 -d --name minio --rm -p 9000:9000 quay.io/minio/minio:latest server /data{1...4})
-	@(env bash $(PWD)/portal-ui/tests/scripts/permissions.sh "portal-ui/tests/permissions-2/")
+	@(env bash $(PWD)/web-app/tests/scripts/permissions.sh "web-app/tests/permissions-2/")
 	@(docker stop minio)
 
 test-permissions-3:
 	@(docker run -v /data1 -v /data2 -v /data3 -v /data4 -d --name minio --rm -p 9000:9000 quay.io/minio/minio:latest server /data{1...4})
-	@(env bash $(PWD)/portal-ui/tests/scripts/permissions.sh "portal-ui/tests/permissions-3/")
+	@(env bash $(PWD)/web-app/tests/scripts/permissions.sh "web-app/tests/permissions-3/")
 	@(docker stop minio)
 
 test-permissions-4:
 	@(docker run -v /data1 -v /data2 -v /data3 -v /data4 -d --name minio --rm -p 9000:9000 quay.io/minio/minio:latest server /data{1...4})
-	@(env bash $(PWD)/portal-ui/tests/scripts/permissions.sh "portal-ui/tests/permissions-4/")
+	@(env bash $(PWD)/web-app/tests/scripts/permissions.sh "web-app/tests/permissions-4/")
 	@(docker stop minio)
 
 test-permissions-5:
 	@(docker run -v /data1 -v /data2 -v /data3 -v /data4 -d --name minio --rm -p 9000:9000 quay.io/minio/minio:latest server /data{1...4})
-	@(env bash $(PWD)/portal-ui/tests/scripts/permissions.sh "portal-ui/tests/permissions-5/")
+	@(env bash $(PWD)/web-app/tests/scripts/permissions.sh "web-app/tests/permissions-5/")
 	@(docker stop minio)
 
 test-permissions-6:
 	@(docker run -v /data1 -v /data2 -v /data3 -v /data4 -d --name minio --rm -p 9000:9000 quay.io/minio/minio:latest server /data{1...4})
-	@(env bash $(PWD)/portal-ui/tests/scripts/permissions.sh "portal-ui/tests/permissions-6/")
+	@(env bash $(PWD)/web-app/tests/scripts/permissions.sh "web-app/tests/permissions-6/")
 	@(docker stop minio)
 
 test-permissions-7:
 	@(docker run -v /data1 -v /data2 -v /data3 -v /data4 -d --name minio --rm -p 9000:9000 quay.io/minio/minio:latest server /data{1...4})
-	@(env bash $(PWD)/portal-ui/tests/scripts/permissions.sh "portal-ui/tests/permissions-7/")
+	@(env bash $(PWD)/web-app/tests/scripts/permissions.sh "web-app/tests/permissions-7/")
 	@(docker stop minio)
 
 test-apply-permissions:
-	@(env bash $(PWD)/portal-ui/tests/scripts/initialize-env.sh)
+	@(env bash $(PWD)/web-app/tests/scripts/initialize-env.sh)
 
 test-start-docker-minio:
 	@(docker run -v /data1 -v /data2 -v /data3 -v /data4 -d --name minio --rm -p 9000:9000 quay.io/minio/minio:latest server /data{1...4})
@@ -227,7 +227,7 @@ initialize-permissions: test-start-docker-minio test-apply-permissions
 	@echo "Done initializing permissions test"
 
 cleanup-permissions:
-	@(env bash $(PWD)/portal-ui/tests/scripts/cleanup-env.sh)
+	@(env bash $(PWD)/web-app/tests/scripts/cleanup-env.sh)
 	@(docker stop minio)
 
 initialize-docker-network:
@@ -246,7 +246,7 @@ test-start-docker-nginx-w-subpath:
 	--network host \
 	-d --rm \
 	--add-host=host.docker.internal:host-gateway \
-	-v ./portal-ui/tests/subpath-nginx/nginx.conf:/etc/nginx/nginx.conf \
+	-v ./web-app/tests/subpath-nginx/nginx.conf:/etc/nginx/nginx.conf \
 	--name test-nginx nginx)
 
 test-initialize-minio-nginx: test-start-docker-minio-w-redirect-url test-start-docker-nginx-w-subpath
@@ -285,4 +285,4 @@ release: swagger-gen
 	@echo "Generating Release: $(RELEASE)"
 	@make assets
 	@git add -u .
-	@git add portal-ui/build/
+	@git add web-app/build/

api/configure_console.go

@@ -43,7 +43,7 @@ import (
 
 	"github.com/klauspost/compress/gzhttp"
 
-	portal_ui "github.com/minio/console/portal-ui"
+	portal_ui "github.com/minio/console/web-app"
 	"github.com/minio/pkg/v2/env"
 	"github.com/minio/pkg/v2/mimedb"
 	xnet "github.com/minio/pkg/v2/net"

web-app/README.md

@@ -4,7 +4,7 @@ Requirements: `yarn` and [node](https://nodejs.org/en/download)
 
 ## Available Scripts
 
-In the `/portal-ui` directory, you can run:
+In the `/web-app` directory, you can run:
 
 ### `yarn start`
 
@@ -19,7 +19,8 @@ You will also see any lint errors in the console.
 ### `yarn test`
 
 Launches the test runner in the interactive watch mode.<br />
-See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
+See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more
+information.
 
 ### `yarn build`
 
@@ -35,14 +36,20 @@ See the section about [deployment](https://facebook.github.io/create-react-app/d
 
 **Note: this is a one-way operation. Once you `eject`, you can’t go back!**
 
-If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
+If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will
+remove the single build dependency from your project.
 
-Instead, it will copy all the configuration files and the transitive dependencies (Webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
+Instead, it will copy all the configuration files and the transitive dependencies (Webpack, Babel, ESLint, etc) right
+into your project so you have full control over them. All of the commands except `eject` will still work, but they will
+point to the copied scripts so you can tweak them. At this point you’re on your own.
 
-You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
+You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you
+shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t
+customize it when you are ready for it.
 
 ## Learn More
 
-You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
+You can learn more in
+the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
 
 To learn React, check out the [React documentation](https://reactjs.org/).