[Sprint-3 Release] : Inji web Spring Release with Code Refactoring

.github/workflows/push-trigger.yml

@@ -2,9 +2,9 @@ name: inji-web build upon a push
 
 on:
   release:
-    types: [published]
+    types: [ published ]
   pull_request:
-    types: [opened, reopened, synchronize]
+    types: [ opened, reopened, synchronize ]
   push:
     branches:
       - '!release-branch'
@@ -13,6 +13,7 @@ on:
       - 1.*
       - develop
       - MOSIP*
+      - injiweb*
 
 jobs:
   build-dockers-inji-web:

helm/inji-web/Chart.yaml

@@ -1,8 +1,8 @@
 apiVersion: v2
-name: inji-web
+name: injiweb
 description: A Helm chart for MOSIP injiweb UI module
 type: application
-version: 1.0.0
+version: 0.0.1-develop
 appVersion: ""
 dependencies:
   - name: common

helm/inji-web/copy_cm.sh

@@ -4,12 +4,12 @@
 
 function copying_cm() {
   COPY_UTIL=./copy_cm_func.sh
-  DST_NS=esignet
+  DST_NS=injiweb
 
   $COPY_UTIL configmap global default $DST_NS
   $COPY_UTIL configmap artifactory-share artifactory $DST_NS
   $COPY_UTIL configmap config-server-share config-server $DST_NS
-  $COPY_UTIL configmap softhsm-esignet-share softhsm $DST_NS
+  #$COPY_UTIL configmap softhsm-esignet-share softhsm $DST_NS
   return 0
 }
 
@@ -19,4 +19,4 @@ set -o errexit   ## set -e : exit the script if any statement returns a non-true
 set -o nounset   ## set -u : exit the script if you try to use an uninitialised variable
 set -o errtrace  # trace ERR through 'time command' and other functions
 set -o pipefail  # trace ERR through pipes
-copying_cm   # calling function
+copying_cm   # calling function

helm/inji-web/delete.sh

@@ -1,18 +1,18 @@
 #!/bin/bash
