fix(ci): remove usage of set-env in CI workflows (#343)

Author: prescottprue

.github/workflows/app-deploy.yml

@@ -77,13 +77,20 @@ jobs:
         run: |
           set -o pipefail
 
-          # Set other app configs (settings within .firebaserc in the ci.setEnv section)
-          $(yarn bin)/firebase-ci setEnv
-
+          
           # Find the config associated to the firebase project in .firebaserc
           gitBranch=${GITHUB_REF##*/}
           gcloudProject=$(cat .firebaserc | jq -r --arg alias "$gitBranch" '.projects[$alias]')
 
+          # Set other app configs (settings within .firebaserc in the ci.setEnv section)
+          config=$(cat .firebaserc | jq -r --arg alias "$gitBranch" '.ci.setEnv[$alias]')
+          echo "REACT_APP_FIREADMIN_ENV=$(echo $config | jq -r '.REACT_APP_FIREADMIN_ENV')" >> $GITHUB_ENV
+          echo "REACT_APP_SEGMENT_ID=$(echo $config | jq -r '.REACT_APP_SEGMENT_ID')" >> $GITHUB_ENV
+          echo "REACT_APP_SENTRY_DSN=$(echo $config | jq -r '.REACT_APP_SENTRY_DSN')" >> $GITHUB_ENV
+          echo "REACT_APP_PUBLIC_VAPID_KEY=$(echo $config | jq -r '.REACT_APP_PUBLIC_VAPID_KEY')" >> $GITHUB_ENV
+          echo "REACT_APP_ALGOLIA_APP_ID=$(echo $config | jq -r '.REACT_APP_ALGOLIA_APP_ID')" >> $GITHUB_ENV
+          echo "REACT_APP_ALGOLIA_API_KEY=$(echo $config | jq -r '.REACT_APP_ALGOLIA_API_KEY')" >> $GITHUB_ENV
+
           echo Exporting Firebase SDK Config for $gcloudProject project...
 
           # Use firebase SDK API to get the app's configuration (databaseURL is removed since it is set to the emulator URL above)
@@ -92,16 +99,17 @@ jobs:
               tr '\n' ' ' | \
               sed 's/.*initializeApp(//g' | \
               sed 's/);//g' | \
-              jq -r 'to_entries[] | [.key, (.value | tojson)] | join("::")' | \
-              sed 's/:"/:/g; s/^/echo \"::set-env name=REACT_APP_FIREBASE_/g' \
+              jq -r 'to_entries[] | [.key, (.value | tojson)] | join("=")' | \
+              sed 's/"//1' | \
+              sed 's/:"/:/g; s/^/echo \"REACT_APP_FIREBASE_/g' \
           )
 
           echo Begin evaluating project config to export as environment variables:
 
           # Loop through each line of config and evaluate to export env vars
           while IFS= read -r line; do
             echo Evaluating: $line
-            eval $line
+            eval $line >> $GITHUB_ENV
           done <<< "$firebaseConfig"
 
       - name: Verify App
@@ -137,7 +145,7 @@ jobs:
           packageName=$(cat package.json | jq -r '.name')
           packageVersion=$(cat package.json | jq -r '.version')
           gcloudProject=$(cat .firebaserc | jq -r --arg alias "$gitBranch" '.projects[$alias] // .projects.default')
-          echo "::set-env name=PACKAGE_VERSION::$packageVersion"
+          echo "PACKAGE_VERSION=localhost:$packageVersion" >> $GITHUB_ENV
 
           echo Updating DB path \"/versionInfo/current\" value to version \"$packageVersion\"
 

.github/workflows/app-verify.yml

@@ -74,6 +74,15 @@ jobs:
           # Find the config associated to the firebase project in .firebaserc
           gcloudProject=$(cat .firebaserc | jq -r --arg alias "$gitBranch" '.projects[$alias]  // .projects.default')
 
+          # Set other app configs (settings within .firebaserc in the ci.setEnv section)
+          config=$(cat .firebaserc | jq -r --arg alias "$gitBranch" '.ci.setEnv[$alias] // .ci.setEnv.master')
+          echo "REACT_APP_FIREADMIN_ENV=$(echo $config | jq -r '.REACT_APP_FIREADMIN_ENV')" >> $GITHUB_ENV
+          echo "REACT_APP_SEGMENT_ID=$(echo $config | jq -r '.REACT_APP_SEGMENT_ID')" >> $GITHUB_ENV
+          echo "REACT_APP_SENTRY_DSN=$(echo $config | jq -r '.REACT_APP_SENTRY_DSN')" >> $GITHUB_ENV
+          echo "REACT_APP_PUBLIC_VAPID_KEY=$(echo $config | jq -r '.REACT_APP_PUBLIC_VAPID_KEY')" >> $GITHUB_ENV
+          echo "REACT_APP_ALGOLIA_APP_ID=$(echo $config | jq -r '.REACT_APP_ALGOLIA_APP_ID')" >> $GITHUB_ENV
+          echo "REACT_APP_ALGOLIA_API_KEY=$(echo $config | jq -r '.REACT_APP_ALGOLIA_API_KEY')" >> $GITHUB_ENV
+
           echo Exporting Firebase SDK Config for $gcloudProject project...
 
           # Use firebase SDK API to get the app's configuration (databaseURL is removed since it is set to the emulator URL)
@@ -82,23 +91,21 @@ jobs:
               tr '\n' ' ' | \
               sed 's/.*initializeApp(//g' | \
               sed 's/);//g' | \
-              jq -r 'del(.databaseURL) | to_entries[] | [.key, (.value | tojson)] | join("::")' | \
-              sed 's/:"/:/g; s/^/echo \"::set-env name=REACT_APP_FIREBASE_/g' \
+              jq -r 'del(.databaseURL) | to_entries[] | [.key, (.value | tojson)] | join("=")' | \
+              sed 's/"//1' | \
+              sed 's/:"/:/g; s/^/echo \"REACT_APP_FIREBASE_/g' \
           )
 
           # Set emulator settings
