Remove sharding references (#558)

beesaferoot · web-flow · commit f325a93891cb · 2025-03-12T18:02:45.000+01:00
* Replace Sharding references with Tenant

* Refactor meter association logic in transaction services

* Update documentation to clarify multitenancy approach in Micropower Manager

* Rename Tenant namespace to TenantResolver
diff --git a/docs/development/multitenancy.md b/docs/development/multitenancy.md
@@ -8,11 +8,9 @@ order: 4
 > MPM's multitenancy feature was sometimes called **sharding** (and the corresponding databases **shards**).
 > We are moving away from this notion in favour of **multitenancy** and **tenants**.
 
-## Sharding in Micropower Manager
+## Multitenancy in Micropower Manager
 
-Sharding is a technique employed to partition a large database into smaller, more agile, and easily manageable segments
-known as data shards. In the context of Micropower Manager, sharding is integral to the implementation of Software as a
-Service (SaaS) functionality.
+Multitenancy in Micropower Manager is implemented using a database-per-tenant approach, where each tenant has a dedicated database. This ensures data isolation, enhances security, and allows for more flexible scaling. By storing each tenant's data in a separate database, Micropower Manager enables efficient management of Software as a Service (SaaS) functionality while maintaining performance and customization per tenant.
 
 ### Tenant Representation
 
diff --git a/src/backend/app/Console/Commands/AbstractSharedCommand.php b/src/backend/app/Console/Commands/AbstractSharedCommand.php
@@ -40,13 +40,13 @@ protected function execute(InputInterface $input, OutputInterface $output) {
         if ($companyId) {
             $this->runForCompany($databaseProxyManagerService, (int) $companyId, $input, $output);
         } else {
-            $this->runForAllShards($databaseProxyManagerService, $input, $output);
+            $this->runForAllTenants($databaseProxyManagerService, $input, $output);
         }
 
         return $this->EXECUTION_TYPE;
     }
 
-    private function runForAllShards(
+    private function runForAllTenants(
         DatabaseProxyManagerService $databaseProxyManagerService,
         InputInterface $input,
         OutputInterface $output,
diff --git a/src/backend/app/Http/Middleware/UserDefaultDatabaseConnectionMiddleware.php b/src/backend/app/Http/Middleware/UserDefaultDatabaseConnectionMiddleware.php
@@ -10,8 +10,8 @@
 use Illuminate\Support\Facades\Log;
 use Illuminate\Support\Str;
 use MPM\DatabaseProxy\DatabaseProxyManagerService;
-use MPM\Sharding\ApiCompanyResolverService;
-use MPM\Sharding\ApiResolvers\Data\ApiResolverMap;
+use MPM\TenantResolver\ApiCompanyResolverService;
+use MPM\TenantResolver\ApiResolvers\Data\ApiResolverMap;
 
 /**
  * The goal is to have the database connection on each incomming http request.
diff --git a/src/backend/app/Misc/TransactionDataContainer.php b/src/backend/app/Misc/TransactionDataContainer.php
@@ -39,7 +39,8 @@ public static function initialize(Transaction $transaction): TransactionDataCont
         $container->amount = $transaction->amount;
         $container->rawAmount = $transaction->amount;
 
-        $container->meter = $transaction->meter()->first();
+        $meter = Meter::where('serial_number', $transaction->message)->first();
+        $container->meter = $meter;
 
         try {
             $container->device = $deviceService->getBySerialNumber($transaction->message);
diff --git a/src/backend/app/modules/TenantResolver/ApiCompanyResolverService.php b/src/backend/app/modules/TenantResolver/ApiCompanyResolverService.php
@@ -2,13 +2,13 @@
 
 declare(strict_types=1);
 
-namespace MPM\Sharding;
+namespace MPM\TenantResolver;
 
 use App\Exceptions\ValidationException;
 use Illuminate\Http\Request;
 use Illuminate\Support\Str;
-use MPM\Sharding\ApiResolvers\ApiResolverInterface;
-use MPM\Sharding\ApiResolvers\Data\ApiResolverMap;
+use MPM\TenantResolver\ApiResolvers\ApiResolverInterface;
+use MPM\TenantResolver\ApiResolvers\Data\ApiResolverMap;
 
 class ApiCompanyResolverService {
     public function __construct(private ApiResolverMap $apiResolverMap) {}
diff --git a/src/backend/app/modules/TenantResolver/ApiResolvers/AfricasTalkingApiResolver.php b/src/backend/app/modules/TenantResolver/ApiResolvers/AfricasTalkingApiResolver.php
@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace MPM\Sharding\ApiResolvers;
+namespace MPM\TenantResolver\ApiResolvers;
 
 use App\Exceptions\ValidationException;
 use Illuminate\Http\Request;
diff --git a/src/backend/app/modules/TenantResolver/ApiResolvers/AndroidGatewayCallbackApiResolver.php b/src/backend/app/modules/TenantResolver/ApiResolvers/AndroidGatewayCallbackApiResolver.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace MPM\Sharding\ApiResolvers;
+namespace MPM\TenantResolver\ApiResolvers;
 
 use App\Exceptions\ValidationException;
 use Illuminate\Http\Request;
diff --git a/src/backend/app/modules/TenantResolver/ApiResolvers/ApiResolverInterface.php b/src/backend/app/modules/TenantResolver/ApiResolvers/ApiResolverInterface.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace MPM\Sharding\ApiResolvers;
+namespace MPM\TenantResolver\ApiResolvers;
 
 use Illuminate\Http\Request;
 
diff --git a/src/backend/app/modules/TenantResolver/ApiResolvers/Data/ApiResolverMap.php b/src/backend/app/modules/TenantResolver/ApiResolvers/Data/ApiResolverMap.php
@@ -2,16 +2,16 @@
 
 declare(strict_types=1);
 
-namespace MPM\Sharding\ApiResolvers\Data;
-
-use MPM\Sharding\ApiResolvers\AfricasTalkingApiResolver;
-use MPM\Sharding\ApiResolvers\AndroidGatewayCallbackApiResolver;
-use MPM\Sharding\ApiResolvers\DataExportResolver;
-use MPM\Sharding\ApiResolvers\DownloadingReportsResolver;
-use MPM\Sharding\ApiResolvers\SwiftaPaymentApiResolver;
-use MPM\Sharding\ApiResolvers\TestApiResolver;
-use MPM\Sharding\ApiResolvers\ViberMessagingApiResolver;
-use MPM\Sharding\ApiResolvers\WaveMoneyApiResolver;
+namespace MPM\TenantResolver\ApiResolvers\Data;
+
+use MPM\TenantResolver\ApiResolvers\AfricasTalkingApiResolver;
+use MPM\TenantResolver\ApiResolvers\AndroidGatewayCallbackApiResolver;
+use MPM\TenantResolver\ApiResolvers\DataExportResolver;
+use MPM\TenantResolver\ApiResolvers\DownloadingReportsResolver;
+use MPM\TenantResolver\ApiResolvers\SwiftaPaymentApiResolver;
+use MPM\TenantResolver\ApiResolvers\TestApiResolver;
+use MPM\TenantResolver\ApiResolvers\ViberMessagingApiResolver;
+use MPM\TenantResolver\ApiResolvers\WaveMoneyApiResolver;
 
 class ApiResolverMap {
     public const VIBER_API = 'api/viber-messaging/webhook';
diff --git a/src/backend/app/modules/TenantResolver/ApiResolvers/DataExportResolver.php b/src/backend/app/modules/TenantResolver/ApiResolvers/DataExportResolver.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace MPM\Sharding\ApiResolvers;
+namespace MPM\TenantResolver\ApiResolvers;
 
 use App\Exceptions\ValidationException;
 use Illuminate\Http\Request;
diff --git a/src/backend/app/modules/TenantResolver/ApiResolvers/DownloadingReportsResolver.php b/src/backend/app/modules/TenantResolver/ApiResolvers/DownloadingReportsResolver.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace MPM\Sharding\ApiResolvers;
+namespace MPM\TenantResolver\ApiResolvers;
 
 use App\Exceptions\ValidationException;
 use Illuminate\Http\Request;
diff --git a/src/backend/app/modules/TenantResolver/ApiResolvers/JetsonApiResolver.php b/src/backend/app/modules/TenantResolver/ApiResolvers/JetsonApiResolver.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace MPM\Sharding\ApiResolvers;
+namespace MPM\TenantResolver\ApiResolvers;
 
 use App\Exceptions\ValidationException;
 use Illuminate\Http\Request;
diff --git a/src/backend/app/modules/TenantResolver/ApiResolvers/SwiftaPaymentApiResolver.php b/src/backend/app/modules/TenantResolver/ApiResolvers/SwiftaPaymentApiResolver.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace MPM\Sharding\ApiResolvers;
+namespace MPM\TenantResolver\ApiResolvers;
 
 use Illuminate\Http\Request;
 
diff --git a/src/backend/app/modules/TenantResolver/ApiResolvers/TestApiResolver.php b/src/backend/app/modules/TenantResolver/ApiResolvers/TestApiResolver.php
@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace MPM\Sharding\ApiResolvers;
+namespace MPM\TenantResolver\ApiResolvers;
 
 use App\Exceptions\ValidationException;
 use Illuminate\Http\Request;
diff --git a/src/backend/app/modules/TenantResolver/ApiResolvers/ViberMessagingApiResolver.php b/src/backend/app/modules/TenantResolver/ApiResolvers/ViberMessagingApiResolver.php
@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace MPM\Sharding\ApiResolvers;
+namespace MPM\TenantResolver\ApiResolvers;
 
 use App\Exceptions\ValidationException;
 use Illuminate\Http\Request;
diff --git a/src/backend/app/modules/TenantResolver/ApiResolvers/WaveMoneyApiResolver.php b/src/backend/app/modules/TenantResolver/ApiResolvers/WaveMoneyApiResolver.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace MPM\Sharding\ApiResolvers;
+namespace MPM\TenantResolver\ApiResolvers;
 
 use App\Exceptions\ValidationException;
 use Illuminate\Http\Request;
diff --git a/src/backend/packages/inensus/spark-meter/src/Services/TransactionService.php b/src/backend/packages/inensus/spark-meter/src/Services/TransactionService.php
@@ -2,6 +2,7 @@
 
 namespace Inensus\SparkMeter\Services;
 
+use App\Models\Meter\Meter;
 use App\Models\Meter\MeterToken;
 use App\Models\Transaction\ThirdPartyTransaction;
 use App\Models\Transaction\Transaction;
@@ -381,7 +382,10 @@ private function createToken($sparkTariff, $mainTransaction, $transaction, $spar
             'load' => $chargedEnergy,
         ]);
         $token->transaction()->associate($mainTransaction);
-        $token->meter()->associate($meterParameter->meter);
+        $meter = Meter::where('serial_number', $mainTransaction->message)->first();
+        if ($meter) {
+            $token->meter()->associate($meter);
+        }
         $token->save();
 
         return $token;
diff --git a/src/backend/packages/inensus/steama-meter/src/Services/SteamaTransactionsService.php b/src/backend/packages/inensus/steama-meter/src/Services/SteamaTransactionsService.php
@@ -2,6 +2,7 @@
 
 namespace Inensus\SteamaMeter\Services;
 
+use App\Models\Meter\Meter;
 use App\Models\Meter\MeterToken;
 use App\Models\Transaction\ThirdPartyTransaction;
 use App\Models\Transaction\Transaction;
@@ -237,7 +238,10 @@ private function createToken($steamaMeter, $mainTransaction, $transaction) {
         ]);
 
         $token->transaction()->associate($mainTransaction);
-        $token->meter()->associate($mainTransaction->meter);
+        $meter = Meter::where('serial_number', $mainTransaction->message)->first();
+        if ($meter) {
+            $token->meter()->associate($meter);
+        }
         $token->save();
 
         return $token;

Original file line number	Diff line number	Diff line change
`@@ -40,13 +40,13 @@ protected function execute(InputInterface $input, OutputInterface $output) {`
`40`	`40`	`if ($companyId) {`
`41`	`41`	`$this->runForCompany($databaseProxyManagerService, (int) $companyId, $input, $output);`
`42`	`42`	`} else {`
`43`		`- $this->runForAllShards($databaseProxyManagerService, $input, $output);`
	`43`	`+ $this->runForAllTenants($databaseProxyManagerService, $input, $output);`
`44`	`44`	`}`
`45`	`45`
`46`	`46`	`return $this->EXECUTION_TYPE;`
`47`	`47`	`}`
`48`	`48`
`49`		`- private function runForAllShards(`
	`49`	`+ private function runForAllTenants(`
`50`	`50`	`DatabaseProxyManagerService $databaseProxyManagerService,`
`51`	`51`	`InputInterface $input,`
`52`	`52`	`OutputInterface $output,`