-# Uninstalls injiweb-ui helm charts
+# Uninstalls injiweb helm charts
 ## Usage: ./delete.sh [kubeconfig]
 
 if [ $# -ge 1 ] ; then
   export KUBECONFIG=$1
 fi
 
 function Deleting_injiweb-ui() {
-  NS=esignet
+  NS=injiweb
   while true; do
       read -p "Are you sure you want to delete all esignet helm charts?(Y/n) " yn
       if [ $yn = "Y" ]
         then
-          helm -n $NS delete injiweb-ui
+          helm -n $NS delete injiweb
           break
         else
           break

helm/inji-web/install.sh

@@ -6,8 +6,38 @@ if [ $# -ge 1 ] ; then
   export KUBECONFIG=$1
 fi
 
-NS=esignet
-CHART_VERSION=1.0.0
+NS=injiweb
+CHART_VERSION=0.0.1-develop
+
+DEFAULT_MOSIP_INJIWEB_HOST=$( kubectl get cm global -n config-server -o jsonpath={.data.mosip-injiweb-host} )
+# Check if MOSIP_INJIWEB_HOST is present under configmap/global of configserver
+if echo "$DEFAULT_MOSIP_INJIWEB_HOST" | grep -q "MOSIP_INJIWEB_HOST"; then
+    echo "MOSIP_INJIWEB_HOST is already present in configmap/global of configserver"
+    MOSIP_INJIWEB_HOST=DEFAULT_MOSIP_INJIWEB_HOST
+else
+    read -p "Please provide injiwebhost (eg: injiweb.sandbox.xyz.net ) : " MOSIP_INJIWEB_HOST
+
+    if [ -z "MOSIP_INJIWEB_HOST" ]; then
+    echo "INJIWEB Host not provided; EXITING;"
+    exit 0;
+    fi    
+fi   
+
+CHK_MOSIP_INJIWEB_HOST=$( nslookup "$MOSIP_INJIWEB_HOST" )
+if [ $? -gt 0 ]; then
+    echo "Injiweb Host does not exists; EXITING;"
+    exit 0;
+fi
+
+echo "MOSIP_INJIWEB_HOST is not present in configmap/global of configserver"
+    # Add injiweb host to global
+    kubectl patch configmap global -n config-server --type merge -p "{\"data\": {\"mosip-injiweb-host\": \"$MOSIP_INIEB_HOST\"}}"
+    # Add the host
+    kubectl set env deployment/config-server SPRING_CLOUD_CONFIG_SERVER_OVERRIDES_MOSIP_ESIGNET_INJIWEB_HOST=$MOSIP_INJIWEB_HOST -n config-server
+    # Restart the configserver deployment
+    kubectl -n config-server get deploy -o name | xargs -n1 -t kubectl -n config-server rollout restart 
+
+sleep 400s
 
 echo Create $NS namespace
 kubectl create ns $NS
@@ -20,18 +50,16 @@ function installing_inji-web() {
   helm repo update
 
   echo Copy configmaps
- # ./copy_cm.sh
+  ./copy_cm.sh
 
-  ESIGNET_HOST=$(kubectl get cm global -o jsonpath={.data.mosip-esignet-host})
   INJI_HOST=$(kubectl get cm global -o jsonpath={.data.mosip-injiweb-host})
   echo Installing INJIWEB
-  helm -n $NS install inji-web mosip/inji-web \
+  helm -n $NS install injiweb mosip/inji-web \
   -f values.yaml \
-  --set esignet_redirect_url=$ESIGNET_HOST \
   --set istio.hosts\[0\]=$INJI_HOST \
   --version $CHART_VERSION
 
-#  kubectl -n $NS  get deploy -o name |  xargs -n1 -t  kubectl -n $NS rollout status
+  kubectl -n $NS  get deploy -o name |  xargs -n1 -t  kubectl -n $NS rollout status
 
   echo Installed inji-web
   return 0

helm/inji-web/restart.sh

@@ -7,7 +7,7 @@ if [ $# -ge 1 ] ; then
 fi
 
 function Restarting_oidc-ui() {
-  NS=esignet
+  NS=injiweb
   kubectl -n $NS rollout restart deploy oidc-ui
 
   kubectl -n $NS  get deploy -o name |  xargs -n1 -t  kubectl -n $NS rollout status

helm/inji-web/values.yaml

@@ -248,8 +248,7 @@ extraEnvVarsCM:
   - global
   - config-server-share
   - artifactory-share
-  - softhsm-esignet-share
-  - oidc-ui
+  #- softhsm-esignet-share
 
 ## Secret with extra environment variables
 ##
@@ -433,5 +432,5 @@ istio:
       portName: http
       port: 80
   hosts:
-    - inji.sandbox.xyz.net
+    - injiweb.sandbox.xyz.net
   prefix: /

inji-web/.env

@@ -1 +1,3 @@
 #REACT_APP_MIMOTO_URL=http://localhost:3010
+#REACT_APP_AUTHORIZATION_REDIRECT_URL = http://localhost:3001/redirect
+REACT_APP_APPLICATION_THEME=orange_theme

inji-web/Dockerfile

@@ -40,4 +40,4 @@ COPY ./nginx.conf /etc/nginx/conf.d/default.conf
 EXPOSE 3004
 
 # The main command to start Nginx when the container runs
-CMD ["nginx", "-g", "daemon off;"]
+CMD ["nginx", "-g", "daemon off;"]

inji-web/adr/0.0.1-injiweb-refactoring.md

@@ -0,0 +1,71 @@
+# Inji Web  Design Decisions.
+
+**Date:** 2024-04-17
+
+## 1. Migration from JS To TS
+
+### context :
+Why TS ?
+
+1. TS gives us more control on data that is passed within the application
+2. TypeScript code tends to be more readable compared to JavaScript, primarily due to its static typing feature.
+3. Its more developer friendly
+
+### decision :
+We will be moving to TS from JS
+
+
+## 2. Folder Structure Maintenance for Tests
+
+### context :
+Its better we move all the test files outside the src, so that source is more cleaner with the implementation and mocks are packed separately.
+
+### decision :
+We will be maintaining the same folder structure as src folder under __ tests __ folder to package all the test files together.
+
+## 3. State Management Library
+
+### context :
+Since the application involves intermediary state changes, Its better we decide a state management library to cater our needs.
+
+### option 1 : Redux
+
+1. Redux is a light weight js library, which is independent on the language / library we are using.
+2. Its very easy to use and main
+3. But Its maintains the global state /context
+
+### option 2 : XState
+
+1. XState library is very helpful in maintaining /managing the complex states.
+2. XState works using finite state machines.
+3. plugins / editors are available to create and debug the flows.
+4. But Its more dependent on the state machine, and more tied up with the controller / state machine
+
+### decision
+Since INJI Web is a light weight project with small use case, We will go with Redux, and having xstate for INJIWEB will be hard to maintain.
+
+## 4. UI Management Libraries ( TailwindCSS Over Material UI)
+
+### context :
+Since the application involves UI pages and components, Its better we decide a UI management library to cater our needs.
+
+### option 1 : Material UI
+1. Material UI is a JavaScript framework
+2. Material UI Provides Pre Constructed JS Components and little customization to match our wireframe.
+3. But Material UI has to load the entire Framework to render the Page, which increase the loadup time of the application.
+4. Application will be scalable, but not Customisable.
+
+### option 2 : Tailwind CSS
+1. TailwindCSS is a CSS library that applies the styles and downloads only the styles that is required for the application to load.
+2. Tailwind css over more customization to cater our needed, its easy to manage and scale.
+3. Tailwind css is easy to maintain and very light weight.
+
+### Decision :
+We will go with TailwindCSS over Material UI for the following reasons
+1. Tailwind CSS is light weight
+2. It improves the loadup time, as it Downloads only the styles that are needed.
+3. Its provides more customisability, where system integrators can use it to cater their needs and design
+
+## People
+Owners: Vijayakumar, S
+Reviewers / team:  Vijayakumar S , challa,  Shiva Kumar, Sasikumar Ganesan