-          echo "::set-env name=REACT_APP_FIREBASE_DATABASE_EMULATOR_HOST::localhost:$(cat firebase.json | jq .emulators.database.port)"
-          echo "::set-env name=REACT_APP_FIRESTORE_EMULATOR_HOST::localhost:$(cat firebase.json | jq .emulators.firestore.port)"
-
-          # Set other app configs (settings within .firebaserc in the ci.setEnv section)
-          $(yarn bin)/firebase-ci setEnv
+          echo "REACT_APP_FIREBASE_DATABASE_EMULATOR_HOST=localhost:$(cat firebase.json | jq .emulators.database.port)" >> $GITHUB_ENV
+          echo "REACT_APP_FIRESTORE_EMULATOR_HOST=localhost:$(cat firebase.json | jq .emulators.firestore.port)" >> $GITHUB_ENV
 
           echo Begin evaluating project config to export as environment variables:
 
           # Loop through each line of config and evaluate to export env vars
           while IFS= read -r line; do
             echo Evaluating: $line
-            eval $line
+            eval $line >> $GITHUB_ENV
           done <<< "$firebaseConfig"
 
       - name: Print CI Env Variables
@@ -159,7 +166,6 @@ jobs:
           key: ${{ runner.os }}-firebase-${{ steps.cache-settings.outputs.firebase-tools }}
 
       - name: Set Test Environment Settings
-        id: emulator-settings
         env:
           GITHUB_REF: ${{ github.ref }}
           SKIP_CYPRESS_RECORDING: ${{ secrets.SKIP_CYPRESS_RECORDING }}
@@ -168,14 +174,14 @@ jobs:
           gcloudProject=$(cat .firebaserc | jq -r --arg branch "$gitBranch" '.projects[$branch] // .projects.master')
           
           echo "Exposing settings to environment for branch: $gitBranch and project: $gcloudProject..."
