RCORE-1940 conditionally compile out the app services code (#7589)

* conditionally compile out the app services code

* exclude more code

* review touchups

* make the conditional define part of compile definitions rather than an include

Author: ironage

CHANGELOG.md

@@ -47,6 +47,7 @@
 * App metadata storage has been entirely rewritten in preparation for supporting sharing metadata realms between processes. ([PR #7300](https://github.com/realm/realm-core/pull/7300).
 * The metadata disabled mode has been replaced with an in-memory metadata mode which performs similarly and doesn't work weirdly differently from the normal mode. The new mode is intended for testing purposes, but should be suitable for production usage if there is a scenario where metadata persistence is not needed. ([PR #7300](https://github.com/realm/realm-core/pull/7300).
 * The ownership relationship between App and User has changed. User now strongly retains App and App has a weak cache of Users. This means that creating a SyncConfig or opening a Realm will keep the parent App alive, rather than things being in a broken state if the App is deallocated. ([PR #7300](https://github.com/realm/realm-core/pull/7300).
+* A new CMake define `REALM_APP_SERVICES` can be used to compile out core's default implmentation of the application services. ([#7268](https://github.com/realm/realm-core/issues/7268))
 
 ----------------------------------------------
 

CMakeLists.txt

@@ -266,6 +266,7 @@ option(REALM_VALGRIND "Tell the test suite we are running with valgrind" OFF)
 option(REALM_SYNC_MULTIPLEXING "Enables/disables sync session multiplexing by default" ON)
 set(REALM_MAX_BPNODE_SIZE "1000" CACHE STRING "Max B+ tree node size.")
 option(REALM_ENABLE_GEOSPATIAL "Enable geospatial types and queries." ON)
+option(REALM_APP_SERVICES "Enable the default app services implementation." ON)
 
 # Find dependencies
 set(THREADS_PREFER_PTHREAD_FLAG ON)

Package.swift

@@ -17,6 +17,7 @@ var cxxSettings: [CXXSetting] = [
     .define("REALM_ENABLE_ENCRYPTION", to: "1"),
     .define("REALM_ENABLE_SYNC", to: "1"),
     .define("REALM_ENABLE_GEOSPATIAL", to: "1"),
+    .define("REALM_APP_SERVICES", to: "1"),
 
     .define("REALM_VERSION_MAJOR", to: String(versionCompontents[0])),
     .define("REALM_VERSION_MINOR", to: String(versionCompontents[1])),
@@ -493,7 +494,8 @@ let package = Package(
         .target(
             name: "RealmFFI",
             dependencies: ["Capi"],
-            path: "src/swift"),
+            path: "src/swift",
+            cxxSettings: (cxxSettings) as [CXXSetting]),
         .target(
             name: "Catch2Generated",
             path: "external/generated",

evergreen/config.yml

@@ -1874,3 +1874,17 @@ buildvariants:
   tasks:
   - name: compile_local_tests
 
+- name: ubuntu-no-app-services
+  display_name: "Ubuntu (AppServices Disabled)"
+  run_on: ubuntu2204-arm64-large
+  expansions:
+    cmake_url: "https://s3.amazonaws.com/static.realm.io/evergreen-assets/cmake-3.26.3-linux-aarch64.tar.gz"
+    cmake_bindir: "./cmake_binaries/bin"
+    fetch_missing_dependencies: On
+    c_compiler: "/opt/clang+llvm/bin/clang"
+    cxx_compiler: "/opt/clang+llvm/bin/clang++"
+    extra_flags: "-DREALM_APP_SERVICES=OFF"
+    disable_tests_against_baas: On
+  tasks:
+  - name: compile_local_tests
+

src/realm.h

@@ -1,7 +1,20 @@
-/*
-    FIXME: License, since this header may be distributed independently from
-    other headers.
-*/
+/*************************************************************************
+ *
+ * Copyright 2024 Realm Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ **************************************************************************/
 
 #ifndef REALM_H
 #define REALM_H
@@ -2861,16 +2874,39 @@ RLM_API realm_http_transport_t* realm_http_transport_new(realm_http_request_func
 RLM_API void realm_http_transport_complete_request(void* request_context, const realm_http_response_t* response);
 
 /* App */
-typedef struct realm_app realm_app_t;
-typedef struct realm_app_credentials realm_app_credentials_t;
 typedef struct realm_user realm_user_t;
-
 typedef enum realm_user_state {
     RLM_USER_STATE_LOGGED_OUT,
     RLM_USER_STATE_LOGGED_IN,
     RLM_USER_STATE_REMOVED
 } realm_user_state_e;
 
+// This type should never be returned from a function.
+// It's only meant as an asynchronous callback argument.
+// Pointers to this struct and its pointer members are only valid inside the scope
+// of the callback they were passed to.
+typedef struct realm_app_error {
+    realm_errno_e error;
+    realm_error_categories categories;
+    const char* message;
+
+    /**
+     * The underlying HTTP status code returned by the server,
+     * otherwise zero.
+     */
+    int http_status_code;
+
+    /**
+     * A link to MongoDB Realm server logs related to the error,
+     * or NULL if error response didn't contain log information.
+     */
+    const char* link_to_server_logs;
+} realm_app_error_t;
+
+#if REALM_APP_SERVICES
+typedef struct realm_app realm_app_t;
+typedef struct realm_app_credentials realm_app_credentials_t;
+
 typedef enum realm_auth_provider {
     RLM_AUTH_PROVIDER_ANONYMOUS,
     RLM_AUTH_PROVIDER_ANONYMOUS_NO_REUSE,
@@ -2896,28 +2932,6 @@ typedef struct realm_app_user_apikey {
     bool disabled;
 } realm_app_user_apikey_t;
 
-// This type should never be returned from a function.
-// It's only meant as an asynchronous callback argument.
-// Pointers to this struct and its pointer members are only valid inside the scope
-// of the callback they were passed to.
-typedef struct realm_app_error {
-    realm_errno_e error;
-    realm_error_categories categories;
-    const char* message;
-
-    /**
-     * The underlying HTTP status code returned by the server,
-     * otherwise zero.
-     */
-    int http_status_code;
-
-    /**
-     * A link to MongoDB Realm server logs related to the error,
-     * or NULL if error response didn't contain log information.
-     */
-    const char* link_to_server_logs;
-} realm_app_error_t;
-
 typedef struct realm_user_identity {
     /**
      * Ptr to null terminated string representing user identity (memory has to be freed by SDK)
@@ -3391,19 +3405,6 @@ RLM_API void realm_app_sync_client_wait_for_sessions_to_terminate(realm_app_t*)
  */
 RLM_API char* realm_app_sync_client_get_default_file_path_for_realm(const realm_sync_config_t*,
                                                                     const char* custom_filename);
-/**
- * Return the identiy for the user passed as argument
- * @param user ptr to the user for which the identiy has to be retrieved
- * @return a ptr to the identity string. This must be manually released with realm_free().
- */
-RLM_API char* realm_user_get_identity(const realm_user_t* user) RLM_API_NOEXCEPT;
-
-/**
- * Retrieve the state for the user passed as argument
- * @param user ptr to the user for which the state has to be retrieved
- * @return realm_user_state_e value
- */
-RLM_API realm_user_state_e realm_user_get_state(const realm_user_t* user) RLM_API_NOEXCEPT;
 
 /**
  * Get the list of identities of this @a user.
@@ -3430,8 +3431,6 @@ RLM_API char* realm_user_get_device_id(const realm_user_t*) RLM_API_NOEXCEPT;
  */
 RLM_API bool realm_user_log_out(realm_user_t*);
 
-RLM_API bool realm_user_is_logged_in(const realm_user_t*) RLM_API_NOEXCEPT;
-
 /**
  * Get the custom user data from the user's access token.
  *
@@ -3452,24 +3451,65 @@ RLM_API char* realm_user_get_custom_data(const realm_user_t*) RLM_API_NOEXCEPT;
  */
 RLM_API char* realm_user_get_profile_data(const realm_user_t*);
 
+typedef struct realm_app_user_subscription_token realm_app_user_subscription_token_t;
+typedef void (*realm_sync_on_user_state_changed_t)(realm_userdata_t userdata, realm_user_state_e s);
 /**
- * Return the access token associated with the user.
- * @return a string that rapresents the access token
+ * @return a notification token object. Dispose it to stop receiving notifications.
  */
-RLM_API char* realm_user_get_access_token(const realm_user_t*);
+RLM_API realm_app_user_subscription_token_t*
+realm_sync_user_on_state_change_register_callback(realm_user_t*, realm_sync_on_user_state_changed_t,
+                                                  realm_userdata_t userdata,
+                                                  realm_free_userdata_func_t userdata_free);
 
 /**
- * Return the refresh token associated with the user.
- * @return a string that represents the refresh token
+ * In case manual reset is needed, run this function in order to reset sync client files.
+ * The sync_path is going to passed into realm_sync_error_handler_func_t, if manual reset is needed.
+ * This function is supposed to be called inside realm_sync_error_handler_func_t callback, if sync client reset is
+ * needed
+ * @param realm_app ptr to realm app.
+ * @param sync_path path where the sync files are.
+ * @param did_run ptr to bool, which will be set to true if operation was successful
+ * @return true if operation was successful
  */
-RLM_API char* realm_user_get_refresh_token(const realm_user_t*);
+RLM_API bool realm_sync_immediately_run_file_actions(realm_app_t* realm_app, const char* sync_path,
+                                                     bool* did_run) RLM_API_NOEXCEPT;
 
 /**
  * Return the realm app for the user passed as parameter.
  * @return a ptr to the app for the user.
  */
 RLM_API realm_app_t* realm_user_get_app(const realm_user_t*) RLM_API_NOEXCEPT;
 
+#endif // REALM_APP_SERVICES
+
+/**
+ * Return the identiy for the user passed as argument
+ * @param user ptr to the user for which the identiy has to be retrieved
+ * @return a ptr to the identity string. This must be manually released with realm_free().
+ */
+RLM_API char* realm_user_get_identity(const realm_user_t* user) RLM_API_NOEXCEPT;
+
+/**
+ * Retrieve the state for the user passed as argument
+ * @param user ptr to the user for which the state has to be retrieved
+ * @return realm_user_state_e value
+ */
+RLM_API realm_user_state_e realm_user_get_state(const realm_user_t* user) RLM_API_NOEXCEPT;
+
+RLM_API bool realm_user_is_logged_in(const realm_user_t*) RLM_API_NOEXCEPT;
+
+/**
+ * Return the access token associated with the user.
+ * @return a string that rapresents the access token
+ */
+RLM_API char* realm_user_get_access_token(const realm_user_t*);
+
+/**
+ * Return the refresh token associated with the user.
+ * @return a string that represents the refresh token
+ */
+RLM_API char* realm_user_get_refresh_token(const realm_user_t*);
+
 
 /* Sync */
 typedef enum realm_sync_client_reconnect_mode {
@@ -3601,13 +3641,10 @@ typedef enum realm_flx_sync_subscription_set_state {
 typedef void (*realm_sync_on_subscription_state_changed_t)(realm_userdata_t userdata,
                                                            realm_flx_sync_subscription_set_state_e state);
 
-typedef void (*realm_sync_on_user_state_changed_t)(realm_userdata_t userdata, realm_user_state_e s);
-
 
 typedef struct realm_async_open_task_progress_notification_token realm_async_open_task_progress_notification_token_t;
 typedef struct realm_sync_session_connection_state_notification_token
     realm_sync_session_connection_state_notification_token_t;
-typedef struct realm_app_user_subscription_token realm_app_user_subscription_token_t;
 
 /**
  * Callback function invoked by the async open task once the realm is open and fully synchronized.
@@ -3976,18 +4013,6 @@ RLM_API void realm_sync_session_resume(realm_sync_session_t*) RLM_API_NOEXCEPT;
 RLM_API void realm_sync_session_get_file_ident(realm_sync_session_t*,
                                                realm_salted_file_ident_t* out) RLM_API_NOEXCEPT;
 
-/**
- * In case manual reset is needed, run this function in order to reset sync client files.
- * The sync_path is going to passed into realm_sync_error_handler_func_t, if manual reset is needed.
- * This function is supposed to be called inside realm_sync_error_handler_func_t callback, if sync client reset is
- * needed
- * @param realm_app ptr to realm app.
- * @param sync_path path where the sync files are.
- * @param did_run ptr to bool, which will be set to true if operation was successful
- * @return true if operation was successful
- */
-RLM_API bool realm_sync_immediately_run_file_actions(realm_app_t* realm_app, const char* sync_path,
-                                                     bool* did_run) RLM_API_NOEXCEPT;
 
 /**
  * Register a callback that will be invoked every time the session's connection state changes.
@@ -4014,14 +4039,6 @@ RLM_API realm_sync_session_connection_state_notification_token_t* realm_sync_ses
     realm_userdata_t userdata, realm_free_userdata_func_t userdata_free) RLM_API_NOEXCEPT;
 
 
-/**
- * @return a notification token object. Dispose it to stop receiving notifications.
- */
-RLM_API realm_app_user_subscription_token_t*
-realm_sync_user_on_state_change_register_callback(realm_user_t*, realm_sync_on_user_state_changed_t,
-                                                  realm_userdata_t userdata,
-                                                  realm_free_userdata_func_t userdata_free);
-
 /**
  * Register a callback that will be invoked when all pending downloads have completed.
  */
@@ -4057,6 +4074,9 @@ RLM_API void realm_sync_session_handle_error_for_testing(const realm_sync_sessio
  */
 RLM_API void realm_register_user_code_callback_error(realm_userdata_t usercode_error) RLM_API_NOEXCEPT;
 
+
+#if REALM_APP_SERVICES
+
 typedef struct realm_mongodb_collection realm_mongodb_collection_t;
 
 typedef struct realm_mongodb_find_options {
@@ -4275,6 +4295,8 @@ RLM_API bool realm_mongo_collection_find_one_and_delete(realm_mongodb_collection
                                                         realm_userdata_t data, realm_free_userdata_func_t delete_data,
                                                         realm_mongodb_callback_t callback);
 
+#endif // REALM_APP_SERVICES
+
 /**
  * Creates a new sync socket instance for the Sync Client that handles the operations for a custom
  * websocket and event loop implementation.