v1.10.0

### New Features * The SearchBar now supports displaying a loading indicator while a search is running. * The SearchBar also now has support for voice search. * We now support several new languages, including simplified/traditional Chinese and several variants of Arabic. * `universalLimit` config option (#1444) * Session tracking using the browser's session storage (#1452) * `querySource` can now be set at runtime using `ANSWERS.setQuerySource()` (#1464) * Display email validation error in QuestionSubmission (#1505) * Support for DirectAnswers on vertical searches (#1483) * Support providerOptions on the map (#1484) * Create entry points for multi-lang SDK bundles (#1501) ### Speed Improvements * replace IconComponent usages with handlebars partials (#1445) (#1451) (#1458) ### Infrastructure * Change CircleCI node_modules caching strategy to use package-lock.json instead of package.json (#1457) * `canary/latest` assets are now built with i18n support (#1459) * More tests + acceptance testing improvements * Automated publishing for the standalone SearchBar assets (#1529) ### SearchBar-only release notes * The SearchBar now supports displaying a loading indicator while a search is running. * The SearchBar also now has support for voice search.
yext · Aug 24, 2021 · 7f600ea · 7f600ea
2 parents dffb8eb + 6e7b568
commit 7f600ea
Show file tree

Hide file tree

Showing 149 changed files with 11,374 additions and 3,179 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -10,14 +10,14 @@ commands:
       # Download and cache dependencies
       - restore_cache:
           keys:
-            - v1-dependencies-{{ checksum "package.json" }}
+            - v2-dependencies-{{ checksum "package-lock.json" }}
             # fallback to using the latest cache if no exact match is found
-            - v1-dependencies-
+            - v2-dependencies-
       - run: npm install
       - save_cache:
           paths:
             - node_modules
-          key: v1-dependencies-{{ checksum "package.json" }}
+          key: v2-dependencies-{{ checksum "package-lock.json" }}
   deploy-to-aws:
     description: "Deploys the dist directory to a given subdirectory of the answers bucket"
     parameters:
@@ -27,6 +27,9 @@ commands:
       cache-control:
         type: string
         default: "no-cache"
+      deploy-bucket:
+        type: string
+        default: answers
     steps:
       - attach_workspace:
           at: ~/answers
@@ -38,7 +41,7 @@ commands:
             echo -e $AWS_PROD_PROFILE >> ~/.aws/config
       - aws-s3/copy:
           from: dist
-          to: '${AWS_DEPLOY_BUCKET}<< parameters.subdirectory >>'
+          to: 's3://assets.sitescdn.net/<< parameters.deploy-bucket >><< parameters.subdirectory >>'
           arguments: |
             --acl public-read \
             --cache-control << parameters.cache-control >> \
@@ -71,6 +74,18 @@ jobs:
           paths:
             - dist
             - .circleci
+  build_search_bar:
+    docker:
+      - image: circleci/node:14.5
+    working_directory: ~/answers
+    steps:
+      - setup-workspace
+      - run: npm run build-search-bar-only
+      - persist_to_workspace:
+          root: .
+          paths:
+            - dist
+            - .circleci
   # run the jest unit tests
   unit_test:
     docker:
@@ -91,7 +106,18 @@ jobs:
       - setup-workspace
       - attach_workspace:
           at: ~/answers
