diff options
Diffstat (limited to 'src/mongo/db')
-rw-r--r-- | src/mongo/db/SConscript | 11 | ||||
-rw-r--r-- | src/mongo/db/change_streams_cluster_parameter.cpp | 62 | ||||
-rw-r--r-- | src/mongo/db/change_streams_cluster_parameter.h | 42 | ||||
-rw-r--r-- | src/mongo/db/change_streams_cluster_parameter.idl | 64 | ||||
-rw-r--r-- | src/mongo/db/change_streams_cluster_parameter_test.cpp | 78 |
5 files changed, 257 insertions, 0 deletions
diff --git a/src/mongo/db/SConscript b/src/mongo/db/SConscript index ea0817030cc..f06e89c7c3d 100644 --- a/src/mongo/db/SConscript +++ b/src/mongo/db/SConscript @@ -510,6 +510,14 @@ env.Library( ) env.Library( + target='change_streams_cluster_parameter', + source=['change_streams_cluster_parameter.idl', 'change_streams_cluster_parameter.cpp'], + LIBDEPS=[ + '$BUILD_DIR/mongo/idl/cluster_server_parameter', + ], +) + +env.Library( target='change_stream_change_collection_manager', source=[ 'change_stream_change_collection_manager.cpp', @@ -2508,6 +2516,7 @@ env.Library( '$BUILD_DIR/mongo/client/clientdriver_minimal', '$BUILD_DIR/mongo/db/change_stream_change_collection_manager', '$BUILD_DIR/mongo/db/change_stream_options_manager', + '$BUILD_DIR/mongo/db/change_streams_cluster_parameter', '$BUILD_DIR/mongo/db/pipeline/change_stream_expired_pre_image_remover', '$BUILD_DIR/mongo/idl/cluster_server_parameter', '$BUILD_DIR/mongo/idl/cluster_server_parameter_op_observer', @@ -2680,6 +2689,7 @@ if wiredtiger: source=[ 'cancelable_operation_context_test.cpp', 'catalog_raii_test.cpp', + 'change_streams_cluster_parameter_test.cpp', 'client_strand_test.cpp', 'client_context_test.cpp', 'collection_index_usage_tracker_test.cpp', @@ -2755,6 +2765,7 @@ if wiredtiger: '$BUILD_DIR/mongo/db/catalog/import_collection_oplog_entry', '$BUILD_DIR/mongo/db/catalog/index_build_entry_idl', '$BUILD_DIR/mongo/db/catalog/local_oplog_info', + '$BUILD_DIR/mongo/db/change_streams_cluster_parameter', '$BUILD_DIR/mongo/db/mongohasher', '$BUILD_DIR/mongo/db/pipeline/change_stream_expired_pre_image_remover', '$BUILD_DIR/mongo/db/query/common_query_enums_and_helpers', diff --git a/src/mongo/db/change_streams_cluster_parameter.cpp b/src/mongo/db/change_streams_cluster_parameter.cpp new file mode 100644 index 00000000000..c0ac9577f2e --- /dev/null +++ b/src/mongo/db/change_streams_cluster_parameter.cpp @@ -0,0 +1,62 @@ +/** + * Copyright (C) 2022-present MongoDB, Inc. + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the Server Side Public License, version 1, + * as published by MongoDB, Inc. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * Server Side Public License for more details. + * + * You should have received a copy of the Server Side Public License + * along with this program. If not, see + * <http://www.mongodb.com/licensing/server-side-public-license>. + * + * As a special exception, the copyright holders give permission to link the + * code of portions of this program with the OpenSSL library under certain + * conditions as described in each individual source file and distribute + * linked combinations including the program with the OpenSSL library. You + * must comply with the Server Side Public License in all respects for + * all of the code used other than as permitted herein. If you modify file(s) + * with this exception, you may extend this exception to your version of the + * file(s), but you are not obligated to do so. If you do not wish to do so, + * delete this exception statement from your version. If you delete this + * exception statement from all source files in the program, then also delete + * it in the license file. + */ + +#define MONGO_LOGV2_DEFAULT_COMPONENT ::mongo::logv2::LogComponent::kQuery + +#include "mongo/db/change_streams_cluster_parameter.h" + +#include "mongo/base/status.h" +#include "mongo/db/change_streams_cluster_parameter_gen.h" +#include "mongo/logv2/log.h" +namespace mongo { + +Status validateChangeStreamsClusterParameter( + const ChangeStreamsClusterParameterStorage& clusterParameter) { + LOGV2_DEBUG(6594801, + 1, + "Validating change streams cluster parameter", + "enabled"_attr = clusterParameter.getEnabled(), + "expireAfterSeconds"_attr = clusterParameter.getExpireAfterSeconds()); + if (clusterParameter.getEnabled()) { + if (clusterParameter.getExpireAfterSeconds() <= 0) { + return Status(ErrorCodes::BadValue, + "Expected a positive integer for 'expireAfterSeconds' field if 'enabled' " + "field is true"); + } + } else { + if (clusterParameter.getExpireAfterSeconds() != 0) { + return Status( + ErrorCodes::BadValue, + "Expected a zero value for 'expireAfterSeconds' if 'enabled' field is false"); + } + } + return Status::OK(); +} + +} // namespace mongo diff --git a/src/mongo/db/change_streams_cluster_parameter.h b/src/mongo/db/change_streams_cluster_parameter.h new file mode 100644 index 00000000000..ebeedaa0e8b --- /dev/null +++ b/src/mongo/db/change_streams_cluster_parameter.h @@ -0,0 +1,42 @@ +/** + * Copyright (C) 2022-present MongoDB, Inc. + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the Server Side Public License, version 1, + * as published by MongoDB, Inc. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * Server Side Public License for more details. + * + * You should have received a copy of the Server Side Public License + * along with this program. If not, see + * <http://www.mongodb.com/licensing/server-side-public-license>. + * + * As a special exception, the copyright holders give permission to link the + * code of portions of this program with the OpenSSL library under certain + * conditions as described in each individual source file and distribute + * linked combinations including the program with the OpenSSL library. You + * must comply with the Server Side Public License in all respects for + * all of the code used other than as permitted herein. If you modify file(s) + * with this exception, you may extend this exception to your version of the + * file(s), but you are not obligated to do so. If you do not wish to do so, + * delete this exception statement from your version. If you delete this + * exception statement from all source files in the program, then also delete + * it in the license file. + */ + +#pragma once + +#include "mongo/base/status.h" +namespace mongo { + +class ChangeStreamsClusterParameterStorage; + +/** + * Validates 'changeStreams' cluster-wide parameter. + */ +Status validateChangeStreamsClusterParameter( + const ChangeStreamsClusterParameterStorage& clusterParameter); +} // namespace mongo diff --git a/src/mongo/db/change_streams_cluster_parameter.idl b/src/mongo/db/change_streams_cluster_parameter.idl new file mode 100644 index 00000000000..74563d47752 --- /dev/null +++ b/src/mongo/db/change_streams_cluster_parameter.idl @@ -0,0 +1,64 @@ +# Copyright (C) 2022-present MongoDB, Inc. +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the Server Side Public License, version 1, +# as published by MongoDB, Inc. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# Server Side Public License for more details. +# +# You should have received a copy of the Server Side Public License +# along with this program. If not, see +# <http://www.mongodb.com/licensing/server-side-public-license>. +# +# As a special exception, the copyright holders give permission to link the +# code of portions of this program with the OpenSSL library under certain +# conditions as described in each individual source file and distribute +# linked combinations including the program with the OpenSSL library. You +# must comply with the Server Side Public License in all respects for +# all of the code used other than as permitted herein. If you modify file(s) +# with this exception, you may extend this exception to your version of the +# file(s), but you are not obligated to do so. If you do not wish to do so, +# delete this exception statement from your version. If you delete this +# exception statement from all source files in the program, then also delete +# it in the license file. +# + +global: + cpp_namespace: "mongo" + cpp_includes: + - "mongo/db/change_streams_cluster_parameter.h" + +imports: + - "mongo/idl/basic_types.idl" + - "mongo/idl/cluster_server_parameter.idl" + +structs: + ChangeStreamsClusterParameterStorage: + description: "A specification for the 'changeStreams' cluster-wide configuration parameter + type." + inline_chained_structs: true + chained_structs: + ClusterServerParameter: clusterServerParameter + fields: + enabled: + description: "Enable or disable change streams." + type: bool + default: false + expireAfterSeconds: + description: "The number of seconds to retain the change events. This value will be a + non-zero positive value if the change stream is enabled and a zero value if the change + stream is disabled." + type: safeInt64 + default: 0 + +server_parameters: + changeStreams: + description: "The cluster-wide configuration parameter for the change stream in the serverless." + set_at: cluster + cpp_vartype: ChangeStreamsClusterParameterStorage + cpp_varname: gChangeStreamsClusterParameter + validator: + callback: validateChangeStreamsClusterParameter diff --git a/src/mongo/db/change_streams_cluster_parameter_test.cpp b/src/mongo/db/change_streams_cluster_parameter_test.cpp new file mode 100644 index 00000000000..80ef8d71da7 --- /dev/null +++ b/src/mongo/db/change_streams_cluster_parameter_test.cpp @@ -0,0 +1,78 @@ +/** + * Copyright (C) 2022-present MongoDB, Inc. + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the Server Side Public License, version 1, + * as published by MongoDB, Inc. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * Server Side Public License for more details. + * + * You should have received a copy of the Server Side Public License + * along with this program. If not, see + * <http://www.mongodb.com/licensing/server-side-public-license>. + * + * As a special exception, the copyright holders give permission to link the + * code of portions of this program with the OpenSSL library under certain + * conditions as described in each individual source file and distribute + * linked combinations including the program with the OpenSSL library. You + * must comply with the Server Side Public License in all respects for + * all of the code used other than as permitted herein. If you modify file(s) + * with this exception, you may extend this exception to your version of the + * file(s), but you are not obligated to do so. If you do not wish to do so, + * delete this exception statement from your version. If you delete this + * exception statement from all source files in the program, then also delete + * it in the license file. + */ + +#include "mongo/db/change_streams_cluster_parameter.h" +#include "mongo/db/change_streams_cluster_parameter_gen.h" +#include "mongo/unittest/unittest.h" + +namespace mongo { +namespace { + + +TEST(ValidateChangeStreamsClusterParameter, EnabledWithSuccess) { + ChangeStreamsClusterParameterStorage changeStreamClusterParam; + changeStreamClusterParam.setEnabled(true); + changeStreamClusterParam.setExpireAfterSeconds(3600); + auto result = validateChangeStreamsClusterParameter(changeStreamClusterParam); + ASSERT_TRUE(result.isOK()); +} + +TEST(ValidateChangeStreamsClusterParameter, EnabledWithNonPositiveExpireAfterSeconds) { + ChangeStreamsClusterParameterStorage changeStreamClusterParam; + changeStreamClusterParam.setEnabled(true); + changeStreamClusterParam.setExpireAfterSeconds(0); + auto resultZero = validateChangeStreamsClusterParameter(changeStreamClusterParam); + ASSERT_EQ(resultZero.code(), ErrorCodes::BadValue); + + changeStreamClusterParam.setExpireAfterSeconds(-1); + auto resultNegative = validateChangeStreamsClusterParameter(changeStreamClusterParam); + ASSERT_EQ(resultNegative.code(), ErrorCodes::BadValue); +} + +TEST(ValidateChangeStreamsClusterParameter, DisabledWithSuccess) { + ChangeStreamsClusterParameterStorage changeStreamClusterParam; + changeStreamClusterParam.setEnabled(false); + auto resultDefault = validateChangeStreamsClusterParameter(changeStreamClusterParam); + ASSERT_TRUE(resultDefault.isOK()); + + changeStreamClusterParam.setExpireAfterSeconds(0); + auto resultZero = validateChangeStreamsClusterParameter(changeStreamClusterParam); + ASSERT_TRUE(resultDefault.isOK()); +} + +TEST(ValidateChangeStreamsClusterParameter, DisabledWithNonZeroExpireAfterSeconds) { + ChangeStreamsClusterParameterStorage changeStreamClusterParam; + changeStreamClusterParam.setEnabled(false); + changeStreamClusterParam.setExpireAfterSeconds(1); + auto result = validateChangeStreamsClusterParameter(changeStreamClusterParam); + ASSERT_EQ(result.code(), ErrorCodes::BadValue); +} + +} // namespace +} // namespace mongo |