fix(bug-report-dialog): Don't show Bug Report Dialog if no ravenUrl is provided (#220)

* Don't show Bug Report Dialog if no ravenUrl is provided

* fix(raven): missing url in deployment

* fix(demo): dont use undefined string

* chore(frontend): update script to handle optional variables

* Update Phonebook.Frontend/substitute_variables.sh

* fix(bug-report-dialog): add hasBackdrop

resolves #214
resolves #260
resolves part of #99

Author: mschwrdtnr

Phonebook.Demo/values.yml

@@ -5,10 +5,10 @@
 # General Variables
 host: &host 'demo-phonebook.me'
 contactUrl: 'https://github.com/T-Systems-MMS/phonebook/issues'
-roomPlanningToolUrl: 'undefined'
+roomPlanningToolUrl: null
 contactEmail: &contactEmail 'phonebook-t-systems-mms@mg.telekom.de'
-ravenUrl: 'undefined'
-employeePictureEndpoint: 'undefined'
+ravenUrl: null
+employeePictureEndpoint: null
 assetsEndpoint: 'https://demo-phonebook.me/assets'
 environment: 'preview'
 environmentTag: 'demo'

Phonebook.Frontend/src/app/app.component.ts

@@ -11,6 +11,7 @@ import { DisplayNotificationDialog } from 'src/app/shared/dialogs/display-notifi
 import { IeWarningComponent } from 'src/app/shared/dialogs/ie-warning/ie-warning.component';
 import { AppState, InitTheme, SetSendFeedback } from 'src/app/shared/states/App.state';
 import { ReleaseInfoService } from './services/release-info.service';
+import { runtimeEnvironment } from 'src/environments/runtime-environment';
 
 @Component({
   selector: 'app-root',
@@ -96,8 +97,10 @@ export class AppComponent implements OnInit {
 
     // Ask for Permission to send Bug reports
     const test = this.store.selectSnapshot(AppState.sendFeedback);
-    if (this.store.selectSnapshot(AppState.sendFeedback) == null) {
-      const matDialogRef = this.matDialog.open(BugReportConsentComponent);
+    if (this.store.selectSnapshot(AppState.sendFeedback) == null && runtimeEnvironment.ravenURL != null) {
+      const matDialogRef = this.matDialog.open(BugReportConsentComponent, {
+        hasBackdrop: true
+      });
       matDialogRef.afterClosed().subscribe(consent => {
         this.store.dispatch(new SetSendFeedback(consent));
       });

Phonebook.Frontend/substitute_variables.sh

@@ -1,7 +1,10 @@
 #!/bin/bash
 
-# State all variables which are required here
-variables=( BASE_URL SERVER_NAME ENVIRONMENT ENVIRONMENT_TAG EMPLOYEE_PICTURES_ENDPOINT ASSETS_ENDPOINT CONTACT_EMAIL CONTACT_URL ROOMPLANNINGTOOL_URL)
+# State all required variables here
+requiredVariables=( BASE_URL SERVER_NAME ENVIRONMENT ENVIRONMENT_TAG ASSETS_ENDPOINT CONTACT_EMAIL CONTACT_URL)
+
+# State all optional variables here
+optionalVariables=( RAVEN_URL EMPLOYEE_PICTURES_ENDPOINT ROOMPLANNINGTOOL_URL)
 
 # BASE_URL - used througout the whole app (e.g. opensearch.xml) - example: https://example.com/
 
@@ -12,27 +15,37 @@ if [[ -z $1 ]]; then
     exit 1
 fi
 
-for i in "${variables[@]}"
+# Variables defined as required will error if not supplied
+for i in "${requiredVariables[@]}"
 do
   # Error if variable is not defined
   if [[ -z ${!i} ]]; then
     echo 'ERROR: Variable "'$i'" not defined.'
     exit 1
   fi
+done
 
-  # Escape special characters, for URLs
-  replaceString=$(echo ${!i} | sed -e 's/[\/&]/\\&/g')
-
-  # Get all files including the environment variable (and ending with '.html') substitute the placeholder with its content
-  if [ "$DEBUG" = true ]
-  then
-    # If DEBUG=true in order to log the replaced files
-    grep -rl --include \*.html --include \*.xml --include \*.conf "$i" "$1" | xargs sed -i "s/\${""$i""}/$replaceString/Ig;w /dev/stdout"
+# Write Variables to files
+for i in "${requiredVariables[@]}" "${optionalVariables[@]}"
+do
+  # Inform if a variable is not defined
+  if [[ -z ${!i} ]]; then
+    echo 'INFO: Variable "'$i'" not defined.'
   else
-    # If DEBUG=false do it without logging
-    grep -rl --include \*.html --include \*.xml --include \*.conf "$i" "$1" | xargs sed -i "s/\${""$i""}/$replaceString/Ig"
+    # Escape special characters, for URLs
+    replaceString=$(echo ${!i} | sed -e 's/[\/&]/\\&/g')
+
+    # Get all files including the environment variable (and ending with '.html') substitute the placeholder with its content
+    if [ "$DEBUG" = true ]
+    then
+      # If DEBUG=true in order to log the replaced files
+      grep -rl --include \*.html --include \*.xml --include \*.conf "$i" "$1" | xargs sed -i "s/\${""$i""}/$replaceString/Ig;w /dev/stdout"
+    else
+      # If DEBUG=false do it without logging
+      grep -rl --include \*.html --include \*.xml --include \*.conf "$i" "$1" | xargs sed -i "s/\${""$i""}/$replaceString/Ig"
+    fi
   fi
 done
 
 # Execute all other parameters
-exec "${@:2}"
+exec "${@:2}"