fix: change permissions proto package so it doesn't clash with message (

#198)
momentohq · Aug 18, 2023 · 6c8ae5b · 6c8ae5b
1 parent ce843d6
commit 6c8ae5b
Show file tree

Hide file tree

Showing 10 changed files with 108 additions and 11 deletions.
diff --git a/javascript-web/generate_protos.sh b/javascript-web/generate_protos.sh
@@ -65,7 +65,7 @@ mkdir $out
 # So we do a terrible hack to comment out the package declaration before generating the JS types,
 # but add them back before generating the GRPC web bindings
 
-proto_file_list=" permissions.proto extensions.proto cacheclient.proto controlclient.proto auth.proto cacheping.proto cachepubsub.proto vectorindex.proto token.proto "
+proto_file_list=" permissionmessages.proto extensions.proto cacheclient.proto controlclient.proto auth.proto cacheping.proto cachepubsub.proto vectorindex.proto token.proto "
 
 echo "Backing up protos dir"
 cp -r ../proto ../proto.bak
@@ -74,7 +74,7 @@ echo "Commenting out package declarations"
 for f in $proto_file_list
 do
   $sed_command 's/^\s*package \(.*\)/\/\/package \1/g' ../proto/${f}
-  $sed_command 's/permissions.Permissions/Permissions/g' ../proto/${f}
+  $sed_command 's/permission_messages.Permissions/Permissions/g' ../proto/${f}
 done
 
 protoc -I=../proto -I=/usr/local/include \

diff --git a/javascript/generate_protos.sh b/javascript/generate_protos.sh
@@ -2,4 +2,4 @@
 set -e
 set -x
 
-PATH=node_modules/protoc-gen-ts/bin/:$PATH protoc -I=../proto -I=/usr/local/include --ts_out=src permissions.proto cacheclient.proto controlclient.proto cachepubsub.proto auth.proto cacheping.proto vectorindex.proto token.proto
+PATH=node_modules/protoc-gen-ts/bin/:$PATH protoc -I=../proto -I=/usr/local/include --ts_out=src permissionmessages.proto cacheclient.proto controlclient.proto cachepubsub.proto auth.proto cacheping.proto vectorindex.proto token.proto
diff --git a/kotlin-messages/kotlin/messages/generated-sources/descriptors/client_protos.dsc b/kotlin-messages/kotlin/messages/generated-sources/descriptors/client_protos.dsc
diff --git a/proto/auth.proto b/proto/auth.proto
@@ -1,6 +1,6 @@
 syntax = "proto3";
 
-import "permissions.proto";
+import "permissionmessages.proto";
 
 option go_package = "github.com/momentohq/client-sdk-go;client_sdk_go";
 option java_multiple_files = true;
