CDRIVER-5948 remove deprecated cursor API (#1959)

* remove `mongoc_cursor_get_hint`
* remove `mongoc_cursor_set_hint`
* remove `mongoc_cursor_new_from_command_reply`
* reword NEWS for consistency

Author: kevinAlbs

NEWS

@@ -51,13 +51,9 @@ Unreleased (2.0.0)
 * `mongoc_server_description_ismaster` is removed. Use the equivalent `mongoc_server_description_hello` instead.
 * `MONGOC_QUERY_SLAVE_OK` is removed. Use the equivalent `MONGOC_QUERY_SECONDARY_OK` instead.
 * `MONGOC_URI_SLAVEOK` is removed. It was unused.
-* `mongoc_collection_save` is removed. Use `mongoc_collection_insert_one` or `mongoc_collection_replace_one` instead.
 * `mongoc_client_command`, `mongoc_database_command`, and `mongoc_collection_command` are removed. Use `mongoc_client_command_simple`,  `mongoc_database_command_simple`, and `mongoc_collection_command_simple` instead.
 * `MONGOC_URI_MAXIDLETIMEMS` and `MONGOC_URI_WAITQUEUEMULTIPLE` are removed. They were unused.
 * `bson_string_t` and associated functions are removed.
-* `mongoc_cursor_is_alive` is removed. Use the equivalent `mongoc_cursor_more` instead.
-* `mongoc_collection_delete` is removed. Use `mongoc_collection_delete_one` or `mongoc_collection_delete_many` instead.
-* `mongoc_delete_flags_t` and `mongoc_reply_flags_t` are removed.
 * Support for `ENABLE_SASL=CYRUS` on Windows is removed. Use `ENABLE_SASL=SSPI` or `ENABLE_SASL=OFF` instead.
     * The associated Windows-only option `CYRUS_PLUGIN_PATH_PREFIX` is removed.
 * Support for the deprecated `minPoolSize` URI option is removed along with associated API: `MONGOC_URI_MINPOOLSIZE` and `mongoc_client_pool_min_size`.
@@ -74,24 +70,33 @@ Unreleased (2.0.0)
   * `mongoc_bulk_operation_get_hint` is removed. Use `mongoc_bulk_operation_get_server_id` instead.
   * `mongoc_bulk_operation_set_hint` is removed. Use `mongoc_bulk_operation_set_server_id` instead.
 * Deprecated `mongoc_apm_command_*_get_server_connection_id` functions are removed. Use `mongoc_apm_command_*_get_server_connection_id_int64` instead.
-* Deprecated index management API has been removed:
+* Deprecated index management API is removed:
   * `mongoc_collection_create_index_with_opts`, `mongoc_collection_create_index`, and `mongoc_collection_ensure_index` are removed. Use `mongoc_collection_create_indexes_with_opts` instead.
   * `mongoc_index_opt_t`, `mongoc_index_opt_geo_t` `mongoc_index_opt_wt_t` are removed. Pass options using `bson_t` to `mongoc_collection_create_indexes_with_opts` instead.
   * `mongoc_collection_find_indexes` is removed. Use `mongoc_collection_find_indexes_with_opts` instead.
   * See [MongoDB documentation](https://www.mongodb.com/docs/languages/c/c-driver/current/indexes/) for working with indexes.
-* `mongoc_collection_find` is removed. Use `mongoc_collection_find_with_opts` instead.
-* `mongoc_collection_insert_bulk` is removed. Use `mongoc_collection_insert_many` instead.
-* `mongoc_collection_create_bulk_operation` is removed. Use `mongoc_collection_create_bulk_operation_with_opts` instead.
-* `mongoc_collection_get_last_error` is removed. To get results from write operations, instead use:
-    - `mongoc_collection_update_one`
-    - `mongoc_collection_update_many`
-    - `mongoc_collection_replace_one`
-    - `mongoc_collection_delete_one`
-    - `mongoc_collection_delete_many`
-    - `mongoc_collection_insert_one`
-    - `mongoc_collection_insert_many`
-    - `mongoc_bulkwrite_t`
-    - `mongoc_bulk_operation_t`
+* Deprecated cursor API is removed:
+  * `mongoc_cursor_is_alive` is removed. Use the equivalent `mongoc_cursor_more` instead.
+  * `mongoc_cursor_set_hint` is removed. Use the equivalent `mongoc_cursor_set_server_id` instead.
+  * `mongoc_cursor_get_hint` is removed. Use the equivalent `mongoc_cursor_get_server_id` instead.
+  * `mongoc_cursor_new_from_command_reply` is removed. Use `mongoc_cursor_new_from_command_reply_with_opts` instead.
+* Deprecated CRUD API is removed:
+  * `mongoc_collection_save` is removed. Use `mongoc_collection_insert_one` or `mongoc_collection_replace_one` instead.
+  * `mongoc_collection_delete` is removed. Use `mongoc_collection_delete_one` or `mongoc_collection_delete_many` instead.
+  * `mongoc_delete_flags_t` and `mongoc_reply_flags_t` are removed.
+  * `mongoc_collection_find` is removed. Use `mongoc_collection_find_with_opts` instead.
+  * `mongoc_collection_insert_bulk` is removed. Use `mongoc_collection_insert_many` instead.
+  * `mongoc_collection_create_bulk_operation` is removed. Use `mongoc_collection_create_bulk_operation_with_opts` instead.
+  * `mongoc_collection_get_last_error` is removed. To get results from write operations, instead use:
+      * `mongoc_collection_update_one`
+      * `mongoc_collection_update_many`
+      * `mongoc_collection_replace_one`
+      * `mongoc_collection_delete_one`
+      * `mongoc_collection_delete_many`
+      * `mongoc_collection_insert_one`
+      * `mongoc_collection_insert_many`
+      * `mongoc_bulkwrite_t`
+      * `mongoc_bulk_operation_t`
 * `mongoc_collection_stats` is removed. Use the [$collStats aggregation pipeline stage](https://www.mongodb.com/docs/manual/reference/operator/aggregation/collStats/) with `mongoc_collection_aggregate` instead.
 * `mongoc_collection_validate` is removed. Run the [validate](https://www.mongodb.com/docs/manual/reference/command/validate/) command directly with `mongoc_client_read_command_with_opts` instead.
 

src/libmongoc/doc/mongoc_cursor_get_hint.rst

@@ -51,18 +51,15 @@ Example
     mongoc_cursor_error
     mongoc_cursor_error_document
     mongoc_cursor_get_batch_size
-    mongoc_cursor_get_hint
     mongoc_cursor_get_server_id
     mongoc_cursor_get_host
     mongoc_cursor_get_id
     mongoc_cursor_get_limit
     mongoc_cursor_get_max_await_time_ms
     mongoc_cursor_more
-    mongoc_cursor_new_from_command_reply
     mongoc_cursor_new_from_command_reply_with_opts
     mongoc_cursor_next
     mongoc_cursor_set_batch_size
-    mongoc_cursor_set_hint
     mongoc_cursor_set_server_id
     mongoc_cursor_set_limit
     mongoc_cursor_set_max_await_time_ms

src/libmongoc/doc/mongoc_cursor_new_from_command_reply.rst

@@ -1506,12 +1506,6 @@ mongoc_cursor_get_limit (const mongoc_cursor_t *cursor)
 }
 
 
-bool
-mongoc_cursor_set_hint (mongoc_cursor_t *cursor, uint32_t server_id)
-{
-   return mongoc_cursor_set_server_id (cursor, server_id);
-}
-
 bool
 mongoc_cursor_set_server_id (mongoc_cursor_t *cursor, uint32_t server_id)
 {
@@ -1533,12 +1527,6 @@ mongoc_cursor_set_server_id (mongoc_cursor_t *cursor, uint32_t server_id)
 }
 
 
-uint32_t
-mongoc_cursor_get_hint (const mongoc_cursor_t *cursor)
-{
-   return mongoc_cursor_get_server_id (cursor);
-}
-
 uint32_t
 mongoc_cursor_get_server_id (const mongoc_cursor_t *cursor)
 {
@@ -1583,31 +1571,6 @@ mongoc_cursor_get_max_await_time_ms (const mongoc_cursor_t *cursor)
 }
 
 
-/* deprecated for mongoc_cursor_new_from_command_reply_with_opts */
-mongoc_cursor_t *
-mongoc_cursor_new_from_command_reply (mongoc_client_t *client, bson_t *reply, uint32_t server_id)
-{
-   mongoc_cursor_t *cursor;
-   bson_t cmd = BSON_INITIALIZER;
-   bson_t opts = BSON_INITIALIZER;
-
-   BSON_ASSERT_PARAM (client);
-   BSON_ASSERT (reply);
-   /* options are passed through by adding them to reply. */
-   bsonBuildAppend (*reply, insert (opts, not(key ("cursor", "ok", "operationTime", "$clusterTime", "$gleStats"))));
-
-   if (server_id) {
-      bson_append_int64 (&opts, "serverId", 8, server_id);
-   }
-
-   cursor = _mongoc_cursor_cmd_new_from_reply (client, &cmd, &opts, reply);
-   bson_destroy (&cmd);
-   bson_destroy (&opts);
-
-   return cursor;
-}
-
-
 mongoc_cursor_t *
 mongoc_cursor_new_from_command_reply_with_opts (mongoc_client_t *client, bson_t *reply, const bson_t *opts)
 {

src/libmongoc/doc/mongoc_cursor_set_hint.rst

@@ -93,11 +93,6 @@ mongoc_cursor_set_max_await_time_ms (mongoc_cursor_t *cursor, uint32_t max_await
 MONGOC_EXPORT (uint32_t)
 mongoc_cursor_get_max_await_time_ms (const mongoc_cursor_t *cursor);
 
-BSON_DEPRECATED_FOR (mongoc_cursor_new_from_command_reply_with_opts)
-MONGOC_EXPORT (mongoc_cursor_t *)
-   mongoc_cursor_new_from_command_reply (struct _mongoc_client_t *client, bson_t *reply, uint32_t server_id)
-      BSON_GNUC_WARN_UNUSED_RESULT;
-
 MONGOC_EXPORT (mongoc_cursor_t *)
 mongoc_cursor_new_from_command_reply_with_opts (struct _mongoc_client_t *client, bson_t *reply, const bson_t *opts)
    BSON_GNUC_WARN_UNUSED_RESULT;

src/libmongoc/doc/mongoc_cursor_t.rst

@@ -291,7 +291,8 @@ test_reset_callbacks (void)
    /* reset callbacks */
    mongoc_client_set_apm_callbacks (client, NULL, NULL);
    /* destroys cmd_reply */
-   cursor = mongoc_cursor_new_from_command_reply (client, &cmd_reply, sd->id);
+   cursor = mongoc_cursor_new_from_command_reply_with_opts (
+      client, &cmd_reply, tmp_bson ("{'serverId': %" PRIu32 "}", sd->id));
    ASSERT (mongoc_cursor_next (cursor, &b));
    ASSERT_CMPINT (incremented, ==, 1); /* same value as before */
 

src/libmongoc/src/mongoc/mongoc-cursor.c

@@ -465,7 +465,7 @@ test_cursor_server_hint_with_exhaust (void *unused)
                                                                NULL /* read_prefs */);
 
    // Set a bogus server ID.
-   mongoc_cursor_set_hint (cursor, 123);
+   mongoc_cursor_set_server_id (cursor, 123);
 
    // Iterate the cursor.
    const bson_t *result;