Merge pull request #305 from junior/storefront_update (initial support for Oracle Digital Assistant)

junior · web-flow · commit 301ecb21b7f9 · 2022-01-31T10:08:49.000-06:00
Storefront update and initial support for Oracle Digital Assistant
diff --git a/deploy/complete/docker-compose/docker-compose.yml b/deploy/complete/docker-compose/docker-compose.yml
@@ -78,7 +78,7 @@ services:
 
   # Storefront backend API service
   storefront:
-    image: iad.ocir.io/oracle/ateam/mushop-storefront:2.2
+    image: iad.ocir.io/oracle/ateam/mushop-storefront:2.3.0
     hostname: storefront
     restart: always
     cap_drop:
diff --git a/deploy/complete/helm-chart/mushop/Chart.yaml b/deploy/complete/helm-chart/mushop/Chart.yaml
@@ -2,4 +2,4 @@ apiVersion: v1
 appVersion: "1.0"
 description: MuShop App microservices chart
 name: mushop
-version: 0.1.1
+version: 0.1.2
diff --git a/deploy/complete/helm-chart/mushop/charts/nats/values.yaml b/deploy/complete/helm-chart/mushop/charts/nats/values.yaml
@@ -2,12 +2,12 @@ replicaCount: 1
 
 image:
   repository: nats
-  tag: 2.1.2
+  tag: 2.7.1
   pullPolicy: IfNotPresent
 
 exporter: 
-  repository: synadia/prometheus-nats-exporter
-  tag: 0.6.2
+  repository: natsio/prometheus-nats-exporter
+  tag: 0.9.1
   pullPolicy: IfNotPresent
 
 osb: {}
diff --git a/deploy/complete/helm-chart/mushop/charts/storefront/Chart.yaml b/deploy/complete/helm-chart/mushop/charts/storefront/Chart.yaml
@@ -1,5 +1,5 @@
 apiVersion: v1
 name: storefront
-appVersion: 0.1.0
-version: 0.1.0
+appVersion: 2.3.0
+version: 0.2.0
 description: Helm chart for storefront component of the MuShop
diff --git a/deploy/complete/helm-chart/mushop/charts/storefront/templates/storefront-deployment.yaml b/deploy/complete/helm-chart/mushop/charts/storefront/templates/storefront-deployment.yaml
@@ -30,6 +30,17 @@ spec:
               containerPort: 8080
             - name: status
               containerPort: 8888
+          env:
+          - name: ODA_ENABLED
+            value: {{ .Values.env.odaEnabled | default "false" | quote }}
+          - name: ODA_URI
+            value: {{ .Values.env.odaUri | quote }}
+          - name: ODA_CHANNEL_ID
+            value: {{ .Values.env.odaChannelId | quote }}
+          - name: ODA_SECRET
+            value: {{ .Values.env.odaSecret | quote }}
+          - name: ODA_USER_INIT_MESSAGE
+            value: {{ .Values.env.odaUserHiddenInitMessage | quote }}
           livenessProbe:
             httpGet:
               path: /
@@ -45,6 +56,7 @@ spec:
             {{- toYaml .Values.resources | nindent 12 }}
           securityContext:
             {{- toYaml .Values.securityContext | nindent 12 }}
+            readOnlyRootFilesystem: {{ if eq (.Values.env.odaEnabled | default false) true }}false{{ else }}true{{ end }}
       volumes:
         - name: tmp-volume
           emptyDir:
diff --git a/deploy/complete/helm-chart/mushop/charts/storefront/values.yaml b/deploy/complete/helm-chart/mushop/charts/storefront/values.yaml
@@ -2,9 +2,16 @@ replicaCount: 1
 
 image:
   repository: iad.ocir.io/oracle/ateam/mushop-storefront
-  tag: 2.2
+  tag: 2.3
   pullPolicy: Always
 
+env:
+  odaEnabled:
+  odaUri:
+  odaChannelId:
+  odaSecret:
+  odaUserHiddenInitMessage:
+
 resources:
   limits:
     cpu: 300m
@@ -15,7 +22,7 @@ resources:
 
 securityContext:
   runAsNonRoot: true
-  runAsUser: 10001
+  runAsUser: 101
   capabilities:
     drop:
       - all
@@ -24,7 +31,6 @@ securityContext:
       - CHOWN
       - SETGID
       - SETUID
-  readOnlyRootFilesystem: true
 
 hpa:
   enabled: true
diff --git a/deploy/complete/helm-chart/mushop/requirements.yaml b/deploy/complete/helm-chart/mushop/requirements.yaml
@@ -31,7 +31,7 @@ dependencies:
     version: 0.1.0
     condition: session.enabled
   - name: storefront
-    version: 0.1.0
+    version: 0.2.0
     condition: storefront.enabled
   - name: user
     version: 0.1.0
