Merge branch 'main' into COMPASS-8376-add-gen-ai-endpoints-compass-web

Author: Anemy

.evergreen/functions.yml

@@ -683,7 +683,6 @@ functions:
         env:
           <<: *compass-env
           DEBUG: ${debug|}
-          COMPASS_E2E_ATLAS_CLOUD_SANDBOX_CLOUD_CONFIG: 'qa'
           COMPASS_E2E_ATLAS_CLOUD_SANDBOX_USERNAME: ${e2e_tests_compass_web_atlas_username}
           COMPASS_E2E_ATLAS_CLOUD_SANDBOX_PASSWORD: ${e2e_tests_compass_web_atlas_password}
           COMPASS_E2E_ATLAS_CLOUD_SANDBOX_DBUSER_USERNAME: ${e2e_tests_compass_web_atlas_db_username}

.evergreen/start-atlas-cloud-cluster.sh

@@ -1,10 +1,61 @@
 #!/bin/bash
 
+# This script helps to automatically provision Atlas cluster for running the e2e
+# tests against. In CI this will always create a new cluster and delete it when
+# the test run is finished. You can also use this script locally to run e2e
+# tests against a "logged in" Atlas Cloud experience in compass-web sandbox.
+#
+# While the provisioning of clusters is automated, you should be aware that it
+# requires some extra environmental variables to be available when you are
+# running it. If you want to be able to run these e2e tests locally, following
+# steps are required:
+#
+# - Create a test Atlas user on one of the testing environments (-dev / -qa).
+#   You can only use your work emails with a subaddress to create those (e.g,
+#   [email protected]).
+#
+# - Setup a new org and project. Save the org id and project id for later.
+#
+# - Create new db user with username / password auth and admin role. This user
+#   will be used to prepopulate dbs with data in tests. Save the credentials.
+#
+# - Create a new API key (Access Manager > Project Access > Create Application >
+#   API Key) for the project you created and save the public and private keys.
+#
+# - (Optional) Deploy a cluster with a required configuration through Atlas
+#   Cloud UI. If you skip the step, the script will deploy a default cluster for
+#   you.
+#
+# - Make sure that you have the following environmental variables provided to
+#   the script below:
+#
+#     MCLI_OPS_MANAGER_URL  API base url matching the environment you used to
+#                           create your user (https://cloud{-dev,-qa}.mongodb.com/)
+#     MCLI_PUBLIC_API_KEY   Public API key
+#     MCLI_PRIVATE_API_KEY  Private API key
+#     MCLI_ORG_ID           Org ID
+#     MCLI_PROJECT_ID       Project ID
+#
+#     COMPASS_E2E_ATLAS_CLOUD_SANDBOX_USERNAME         Cloud user you created
+#     COMPASS_E2E_ATLAS_CLOUD_SANDBOX_PASSWORD         Cloud user password
+#     COMPASS_E2E_ATLAS_CLOUD_SANDBOX_DBUSER_USERNAME  Db user for the project
+#     COMPASS_E2E_ATLAS_CLOUD_SANDBOX_DBUSER_PASSWORD  Db user password
+#
+# - Source the script followed by running the tests to make sure that some
+#   variables exported from this script are available for the test env:
+#
+#   (ATLAS_CLOUD_TEST_CLUSTER_NAME="TestCluster" source .evergreen/start-atlas-cloud-cluster.sh \
+#     && npm run -w compass-e2e-tests test web -- --test-atlas-cloud-sandbox --test-filter="atlas-cloud/**/*")
+
+_ATLAS_CLOUD_TEST_CLUSTER_NAME=${ATLAS_CLOUD_TEST_CLUSTER_NAME:-""}
+
 # Atlas limits the naming to something like /^[\w\d-]{,23}$/ (and will auto
 # truncate if it's too long) so we're very limited in terms of how unique this
 # name can be. Hopefully the epoch + part of git hash is enough for these to not
 # overlap when tests are running
