Initial renaming (#4589)

* Renaming MongoDB Realm to Altas App Services
realm · Jun 1, 2022 · 0ad4e1a · 0ad4e1a
1 parent 6076261
commit 0ad4e1a
Show file tree

Hide file tree

Showing 23 changed files with 72 additions and 69 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml
@@ -5,7 +5,7 @@ body:
   - type: markdown
     attributes:
       value: |
-        Please provide as much detail as you can so we have a better chance of fixing the bug quickly. 
+        Please provide as much detail as you can so we have a better chance of fixing the bug quickly.
         Thanks for your contribution to improve this project!
   - type: dropdown
     id: frequency
@@ -42,7 +42,7 @@ body:
         - Yes, sometimes
         - Not yet
     validations:
-      required: true 
+      required: true
   - type: textarea
     id: code-snippets
     attributes:
@@ -67,7 +67,8 @@ body:
       label: What SDK flavour are you using?
       options:
         - Local Database only
-        - MongoDB Realm (i.e. Sync, auth, functions)
+        - Atlas Device Sync
+        - Atlas App Services (auth, functions, etc.)
     validations:
       required: true
   - type: dropdown

diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
@@ -3,6 +3,6 @@ contact_links:
   - name: General Questions and Inquiries
     url: https://developer.mongodb.com/community/forums/c/realm-sdks
     about: Please ask general design/architecture questions in the community forums.
-  - name: MongoDB Realm (Sync) Production Issues
+  - name: Atlas Device Sync and Atlas App Services Production Issues
     url: https://support.mongodb.com/
     about: Please report urgent production issues to the support portal directly.
diff --git a/.github/ISSUE_TEMPLATE/hermes.yml b/.github/ISSUE_TEMPLATE/hermes.yml
@@ -32,7 +32,7 @@ body:
         - Yes, sometimes
         - Not yet
     validations:
-      required: true 
+      required: true
   - type: textarea
     id: code-snippets
     attributes:
@@ -57,7 +57,8 @@ body:
       label: What SDK flavour are you using?
       options:
         - Local Database only
-        - MongoDB Realm (i.e. Sync, auth, functions)
+        - Atlas Device Sync
+        - Atlas App Services (auth, functions, etc.)
   - type: dropdown
     id: encryption
     attributes:

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -193,7 +193,7 @@ Consider adding `--no-clean` to prevent the CocoaPods CLI from deleting the temp
 
 ### How To: Login to the GitHub docker container registry
 
-Testing against the MongoDB Realm server locally requires that you have access to the MongoDB Realm docker image (`ghcr.io/realm/ci/mongodb-realm-test-server`). To provide your local docker deamon with the credentials necessary to pull the image, you must first authenticate using you GitHub username and an API token.
+Testing against the Atlas Device Sync server locally requires that you have access to the Atlas App Services docker image (`ghcr.io/realm/ci/mongodb-realm-test-server`). To provide your local docker deamon with the credentials necessary to pull the image, you must first authenticate using you GitHub username and an API token.
 
 First navigate to https://github.com/settings/tokens to generate a token - it just needs the `read:packages` scope.
 

diff --git a/docs/sync.js b/docs/sync.js
@@ -21,8 +21,8 @@
 /**
  * This describes the options used to create a {@link Realm.App} instance.
  * @typedef {Object} Realm.App~AppConfiguration
- * @property {string} id - The id of the MongoDB Realm app.
- * @property {string} [baseUrl] - The base URL of the MongoDB Realm server.
+ * @property {string} id - The id of the Atlas App Services application.
+ * @property {string} [baseUrl] - The base URL of the Atlas App Services server.
  * @property {number} [timeout] - General timeout (in millisecs) for requests.
  * @property {Realm.App~LocalAppConfiguration} [app] - local app configuration
  */
@@ -44,7 +44,7 @@
  */
 
 /**
- * This describes the different options used to create a {@link Realm} instance with MongoDB Realm synchronization.
+ * This describes the different options used to create a {@link Realm} instance with Atlas App Services synchronization.
  * @typedef {Object} Realm.App.Sync~SyncConfiguration
  * @property {Realm.User} user - A {@link Realm.User} object obtained by calling `Realm.App.logIn`.
  * @property {Realm.App.Sync~SSLConfiguration} [ssl] - SSL configuration.
@@ -87,7 +87,7 @@
  * const realm = await Realm.open(config);
  *
  * // At this point, the Realm will be open with the data for the initial set
- * // subscriptions fully synchronised.
+ * // subscriptions fully synchronized.
  * ```
  * @typedef {Object} Realm.App.Sync~InitialSubscriptionsConfiguration
  * @property {callback(realm)} update - callback called with a
@@ -101,7 +101,7 @@
  */
 
 /**
- * This describes the different options used to create a {@link Realm} instance with MongoDB Realm synchronization.
+ * This describes the different options used to create a {@link Realm} instance with Atlas Device Sync.
  * @typedef {Object} Realm.App.Sync~SSLConfiguration
  * @property {boolean} validate - Indicating if SSL certificates must be validated. Default is `true`.
  * @property {string} certificatePath - A path where to find trusted SSL certificates.
@@ -134,7 +134,7 @@
  */
 
 /**
- * The class represents a MongoDB Realm App.
+ * The class represents an Atlas App Services Application.
  *
  * ```js
  * let app = new Realm.App(config);
@@ -144,7 +144,7 @@
  */
 class App {
   /**
-   * Creates a new app and connects to a MongoDB Realm instance.
+   * Creates a new app and connects to an Atlas App Services instance.
    *
    * @param {(Realm.App~AppConfiguration|string)} configOrId - The configuration of the app or a string app id.
    * @throws If no app id is provided.
@@ -243,7 +243,7 @@ class App {
 
 /**
  *
- * Class for interacting with MongoDB Realm Cloud.
+ * Class for interacting with Atlas App Services.
  *
  * @memberof Realm.App
  */
@@ -289,7 +289,7 @@ class Sync {
   static enableSessionMultiplexing(app) {}
 
   /**
-   * A callback passed to `Realm.App.Sync.setLogger` when instrumenting the MongoDB Realm Cloud client with a custom logger.
+   * A callback passed to `Realm.App.Sync.setLogger` when instrumenting the Atlas Device Sync client with a custom logger.
    * @callback Realm.App.Sync~logCallback
    * @param {number} level The level of the log entry between 0 and 8 inclusively.
    * Use this as an index into `['all', 'trace', 'debug', 'detail', 'info', 'warn', 'error', 'fatal', 'off']` to get the name of the level.
@@ -327,14 +327,14 @@ class Sync {
   /**
    * Initiate a client reset. The Realm must be closed prior to the reset.
    *
-   * A synced Realm may need to be reset if the communications with the MongoDB Realm Server
+   * A synced Realm may need to be reset if the communications with the Atlas Device Sync Server
    * indicate an unrecoverable error that prevents continuing with normal synchronization. The
    * most common reason for this is if a client has been disconnected for too long.
    *
    * The local copy of the Realm is moved into a recovery directory
    * for safekeeping.
    *
-   * Local writes that were not successfully synchronized to the MongoDB Realm server
+   * Local writes that were not successfully synchronized to Atlas
    * will be present in the local recovery copy of the Realm file. The re-downloaded Realm will
    * initially contain only the data present at the time the Realm was synchronized up on the server.
    *
@@ -486,7 +486,7 @@ class Credentials {
   static jwt(token) {}
 
   /**
-   * Creates credentials with a MongoDB Realm function and user identifier.
+   * Creates credentials with an Atlas App Services function and user identifier.
    * @param {string} payload A string identifying the user. Usually an identity token or a username.
    * @return {Promise<Credentials>} An instance of `Credentials` that can be used in {@linkcode Realm.App.logIn}.
    */
@@ -776,8 +776,8 @@ class UserIdentity {
  */
 class User {
   /**
-   * Gets the id of this user on MongoDB Realm Cloud.
-   * The id is a guaranteed to be unique among all users on MongoDB Realm Cloud .
+   * Gets the id of this user on Atlas App Services.
+   * The id is a guaranteed to be unique among all users on Atlas App Services.
    * @type {string}
    */
   get id() {}
@@ -954,8 +954,8 @@ class User {
 }
 
 /**
- * An object encapsulating a MongoDB Realm Cloud session. Sessions represent the communication between the
- * client (and a local Realm file on disk), and the server (and a remote Realm at a given URL stored on a Realm Object Server).
+ * An object encapsulating an Atlas Device Sync session. Sessions represent the communication between the
+ * client (and a local Realm file on disk), and the server.
  * Sessions are always created by the SDK and vended out through various APIs. The lifespans of sessions
  * associated with Realms are managed automatically.
  * @memberof Realm.App.Sync
@@ -983,8 +983,8 @@ class Session {
   /**
    * Gets the current state of the session.
    * Can be either:
-   *  - "active": The sync session is actively communicating or attempting to communicate with MongoDB Realm. A session may be considered active even if it is not currently connected. To find out if a session is online, check its connection state.
-   *  - "inactive": The sync session is not attempting to communicate with MongoDB Realm due to the user logging out or synchronization being paused.
+   *  - "active": The sync session is actively communicating or attempting to communicate with Atlas App Services. A session may be considered active even if it is not currently connected. To find out if a session is online, check its connection state.
+   *  - "inactive": The sync session is not attempting to communicate with Atlas App Services due to the user logging out or synchronization being paused.
    *  - "invalid": The sync session encountered a non-recoverable error and is permanently invalid. Create a new Session to continue syncing.
    * @type {string}
    */

diff --git a/integration-tests/tests/src/node/rn-package.json b/integration-tests/tests/src/node/rn-package.json
@@ -1,6 +1,6 @@
 {
   "name": "findourdevices",
-  "description": "FindOurDevices is a React Native and MongoDB Realm example application.",
+  "description": "FindOurDevices is a React Native and Atlas App Services example application.",
   "version": "0.0.1",
   "license": "See the actual license in the file LICENSE",
   "repository": {

diff --git a/packages/realm-app-importer/README.md b/packages/realm-app-importer/README.md
@@ -1,6 +1,6 @@
 # Realm App Importer
 
-Imports an app directory into MongoDB Realm (formerly known as Stitch).
+Imports an app directory into Atlas App Services.
 
 This CLI works around a few shortcomings of the official Realm CLI - most notably around import of apps referencing secrets and the fact that the CLI updates apps (leaving upstages changes to app directories, degrading developer experience).
 
@@ -47,7 +47,7 @@ Positionals:
 Options:
   --version              Show version number                           [boolean]
   --help                 Show help                                     [boolean]
-  --base-url             Base url of the MongoDB Realm server to import the app
+  --base-url             Base url of the Atlas App Services to import the app
                          into        [string] [default: "http://localhost:9090"]
   --username             Username of an adminstrative user
                                     [string] [default: "[email protected]"]

diff --git a/packages/realm-app-importer/src/cli.ts b/packages/realm-app-importer/src/cli.ts
@@ -126,27 +126,27 @@ yargs
   .option("base-url", {
     type: "string",
     default: DEFAULTS.baseUrl,
-    description: "Base url of the MongoDB Realm server to import the app into",
+    description: "Base url of Altas App Services to import the app into",
   })
   .option("username", {
     type: "string",
     default: DEFAULTS.username,
-    description: "Username of an adminstrative user",
+    description: "Username of an administrative user",
   })
   .option("password", {
     type: "string",
     default: DEFAULTS.password,
-    description: "Password of an adminstrative user",
+    description: "Password of an administrative user",
   })
   .option("public-api-key", {
     type: "string",
     default: DEFAULTS.publicKey,
-    description: "Public part of API key with adminstrative privileges",
+    description: "Public part of API key with administrative privileges",
   })
   .option("private-api-key", {
     type: "string",
     default: DEFAULTS.privateKey,
-    description: "Private part of API key with adminstrative privileges",
+    description: "Private part of API key with administrative privileges",
   })
   .option("apps-directory-path", {
     type: "string",

diff --git a/packages/realm-web-integration-tests/README.md b/packages/realm-web-integration-tests/README.md
@@ -4,7 +4,7 @@ For ultimate flexability, the tests are written to be able to run from both Node
 
 ## Running the tests
 
-Ensure you have access to a running instance of MongoDB Realm.
+Ensure you have access to a running instance of Atlas App Services.
 
 To run it locally, ensure you have Docker and your Realm AWS credentials installed and run
 
@@ -47,7 +47,7 @@ Currently, these are only available when running in a browser.
 
 Before running tests which depends on a specific authentication provider:
 1. Run once to import the app,
-2. Go to http://localhost:9090 (or wherever your MongoDB Realm server is listening)
+2. Go to http://localhost:9090 (or wherever your Atlas App Services server is listening)
 3. Setup the appropriate authentication providers.
 
 To enable testing credentials that require interaction, run with DEV_TOOLS and TEST_CREDENTIALS set to a comma-separated list of credentials.
@@ -58,7 +58,7 @@ DEV_TOOLS=1 TEST_CREDENTIALS=anonymous,email-password,google npm test
 
 ## Running the Google Sign-In integration test
 
-Run the tests once to import a test app into the MongoDB Realm server you're testing against.
+Run the tests once to import a test app into the Atlas App Services server you're testing against.
 Take note of the app id that it gets assigned and navigate to the Admin UI of the server to setup the Google Authentication Provider.
 Make sure to toggle on "OpenID Connect".
 

diff --git a/packages/realm-web-integration-tests/harness/github.ts b/packages/realm-web-integration-tests/harness/github.ts
@@ -28,7 +28,7 @@ if (!AWS_ACCESS_KEY_ID || !AWS_SECRET_ACCESS_KEY) {
 }
 
 async function startServer() {
-  console.log("Starting MongoDB Realm server");
+  console.log("Starting Atlas App Services server");
   const serverProcess = cp.spawn(
     "docker",
     [
@@ -48,7 +48,7 @@ async function startServer() {
   );
   // Kill the server when the process ends
   function killServer() {
-    console.log("Killing the MongoDB Realm server");
+    console.log("Killing the Atlas App Services server");
     // Tell docker to kill the container
     cp.execSync("docker kill mongodb-realm-test-server", {
       encoding: "utf8",
@@ -85,7 +85,7 @@ async function startServer() {
      * Handle an unexpected exit by rejecting the promise
      */
     function handleUnexpectedExit() {
-      const err = new Error("MongoDB Realm server closed before it was ready");
+      const err = new Error("Atlas App Services server closed before it was ready");
       reject(err);
     }
     // Start listening for output

diff --git a/packages/realm-web-integration-tests/src/google-login.ts b/packages/realm-web-integration-tests/src/google-login.ts
@@ -35,7 +35,7 @@ const app = createApp();
 function onSuccess(googleUser: any) {
   const response = googleUser.getAuthResponse();
   const idToken = response.id_token;
-  // Try authenticating with MongoDB Realm
+  // Try authenticating with Atlas App Services
   const credentials = Credentials.google(idToken);
   app.logIn(credentials).then(
     (user) => {

diff --git a/packages/realm-web/README.md b/packages/realm-web/README.md
@@ -1,6 +1,6 @@
 # Realm Web
 
-Accessing MongoDB Realm from a web-browser.
+Accessing Atlas App Services from a web-browser.
 
 ## Documentation
 

diff --git a/packages/realm-web/package.json b/packages/realm-web/package.json
@@ -1,7 +1,7 @@
 {
   "name": "realm-web",
   "version": "1.7.0",
-  "description": "Authenticate and communicate with the MongoDB Realm platform, from your web-browser",
+  "description": "Authenticate and communicate with the Atlas App Services, from your web-browser",
   "main": "./dist/bundle.cjs.js",
   "module": "./dist/bundle.es.js",
   "types": "./dist/bundle.d.ts",

diff --git a/packages/realm-web/src/App.ts b/packages/realm-web/src/App.ts
@@ -57,7 +57,7 @@ export interface AppConfiguration extends Realm.AppConfiguration {
 }
 
 /**
- * MongoDB Realm App
+ * Atlas App Services Application
  */
 export class App<
   FunctionsFactoryType = Realm.DefaultFunctionsFactory & Realm.BaseFunctionsFactory,
@@ -72,7 +72,7 @@ export class App<
    * Get or create a singleton Realm App from an id.
    * Calling this function multiple times with the same id will return the same instance.
    *
-   * @param id The Realm App id visible from the MongoDB Realm UI or a configuration.
+   * @param id The Realm App id visible from the Atlas App Services UI or a configuration.
    * @returns The Realm App instance.
    */
   static getApp(id: string): App {
@@ -134,7 +134,7 @@ export class App<
   private _locationUrl: Promise<string> | null = null;
 
   /**
-   * Construct a Realm App, either from the Realm App id visible from the MongoDB Realm UI or a configuration.
+   * Construct a Realm App, either from the Realm App id visible from the Atlas App Services UI or a configuration.
    *
    * @param idOrConfiguration The Realm App id or a configuration to use for this app.
    */
@@ -145,7 +145,7 @@ export class App<
     if (typeof configuration === "object" && typeof configuration.id === "string") {
       this.id = configuration.id;
     } else {
-      throw new Error("Missing a MongoDB Realm app-id");
+      throw new Error("Missing an Atlas App Services app-id");
     }
     this.baseUrl = configuration.baseUrl || DEFAULT_BASE_URL;
     if (configuration.skipLocationRequest) {

diff --git a/packages/realm-web/src/OAuth2Helper.ts b/packages/realm-web/src/OAuth2Helper.ts
@@ -43,7 +43,7 @@ type WindowOpener = (url: string) => Window | null;
 
 type RedirectResult = {
   /**
-   * The id of the MongoDB Realm app.
+   * The id of the Atlas App Services application.
    */
   appId: string;
 

diff --git a/packages/realm-web/src/User.ts b/packages/realm-web/src/User.ts
@@ -145,7 +145,7 @@ export class User<
   }
 
   /**
-   * @returns The access token used to authenticate the user towards MongoDB Realm.
+   * @returns The access token used to authenticate the user towards Atlas App Services.
    */
   get accessToken(): string | null {
     return this._accessToken;

diff --git a/packages/realm-web/src/index.ts b/packages/realm-web/src/index.ts
@@ -24,7 +24,7 @@ import { App } from "./App";
  * Get or create a singleton Realm App from an id.
  * Calling this function multiple times with the same id will return the same instance.
  *
- * @param id The Realm App id visible from the MongoDB Realm UI or a configuration.
+ * @param id The Realm App id visible from the Atlas App Services UI or a configuration.
  * @returns The Realm App instance.
  */
 export function getApp(id: string): App {