Merge pull request #85 from kbase/dev-add_retryWirtes

add retryWrites

Author: Xiangs18

RELEASE_NOTES.md

@@ -1,5 +1,11 @@
 KBase Feeds Service
 
+### Version 1.0.3
+* The MongoDB clients have been updated to the most recent version.
+* Added the mongo-retrywrites configuration setting in deployment.cfg.templ, defaulting to false.
+* Migrated from Travis CI to GitHub Actions workflows.
+* Updated Python version to 3.7.13.
+
 ### Version 1.0.2
 - Add a cache for bad tokens so they aren't looked up over and over. Maxes out at 10000, then throws out the oldest bad token.
 

deployment/conf/.templates/deploy.cfg.templ

@@ -11,6 +11,7 @@ db-host = {{ default .Env.db_host "ci-mongo" }}
 db-port = {{ default .Env.db_port "27017" }}
 db-user = {{ default .Env.db_user "feedsserv" }}
 db-pw = {{ default .Env.db_pw "fake_password" }}
+db-retrywrites={{ default .Env.db_retrywrites "false" }}
 
 # admins are allowed to use their auth tokens to create global notifications.
 # examples would be notices about KBase downtime or events.

deployment/deploy.cfg.example

@@ -12,6 +12,10 @@ db-port=6379
 db-user=
 db-pw=
 
+# Whether to enable ('true') the MongoDB retryWrites parameter or not (anything other than 'true').
+# See https://www.mongodb.com/docs/manual/core/retryable-writes/
+db-retrywrites=false
+
 # Service urls
 auth-url=https://ci.kbase.us/services/auth
 workspace-url=https://ci.kbase.us/services/ws

feeds/config.py

@@ -15,6 +15,7 @@
 KEY_DB_PW = "db-pw"
 KEY_DB_NAME = "db-name"
 KEY_DB_ENGINE = "db-engine"
+KEY_DB_RETRYWRITES = "db-retrywrites"
 KEY_GLOBAL_FEED = "global-feed"
 KEY_DEBUG = "debug"
 KEY_LIFESPAN = "lifespan"
@@ -60,6 +61,7 @@ def __init__(self):
         self.db_user = self._get_line(cfg, KEY_DB_USER, required=False)
         self.db_pw = self._get_line(cfg, KEY_DB_PW, required=False)
         self.db_name = self._get_line(cfg, KEY_DB_NAME, required=False)
+        self.db_retrywrites = self._get_line(cfg, KEY_DB_RETRYWRITES, required=False) == "true"
         self.global_feed = self._get_line(cfg, KEY_GLOBAL_FEED)
         self.global_feed_type = "user"  # doesn't matter, need a valid Entity type...
         try:

feeds/server.py

@@ -33,7 +33,7 @@
     log_error
 )
 
-VERSION = "1.0.2"
+VERSION = "1.0.3"
 
 try:
     from feeds import gitcommit

feeds/storage/mongodb/connection.py

@@ -99,8 +99,9 @@ def __init__(self):
             port=self.cfg.db_port,
             username=self.cfg.db_user,
             password=self.cfg.db_pw,
+            retryWrites=self.cfg.db_retrywrites,
             authSource=self.cfg.db_name
-            )
+        )
         self.db = self.conn[self.cfg.db_name]
         self._setup_indexes()
         self._setup_schema()

test/test.cfg

@@ -20,6 +20,10 @@ service-narrative=narrativeservice
 service-jobs=jobsservice
 service-kbase=kbase
 
+# Whether to enable ('true') the MongoDB retryWrites parameter or not (anything other than 'true').
+# See https://www.mongodb.com/docs/manual/core/retryable-writes/
+db-retrywrites=false
+
 [test]
 mongo-exe=/usr/local/bin/mongod
 test-temp-dir=./test-temp-dir

test/test_config.py

@@ -15,6 +15,7 @@
     'db-engine=redis',
     'db-host=foo',
     'db-port=5',
+    'db-retrywrites=false',
     'auth-url=baz',
     'njs-url=njs',
     'workspace-url=ws',
@@ -69,7 +70,7 @@ def test_config_bad_port(dummy_config, dummy_auth_token, bad_val):
 @pytest.mark.parametrize("bad_val", [("foo"), (-100), (0), (0.5)])
 def test_config_bad_lifespan(dummy_config, dummy_auth_token, bad_val):
     cfg_text = GOOD_CONFIG.copy()
-    cfg_text[10] = "lifespan=wrong"
+    cfg_text[11] = "lifespan=wrong"
     cfg_path = dummy_config(cfg_text)
     feeds_config_backup = os.environ.get('FEEDS_CONFIG')
     os.environ['FEEDS_CONFIG'] = cfg_path
@@ -84,7 +85,7 @@ def test_config_bad_lifespan(dummy_config, dummy_auth_token, bad_val):
 @pytest.mark.parametrize("bad_val", [("foo"), (-100), (0), (0.5)])
 def test_config_bad_note_count(dummy_config, dummy_auth_token, bad_val):
     cfg_text = GOOD_CONFIG.copy()
-    cfg_text[11] = "default-note-count={}".format(bad_val)
+    cfg_text[12] = "default-note-count={}".format(bad_val)
     cfg_path = dummy_config(cfg_text)
     feeds_config_backup = os.environ.get('FEEDS_CONFIG')
     os.environ['FEEDS_CONFIG'] = cfg_path
@@ -221,6 +222,29 @@ def test_get_config(dummy_config, dummy_auth_token):
     cfg = config.get_config()
     assert cfg.db_host == 'foo'
     assert cfg.db_port == 5
+    assert cfg.db_retrywrites == False
+    assert cfg.auth_url == 'baz'
+    assert cfg.auth_token == FAKE_AUTH_TOKEN
+    del os.environ['FEEDS_CONFIG']
+    if path_backup is not None:
+        os.environ['FEEDS_CONFIG'] = path_backup
+    config.__config = None
+
+
+def test_config_retryWrites_is_true(dummy_config, dummy_auth_token):
+    # set db-retrywrites=true
+    cfg_text = GOOD_CONFIG.copy()
+    cfg_text[4] = 'db-retrywrites=true'
+    cfg_path = dummy_config(cfg_text)
+
+    path_backup = os.environ.get('FEEDS_CONFIG')
+    os.environ['FEEDS_CONFIG'] = cfg_path
+    config.__config = None
+
+    cfg = config.get_config()
+    assert cfg.db_host == 'foo'
+    assert cfg.db_port == 5
+    assert cfg.db_retrywrites == True
     assert cfg.auth_url == 'baz'
     assert cfg.auth_token == FAKE_AUTH_TOKEN
     del os.environ['FEEDS_CONFIG']