diff --git a/deploy/complete/helm-chart/mushop/values-dev.yaml b/deploy/complete/helm-chart/mushop/values-dev.yaml
@@ -15,6 +15,14 @@ api:
     mediaUrl:                 # URL for catalogue image assets (https://objectstorage.[REGION].oraclecloud.com/n/[NAMESPACE]/b/[BUCKET_NAME]/o/)
     newsletterSubscribeUrl:   # Newsletter subscription endpoint (https://[API_GATEWAY_URL]/newsletter/subscribe)
 
+storefront:
+  env:
+    odaEnabled:               # Enables the Oracle Digital Assistant as widget on the storefront
+    odaUri:                   # Oracle Digital Assistant Channel URI to be used with MuShop
+    odaChannelId:             # Oracle Digital Assistant Channel Id to be used with MuShop
+    odaSecret:                # Used if client auth is enabled.
+    odaUserHiddenInitMessage: # Hidden Init Message if any. Makes the Digital Assistant proactive.
+
 carts:
   secrets:
     oadbAdminPassword:    # ADMIN password entered when provisioning ATP database
diff --git a/deploy/complete/helm-chart/mushop/values-prod-reference.yaml b/deploy/complete/helm-chart/mushop/values-prod-reference.yaml
@@ -33,4 +33,12 @@ ingress:
 api:
   env:
     mediaUrl:                 # Object Storage URL for catalog image assets
-    newsletterSubscribeUrl:   # Newsletter subscription endpoint (https://[API_GATEWAY_URL]/newsletter/subscribe)
+    newsletterSubscribeUrl:   # Newsletter subscription endpoint (https://[API_GATEWAY_URL]/newsletter/subscribe)
+
+storefront:
+  env:
+    odaEnabled:               # Enables the Oracle Digital Assistant as widget on the storefront
+    odaUri:                   # Oracle Digital Assistant Channel URI to be used with MuShop
+    odaChannelId:             # Oracle Digital Assistant Channel Id to be used with MuShop
+    odaSecret:                # Used if client auth is enabled.
+    odaUserHiddenInitMessage: # Hidden Init Message if any. Makes the Digital Assistant proactive.
diff --git a/deploy/complete/helm-chart/setup/requirements.yaml b/deploy/complete/helm-chart/setup/requirements.yaml
@@ -5,22 +5,22 @@
 dependencies:
   # Prometheus
   - name: prometheus
-    version: 14.6.0
+    version: 15.1.1
     condition: prometheus.enabled
     repository: https://prometheus-community.github.io/helm-charts
   # Grafana
   - name: grafana
-    version: 6.16.3
+    version: 6.21.1
     condition: grafana.enabled
     repository: https://grafana.github.io/helm-charts
   # HPA Metrics
   - name: metrics-server
-    version: 2.11.4
+    version: 3.7.0
     condition: metrics-server.enabled
-    repository: https://charts.helm.sh/stable
+    repository: https://kubernetes-sigs.github.io/metrics-server
   # Ingress Controller
   - name: ingress-nginx
-    version: 4.0.1
+    version: 4.0.13
     condition: ingress-nginx.enabled
     repository: https://kubernetes.github.io/ingress-nginx
   # Service Catalog
@@ -30,7 +30,7 @@ dependencies:
     repository: https://kubernetes-sigs.github.io/service-catalog 
   # cert-manager
   - name: cert-manager
-    version: 1.5.3
+    version: 1.7.0
     condition: cert-manager.enabled
     repository: https://charts.jetstack.io
   # jenkins