@@ -73,7 +73,7 @@ message _GenerateApiTokenRequest {
 
     string auth_token = 3;
 
-    permissions.Permissions permissions = 4;
+    permission_messages.Permissions permissions = 4;
 }
 
 message _GenerateApiTokenResponse {

diff --git a/proto/permissionmessages.proto b/proto/permissionmessages.proto
@@ -0,0 +1,97 @@
+syntax = "proto3";
+
+option go_package = "github.com/momentohq/client-sdk-go;client_sdk_go";
+option java_multiple_files = true;
+option java_package = "grpc.permission_messages";
+
+package permission_messages;
+
+// Aliases for categories of functionality.
+enum CacheRole {
+  CachePermitNone = 0;
+  // Restricts access to apis that read and write data from caches: No higher level resource description or modification.
+  CacheReadWrite = 1;
+  // Restricts access to apis that read from caches: No higher level resource description or modification.
+  CacheReadOnly = 2;
+  // Restricts access to apis that write from caches: No higher level resource description or modification.
+  // Doesn't allow conditional write APIs (SetIfNotExists, IncreaseTTL etc)
+  CacheWriteOnly = 3;
+}
+
+// Aliases for categories of functionality.
+enum TopicRole {
+  TopicPermitNone = 0;
+  // Restricts access to apis that read and write data from topics: No higher level resource description or modification.
+  TopicReadWrite = 1;
+  // Restricts access to apis that read from topics: No higher level resource description or modification.
+  TopicReadOnly = 2;
+  // Restricts access to apis that write from topics: No higher level resource description or modification.
+  TopicWriteOnly = 3;
+}
+
+enum SuperUserPermissions {
+  SuperUser = 0;
+}
+
+message Permissions {
+  oneof kind {
+    SuperUserPermissions super_user = 1;
+    ExplicitPermissions explicit = 2;
+  }
+}
+
+message ExplicitPermissions {
+  repeated PermissionsType permissions = 1;
+}
+
+message PermissionsType {
+  oneof kind {
+    CachePermissions cache_permissions = 1;
+    TopicPermissions topic_permissions = 2;
+  }
+
+  message All {}
+
+  message CacheSelector {
+    oneof kind {
+      string cache_name = 1;
+    }
+  }
+
+  message CacheItemSelector {
+    oneof kind {
+      bytes key = 1;
+      bytes key_prefix = 2;
+    }
+  }
+
+  message CachePermissions {
+    CacheRole role = 1;
+    oneof cache {
+      All all_caches = 2;
+      CacheSelector cache_selector = 3;
+    }
+    oneof cache_item {
+      All all_items = 4;
+      CacheItemSelector item_selector = 5;
+    }
+  }
+
+  message TopicSelector {
+    oneof kind {
+      string topic_name = 1;
+    }
+  }
+
+  message TopicPermissions {
+    TopicRole role = 1;
+    oneof cache {
+      All all_caches = 2;
+      CacheSelector cache_selector = 3;
+    }
+    oneof topic {
+      All all_topics = 4;
+      TopicSelector topic_selector = 5;
+    }
+  }
+}
diff --git a/proto/permissions.proto → proto/shared/permissions.proto b/proto/permissions.proto → proto/shared/permissions.proto
diff --git a/proto/token.proto b/proto/token.proto
@@ -1,6 +1,6 @@
 syntax = "proto3";
 
-import "permissions.proto";
+import "permissionmessages.proto";
 
 option go_package = "github.com/momentohq/client-sdk-go;client_sdk_go";
 option java_multiple_files = true;
@@ -23,7 +23,7 @@ message _GenerateAuthAcornRequest {
 
   string auth_token = 2;
 
-  permissions.Permissions permissions = 3;
+  permission_messages.Permissions permissions = 3;
 }
 
 message _GenerateAuthAcornResponse {

diff --git a/python/run-protoc.sh b/python/run-protoc.sh
@@ -23,7 +23,7 @@ do
     if [[ $python_protobuf_version == "protobuf>4" ]]; then
         pyi_out="--pyi_out=$src_path"
     fi
-    poetry run python -m grpc_tools.protoc -I../proto --python_out=$src_path $pyi_out --grpc_python_out=$src_path permissions.proto extensions.proto cacheclient.proto controlclient.proto auth.proto cachepubsub.proto vectorindex.proto token.proto
+    poetry run python -m grpc_tools.protoc -I../proto --python_out=$src_path $pyi_out --grpc_python_out=$src_path permissionmessages.proto extensions.proto cacheclient.proto controlclient.proto auth.proto cachepubsub.proto vectorindex.proto token.proto
 
     # A shortcoming of the generated code is in the grpc generated code,
     # the protobuf imports are absolute instead of relative.

diff --git a/rust/momento-protos/src/lib.rs b/rust/momento-protos/src/lib.rs
@@ -1,5 +1,5 @@
-pub mod permissions {
-  include!("permissions.rs");
+pub mod permission_messages {
+  include!("permission_messages.rs");
 }
 
 pub mod auth {

diff --git a/rust/proto_generator/build.rs b/rust/proto_generator/build.rs
@@ -18,7 +18,7 @@ fn main() {
         .out_dir(out_dir)
         .compile(
             &[
-                format!("{proto_dir}/permissions.proto"),
+                format!("{proto_dir}/permissionmessages.proto"),
                 format!("{proto_dir}/auth.proto"),
                 format!("{proto_dir}/token.proto"),
                 format!("{proto_dir}/cacheclient.proto"),