cosmos spring multi-tenant samples #663

TheovanKraay · 2023-02-24T18:44:54Z

Purpose

Adding samples for multi-tenancy in Spring Cosmos DB for database and container level isolation.

These are based on PRs for:

container level multi-tenancy: Azure/azure-sdk-for-java#33400
database level multi-tenancy: Azure/azure-sdk-for-java#32516

...

Does this introduce a breaking change?

[ ] Yes
[x] No

Pull Request Type

What kind of change does this Pull Request introduce?

[ ] Bugfix
[ ] Feature
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[ ] Documentation content changes
[x] Other... Please describe: code samples

How to Test

Get the code

git clone [repo-address]
cd [repo-name]
git checkout [branch-name]
npm install

Test the code

What to Check

Verify that the following are valid

...

Other Information

...nt-samples/tenant-by-container/src/main/java/com/azure/spring/data/cosmos/example/Order.java

.../tenant-by-container/src/main/java/com/azure/spring/data/cosmos/example/OrderController.java

...ant-samples/tenant-by-container/src/main/java/com/azure/spring/data/cosmos/example/User.java

...s/tenant-by-container/src/main/java/com/azure/spring/data/cosmos/example/UserController.java

...main/java/com/azure/spring/data/cosmos/example/tenant/MultiTenantContainerCosmosFactory.java

...mples/tenant-by-database/src/main/java/com/azure/spring/data/cosmos/example/Application.java

...es/tenant-by-database/src/main/java/com/azure/spring/data/cosmos/example/HomeController.java

...ant-samples/tenant-by-database/src/main/java/com/azure/spring/data/cosmos/example/Order.java

...s/tenant-by-database/src/main/java/com/azure/spring/data/cosmos/example/OrderController.java

...s/tenant-by-database/src/main/java/com/azure/spring/data/cosmos/example/OrderRepository.java

...nant-samples/tenant-by-database/src/main/java/com/azure/spring/data/cosmos/example/User.java

...es/tenant-by-database/src/main/java/com/azure/spring/data/cosmos/example/UserController.java

...es/tenant-by-database/src/main/java/com/azure/spring/data/cosmos/example/UserRepository.java

trande4884 · 2023-02-27T23:40:24Z

Should we move common files like those for User, Order and TenantStorage to a common directory that can be shared to reduce duplication? Or do we want each to be fully self-contained so we do not do that?

TheovanKraay · 2023-03-10T19:01:05Z

Should we move common files like those for User, Order and TenantStorage to a common directory that can be shared to reduce duplication? Or do we want each to be fully self-contained so we do not do that?

Just because this is a sample, prefer it to be a bit more contrived than usual.

chenrujun

I left some comments about the first sample. The comments can apply to both of the 2 samples. Please update the 2 samples according to my comments.

cosmos/azure-spring-data-cosmos/cosmos-multi-tenant-samples/tenant-by-container/pom.xml

cosmos/azure-spring-data-cosmos/cosmos-multi-tenant-samples/tenant-by-container/README.md

chenrujun · 2023-03-14T09:28:55Z

...nt-by-container/src/main/java/com/azure/spring/data/cosmos/example/tenant/TenantStorage.java

