Skip to content

Open Source alternative to Algolia + Pinecone and an Easier-to-Use alternative to ElasticSearch ⚡ 🔍 ✨ Fast, typo tolerant, in-memory fuzzy Search Engine for building delightful search experiences

Make cors domains a separate parameter.

Kishore Nallanb502f5ddb8e8
diff --git a/include/cmdline.h b/include/cmdline.h
index cf8e3187..1a7fb32a 100644
--- a/include/cmdline.h
+++ b/include/cmdline.h
@@ -469,7 +469,9 @@ namespace cmdline{
errors.push_back("option needs value: --"+name);
continue;
}
- else{
+ else if(options[name]->is_boolean()) {
+ set_option(name, "true");
+ } else {
i++;
set_option(name, argv[i]);
}
@@ -519,7 +521,7 @@ namespace cmdline{
for (std::map<std::string, option_base*>::iterator p=options.begin();
p!=options.end(); p++)
- if (!p->second->valid())
+ if (p->second && !p->second->valid())
errors.push_back("need option: --"+std::string(p->first));
return errors.size()==0;
@@ -626,6 +628,7 @@ namespace cmdline{
virtual ~option_base(){}
virtual bool has_value() const=0;
+ virtual bool is_boolean() const=0;
virtual bool set()=0;
virtual bool set(const std::string &value)=0;
virtual bool has_set() const=0;
@@ -649,6 +652,8 @@ namespace cmdline{
bool has_value() const { return false; }
+ bool is_boolean() const { return true; }
+
bool set(){
has=true;
return true;
@@ -719,6 +724,12 @@ namespace cmdline{
}
bool set(const std::string &value){
+ if(is_boolean()) {
+ actual = (value == "" || value == "true");
+ has = true;
+ return true;
+ }
+
try{
actual=read(value);
has=true;
@@ -758,6 +769,10 @@ namespace cmdline{
return "--"+nam+"="+detail::readable_typename<T>();
}
+ bool is_boolean() const {
+ return std::is_same<T, bool>::value;
+ }
+
protected:
std::string full_description(const std::string &desc){
return
diff --git a/include/config.h b/include/config.h
index f3ac45e4..3ea0bbf4 100644
--- a/include/config.h
+++ b/include/config.h
@@ -56,7 +56,7 @@ protected:
this->api_address = "0.0.0.0";
this->api_port = 8108;
this->peering_port = 8107;
- this->enable_cors = false;
+ this->enable_cors = true;
this->max_memory_ratio = 1.0f;
this->snapshot_interval_seconds = 3600;
this->healthy_read_lag = 1000;
@@ -291,8 +291,12 @@ public:
this->ssl_certificate = get_env("TYPESENSE_SSL_CERTIFICATE");
this->ssl_certificate_key = get_env("TYPESENSE_SSL_CERTIFICATE_KEY");
- std::string cors_value = get_env("TYPESENSE_ENABLE_CORS");
- set_cors_parameters(cors_value);
+ std::string enable_cors_str = get_env("TYPESENSE_ENABLE_CORS");
+ StringUtils::toupper(enable_cors_str);
+ this->enable_cors = ("TRUE" == enable_cors_str || enable_cors_str.empty()) ? true : false;
+
+ std::string cors_domains_value = get_env("TYPESENSE_CORS_DOMAINS");
+ set_cors_domains(cors_domains_value);
if(!get_env("TYPESENSE_MAX_MEMORY_RATIO").empty()) {
this->max_memory_ratio = std::stof(get_env("TYPESENSE_MAX_MEMORY_RATIO"));
@@ -397,8 +401,14 @@ public:
}
if(reader.Exists("server", "enable-cors")) {
- std::string cors_value = reader.Get("server", "enable-cors", "false");
- set_cors_parameters(cors_value);
+ auto enable_cors_value = reader.Get("server", "enable-cors", "true");
+ StringUtils::tolowercase(enable_cors_value);
+ this->enable_cors = enable_cors_value == "true";
+ }
+
+ if(reader.Exists("server", "cors-domains")) {
+ std::string cors_value = reader.Get("server", "cors-domains", "");
+ set_cors_domains(cors_value);
}
if(reader.Exists("server", "peering-address")) {
@@ -501,8 +511,12 @@ public:
}
if(options.exist("enable-cors")) {
- std::string cors_value = options.get<std::string>("enable-cors");
- set_cors_parameters(cors_value);
+ this->enable_cors = options.get<bool>("enable-cors");
+ }
+
+ if(options.exist("cors-domains")) {
+ std::string cors_domains_value = options.get<std::string>("cors-domains");
+ set_cors_domains(cors_domains_value);
}
if(options.exist("peering-address")) {
@@ -558,15 +572,11 @@ public:
}
}
- void set_cors_parameters(std::string& cors_value) {
- StringUtils::tolowercase(cors_value);
- this->enable_cors = !(cors_value == "false");
-
- if(cors_value != "true" && cors_value != "false") {
- std::vector<std::string> cors_values;
- StringUtils::split(cors_value, cors_values, ",");
- cors_domains.insert(cors_values.begin(), cors_values.end());
- }
+ void set_cors_domains(std::string& cors_domains_value) {
+ std::vector<std::string> cors_values_vec;
+ StringUtils::split(cors_domains_value, cors_values_vec, ",");
+ cors_domains.clear();
+ cors_domains.insert(cors_values_vec.begin(), cors_values_vec.end());
}
// validation
diff --git a/src/typesense_server_utils.cpp b/src/typesense_server_utils.cpp
index 5d272ad3..2bfcde92 100644
--- a/src/typesense_server_utils.cpp
+++ b/src/typesense_server_utils.cpp
@@ -79,7 +79,8 @@ void init_cmdline_options(cmdline::parser & options, int argc, char **argv) {
options.add<std::string>("ssl-certificate-key", 'k', "Path to the SSL certificate key file.", false, "");
options.add<uint32_t>("ssl-refresh-interval-seconds", '\0', "Frequency of automatic reloading of SSL certs from disk.", false, 8 * 60 * 60);
- options.add<std::string>("enable-cors", '\0', "Enable CORS requests.", false, "true");
+ options.add<bool>("enable-cors", '\0', "Enable CORS requests.", false, true);
+ options.add<std::string>("cors-domains", '\0', "Comma separated list of domains that are allowed for CORS.", false, "");
options.add<float>("max-memory-ratio", '\0', "Maximum fraction of system memory to be used.", false, 1.0f);
options.add<int>("snapshot-interval-seconds", '\0', "Frequency of replication log snapshots.", false, 3600);
diff --git a/test/config_test.cpp b/test/config_test.cpp
index d266f149..c93e3aeb 100644
--- a/test/config_test.cpp
+++ b/test/config_test.cpp
@@ -43,6 +43,7 @@ TEST(ConfigTest, LoadCmdLineArguments) {
ASSERT_EQ("abcd", config.get_api_key());
ASSERT_EQ(8080, config.get_api_port());
ASSERT_EQ("/tmp/data", config.get_data_dir());
+ ASSERT_EQ(true, config.get_enable_cors());
}
TEST(ConfigTest, LoadEnvVars) {
@@ -93,7 +94,7 @@ TEST(ConfigTest, LoadConfigFile) {
ASSERT_EQ("1234", config.get_api_key());
ASSERT_EQ("/tmp/logs", config.get_log_dir());
ASSERT_EQ(9090, config.get_api_port());
- ASSERT_EQ(false, config.get_enable_cors());
+ ASSERT_EQ(true, config.get_enable_cors());
}
TEST(ConfigTest, LoadIncompleteConfigFile) {
@@ -142,6 +143,7 @@ TEST(ConfigTest, CmdLineArgsOverrideConfigFileAndEnvVars) {
"--data-dir=/tmp/data",
"--api-key=abcd",
"--listen-address=192.168.10.10",
+ "--cors-domains=http://localhost:8108",
std::string("--config=") + std::string(ROOT_DIR)+"test/valid_sparse_config.ini"
};
@@ -150,6 +152,7 @@ TEST(ConfigTest, CmdLineArgsOverrideConfigFileAndEnvVars) {
putenv((char*)"TYPESENSE_LISTEN_PORT=9090");
putenv((char*)"TYPESENSE_LISTEN_ADDRESS=127.0.0.1");
putenv((char*)"TYPESENSE_ENABLE_CORS=TRUE");
+ putenv((char*)"TYPESENSE_CORS_DOMAINS=http://localhost:7108");
std::vector<char*> argv = get_argv(args);
init_cmdline_options(options, argv.size() - 1, argv.data());
@@ -167,4 +170,43 @@ TEST(ConfigTest, CmdLineArgsOverrideConfigFileAndEnvVars) {
ASSERT_EQ(true, config.get_enable_cors());
ASSERT_EQ("192.168.10.10", config.get_api_address());
ASSERT_EQ("abcd", config.get_api_key()); // cli parameter overrides file config
+ ASSERT_EQ(1, config.get_cors_domains().size()); // cli parameter overrides file config
+ ASSERT_EQ("http://localhost:8108", *(config.get_cors_domains().begin()));
+}
+
+TEST(ConfigTest, CorsDefaults) {
+ cmdline::parser options;
+
+ std::vector<std::string> args = {
+ "./typesense-server",
+ "--data-dir=/tmp/data",
+ "--api-key=abcd",
+ "--listen-address=192.168.10.10",
+ std::string("--config=") + std::string(ROOT_DIR)+"test/valid_sparse_config.ini"
+ };
+
+ std::vector<char*> argv = get_argv(args);
+ init_cmdline_options(options, argv.size() - 1, argv.data());
+ options.parse(argv.size() - 1, argv.data());
+
+ ConfigImpl config;
+ config.load_config_cmd_args(options);
+
+ ASSERT_EQ(true, config.get_enable_cors());
+ ASSERT_EQ(0, config.get_cors_domains().size());
+
+ unsetenv("TYPESENSE_ENABLE_CORS");
+ unsetenv("TYPESENSE_CORS_DOMAINS");
+
+ ConfigImpl config2;
+ config2.load_config_env();
+
+ ASSERT_EQ(true, config2.get_enable_cors());
+ ASSERT_EQ(0, config2.get_cors_domains().size());
+
+ ConfigImpl config3;
+ config3.load_config_file(options);
+
+ ASSERT_EQ(true, config3.get_enable_cors());
+ ASSERT_EQ(1, config3.get_cors_domains().size());
}
diff --git a/test/valid_config.ini b/test/valid_config.ini
index 505bec16..7bf445d3 100644
--- a/test/valid_config.ini
+++ b/test/valid_config.ini
@@ -8,3 +8,4 @@ api-key = 1234
log-dir = /tmp/logs
listen-port = 9090
+enable-cors = True
\ No newline at end of file
diff --git a/test/valid_sparse_config.ini b/test/valid_sparse_config.ini
index 977c3bde..7d668572 100644
--- a/test/valid_sparse_config.ini
+++ b/test/valid_sparse_config.ini
@@ -3,3 +3,4 @@
[server]
api-key = supersecret
listen-address = localhost
+cors-domains = http://localhost:6108
\ No newline at end of file