feat: Add Cassandra/AstraDB online store contribution #2873

hemidactylus · 2022-06-28T09:51:40Z

This PR adds support for Cassandra/Astra DB online store for Feast.

What this PR does / why we need it:
Self-managed Cassandra clusters and Astra DB instances (based on Apache Cassandra) are a good fit to work as online features stores. This plugin makes it possible to do so within Feast.

Notes:

make test-python: all passed.
The documentation is up to date, with a README.md in the module dir and the relevant rst autodoc files.

codecov-commenter · 2022-06-28T20:17:07Z

Codecov Report

Merging #2873 (6cd1e90) into master (63d541d) will increase coverage by 9.02%.
The diff coverage is 11.01%.

@@            Coverage Diff             @@
##           master    #2873      +/-   ##
==========================================
+ Coverage   67.64%   76.67%   +9.02%     
==========================================
  Files         167      198      +31     
  Lines       14696    16344    +1648     
==========================================
+ Hits         9941    12531    +2590     
+ Misses       4755     3813     -942

Flag	Coverage Δ
integrationtests	`67.44% <18.18%> (-0.20%)`	⬇️
unittests	`58.61% <11.01%> (?)`

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
sdk/python/feast/cli.py	`41.69% <ø> (ø)`
sdk/python/feast/repo_config.py	`88.80% <ø> (+5.40%)`	⬆️
setup.py	`0.00% <0.00%> (ø)`
...b/cassandra_online_store/cassandra_online_store.py	`2.63% <2.63%> (ø)`
sdk/python/feast/file_utils.py	`40.00% <40.00%> (ø)`
.../feature_repos/universal/online_store/cassandra.py	`42.85% <42.85%> (ø)`
...ine_stores/contrib/cassandra_repo_configuration.py	`100.00% <100.00%> (ø)`
sdk/python/feast/repo_operations.py	`51.70% <100.00%> (+26.94%)`	⬆️
...s/contrib/trino_offline_store/tests/data_source.py	`17.64% <0.00%> (ø)`
...ffline_stores/contrib/trino_offline_store/trino.py	`8.72% <0.00%> (ø)`
... and 98 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

achals

Thanks for the PR @hemidactylus ! This generally looks good to me. one thing that I would add is to add the spec for how data is stored in C* or Astra here: https://github.com/feast-dev/feast/tree/master/docs/specs

Other than that, I think the main gap is in testing. What kind of support do you need there to get this over the line?

achals · 2022-06-30T20:26:18Z

sdk/python/feast/infra/online_stores/contrib/cassandra_online_store/cassandra_online_store.py

+            cache_key = statement
+            if cache_key not in self._prepared_statements:
+                logger.info(f"Preparing a {op_name} statement on {fqtable}.")
+                self._prepared_statements[cache_key] = session.prepare(statement)


Curious, what effect does preparing sessions have here?