-ATLAS_CLOUD_TEST_CLUSTER_NAME="e2e-$(date +"%s")-$(git rev-parse HEAD)"
+DEFAULT_ATLAS_CLOUD_TEST_CLUSTER_NAME="e2e-$(date +"%s")-$(git rev-parse HEAD)"
+
+ATLAS_CLUSTER_NAME="${_ATLAS_CLOUD_TEST_CLUSTER_NAME:-$DEFAULT_ATLAS_CLOUD_TEST_CLUSTER_NAME}"
 
 function atlascli() {
   docker run \
@@ -17,23 +68,43 @@ function atlascli() {
 }
 
 cleanup() {
-  echo "Scheduling Atlas deployment \`$ATLAS_CLOUD_TEST_CLUSTER_NAME\` for deletion..."
-  atlascli clusters delete $ATLAS_CLOUD_TEST_CLUSTER_NAME --force
+  # Assuming that we want to preserve the cluster if the name was provided
+  # outside of script. Helpful when trying to run the tests locally, you can
+  # automatically create a cluster with a custom name for the first time, but
+  # then re-use it when running the tests again. Don't forget to clean it up
+  # after you're done!
+  if [ -z "$_ATLAS_CLOUD_TEST_CLUSTER_NAME" ]; then
+    echo "Scheduling Atlas deployment \`$ATLAS_CLUSTER_NAME\` for deletion..."
+    atlascli clusters delete $ATLAS_CLUSTER_NAME --force
+  else
+    echo "Custom cluster name provided ($_ATLAS_CLOUD_TEST_CLUSTER_NAME), skipping cluster cleanup"
+  fi
 }
 
 trap cleanup EXIT
 
-echo "Creating Atlas deployment \`$ATLAS_CLOUD_TEST_CLUSTER_NAME\` to test against..."
-atlascli clusters create $ATLAS_CLOUD_TEST_CLUSTER_NAME \
+echo "Creating Atlas deployment \`$ATLAS_CLUSTER_NAME\` to test against..."
+atlascli clusters create $ATLAS_CLUSTER_NAME \
   --provider AWS \
   --region US_EAST_1 \
   --tier M10
 
 echo "Waiting for the deployment to be provisioned..."
-atlascli clusters watch "$ATLAS_CLOUD_TEST_CLUSTER_NAME"
+atlascli clusters watch $ATLAS_CLUSTER_NAME
 
 echo "Getting connection string for provisioned cluster..."
-ATLAS_CLOUD_TEST_CLUSTER_CONNECTION_STRING_JSON="$(atlascli clusters connectionStrings describe $ATLAS_CLOUD_TEST_CLUSTER_NAME -o json)"
+CONNECTION_STRINGS_JSON="$(atlascli clusters connectionStrings describe $ATLAS_CLUSTER_NAME -o json)"
+
+export COMPASS_E2E_ATLAS_CLOUD_SANDBOX_CLOUD_CONFIG=$(
+  if [[ "$MCLI_OPS_MANAGER_URL" =~ "-dev" ]]; then
+    echo "dev"
+  elif [[ "$MCLI_OPS_MANAGER_URL" =~ "-qa" ]]; then
+    echo "qa"
+  else
+    echo "prod"
+  fi
+)
+echo "Cloud config: $COMPASS_E2E_ATLAS_CLOUD_SANDBOX_CLOUD_CONFIG"
 
-export COMPASS_E2E_ATLAS_CLOUD_SANDBOX_DEFAULT_CONNECTIONS="{\"$ATLAS_CLOUD_TEST_CLUSTER_NAME\": $ATLAS_CLOUD_TEST_CLUSTER_CONNECTION_STRING_JSON}"
+export COMPASS_E2E_ATLAS_CLOUD_SANDBOX_DEFAULT_CONNECTIONS="{\"$ATLAS_CLUSTER_NAME\": $CONNECTION_STRINGS_JSON}"
 echo "Cluster connections: $COMPASS_E2E_ATLAS_CLOUD_SANDBOX_DEFAULT_CONNECTIONS"

.github/workflows/bump-packages.yaml

@@ -55,5 +55,6 @@ jobs:
           commit-message: 'chore(release): bump package versions'
           branch: ci/bump-packages
           title: 'chore(release): bump package versions'
+          labels: no-title-validation
           body: |
             - Bump package versions

.github/workflows/update-electron.yaml

@@ -40,14 +40,15 @@ jobs:
         run: |
           node scripts/update-electron.js
           git add .
-          git commit --no-allow-empty -m "chore: update electron" || true
+          git commit --no-allow-empty -m "chore(deps): update electron" || true
       - name: Create Pull Request
         id: cpr
         uses: peter-evans/create-pull-request@v6
         with:
           token: ${{ secrets.SVC_DEVTOOLSBOT_TOKEN }}
-          commit-message: 'chore: update electron'
+          commit-message: 'chore(deps): update electron'
           branch: ci/update-electron
-          title: 'chore: update electron'
+          title: 'chore(deps): update electron'
+          labels: no-title-validation
           body: |
             - Update electron

THIRD-PARTY-NOTICES.md

@@ -1,5 +1,5 @@
 The following third-party software is used by and included in **Mongodb Compass**.
-This document was automatically generated on Tue Oct 29 2024.
+This document was automatically generated on Wed Oct 30 2024.
 
 ## List of dependencies
 
@@ -211,6 +211,7 @@ Package|Version|License
 **[cookie-signature](#28f6116b52488ac66a14424869fc346f611bea6c894e7d0f7f2ca701deb8e49c)**|1.0.6|MIT
 **[cookie](#6fffbd43d8f0d9a659c21e31a0935f0a1226c9990be593a9649dcd61e4db1204)**|0.7.1|MIT
 **[core-js](#2d0305d15eab4ad23db10b97faf9d8e8e0d5ad30a616c5892d1edd535d8a08c8)**|3.17.3|MIT
+**[cpu-features](#fa992e00865a6ed732ac63bbf64c89ee2da4ec39944684e6002a3a34b5adb65c)**|0.0.9|MIT
 **[crelt](#9eba7acaba2af9d27a0a18fcf40d1f133ffa888d85321e4633e7dac58cab2db9)**|1.0.5|MIT
 **[cross-fetch](#2cd4375069c47bf89a4b399cd21cd9573086803b2cb9fc56c29df5a598e051e5)**|3.1.8|MIT
 **[cross-spawn](#67de3a765808182ee1018c35bc07d7a023a8d645e98cc32814dcac2fc2c427ff)**|7.0.3|MIT
@@ -247,7 +248,7 @@ Package|Version|License
 **[ee-first](#e2746902c758ae8a6f91ffb9618cd53717f936cb33c6323e65b6b7b24f7ebefe)**|1.1.1|MIT
 **[electron-dl](#e97e034c7b93c63e7a433d75f6f1de3e0668764225ebbd61dbde8d1b55d6f3b7)**|3.5.0|MIT
 **[electron-squirrel-startup](#09fb8168e8fda2e174f8d1a1c392ffd8f762c5637c788edd00d1e2486d060349)**|1.0.1|Apache-2.0
-**[electron](#4dac8b39331bcb6b30b99afe0849c00e3153935fcab1f1086622b9a2ccb4afc8)**|32.2.1|MIT
+**[electron](#ddfad0a406da8c661d832155ebc87c378ac67db5d3c70f33126149f0084c639b)**|32.2.2|MIT
 **[encodeurl](#b89152db475e86531e570f87b45d8a51aa5e5d87d4cc3b960cee7b8febf1d26a)**|1.0.2|MIT
 **[encodeurl](#177948a319ae0aeebbd65742c53c62b37c75ec1d021afa5a188d10a7ceae6623)**|2.0.0|MIT
 **[end-of-stream](#fadc10994f5fa767d06fb25cfff35fb17a895daf3bc3477c782907668ed16563)**|1.4.4|MIT
@@ -17717,6 +17718,34 @@ License files:
 
 
 
+<a id="fa992e00865a6ed732ac63bbf64c89ee2da4ec39944684e6002a3a34b5adb65c"></a>
+### [cpu-features](https://www.npmjs.com/package/cpu-features) (version 0.0.9)
+License tags: MIT
+
+License files:
+* LICENSE:
+
+      Copyright Brian White. All rights reserved.      
+            
+      Permission is hereby granted, free of charge, to any person obtaining a copy      
+      of this software and associated documentation files (the "Software"), to      
+      deal in the Software without restriction, including without limitation the      
+      rights to use, copy, modify, merge, publish, distribute, sublicense, and/or      
+      sell copies of the Software, and to permit persons to whom the Software is      
+      furnished to do so, subject to the following conditions:      
+            
+      The above copyright notice and this permission notice shall be included in      
+      all copies or substantial portions of the Software.      
+            
+      THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR      
+      IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,      
+      FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE      
+      AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER      
+      LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING      
+      FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS      
+      IN THE SOFTWARE.
+
+
 <a id="9eba7acaba2af9d27a0a18fcf40d1f133ffa888d85321e4633e7dac58cab2db9"></a>
 ### [crelt](https://www.npmjs.com/package/crelt) (version 1.0.5)
 License tags: MIT
@@ -19186,8 +19215,8 @@ License files:
 
 
 
-<a id="4dac8b39331bcb6b30b99afe0849c00e3153935fcab1f1086622b9a2ccb4afc8"></a>
-### [electron](https://www.npmjs.com/package/electron) (version 32.2.1)
+<a id="ddfad0a406da8c661d832155ebc87c378ac67db5d3c70f33126149f0084c639b"></a>
+### [electron](https://www.npmjs.com/package/electron) (version 32.2.2)
 License tags: MIT
 
 License files:

configs/webpack-config-compass/package.json

@@ -73,7 +73,7 @@
     "cli-progress": "^3.9.1",
     "core-js": "^3.17.3",
     "css-loader": "^4.3.0",
-    "electron": "^32.2.1",
+    "electron": "^32.2.2",
     "html-webpack-plugin": "^5.6.0",
     "less": "^3.13.1",
     "less-loader": "^10.0.1",

docs/tracking-plan.md

@@ -1,7 +1,7 @@
 
 # Compass Tracking Plan
 
-Generated on Tue, Oct 29, 2024 at 02:12 PM
+Generated on Wed, Oct 30, 2024 at 02:38 PM
 
 ## Table of Contents
 
@@ -148,6 +148,7 @@ Generated on Tue, Oct 29, 2024 at 02:12 PM
 
 ### Schema
 - [Schema Analyzed](#event--SchemaAnalyzedEvent)
+- [Schema Exported](#event--SchemaExportedEvent)
 
 ### Schema Validation
 - [Schema Validation Added](#event--SchemaValidationAddedEvent)
@@ -1801,6 +1802,25 @@ This event is fired when user analyzes the schema.
 - **connection_id** (optional): `string | undefined`
   - The id of the connection associated to this event.
 
+<a name="event--SchemaExportedEvent"></a>
+
+### Schema Exported
+
+This event is fired when user shares the schema.
+
+**Properties**:
+
+- **has_schema** (required): `boolean`
+  - Indicates whether the schema was analyzed before sharing.
+- **schema_width** (required): `number`
+  - The number of fields at the top level.
+- **schema_depth** (required): `number`
+  - The number of nested levels.
+- **geo_data** (required): `boolean`
+  - Indicates whether the schema contains geospatial data.
+- **connection_id** (optional): `string | undefined`
+  - The id of the connection associated to this event.
+
 
 ## Schema Validation