diff --git a/deploy/complete/helm-chart/setup/values.yaml b/deploy/complete/helm-chart/setup/values.yaml
@@ -1,4 +1,5 @@
-# https://github.com/helm/charts/blob/master/stable/metrics-server/README.md
+## https://github.com/kubernetes-sigs/metrics-server/blob/master/charts/metrics-server/README.md
+## https://artifacthub.io/packages/helm/metrics-server/metrics-server
 metrics-server:
   enabled: true
   args: [
@@ -120,7 +121,6 @@ grafana:
     - grafana-worldmap-panel
     - grafana-piechart-panel
     - btplc-status-dot-panel
-    - grafana-github-datasource
 
 # https://github.com/helm/charts/blob/master/stable/jenkins/README.md
 jenkins:
diff --git a/deploy/complete/kubernetes/manifests/storefront-dep.yaml b/deploy/complete/kubernetes/manifests/storefront-dep.yaml
@@ -24,7 +24,7 @@ spec:
     spec:
       containers:
       - name: storefront
-        image: iad.ocir.io/oracle/ateam/mushop-storefront:2.2
+        image: iad.ocir.io/oracle/ateam/mushop-storefront:2.3
         imagePullPolicy: Always
         ports:
         - name: http
diff --git a/deploy/complete/kubernetes/mushop.yaml b/deploy/complete/kubernetes/mushop.yaml
@@ -1529,7 +1529,7 @@ spec:
     spec:
       containers:
         - name: storefront
-          image: "iad.ocir.io/oracle/ateam/mushop-storefront:2.2"
+          image: "iad.ocir.io/oracle/ateam/mushop-storefront:2.3"
           imagePullPolicy: IfNotPresent
           ports:
             - name: http
diff --git a/deploy/complete/terraform/chart-values/grafana-values.yaml b/deploy/complete/terraform/chart-values/grafana-values.yaml
@@ -84,4 +84,3 @@ plugins:
   - grafana-worldmap-panel
   - grafana-piechart-panel
   - btplc-status-dot-panel
-  - grafana-github-datasource
diff --git a/deploy/complete/terraform/mushop-utilities.tf b/deploy/complete/terraform/mushop-utilities.tf
@@ -18,7 +18,7 @@ resource "helm_release" "prometheus" {
   name       = "prometheus"
   repository = local.helm_repository.prometheus
   chart      = "prometheus"
-  version    = "14.4.1"
+  version    = "15.1.1"
   namespace  = kubernetes_namespace.cluster_utilities_namespace.id
   wait       = false
 
@@ -37,7 +37,7 @@ resource "helm_release" "grafana" {
   name       = "mushop-utils-grafana" # mushop-utils included to be backwards compatible to the docs and setup chart install
   repository = local.helm_repository.grafana
   chart      = "grafana"
-  version    = "6.14.1"
+  version    = "6.21.1"
   namespace  = kubernetes_namespace.cluster_utilities_namespace.id
   wait       = false
 
@@ -86,12 +86,13 @@ EOF
   count = var.grafana_enabled ? 1 : 0
 }
 
-## https://github.com/helm/charts/blob/master/stable/metrics-server/README.md
+## https://github.com/kubernetes-sigs/metrics-server/blob/master/charts/metrics-server/README.md
+## https://artifacthub.io/packages/helm/metrics-server/metrics-server
 resource "helm_release" "metrics_server" {
   name       = "metrics-server"
-  repository = local.helm_repository.stable
+  repository = local.helm_repository.metrics_server
   chart      = "metrics-server"
-  version    = "2.11.4"
+  version    = "3.7.0"
   namespace  = kubernetes_namespace.cluster_utilities_namespace.id
   wait       = false
 
@@ -110,7 +111,7 @@ resource "helm_release" "ingress_nginx" {
   name       = "mushop-utils-ingress-nginx" # mushop-utils included to be backwards compatible to the docs and setup chart install
   repository = local.helm_repository.ingress_nginx
   chart      = "ingress-nginx"
-  version    = "3.34.0"
+  version    = "4.0.13"
   namespace  = kubernetes_namespace.cluster_utilities_namespace.id
   wait       = true
 
@@ -161,7 +162,7 @@ resource "helm_release" "cert_manager" {
   name       = "cert-manager"
   repository = local.helm_repository.jetstack
   chart      = "cert-manager"
-  version    = "1.4.1"
+  version    = "1.7.0"
   namespace  = kubernetes_namespace.cluster_utilities_namespace.id
   wait       = true # wait to allow the webhook be properly configured
 
@@ -211,5 +212,6 @@ locals {
     svc_catalog   = "https://kubernetes-sigs.github.io/service-catalog" # Service Catalog
     grafana       = "https://grafana.github.io/helm-charts"
     prometheus    = "https://prometheus-community.github.io/helm-charts"
+    metrics_server = "https://kubernetes-sigs.github.io/metrics-server"
   }
 }
diff --git a/src/storefront/Dockerfile b/src/storefront/Dockerfile
@@ -1,13 +1,13 @@
 #
-# Copyright (c) 2019-2021 Oracle and/or its affiliates. All rights reserved.
+# Copyright (c) 2019-2022 Oracle and/or its affiliates. All rights reserved.
 # The Universal Permissive License (UPL), Version 1.0
 #
 ARG version
 
 ###############################
 #    Build stage (node/npm)   #
 ###############################
-FROM --platform=${BUILDPLATFORM:-linux/amd64} node:14-alpine as builder
+FROM --platform=${BUILDPLATFORM:-linux/amd64} node:16-alpine as builder
 
 RUN apk update && apk add --no-cache \
     autoconf \
@@ -47,9 +47,14 @@ RUN npm run build
 ###############################
 FROM --platform=${TARGETPLATFORM:-linux/amd64} nginxinc/nginx-unprivileged:1.20-alpine
 
+USER root
+RUN chown -R 101:101 /usr/share/nginx
+USER 101
 COPY nginx/nginx.conf /etc/nginx/nginx.conf
 COPY nginx/default.conf /etc/nginx/conf.d/default.conf
-COPY --from=builder /usr/src/app/build /usr/share/nginx/html
+COPY --chmod=555 nginx/15-storefront-extras.sh /docker-entrypoint.d/15-storefront-extras.sh
+COPY --chown=101:101 --from=builder /usr/src/app/build /usr/share/nginx/html
+
 
 EXPOSE 8080
 EXPOSE 8888
diff --git a/src/storefront/VERSION b/src/storefront/VERSION
@@ -1 +1 @@
-2.2.5
+2.3.0
diff --git a/src/storefront/gulpfile.js b/src/storefront/gulpfile.js
@@ -95,6 +95,14 @@ gulp.task('scripts', function() {
     }));
 });
 
+// Scripts Extras
+gulp.task('oda:copy', function() {
+  return gulp.src('src/scripts/oda/*')
+    .pipe(gulp.dest(`${opt.buildDir}/scripts/oda`))
+});
+
+gulp.task('extras', gulp.series('oda:copy'));
+
 // Images
 
 // copy images into build
@@ -130,7 +138,8 @@ gulp.task('copy', function() {
     'src/*',
     '!src/images/*',
     '!src/styles/*',
-    '!src/scripts/*'
+    '!src/scripts/*',
+    '!src/scripts/oda/*'
   ], {
     base: 'src'
   })
@@ -208,7 +217,8 @@ gulp.task('watch:copy', function() {
     'src/*',
     '!src/images/*',
     '!src/styles/*',
-    '!src/scripts/*'
+    '!src/scripts/*',
+    '!src/scripts/oda/*'
   ], gulp.series('copy'));
 });
 
