Move keyspace translations to public functions in query files#1130
Merged
davidebriani merged 1 commit intoastarte-platform:release-1.2from Mar 11, 2025
Merged
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## release-1.2 #1130 +/- ##
===============================================
- Coverage 70.73% 68.78% -1.96%
===============================================
Files 176 327 +151
Lines 5184 7505 +2321
===============================================
+ Hits 3667 5162 +1495
- Misses 1517 2343 +826 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
eddbbt
force-pushed
the
keyspace_translation_rationalize
branch
from
59b4dbe to
28dca1b
Compare
noaccOS
reviewed
Mar 10, 2025
| keyspace_name = | ||
| CQLUtils.realm_name_to_keyspace_name(realm_name, Config.astarte_instance_id!()) | ||
|
|
||
| with {:valid, true} <- {:valid, Realm.valid_name?(realm_name)}, |
Collaborator
There was a problem hiding this comment.
this makes me think: are we actually not checking for valid realm names anymore? Are we allowing the user to query on the system keyspace?
Contributor
Author
There was a problem hiding this comment.
This is actually a good point, let me fix this asap
| astarte_keyspace = Realm.keyspace_name("astarte") | ||
|
|
||
| case Queries.check_astarte_health(astarte_keyspace, :quorum) do | ||
| # TODO shall we check for an encoded astarte realm or it's fine to use the generic "astarte one"? |
Collaborator
There was a problem hiding this comment.
astarte is fine, as we're checking for astarte's health. Astarte is healthy even if there are no installed realms, but it needs the astarte realm to function
eddbbt
force-pushed
the
keyspace_translation_rationalize
branch
2 times, most recently
from
727eed5 to
79e5575
Compare
eddbbt
force-pushed
the
keyspace_translation_rationalize
branch
5 times, most recently
from
2ec918d to
9cc4b92
Compare
noaccOS
reviewed
Mar 11, 2025
Comment on lines
+33
to
+38
| def keyspace_name("astarte") do | ||
| CQLUtils.realm_name_to_keyspace_name("astarte", Config.astarte_instance_id!()) | ||
| end | ||
|
|
||
| def keyspace_name(realm_name) do | ||
| CQLUtils.realm_name_to_keyspace_name(realm_name, Config.astarte_instance_id!()) | ||
| keyspace = CQLUtils.realm_name_to_keyspace_name(realm_name, Config.astarte_instance_id!()) | ||
|
|
||
| with {:valid, true} <- {:valid, Realm.valid_name?(keyspace)} do | ||
| keyspace | ||
| end |
Collaborator
There was a problem hiding this comment.
This is a bit all over the place:
- the spec says the return type is a string, but it now is
String.t() | {:valid, false}. I suggest we either change this function to a{:ok, keyspace_name} | {:error, :invalid_realm_name}or crash instead. "astarte"is not a valid realm name, and as such you declared its own body to make sure calls to it still succeed. We do not want users querying on theastartekeyspace, I suggest we make another ad-hoc function used only for the queries actually requiring the astarte keyspace, something likeRealm.astarte_keyspace_name()
eddbbt
force-pushed
the
keyspace_translation_rationalize
branch
3 times, most recently
from
b072c43 to
8f685c2
Compare
eddbbt
force-pushed
the
keyspace_translation_rationalize
branch
from
8f685c2 to
d3ebd3d
Compare
Signed-off-by: Eddy Babetto <eddy.babetto@secomind.com>
eddbbt
force-pushed
the
keyspace_translation_rationalize
branch
from
d3ebd3d to
db3982f
Compare
davidebriani
approved these changes
Mar 11, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fix astarte keyspace encoding, check and fix for functions that used to require a plain or encoded realm name in order to generally have:
def functions -> accepts plain realm name, encode into keyspace and then use that
defp -> accepts only keyspaces
There are actually one or two occurrences that require a rework to match the above case(s), but this would affect the entire application logic (maybe in another PR?)