-      - run: npx testcafe chrome:headless,firefox:headless tests/acceptance/acceptancesuites/*.js -q
+      - run: ./.circleci/run_headless_acceptance.sh
+  headless_acceptance_test_search_bar:
+    docker:
+      - image: circleci/node:14.5-browsers
+    working_directory: ~/answers
+    steps:
+      - setup-workspace
+      - attach_workspace:
+          at: ~/answers
+      - run:
+          name: Search Bar Acceptance Tests
+          command: npx testcafe -c 3 "chrome:headless,firefox:headless" --config-file ./.circleci/testcafe_search_bar.json -q
   # run the browserstack testcafe acceptance tests
   browserstack_acceptance_test:
     docker:
@@ -102,22 +128,17 @@ jobs:
       - attach_workspace:
           at: ~/answers
       - run: ./.circleci/run_browserstack_acceptance.sh
-  # verify all translations are present
-  translation_test:
+  useragent_acceptance_test:
     docker:
-      - image: circleci/node:14.5
+      - image: circleci/node:14.5-browsers
     working_directory: ~/answers
     steps:
       - setup-workspace
       - attach_workspace:
           at: ~/answers
-      - run: 
-          name: Verify translation files
-          command: |
-            sudo apt-get install -qq gettext
-            ./.circleci/run_translation_verification.sh
-  # verify that the third party notices file is up to date
-  third_party_notices_test:
+      - run: ./.circleci/run_useragent_acceptance.sh
+  # verify all translations are present
+  translation_test:
     docker:
       - image: circleci/node:14.5
     working_directory: ~/answers
@@ -126,8 +147,10 @@ jobs:
       - attach_workspace:
           at: ~/answers
       - run: 
-          name: Verify third party notices
-          command: ./.circleci/validate_third_party_notices.sh
+          name: Verify translation files
+          command: |
+            sudo apt-get install -qq gettext
+            ./.circleci/run_translation_verification.sh
   # deploy to S3 in the root folder, overwriting the existing latest version
   deploy_latest:
     docker:
@@ -177,6 +200,29 @@ jobs:
       - deploy-to-aws:
           subdirectory: '/${MAJOR_VERSION}'
           cache-control: 'max-age=43200'
+  # deploys assets to a long-lived-cache folder in the S3 bucket named by release tag
+  deploy_search_bar_version:
+    docker:
+      - image: circleci/python:2.7
+    working_directory: ~/answers
+    steps:
+      - deploy-to-aws:
+          deploy-bucket: 'answers-search-bar'
+          subdirectory: '/${CIRCLE_TAG##search-bar-}'
+          cache-control: 'max-age=31536000'
+      - run:
+          name: "Get major and minor version substrings"
+          command: |
+            echo "export MINOR_VERSION="$(echo "${CIRCLE_TAG##search-bar-}" | cut -d '.' -f 1,2)"" >> $BASH_ENV
+            echo "export MAJOR_VERSION="$(echo "${CIRCLE_TAG##search-bar-}" | cut -d '.' -f 1)"" >> $BASH_ENV
+      - deploy-to-aws:
+          deploy-bucket: 'answers-search-bar'
+          subdirectory: '/${MINOR_VERSION}'
+          cache-control: 'max-age=43200'
+      - deploy-to-aws:
+          deploy-bucket: 'answers-search-bar'
+          subdirectory: '/${MAJOR_VERSION}'
+          cache-control: 'max-age=43200'
 workflows:
   version: 2
   build_and_deploy:
@@ -185,6 +231,7 @@ workflows:
           filters:
             branches:
               ignore:
+                - develop
                 - master
                 - /^support\/.*/
                 - /^hotfix\/.*/
@@ -199,39 +246,25 @@ workflows:
       - browserstack_acceptance_test:
           requires:
             - build
-      - translation_test:
+      - useragent_acceptance_test:
           requires:
             - build
-      - third_party_notices_test:
+      - translation_test:
           requires:
             - build
-      - deploy_canary:
-          filters:
-            branches:
-              only: develop
-          requires:
-            - unit_test
-            - headless_acceptance_test
-            - browserstack_acceptance_test
-            - translation_test
-            - third_party_notices_test
       - deploy_branch:
-          filters:
-            branches:
-              ignore:
-                - develop
           requires:
             - unit_test
             - browserstack_acceptance_test
+            - useragent_acceptance_test
             - headless_acceptance_test
-            - translation_test
-            - third_party_notices_test
   build_and_deploy_i18n:
     jobs:
       - build_i18n:
           filters:
             branches:
               only:
+                - develop
                 - /^support\/.*/
                 - /^hotfix\/.*/
                 - /^feature\/.*-i18n/
@@ -245,19 +278,32 @@ workflows:
       - browserstack_acceptance_test:
           requires:
             - build_i18n
-      - translation_test:
+      - useragent_acceptance_test:
           requires:
             - build_i18n
-      - third_party_notices_test:
+      - translation_test:
           requires:
             - build_i18n
       - deploy_branch:
+          filters:
+            branches:
+              ignore:
+                - develop
           requires:
             - unit_test
             - browserstack_acceptance_test
+            - useragent_acceptance_test
             - headless_acceptance_test
             - translation_test
-            - third_party_notices_test
+      - deploy_canary:
+          filters:
+            branches:
+              only: develop
+          requires:
+            - unit_test
+            - headless_acceptance_test
+            - browserstack_acceptance_test
+            - useragent_acceptance_test
   build_and_deploy_hold:
     jobs:
       - build_i18n:
@@ -285,13 +331,13 @@ workflows:
               only: /^v.*/
           requires:
             - build_i18n
-      - translation_test:
+      - useragent_acceptance_test:
           filters:
             tags:
               only: /^v.*/
           requires:
             - build_i18n
-      - third_party_notices_test:
+      - translation_test:
           filters:
             tags:
               only: /^v.*/
@@ -305,9 +351,9 @@ workflows:
           requires:
             - unit_test
             - browserstack_acceptance_test
+            - useragent_acceptance_test
             - headless_acceptance_test
             - translation_test
-            - third_party_notices_test
       - deploy_latest:
           filters:
             branches:
@@ -322,3 +368,37 @@ workflows:
               ignore: /.*/
           requires:
             - hold