-          echo "::set-env name=GCLOUD_PROJECT::$gcloudProject"
-          echo "::set-env name=FIREBASE_DATABASE_EMULATOR_HOST::localhost:$(cat firebase.json | jq .emulators.database.port)"
-          echo "::set-env name=FIRESTORE_EMULATOR_HOST::localhost:$(cat firebase.json | jq .emulators.firestore.port)"
-          echo "::set-env name=CYPRESS_BASE_URL::http://localhost:$(cat package.json | jq .config.port)"
+          echo "GCLOUD_PROJECT=$gcloudProject" >> $GITHUB_ENV
+          echo "FIREBASE_DATABASE_EMULATOR_HOST=localhost:$(cat firebase.json | jq .emulators.database.port)" >> $GITHUB_ENV
+          echo "FIRESTORE_EMULATOR_HOST=localhost:$(cat firebase.json | jq .emulators.firestore.port)" >> $GITHUB_ENV
+          echo "CYPRESS_BASE_URL=http://localhost:$(cat package.json | jq .config.port)" >> $GITHUB_ENV
           
           echo "Generating Service Account File..."
           echo "$(echo $SERVICE_ACCOUNT | jq .)" > $HOME/serviceAccount.json
-          echo "::set-env name=GOOGLE_APPLICATION_CREDENTIALS::$HOME/serviceAccount.json"
+          echo "GOOGLE_APPLICATION_CREDENTIALS=$HOME/serviceAccount.json" >> $GITHUB_ENV
 
       - name: Print CI Env Variables
         run: |

Dockerfile

@@ -21,9 +21,6 @@ COPY . .
 # Install dependencies (skipping install of Cypress binary)
 RUN CYPRESS_INSTALL_BINARY=0 yarn --pure-lockfile --no-cache
 
-## Create project/env specific config
-RUN yarn build:config
-
 ## Build app bundle and index.html
 RUN yarn build
 

cypress/integration/ProjectsPage.spec.js

@@ -92,7 +92,11 @@ describe('Projects Page', () => {
     })
 
     it('does not display the same project twice (even is creator is also collaborator)', () => {
-      cy.get(createSelector('project-tile-name')).its('length').should('be', 3)
+      // Confirm collab projects are being shown (needed to prevent check before collab projects loaded)
+      cy.get(createIdSelector('collab-project-1')).should('exist')
+      cy.get(createSelector('project-tile-name'))
+        .its('length')
+        .should('equal', 3)
     })
   })
 })

package.json

@@ -6,7 +6,6 @@
     "clean": "rimraf build",
     "size": "size-limit",
     "build": "react-scripts build",
-    "build:config": "firebase-ci createConfig",
     "build:size": "yarn build && size-limit",
     "build:size:why": "yarn build && yarn size --why",
     "start": "react-scripts start",
@@ -88,7 +87,7 @@
     "eslint-plugin-react-hooks": "^4.1.2",
     "eslint-plugin-standard": "^4.0.1",
     "firebase-admin": "^9.2.0",
-    "firebase-ci": "^0.14.0",
+    "firebase-ci": "^0.15.0",
     "firebase-tools": "8.12.0",
     "husky": "^4.2.5",
     "lint-staged": "^10.2.11",

yarn.lock

@@ -7108,16 +7108,16 @@ firebase-admin@^9.2.0:
     "@google-cloud/firestore" "^4.0.0"
     "@google-cloud/storage" "^5.3.0"
 
-firebase-ci@^0.14.0:
-  version "0.14.0"
-  resolved "https://registry.yarnpkg.com/firebase-ci/-/firebase-ci-0.14.0.tgz#dce5a4733deb33eeaf6de353a8541f4dfc0e3ab3"
-  integrity sha512-EapJbOPKD3AsWrkATDNRFH20mF6cXcsya2YuyJx4BGTPz8Bh8luRkqdU1Ub0V+0Yz11QCw5UUdU9Q2zoNtCz2Q==
+firebase-ci@^0.15.0:
+  version "0.15.0"
+  resolved "https://registry.yarnpkg.com/firebase-ci/-/firebase-ci-0.15.0.tgz#2053975fb8206e5512656445814529da652a9289"
+  integrity sha512-4/cEmTt9i3GO96sakuS3Wvp3xAE3bpkF4vKUdFsSe5wLQvXbd0ohfrUPYiE2THdZ6Ntj8LDNGe7vGiO2va98Kg==
   dependencies:
     chalk "^3.0.0"
     command-exists "^1.2.8"
     commander "^4.1.0"
     figures "^3.1.0"
-    lodash "^4.17.15"
+    lodash "^4.17.20"
 
 [email protected]:
   version "8.12.0"