+        containers = database.readAllContainers();
+        String msg="Listing containers in tenants database:\n";
+        containers.byPage(100).flatMap(readAllContainersResponse -> {
+            logger.info("read {} containers(s) with request charge of {}", readAllContainersResponse.getResults().size(),readAllContainersResponse.getRequestCharge());


read -> Read.

...nt-by-container/src/main/java/com/azure/spring/data/cosmos/example/tenant/TenantStorage.java

...ant-by-database/src/main/java/com/azure/spring/data/cosmos/example/tenant/TenantStorage.java

...nt-by-container/src/main/java/com/azure/spring/data/cosmos/example/tenant/TenantStorage.java

...by-container/src/main/java/com/azure/spring/data/cosmos/example/tenant/WebConfiguration.java

chenrujun

I left some comments about the first sample. The comments can apply to both of the 2 samples. Please update the 2 samples according to my comments.

chenrujun · 2023-03-16T02:44:48Z

Hi, @TheovanKraay

container level multi-tenancy: Azure/azure-sdk-for-java#33400
database level multi-tenancy: Azure/azure-sdk-for-java#32516

Is it possible to demonstrate the 2 features by spring profile instead of 2 sample projects?
Here is an example: https://github.com/chenrujun/service-bus-dead-letter-queue-sample/blob/e2ab89fde4b6fce2dbb4163efc50a2a4c7d3a2a3/README.md#receive-message-by-jmslistener

TheovanKraay · 2023-03-16T13:31:05Z

Hi, @TheovanKraay

container level multi-tenancy: Azure/azure-sdk-for-java#33400
database level multi-tenancy: Azure/azure-sdk-for-java#32516

Is it possible to demonstrate the 2 features by spring profile instead of 2 sample projects? Here is an example: https://github.com/chenrujun/service-bus-dead-letter-queue-sample/blob/e2ab89fde4b6fce2dbb4163efc50a2a4c7d3a2a3/README.md#receive-message-by-jmslistener

Whilst I like the idea, can we keep it as it is for now? It will be a lot of effort to re-factor. Also, in practice, changing tenant isolation level also changes how you will architect the data model (e.g. co-locating types and different throughput settings etc), and I think one is likely to go one way or another for a given multi-tenant app, but not both. So, I am not sure real-world apps will have different profiles for different isolation levels using Cosmos. @trande4884 any thoughts on this?

TheovanKraay · 2023-03-16T13:31:29Z

I left some comments about the first sample. The comments can apply to both of the 2 samples. Please update the 2 samples according to my comments.

Ok, I will address them.

chenrujun · 2023-03-17T05:56:49Z

@TheovanKraay

Whilst I like the idea, can we keep it as it is for now? It will be a lot of effort to re-factor.

OK.

trande4884 · 2023-03-17T15:09:56Z

Hi, @TheovanKraay

container level multi-tenancy: Azure/azure-sdk-for-java#33400
database level multi-tenancy: Azure/azure-sdk-for-java#32516

Is it possible to demonstrate the 2 features by spring profile instead of 2 sample projects? Here is an example: https://github.com/chenrujun/service-bus-dead-letter-queue-sample/blob/e2ab89fde4b6fce2dbb4163efc50a2a4c7d3a2a3/README.md#receive-message-by-jmslistener

Whilst I like the idea, can we keep it as it is for now? It will be a lot of effort to re-factor. Also, in practice, changing tenant isolation level also changes how you will architect the data model (e.g. co-locating types and different throughput settings etc), and I think one is likely to go one way or another for a given multi-tenant app, but not both. So, I am not sure real-world apps will have different profiles for different isolation levels using Cosmos. @trande4884 any thoughts on this?

I agree to hold off on the Profile change. I think it could be discussed for a future PR if we want to go that route, but I have not seen any activity from our users on Profile usage so I'm not sure that is the best route to go in our samples. I also just like the standalone samples as they are very clear to the user as to what is needed.

…om/TheovanKraay/azure-spring-boot-samples into cosmos-spring-multi-tenant-samples

chenrujun · 2023-04-10T05:54:50Z

cosmos/azure-spring-data-cosmos/cosmos-multi-tenant-samples/multi-tenant-by-container/README.md

+1. The app uses environment variables `ACCOUNT_HOST` and `ACCOUNT_KEY`. Make sure these environment variables exist, and are set to your Azure Cosmos DB account `URI` and `PRIMARY KEY` respectively.
+
+## Run application
+1. git clone -b cosmos-spring-multi-tenant-samples https://github.com/TheovanKraay/azure-spring-boot-samples.git


Update this url

chenrujun · 2023-04-10T05:59:49Z

cosmos/azure-spring-data-cosmos/cosmos-multi-tenant-samples/multi-tenant-by-container/pom.xml

+        <dependency>
+            <groupId>com.azure</groupId>
+            <artifactId>azure-spring-data-cosmos</artifactId>
+            <version>LATEST</version>


Use property here.

chenrujun · 2023-04-10T06:59:31Z

cosmos/azure-spring-data-cosmos/cosmos-multi-tenant-samples/multi-tenant-by-container/pom.xml

+    <artifactId>multi-tenant-by-container</artifactId>
+    <version>1.0-SNAPSHOT</version>
+    <properties>
+        <azure.spring.data.cosmos.version>LATEST</azure.spring.data.cosmos.version>


Delete this property. Now the latest version is 3.33.0. And spring-cloud-azure-dependencies:4.7.0 already depends on azure-spring-data-cosmos:3.33.0.

chenrujun · 2023-04-10T07:04:53Z

...i-tenant-by-container/src/main/java/com/azure/spring/data/cosmos/example/HomeController.java

+
+    @GetMapping(path = "/all")
+    public @ResponseBody String getAllTenantUsersAndOrders() {
+        //because order and user types are co-located with same partition key, we can hit the container once for both


To make the sample as simple as possible, how about just using one repository instead of 2 repositorires (UserRepository and OrderRepository) in this sample? (I remember I mentioned this before.)

Although the structure of the entities themselves in the sample might justify this (because they are contrived and simple), in typical cases of co-locating the entities would probably need to be separate as they are too different. It is already a paradigm shift for user to consider co-locating, so prefer to keep this separate for now (same as reason for not using profiles). If we do anything, it will be to make the entities more complex in the future. But again, prefer to iterate on this (i.e. do this in subsequent PRs as the need arises).

chenrujun · 2023-04-10T07:06:28Z

...-tenant-by-container/src/main/java/com/azure/spring/data/cosmos/example/OrderRepository.java

+
+@Repository
+public interface OrderRepository extends CosmosRepository<Order, String> {
+    //get orders with custom query filtering by type since entities are co-located in same container


It will be easier if we do not bring co-located in this sample.

Can you expand on why? The practice of co-locating entities is important and useful for Cosmos DB. This is the first time we are introducing it for Spring Data, because it is the first time it has been feasible (and it is a by-product of multi-tenant support at container level). It is also a differentiating feature.

@chenrujun - it is important to talk about co-location here, since that's how multi-tenancy will be achieved here.

chenrujun · 2023-04-10T07:06:50Z

...i-tenant-by-container/src/main/java/com/azure/spring/data/cosmos/example/UserRepository.java

+    @Query(value = "SELECT c.id, c.firstName, c.lastName, c.orderDetail FROM c")
+    Slice<JsonNode> getOrdersAndUsers(Pageable pageable);
+
+    //get orders with custom query filtering by type since entities are co-located in same container


chenrujun · 2023-04-10T07:08:15Z

cosmos/azure-spring-data-cosmos/cosmos-multi-tenant-samples/multi-tenant-by-database/pom.xml

+         <dependency>
+            <groupId>com.azure</groupId>
+            <artifactId>azure-spring-data-cosmos</artifactId>
+             <version>LATEST</version>


chenrujun · 2023-04-10T07:08:23Z

cosmos/azure-spring-data-cosmos/cosmos-multi-tenant-samples/multi-tenant-by-database/pom.xml

+    <artifactId>multi-tenant-by-database</artifactId>
+    <version>1.0-SNAPSHOT</version>
+    <properties>
+        <azure.spring.data.cosmos.version>LATEST</azure.spring.data.cosmos.version>


chenrujun · 2023-04-10T07:09:45Z

...ant-by-database/src/main/java/com/azure/spring/data/cosmos/example/tenant/TenantStorage.java

+import java.util.concurrent.ConcurrentHashMap;
+
+@Component
+@PropertySource("classpath:application.yaml")


Delete this if it's not necessary.

kushagraThapar · 2023-04-17T19:10:30Z

...ulti-tenant-by-container/src/main/java/com/azure/spring/data/cosmos/example/Application.java

@@ -0,0 +1,11 @@
+package com.azure.spring.data.cosmos.example;


missing license header

kushagraThapar · 2023-04-17T19:10:40Z

...i-tenant-by-container/src/main/java/com/azure/spring/data/cosmos/example/HomeController.java

@@ -0,0 +1,30 @@
+package com.azure.spring.data.cosmos.example;


missing license header

kushagraThapar · 2023-04-17T19:10:54Z

...-tenant-by-container/src/main/java/com/azure/spring/data/cosmos/example/OrderController.java

@@ -0,0 +1,65 @@
+package com.azure.spring.data.cosmos.example;


missing license header

kushagraThapar · 2023-04-17T19:11:52Z

...-tenant-by-container/src/main/java/com/azure/spring/data/cosmos/example/OrderRepository.java

+
+@Repository
+public interface OrderRepository extends CosmosRepository<Order, String> {
+    //get orders with custom query filtering by type since entities are co-located in same container


@chenrujun - it is important to talk about co-location here, since that's how multi-tenancy will be achieved here.

kushagraThapar · 2023-04-17T19:12:07Z

...i-tenant-by-container/src/main/java/com/azure/spring/data/cosmos/example/UserController.java

@@ -0,0 +1,56 @@
+package com.azure.spring.data.cosmos.example;


missing license header

kushagraThapar · 2023-04-17T19:13:15Z

...i-tenant-by-database/src/main/java/com/azure/spring/data/cosmos/example/OrderController.java

@@ -0,0 +1,68 @@
+package com.azure.spring.data.cosmos.example;


missing license header

kushagraThapar · 2023-04-17T19:13:22Z

...ti-tenant-by-database/src/main/java/com/azure/spring/data/cosmos/example/UserController.java

@@ -0,0 +1,60 @@
+package com.azure.spring.data.cosmos.example;


missing license header

kushagraThapar · 2023-04-17T19:13:30Z

...by-database/src/main/java/com/azure/spring/data/cosmos/example/tenant/TenantInterceptor.java

@@ -0,0 +1,29 @@
+package com.azure.spring.data.cosmos.example.tenant;


missing license header

kushagraThapar · 2023-04-17T19:13:35Z

...ant-by-database/src/main/java/com/azure/spring/data/cosmos/example/tenant/TenantStorage.java

@@ -0,0 +1,82 @@
+package com.azure.spring.data.cosmos.example.tenant;


missing license header

kushagraThapar · 2023-04-17T19:13:42Z

...-by-database/src/main/java/com/azure/spring/data/cosmos/example/tenant/WebConfiguration.java

@@ -0,0 +1,19 @@
+package com.azure.spring.data.cosmos.example.tenant;


missing license header

Reviewed the PR, need to get this out. Other improvements will come up in follow up PR

kushagraThapar

LGTM, thanks @TheovanKraay
@chenrujun - thanks for the review. Since this needs to get out, (and you are on vacation), let's add further improvements in a follow up PR, thanks!

cosmos spring multi-tenant samples

a482886

TheovanKraay requested a review from a team as a code owner February 24, 2023 18:44