+  build_and_deploy_search_bar:
+    jobs:
+      - build_search_bar:
+          filters:
+            tags:
+              only: /^search-bar-v.*/
+            branches:
+              ignore: /.*/
+      - headless_acceptance_test_search_bar:
+          filters:
+            tags:
+              only: /^search-bar-v.*/
+          requires:
+            - build_search_bar
+      - translation_test:
+          filters:
+            tags:
+              only: /^search-bar-v.*/
+          requires:
+            - build_search_bar
+      - hold:
+          type: approval
+          filters:
+            tags:
+              only: /^search-bar-v.*/
+          requires:
+            - headless_acceptance_test_search_bar
+            - translation_test
+      - deploy_search_bar_version:
+          filters:
+            tags:
+              only: /^search-bar-v.*/
+          requires:
+            - hold
diff --git a/.circleci/run_browserstack_acceptance.sh b/.circleci/run_browserstack_acceptance.sh
@@ -5,4 +5,12 @@ export BROWSERSTACK_BUILD_ID="${CIRCLE_BRANCH} - ${CIRCLE_BUILD_NUM}"
 COMMIT_MSG_TITLE=$(git log -n 1 --pretty=format:%s)
 export BROWSERSTACK_TEST_RUN_NAME=$COMMIT_MSG_TITLE
 
-npx testcafe "browserstack:[email protected],browserstack:safari" tests/acceptance/acceptancesuites/*.js -q
+if [[ $CIRCLE_BRANCH == release/*
+  || $CIRCLE_BRANCH == hotfix/*
+  || $CIRCLE_BRANCH == master
+  || $CIRCLE_BRANCH == support/* ]]
+then
+  npx testcafe "browserstack:[email protected],browserstack:safari" --config-file ./.circleci/testcafe.json -q
+else
+  npx testcafe -c 2 "browserstack:[email protected]" --config-file ./.circleci/testcafe.json -q
+fi
diff --git a/.circleci/run_headless_acceptance.sh b/.circleci/run_headless_acceptance.sh
@@ -0,0 +1,11 @@
+#!/bin/bash
+
+if [[ $CIRCLE_BRANCH == release/*
+  || $CIRCLE_BRANCH == hotfix/*
+  || $CIRCLE_BRANCH == master
+  || $CIRCLE_BRANCH == support/* ]]
+then
+  npx testcafe -c 3 "chrome:headless,firefox:headless" --config-file ./.circleci/testcafe.json -q
+else
+  npx testcafe -c 3 "chrome:headless" --config-file ./.circleci/testcafe.json -q
+fi
diff --git a/.circleci/run_translation_verification.sh b/.circleci/run_translation_verification.sh
@@ -1,9 +1,29 @@
 #!/bin/bash
 
+# Verifiy that the messages.pot file in the repo is up to date
+# If there are any git diffs after translations are extracted, the checked-in file is out of date
 npm run extract-translations
+git diff --exit-code conf/i18n/translations/messages.pot > /dev/null # send stdout to /dev/null to reduce clutter in the CI output
+diff_exit_code=$?
 
-cd conf/i18n/translations
+if test $diff_exit_code -eq 1
+then
+  echo "Extracted translations are out of date. Run 'npm run extract-translations' and commit the updated pot file."
+  exit 1
+else
+  echo "The messages.pot translation file is up to date."
+fi
 
-for po_file in *.po
-  do msgcmp $po_file messages.pot
-done
+# Verify that translations are present for all languages
+cd conf/i18n/translations
+if [[ $CIRCLE_BRANCH == release/*
+  || $CIRCLE_BRANCH == hotfix/*
+  || $CIRCLE_BRANCH == master
+  || $CIRCLE_BRANCH == support/* ]]
+then
+  for po_file in *.po
+    do msgcmp $po_file messages.pot
+  done
+else
+  echo "Skipping the verification that all translations are present"
+fi
diff --git a/.circleci/run_useragent_acceptance.sh b/.circleci/run_useragent_acceptance.sh
@@ -0,0 +1,8 @@
+#!/bin/bash
+export BROWSERSTACK_USE_AUTOMATE="1"
+export BROWSERSTACK_PROJECT_NAME="Answers SDK"
+export BROWSERSTACK_BUILD_ID="${CIRCLE_BRANCH} - ${CIRCLE_BUILD_NUM}"
+COMMIT_MSG_TITLE=$(git log -n 1 --pretty=format:%s)
+export BROWSERSTACK_TEST_RUN_NAME=$COMMIT_MSG_TITLE
+
+npx testcafe chrome:headless,firefox:headless,browserstack:safari,browserstack:edge tests/acceptance/useragent/useragentsuite.js --config-file ./.circleci/testcafe.json
diff --git a/.circleci/testcafe.json b/.circleci/testcafe.json
@@ -0,0 +1,5 @@
+{
+  "src": ["tests/acceptance/acceptancesuites/*.js", "!tests/acceptance/acceptancesuites/searchbaronlysuite.js"],
+  "appCommand": "npx serve -l tcp://0.0.0.0:9999",
+  "appInitDelay": 4000
+}
diff --git a/.circleci/testcafe_search_bar.json b/.circleci/testcafe_search_bar.json
@@ -0,0 +1,5 @@
+{
+  "src": ["tests/acceptance/acceptancesuites/searchbaronlysuite.js"],
+  "appCommand": "npx serve -l tcp://0.0.0.0:9999",
+  "appInitDelay": 4000
+}