@@ -229,6 +239,7 @@ gulp.task('build', gulp.series(
     'scripts',
     'copy',
     'images',
+    'extras',
   )
 ));
 
diff --git a/src/storefront/nginx/15-storefront-extras.sh b/src/storefront/nginx/15-storefront-extras.sh
@@ -0,0 +1,31 @@
+#!/bin/sh
+
+set -e
+
+ME=$(basename $0)
+
+WWW_DIR=/usr/share/nginx/html
+
+process_oda() {
+    local ODA_SCRIPTS_DIR=/usr/share/nginx/html/scripts/oda
+
+    if [[ "${ODA_ENABLED}" = true ]]; then
+
+        echo "$ME: Preparing index.html to enable Oracle Digital Assistant"
+        storefrontindex="${WWW_DIR}/index.html"
+        [ -w ${WWW_DIR} ] && echo "$ME: Enabling ODA SDK..." || (echo "$ME: File System Not Writable. Exiting..." && exit 0)
+        sed -i -e 's|<!-- head placeholder 1 -->|<script src="scripts/oda/settings.js"></script>|g' "$storefrontindex" || (echo "$ME: *** Failed to enable ODA SDK. Exiting..." && exit 0)
+        sed -i -e 's|<!-- head placeholder 2 -->|<script src="scripts/oda/web-sdk.js" onload="initSdk('$(echo -e "\x27")'Bots'$(echo -e "\x27")')"></script>|g' "$storefrontindex" || (echo "$ME: *** Failed to enable ODA SDK. Exiting..." && exit 0)
+
+        echo "$ME: Setting ODA variables"
+        odasettingsfile="${ODA_SCRIPTS_DIR}/settings.js"
+        [ -w $odasettingsfile ] && echo "$ME: Running envsubst to update ODA settings.js" || (echo "$ME: settings.js Not Writable. Exiting..." && exit 0)
+        (tmpfile=$(mktemp) && \
+        (cp -a $odasettingsfile $tmpfile) && \
+        (cat $odasettingsfile | envsubst > $tmpfile && mv $tmpfile $odasettingsfile)) || (echo "$ME: *** Failed to update settings.js. Exiting..." && exit 0)
+    fi
+}
+
+process_oda
+
+exit 0
diff --git a/src/storefront/package-lock.json b/src/storefront/package-lock.json
diff --git a/src/storefront/package.json b/src/storefront/package.json
diff --git a/src/storefront/src/images/mucat.png b/src/storefront/src/images/mucat.png
diff --git a/src/storefront/src/scripts/oda/settings.js b/src/storefront/src/scripts/oda/settings.js
diff --git a/src/storefront/src/scripts/oda/web-sdk.js b/src/storefront/src/scripts/oda/web-sdk.js
diff --git a/src/storefront/src/templates/layouts/_index.pug b/src/storefront/src/templates/layouts/_index.pug
diff --git a/src/storefront/src/templates/partials/_copyright.pug b/src/storefront/src/templates/partials/_copyright.pug
diff --git a/src/storefront/src/templates/partials/_head-extras.pug b/src/storefront/src/templates/partials/_head-extras.pug
diff --git a/src/storefront/test/Dockerfile b/src/storefront/test/Dockerfile