Preparing statements means that the "shape" of the statement is exchanged once between client and DB servers and metadata info (schema, types) is cached on both sides under an ID to be re-used later any time the command is sent to the DB (read or write), reducing the parsing-time overhead basically. (See https://docs.datastax.com/en/developer/python-driver/3.25/getting_started/#prepared-statement if you are interested.)

achals · 2022-06-30T20:27:39Z

sdk/python/feast/infra/online_stores/contrib/cassandra_online_store/cassandra_online_store.py

+INSERT_CQL_5_TEMPLATE = (
+    "INSERT INTO {fqtable} (feature_name, "
+    "value, entity_key, event_ts, created_ts)"
+    " VALUES (?, ?, ?, ?, ?);"
+)
+


We're in the process of deprecating created_ts in other sources so I would be tempted to keep this out of the implementation for now if feasible..

All right, I'll be ignoring created_ts even if non-null passed within data to function online_write_batch.
In other words, I'll pretend created_ts is always None and go from there.

achals · 2022-06-30T20:29:55Z

sdk/python/feast/infra/online_stores/contrib/cassandra_online_store/cassandra_online_store.py

+        result: List[Tuple[Optional[datetime], Optional[Dict[str, ValueProto]]]] = []
+
+        for entity_key in entity_keys:
+            entity_key_bin = serialize_entity_key(entity_key).hex()


Just a heads up that there's a bug (#2345) in the implementation of this function right now that we're trying to fix (#2609).

same comment here

hemidactylus · 2022-07-07T22:11:21Z

I added the specifications for this online store in /docs/specs/online_store_format.md and polished a couple of things. The only missing part is testing. I'll try to reach out on the Feast slack about that. Thank you so much!

hemidactylus · 2022-07-11T07:22:52Z

The Cassandra plugin now is covered by the universal online-store tests with Dockerized local cassandra instance. (Thanks to the Feast team for precious guidance!)

adchia · 2022-07-11T13:54:07Z

you'll need to also sign your commits too!

achals · 2022-07-11T16:44:45Z

@hemidactylus thanks for your hard work! I'll be reviewing this today. But like @adchia mentioned do you mind signing your commits?

hemidactylus · 2022-07-13T14:06:24Z

Hello, I should have signed the commit. Thank you for your support and sorry for the inconvenience!

kevjumba

looks great! We still need to add some unit tests I think for the online read and write functionality. @hemidactylus Also, need to fix the integration tests.

sdk/python/feast/infra/online_stores/contrib/cassandra_online_store/cassandra_online_store.py

kevjumba · 2022-07-19T22:38:43Z

sdk/python/feast/infra/online_stores/contrib/cassandra_online_store/cassandra_online_store.py

+        self,
+        config: RepoConfig,
+        project: str,
+        table: FeatureView,


Would rather you name this featureView to prevent confusion

I am a bit reluctant to rename ths parameter other than table: it has this name on any other online store implementation, plus in several places in the test code there are invocations to the method that use table for keyword-arguments.
Wouldn't that break some tests (or worse) ?

kevjumba · 2022-07-19T22:56:37Z

sdk/python/feast/templates/cassandra/bootstrap.py

+    apply_cassandra_store_settings(config_file, settings)
+
+
+def replace_str_in_file(file_path, match_str, sub_str):


can you move these to utils so we can use them for other use cases too?

done (this led me to create a top-level "file_utils.py' module and touch several template-related modules as well).

achals

A few last nits, and a rebase is probably necessary (which may reformat all the python files), but after that I think we're ready to merge!

achals · 2022-07-13T16:19:53Z

sdk/python/tests/integration/feature_repos/universal/online_store/cassandra.py

+        keyspace_creation_command = (
+            "create KEYSPACE %s WITH replication = {'class': 'SimpleStrategy', 'replication_factor': 1};" % keyspace_name
+        )
+        self.container.exec('cqlsh -e "%s"' % keyspace_creation_command)


nit, we usually prefer f-strings in the codebase these days.

Sure, thank you for pointing out.

achals · 2022-07-21T04:51:22Z

sdk/python/feast/infra/online_stores/contrib/cassandra_online_store/cassandra_online_store.py

+        project = config.project
+        #
+        for entity_key, values, timestamp, created_ts in data:
+            entity_key_bin = serialize_entity_key(entity_key).hex()


Strongly recommend using entity_key_serialization_version=2 in serialize_entity_key.

Yep, I'm glad you noticed that!

achals · 2022-07-21T04:51:44Z

sdk/python/feast/infra/online_stores/contrib/cassandra_online_store/cassandra_online_store.py

+        result: List[Tuple[Optional[datetime], Optional[Dict[str, ValueProto]]]] = []
+
+        for entity_key in entity_keys:
+            entity_key_bin = serialize_entity_key(entity_key).hex()


same comment here

adchia · 2022-08-06T02:29:55Z

hey! wanted to double check here and make sure things were still going well?

hemidactylus · 2022-08-08T09:37:39Z

hey! wanted to double check here and make sure things were still going well?

Hello! I was OOTO for some time, sorry. I got back to working on this PR right now, thank you for the feedback!

kevjumba · 2022-08-08T17:31:15Z

@hemidactylus The PR looks pretty good but there is something about the way you setup the test environment that is causing the pr integration tests to hang. Could you please take a look at that?

hemidactylus · 2022-08-09T08:54:00Z

there is something about the way you setup the test environment that is causing the pr integration tests to hang. Could you please take a look at that?

Thank you for spotting that. Fixed now.
More generally, I am almost done adding dedicated test targets in the Makefile, it should all be done at that point.

* Refactor file-editing to a shared utils module * Use f-strings in the CassandraOnlineStoreCreator * Specify version 2 in serializing to make the entity key * Remove unnecessary empty comment lines * Rename proj to columns in _read_rows_by_entity_key * Introduce Cassandra-specific pytest targets * Adapt roadmaps and docs to cover/index Cassandra online store * Add license notes to code files Signed-off-by: Stefano Lottini <[email protected]>

Signed-off-by: Danny Chiao <[email protected]>

adchia

/lgtm

feast-ci-bot · 2022-08-09T16:21:19Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: achals, adchia, hemidactylus

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [achals,adchia]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

# [0.24.0](v0.23.0...v0.24.0) (2022-08-25) ### Bug Fixes * Check if on_demand_feature_views is an empty list rather than None for snowflake provider ([#3046](#3046)) ([9b05e65](9b05e65)) * FeatureStore.apply applies BatchFeatureView correctly ([#3098](#3098)) ([41be511](41be511)) * Fix Feast Java inconsistency with int64 serialization vs python ([#3031](#3031)) ([4bba787](4bba787)) * Fix feature service inference logic ([#3089](#3089)) ([4310ed7](4310ed7)) * Fix field mapping logic during feature inference ([#3067](#3067)) ([cdfa761](cdfa761)) * Fix incorrect on demand feature view diffing and improve Java tests ([#3074](#3074)) ([0702310](0702310)) * Fix Java helm charts to work with refactored logic. Fix FTS image ([#3105](#3105)) ([2b493e0](2b493e0)) * Fix on demand feature view output in feast plan + Web UI crash ([#3057](#3057)) ([bfae6ac](bfae6ac)) * Fix release workflow to release 0.24.0 ([#3138](#3138)) ([a69aaae](a69aaae)) * Fix Spark offline store type conversion to arrow ([#3071](#3071)) ([b26566d](b26566d)) * Fixing Web UI, which fails for the SQL registry ([#3028](#3028)) ([64603b6](64603b6)) * Force Snowflake Session to Timezone UTC ([#3083](#3083)) ([9f221e6](9f221e6)) * Make infer dummy entity join key idempotent ([#3115](#3115)) ([1f5b1e0](1f5b1e0)) * More explicit error messages ([#2708](#2708)) ([e4d7afd](e4d7afd)) * Parse inline data sources ([#3036](#3036)) ([c7ba370](c7ba370)) * Prevent overwriting existing file during `persist` ([#3088](#3088)) ([69af21f](69af21f)) * Register BatchFeatureView in feature repos correctly ([#3092](#3092)) ([b8e39ea](b8e39ea)) * Return an empty infra object from sql registry when it doesn't exist ([#3022](#3022)) ([8ba87d1](8ba87d1)) * Teardown tables for Snowflake Materialization testing ([#3106](#3106)) ([0a0c974](0a0c974)) * UI error when saved dataset is present in registry. ([#3124](#3124)) ([83cf753](83cf753)) * Update sql.py ([#3096](#3096)) ([2646a86](2646a86)) * Updated snowflake template ([#3130](#3130)) ([f0594e1](f0594e1)) ### Features * Add authentication option for snowflake connector ([#3039](#3039)) ([74c75f1](74c75f1)) * Add Cassandra/AstraDB online store contribution ([#2873](#2873)) ([feb6cb8](feb6cb8)) * Add Snowflake materialization engine ([#2948](#2948)) ([f3b522b](f3b522b)) * Adding saved dataset capabilities for Postgres ([#3070](#3070)) ([d3253c3](d3253c3)) * Allow passing repo config path via flag ([#3077](#3077)) ([0d2d951](0d2d951)) * Contrib azure provider with synapse/mssql offline store and Azure registry store ([#3072](#3072)) ([9f7e557](9f7e557)) * Custom Docker image for Bytewax batch materialization ([#3099](#3099)) ([cdd1b07](cdd1b07)) * Feast AWS Athena offline store (again) ([#3044](#3044)) ([989ce08](989ce08)) * Implement spark offline store `offline_write_batch` method ([#3076](#3076)) ([5b0cc87](5b0cc87)) * Initial Bytewax materialization engine ([#2974](#2974)) ([55c61f9](55c61f9)) * Refactor feature server helm charts to allow passing feature_store.yaml in environment variables ([#3113](#3113)) ([85ee789](85ee789))

feast-ci-bot added the size/XXL label Jun 28, 2022

hemidactylus marked this pull request as draft June 28, 2022 09:52

feast-ci-bot added the do-not-merge/work-in-progress label Jun 28, 2022

achals reviewed Jun 30, 2022

View reviewed changes

hemidactylus force-pushed the cassandra branch from 6e8528b to 99d0289 Compare July 7, 2022 22:06

hemidactylus force-pushed the cassandra branch 2 times, most recently from 29a8c0c to ce651b4 Compare July 11, 2022 07:19

hemidactylus requested a review from achals July 11, 2022 07:23

adchia marked this pull request as ready for review July 11, 2022 13:53

feast-ci-bot removed the do-not-merge/work-in-progress label Jul 11, 2022

achals self-assigned this Jul 11, 2022

hemidactylus force-pushed the cassandra branch from ce651b4 to 1022310 Compare July 13, 2022 14:03

hemidactylus force-pushed the cassandra branch from 1022310 to 5f4af9f Compare July 15, 2022 12:51

kevjumba added the ok-to-test label Jul 19, 2022

kevjumba reviewed Jul 19, 2022

View reviewed changes

achals approved these changes Jul 21, 2022

View reviewed changes

feast-ci-bot added the approved label Jul 21, 2022

hemidactylus force-pushed the cassandra branch from 5f4af9f to c6884ea Compare August 8, 2022 14:53

kevjumba added ok-to-test and removed ok-to-test labels Aug 8, 2022

hemidactylus force-pushed the cassandra branch from c6884ea to 02ac46e Compare August 9, 2022 12:25

adchia added 2 commits August 9, 2022 11:51

remove from main CI path and update entity key serialization in template

4c18d45

Signed-off-by: Danny Chiao <[email protected]>

revert makefile change

6cd1e90

Signed-off-by: Danny Chiao <[email protected]>

adchia approved these changes Aug 9, 2022

View reviewed changes

feast-ci-bot assigned adchia Aug 9, 2022

feast-ci-bot added the lgtm label Aug 9, 2022

feast-ci-bot merged commit feb6cb8 into feast-dev:master Aug 9, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Add Cassandra/AstraDB online store contribution #2873

feat: Add Cassandra/AstraDB online store contribution #2873

hemidactylus commented Jun 28, 2022 •

edited by adchia

Loading

codecov-commenter commented Jun 28, 2022 •

edited

Loading

achals left a comment

achals Jun 30, 2022

hemidactylus Jul 6, 2022

achals Jun 30, 2022

hemidactylus Jul 6, 2022

achals Jun 30, 2022

achals Jul 21, 2022

hemidactylus commented Jul 7, 2022

hemidactylus commented Jul 11, 2022

adchia commented Jul 11, 2022

achals commented Jul 11, 2022

hemidactylus commented Jul 13, 2022

kevjumba left a comment •

edited

Loading

kevjumba Jul 19, 2022

hemidactylus Aug 8, 2022

kevjumba Jul 19, 2022

hemidactylus Aug 8, 2022

achals left a comment

achals Jul 13, 2022

hemidactylus Aug 8, 2022

achals Jul 21, 2022

hemidactylus Aug 8, 2022

achals Jul 21, 2022

adchia commented Aug 6, 2022

hemidactylus commented Aug 8, 2022

kevjumba commented Aug 8, 2022

hemidactylus commented Aug 9, 2022

adchia left a comment

feast-ci-bot commented Aug 9, 2022

		apply_cassandra_store_settings(config_file, settings)


		def replace_str_in_file(file_path, match_str, sub_str):

feat: Add Cassandra/AstraDB online store contribution #2873

feat: Add Cassandra/AstraDB online store contribution #2873

Conversation

hemidactylus commented Jun 28, 2022 • edited by adchia Loading

codecov-commenter commented Jun 28, 2022 • edited Loading

Codecov Report

achals left a 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

hemidactylus commented Jul 7, 2022

hemidactylus commented Jul 11, 2022

adchia commented Jul 11, 2022

achals commented Jul 11, 2022

hemidactylus commented Jul 13, 2022

kevjumba left a comment • 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

achals left a 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

adchia commented Aug 6, 2022

hemidactylus commented Aug 8, 2022

kevjumba commented Aug 8, 2022

hemidactylus commented Aug 9, 2022

adchia left a comment

Choose a reason for hiding this comment

feast-ci-bot commented Aug 9, 2022

hemidactylus commented Jun 28, 2022 •

edited by adchia

Loading

codecov-commenter commented Jun 28, 2022 •

edited

Loading

kevjumba left a comment •

edited

Loading