Abstract database calls from direct listener handlers #206

rranjan3 · 2020-01-16T13:56:21Z

Abstract out calls using database/table names in handlers for direct
mode listener. The segregated layer may contain some logic if it has
to deal only with lower/database calls for it. Hence abstracting some
deatils from the layer above. This thin layer can also be used in the
Proxy mode of operations.

Signed-off-by: Rajeev Ranjan [email protected]

danintel

Approved with minor corrections and a question.

examples/common/python/connectors/direct/tcs_listener/tcs_workorder_receipt_handler.py

danintel · 2020-01-16T16:53:50Z

examples/common/python/connectors/common/db_helper/work_order_lmdb_helper.py

+                if (self.kv_helper.get("wo-receipts", wo_id) is not None):
+                    self.kv_helper.remove("wo-receipts", wo_id)
+
+                # TODO: uncomment after fixing lmbd error


Is this comment still needed?

Need to check the intent with initial committer. [email protected]

I guess this is not required any more. @Ram-srini ?

danintel · 2020-01-16T17:03:07Z

examples/common/python/connectors/common/db_helper/workorder_receipt_lmdb_helper.py

+                if update_to_receipt["updaterId"] != updater_id:
+                    raise JSONRPCDispatchException(
+                        JRPCErrorCodes.INVALID_PARAMETER_FORMAT_OR_VALUE,
+                        "Update index and updater id doesn't match"


s/match/match./

danintel · 2020-01-16T17:03:19Z

examples/common/python/connectors/common/db_helper/workorder_receipt_lmdb_helper.py

+        else:
+            raise JSONRPCDispatchException(
+                JRPCErrorCodes.INVALID_PARAMETER_FORMAT_OR_VALUE,
+                "There is no updates available to this receipt"


s/receipt/receipt./

manojgop · 2020-01-17T06:47:52Z

examples/common/python/connectors/common/db_helper/__init__.py

@@ -0,0 +1,15 @@
+# Copyright 2020 Intel Corporation


Please move db_helper to examples/common/python.

This helper module is assisting on the connector components(direct & proxy). Hence I have made it a module common to only both the type of connectors.

manojgop · 2020-01-17T06:48:44Z

examples/common/python/connectors/common/db_helper/work_order_lmdb_helper.py

+logger = logging.getLogger(__name__)
+
+
+class WorkOrderLmdbHelper:


WorkOrderLmdbHelper -> WorkOrderKVHelper
work_order_lmdb_helper.py -> work_order_kv_helper.py

For all the name changes - I have deliberately named them as lmdb helper as I expect similar layers for other kind of databases that would handle the low level database calls.

manojgop · 2020-01-17T06:50:52Z

examples/common/python/connectors/common/db_helper/work_order_lmdb_helper.py

+# ---------------------------------------------------------------------------------------------
+    def submit_wo(self, wo_id, input_json_str):
+        """
+        Function to submit a new work-order


Function to submit and store a new work-order to db

manojgop · 2020-01-17T06:51:33Z

examples/common/python/connectors/common/db_helper/work_order_lmdb_helper.py

+        """
+        Function to perform init activity
+        Parameters:
+            - kv_helper is a object of lmdb database


kv_helper is a object of shared kv database

manojgop · 2020-01-17T06:51:55Z

examples/common/python/connectors/common/db_helper/work_order_lmdb_helper.py

+# ---------------------------------------------------------------------------------------------
+    def get_wo_result(self, wo_id):
+        """
+        Function to get work-order result from lmdb


Function to get work-order result from shared kv database

manojgop · 2020-01-17T06:57:11Z

examples/common/python/connectors/common/db_helper/worker_encryption_key_lmdb_helper.py

+logger = logging.getLogger(__name__)
+
+
+class WorkerEncryptionKeyLmdbHelper:


WorkerEncryptionKeyLmdbHelper -> WorkerEncryptionKeyDbHelper

manojgop · 2020-01-17T06:58:44Z

examples/common/python/connectors/common/db_helper/worker_encryption_key_lmdb_helper.py

+    """
+    WorkerEncryptionKeyDBHelper helps listener or other client
+    facing modules to interact with the kv storage for queries
+    related to encryption key. It implements all low level db


I don't see any encryption key being passed as query parameter in below functions ?

This is a place holder module where functions can be added later on. This module would also abstract any database helper calls from the module above.

manojgop · 2020-01-17T06:59:06Z

examples/common/python/connectors/common/db_helper/worker_registry_lmdb_helper.py

+logger = logging.getLogger(__name__)
+
+
+class WorkerRegistryLmdbHelper:


WorkerRegistryLmdbHelper -> WorkerRegistryDbHelper

manojgop · 2020-01-17T08:15:56Z

examples/common/python/connectors/common/db_helper/workorder_receipt_lmdb_helper.py

+logger = logging.getLogger(__name__)
+
+
+class WorkOrderReceiptLmdbHelper:


WorkOrderReceiptLmdbHelper -> WorkOrderReceiptDbHelper

manojgop · 2020-01-17T08:16:53Z

examples/common/python/connectors/direct/tcs_listener/tcs_work_order_handler.py

@@ -1,4 +1,4 @@
-# Copyright 2019 Intel Corporation
+# Copyright 2020 Intel Corporation


Makes sense. Updated.

Ram-srini · 2020-01-27T09:13:01Z

common/python/connectors/common/db_helper/work_order_lmdb_helper.py

+
+    def clear_a_processed_wo(self):
+        """
+        Function that clears one processed work-order from


Update the comment that it will remove the least recently added entry from processed table.

Ram-srini · 2020-01-27T09:22:01Z

common/python/connectors/common/db_helper/work_order_lmdb_helper.py

@@ -0,0 +1,164 @@
+# Copyright 2020 Intel Corporation


Where should we move this db helper modules? In common/python/database module?

Abstract out calls using database/table names in handlers for direct mode listener. The segregated layer may contain some logic if it has to deal only with lower/database calls for it. Hence abstracting some deatils from the layer above. This thin layer can also be used in the Proxy mode of operations. Signed-off-by: Rajeev Ranjan <[email protected]>

rranjan3 requested review from danintel, dcmiddle, EugeneYYY, manju956, manojgop, pankajgoyal2, Ram-srini and TomBarnes as code owners January 16, 2020 13:56

rranjan3 force-pushed the kv-segregation branch from 57e2736 to 2e2bde7 Compare January 16, 2020 13:58

danintel assigned rranjan3 Jan 16, 2020

danintel approved these changes Jan 16, 2020

View reviewed changes

rranjan3 force-pushed the kv-segregation branch from 2e2bde7 to 25cc026 Compare January 16, 2020 17:28

manojgop suggested changes Jan 17, 2020

View reviewed changes

rranjan3 force-pushed the kv-segregation branch from 25cc026 to 094abae Compare January 27, 2020 06:03

Ram-srini reviewed Jan 27, 2020

View reviewed changes

rranjan3 force-pushed the kv-segregation branch from 094abae to f02efdd Compare January 27, 2020 09:35

rranjan3 force-pushed the kv-segregation branch from f02efdd to 40c2959 Compare February 18, 2020 15:15

rranjan3 force-pushed the kv-segregation branch from 40c2959 to a372793 Compare February 18, 2020 19:07

rranjan3 requested review from karthikamurthy and SriharshaSubbakrishna as code owners January 26, 2022 23:05

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Abstract database calls from direct listener handlers #206

Abstract database calls from direct listener handlers #206

rranjan3 commented Jan 16, 2020

danintel left a comment

danintel Jan 16, 2020

rranjan3 Jan 16, 2020 •

edited

Loading

manojgop Jan 17, 2020

danintel Jan 16, 2020

rranjan3 Jan 27, 2020

danintel Jan 16, 2020

rranjan3 Jan 27, 2020

manojgop Jan 17, 2020

rranjan3 Jan 27, 2020

manojgop Jan 17, 2020

rranjan3 Jan 27, 2020

manojgop Jan 17, 2020

rranjan3 Jan 27, 2020

manojgop Jan 17, 2020

rranjan3 Jan 27, 2020

manojgop Jan 17, 2020

rranjan3 Jan 27, 2020

manojgop Jan 17, 2020

manojgop Jan 17, 2020

rranjan3 Jan 27, 2020

manojgop Jan 17, 2020

manojgop Jan 17, 2020

manojgop Jan 17, 2020

rranjan3 Jan 27, 2020

Ram-srini Jan 27, 2020

rranjan3 Jan 27, 2020

Ram-srini Jan 27, 2020

		logger = logging.getLogger(__name__)


		class WorkOrderLmdbHelper:

		logger = logging.getLogger(__name__)


		class WorkerEncryptionKeyLmdbHelper:

		logger = logging.getLogger(__name__)


		class WorkerRegistryLmdbHelper:

		logger = logging.getLogger(__name__)


		class WorkOrderReceiptLmdbHelper:

		@@ -1,4 +1,4 @@
		# Copyright 2019 Intel Corporation
		# Copyright 2020 Intel Corporation

Abstract database calls from direct listener handlers #206

Are you sure you want to change the base?

Abstract database calls from direct listener handlers #206

Conversation

rranjan3 commented Jan 16, 2020

danintel left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rranjan3 Jan 16, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rranjan3 Jan 16, 2020 •

edited

Loading