Merge pull request #30 from soketi/feature/deprecation

rennokki · web-flow · commit 7044355b75b6 · 2021-06-28T21:47:41.000+03:00
Deprecated Echo Server in favour of pWS
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -52,7 +52,7 @@ jobs:
 
       - name: Load Kubernetes fixtures
         run: |
-          kubectl apply -f tests/fixtures/echo.yaml
+          kubectl apply -f tests/fixtures/pws.yaml
 
       - name: Copy environment variables
         run: |
diff --git a/README.md b/README.md
@@ -1,5 +1,5 @@
-Echo Network Watcher
-=====================
+Soketi Network Watcher
+=======================
 
 ![CI](https://github.com/soketi/network-watcher/workflows/CI/badge.svg?branch=master)
 [![codecov](https://codecov.io/gh/soketi/network-watcher/branch/master/graph/badge.svg)](https://codecov.io/gh/soketi/network-watcher)
@@ -9,13 +9,13 @@ Echo Network Watcher
 ![v1.20.6 K8s Version](https://img.shields.io/badge/K8s%20v1.20.6-Ready-%23326ce5?colorA=306CE8&colorB=green)
 ![v1.21.0 K8s Version](https://img.shields.io/badge/K8s%20v1.21.0-Ready-%23326ce5?colorA=306CE8&colorB=green)
 
-Monitor the [Echo Server](https://github.com/soketi/echo-server) container for memory allowance and new connections when running in Kubernetes.
+Monitor the [pWS server](https://github.com/soketi/pws) container for memory allowance and new connections when running in Kubernetes.
 
 ## 🤔 What does this controller solve?
 
-If you run Echo Server standalone in a cluster, at scale, you might run into capacity issues: RAM usage might be near the limit and even if you decide to horizontally scale the pods, new connections might still come to pods that are near-limit and run into OOM at some point.
+If you run pWS standalone in a cluster, at scale, you might run into capacity issues: RAM usage might be near the limit and even if you decide to horizontally scale the pods, new connections might still come to pods that are near-limit and run into OOM at some point.
 
-Running Network Watcher inside the same pod will solve the issues by continuously checking the Echo Server Usage API, labeling the pods that get over a specified threshold with `echo.soketi.app/accepts-new-connections: "no"`, so that the services watching for the pods will ignore them if also checking for this label:
+Running Network Watcher inside the same pod will solve the issues by continuously checking the pWS Server Usage API, labeling the pods that get over a specified threshold with `pws.soketi.app/accepts-new-connections: "no"`, so that the services watching for the pods will ignore them if also checking for this label:
 
 ```yaml
 spec:
@@ -24,22 +24,22 @@ spec:
     - port: 6001
       targetPort: 6001
       protocol: TCP
-      name: echo
+      name: pws
   selector:
     ...
-    echo.soketi.app/accepts-new-connections: "yes"
+    pws.soketi.app/accepts-new-connections: "yes"
 ```
 
 ## 🙌 Requirements
 
 - PHP 8.0+
-- [Echo Server](https://github.com/soketi/echo-server) 5.3+
+- [pWS Server](https://github.com/soketi/pws) 1.0+
 
 ## Docker image
 
 [Network Watcher is available via Docker](https://hub.docker.com/r/soketi/network-watcher). Use the images to run them into your cluster and use this project to develop the application.
 
-[Network Watcher also comes with the Echo Server Helm chart](https://github.com/soketi/charts/tree/master/charts/echo-server). It just needs to be turned on if you need the network watcher and the according service annotations will be appended automatically.
+[Network Watcher also comes with the pWS Server Helm chart](https://github.com/soketi/charts/tree/master/charts/pws). It just needs to be turned on if you need the network watcher and the according service annotations will be appended automatically.
 
 ## 🚀 Installation
 
@@ -59,7 +59,7 @@ $ php application network:watch
 | - | - | - | - |
 | `POD_NAMESPACE` | `--pod-namespace` | `default` | The Pod namespce to watch. |
 | `POD_NAME` | `--pod-name` | `some-pod` | The Pod name to watch. |
-| `ECHO_APP_PORT` | `--echo-app-port` | `6001` | The port number for the [Echo Server](https://github.com/soketi/echo-server) app. |
+| `SERVER_PORT` | `--server-port` | `6001` | The port number for the [pWS server](https://github.com/soketi/pws). |
 | `MEMORY_PERCENT` | `--memory-percent` | `75` | The threshold (in percent) that, once reached, the Pod will be marked as "not ready" to evict any new connections or requests. |
 | `CHECKING_INTERVAL` | `--checking-interval` | `1` | The amount of seconds to wait between API checks. |
 | `TEST_MODE` | `--test` | - | Run a single check rather than a continous loop of checks. |
diff --git a/app/Commands/WatchNetworkCommand.php b/app/Commands/WatchNetworkCommand.php
@@ -22,7 +22,7 @@ class WatchNetworkCommand extends Command implements SignalableCommandInterface
     protected $signature = 'network:watch
         {--pod-namespace=default : The Pod namespace. Defaults to the current Pod namespace.}
         {--pod-name=some-pod : The Pod name to watch. Defaults to the current Pod name.}
-        {--echo-app-port=6001 : The Echo App socket port.}
+        {--server-port=6001 : The Server port.}
         {--memory-percent=75 : The threshold at which new connections close for a specific server.}
         {--interval=1 : The interval in seconds between each checks.}
         {--test : Run only one loop for testing.}
@@ -33,7 +33,7 @@ class WatchNetworkCommand extends Command implements SignalableCommandInterface
      *
      * @var string
      */
-    protected $description = 'Run the Network watcher controller for the Echo app.';
+    protected $description = 'Run the Network watcher controller for the pWS server.';
 
     /**
      * The current pod the instance is running into.
@@ -76,7 +76,7 @@ public function getSubscribedSignals(): array
     public function handleSignal(int $signal): void
     {
         // Simply just mark the pod as rejecting the new connections while it's terminating.
-        // This way, the Echo Server will close all existing connections internally,
+        // This way, the pWS Server will close all existing connections internally,
         // but the Network Watcher will also mark the pod as not being able to receive new connections for
         // the sole purpose of redirecting the traffic to other pods.
         $this->pod->rejectNewConnections();
@@ -93,14 +93,14 @@ public function handle()
 
         $podNamespace = env('POD_NAMESPACE') ?: $this->option('pod-namespace');
         $podName = env('POD_NAME') ?: $this->option('pod-name');
-        $echoAppPort = env('ECHO_APP_PORT') ?: $this->option('echo-app-port');
+        $serverPort = env('SERVER_PORT') ?: $this->option('server-port');
         $memoryThresholdPercent = env('MEMORY_PERCENT') ?: $this->option('memory-percent');
         $interval = env('CHECKING_INTERVAL') ?: $this->option('interval');
         $test = is_bool(env('TEST_MODE')) ? env('TEST_MODE') : $this->option('test');
 
         $this->line("Namespace: {$podNamespace}");
         $this->line("Pod name: {$podName}");
-        $this->line("Echo port: {$echoAppPort}");
+        $this->line("Server port: {$serverPort}");
         $this->line("Memory threshold: {$memoryThresholdPercent}%");
         $this->line("Monitoring interval: {$interval}s");
 
@@ -113,7 +113,7 @@ public function handle()
         }
 
         while (true) {
-            $this->checkPod($memoryThresholdPercent, $echoAppPort);
+            $this->checkPod($memoryThresholdPercent, $serverPort);
 
             sleep($interval);
 
@@ -148,18 +148,18 @@ protected function registerPodMacros(): void
 
         K8sPod::macro('acceptsConnections', function () {
             /** @var K8sPod $this */
-            return $this->getLabel('echo.soketi.app/accepts-new-connections', 'yes') === 'yes';
+            return $this->getLabel('pws.soketi.app/accepts-new-connections', 'yes') === 'yes';
         });
 
         K8sPod::macro('rejectsConnections', function () {
             /** @var K8sPod $this */
-            return $this->getLabel('echo.soketi.app/accepts-new-connections', 'yes') === 'no';
+            return $this->getLabel('pws.soketi.app/accepts-new-connections', 'yes') === 'no';
         });
 
         K8sPod::macro('acceptNewConnections', function () {
             /** @var K8sPod $this */
             $labels = array_merge($this->getLabels(), [
-                'echo.soketi.app/accepts-new-connections' => 'yes',
+                'pws.soketi.app/accepts-new-connections' => 'yes',
             ]);
 
             $this->refresh()->setLabels($labels)->update();
@@ -170,7 +170,7 @@ protected function registerPodMacros(): void
         K8sPod::macro('rejectNewConnections', function () {
             /** @var K8sPod $this */
             $labels = array_merge($this->getLabels(), [
-                'echo.soketi.app/accepts-new-connections' => 'no',
+                'pws.soketi.app/accepts-new-connections' => 'no',
             ]);
 
             $this->refresh()->setLabels($labels)->update();
@@ -180,7 +180,7 @@ protected function registerPodMacros(): void
 
         K8sPod::macro('ensureItHasDefaultLabel', function () {
             /** @var K8sPod $this */
-            if (! $this->getLabel('echo.soketi.app/accepts-new-connections')) {
+            if (! $this->getLabel('pws.soketi.app/accepts-new-connections')) {
                 $this->acceptNewConnections();
             }
         });
diff --git a/app/Concerns/ChecksCurrentPod.php b/app/Concerns/ChecksCurrentPod.php
@@ -10,13 +10,13 @@ trait ChecksCurrentPod
      * Check the pod metrics to adjust new connection allowance.
      *
      * @param  float  $memoryThresholdPercent
-     * @param  int  $echoAppPort
+     * @param  int  $serverPort
      * @return void
      */
-    protected function checkPod(float $memoryThresholdPercent, int $echoAppPort): void
+    protected function checkPod(float $memoryThresholdPercent, int $serverPort): void
     {
         /** @var \App\Commands\WatchNetworkCommand $this */
-        $usedMemoryPercent = $this->getEchoServerMemoryUsagePercent($echoAppPort);
+        $usedMemoryPercent = $this->getServerMemoryUsagePercent($serverPort);
         $dateTime = now()->toDateTimeString();
 
         $this->line("[{$dateTime}] Current memory usage is {$usedMemoryPercent}%. Checking...", null, 'v');
@@ -26,14 +26,14 @@ protected function checkPod(float $memoryThresholdPercent, int $echoAppPort): vo
         if ($usedMemoryPercent >= $memoryThresholdPercent) {
             if ($this->pod->acceptsConnections()) {
                 $this->info("[{$dateTime}] Pod now rejects connections.");
-                $this->info("[{$dateTime}] Echo container uses {$usedMemoryPercent}%, threshold is {$memoryThresholdPercent}%");
+                $this->info("[{$dateTime}] Server container uses {$usedMemoryPercent}%, threshold is {$memoryThresholdPercent}%");
 
                 $this->rejectNewConnections($usedMemoryPercent, $memoryThresholdPercent);
             }
         } else {
             if ($this->pod->rejectsConnections()) {
                 $this->info("[{$dateTime}] Pod now accepts connections.");
-                $this->info("[{$dateTime}] Echo container uses {$usedMemoryPercent}%, threshold is {$memoryThresholdPercent}%");
+                $this->info("[{$dateTime}] Server container uses {$usedMemoryPercent}%, threshold is {$memoryThresholdPercent}%");
 
                 $this->acceptNewConnections($usedMemoryPercent, $memoryThresholdPercent);
             }
@@ -55,7 +55,7 @@ protected function rejectNewConnections(float $usedMemoryPercent, float $memoryT
         $now = now()->toIso8601String();
 
         $this->pod->newEvent()
-            ->setMessage("Rejecting new connections. Echo container uses {$usedMemoryPercent}%, threshold is {$memoryThresholdPercent}%")
+            ->setMessage("Rejecting new connections. Server container uses {$usedMemoryPercent}%, threshold is {$memoryThresholdPercent}%")
             ->setReason('OverThreshold')
             ->setType('Warning')
             ->setFirstTimestamp($now)
@@ -78,7 +78,7 @@ protected function acceptNewConnections(float $usedMemoryPercent, float $memoryT
         $now = now()->toIso8601String();
 
         $this->pod->newEvent()
-            ->setMessage("Accepting new connections. Echo container uses {$usedMemoryPercent}%, threshold is {$memoryThresholdPercent}%")
+            ->setMessage("Accepting new connections. Server container uses {$usedMemoryPercent}%, threshold is {$memoryThresholdPercent}%")
             ->setReason('BelowThreshold')
             ->setType('Normal')
             ->setFirstTimestamp($now)
@@ -89,23 +89,23 @@ protected function acceptNewConnections(float $usedMemoryPercent, float $memoryT
     /**
      * Get the pod metrics from the Usage API.
      *
-     * @param  int  $echoAppPort
+     * @param  int  $serverPort
      * @return array
      */
-    protected function getUsage(int $echoAppPort): array
+    protected function getUsage(int $serverPort): array
     {
-        return Http::get("http://localhost:{$echoAppPort}/usage")->json();
+        return Http::get("http://localhost:{$serverPort}/usage")->json();
     }
 
     /**
      * Get the percent of used memory from the Usage API.
      *
-     * @param  int  $echoAppPort
+     * @param  int  $serverPort
      * @return float
      */
-    protected function getEchoServerMemoryUsagePercent(int $echoAppPort): float
+    protected function getServerMemoryUsagePercent(int $serverPort): float
     {
-        $usage = $this->getUsage($echoAppPort);
+        $usage = $this->getUsage($serverPort);
 
         return $usage['memory']['percent'] ?? 0.00;
     }
diff --git a/tests/Feature/NetworkWatchTest.php b/tests/Feature/NetworkWatchTest.php
@@ -14,7 +14,7 @@ class NetworkWatchTest extends TestCase
     public function test_watch_pod_rejecting_connections()
     {
         /** @var \RenokiCo\PhpK8s\Kinds\K8sDeployment $deployment */
-        $deployment = LaravelK8s::getDeploymentByName('echo-server-test');
+        $deployment = LaravelK8s::getDeploymentByName('pws-server-test');
 
         while (! $deployment->allPodsAreRunning()) {
             echo "Waiting for {$deployment->getName()} deployment to have pods running...";
@@ -34,15 +34,15 @@ public function test_watch_pod_rejecting_connections()
         $this->artisan('network:watch', [
             '--pod-namespace' => 'default',
             '--pod-name' => $pod->getName(),
-            '--echo-app-port' => 6001,
+            '--server-port' => 6001,
             '--memory-percent' => 80,
             '--interval' => 1,
             '--test' => true,
         ]);
 
         $pod->refresh();
 
-        $this->assertEquals('no', $pod->getLabel('echo.soketi.app/accepts-new-connections'));
+        $this->assertEquals('no', $pod->getLabel('pws.soketi.app/accepts-new-connections'));
 
         $event = $pod->getEvents()->reverse()->first(function ($event) use ($pod) {
             return $event->getAttribute('involvedObject.name') === $pod->getName() &&
@@ -55,7 +55,7 @@ public function test_watch_pod_rejecting_connections()
     public function test_watch_pod_accepting_connections()
     {
         /** @var \RenokiCo\PhpK8s\Kinds\K8sDeployment $deployment */
-        $deployment = LaravelK8s::getDeploymentByName('echo-server-test');
+        $deployment = LaravelK8s::getDeploymentByName('pws-server-test');
 
         while (! $deployment->allPodsAreRunning()) {
             echo "Waiting for {$deployment->getName()} deployment to have pods running...";
@@ -75,21 +75,21 @@ public function test_watch_pod_accepting_connections()
         $this->artisan('network:watch', [
             '--pod-namespace' => 'default',
             '--pod-name' => $pod->getName(),
-            '--echo-app-port' => 6001,
+            '--server-port' => 6001,
             '--memory-percent' => 90,
             '--interval' => 1,
             '--test' => true,
         ]);
 
         $pod->refresh();
 
-        $this->assertEquals('yes', $pod->getLabel('echo.soketi.app/accepts-new-connections'));
+        $this->assertEquals('yes', $pod->getLabel('pws.soketi.app/accepts-new-connections'));
     }
 
     public function test_signaling_should_incapacitate_the_pod()
     {
         /** @var \RenokiCo\PhpK8s\Kinds\K8sDeployment $deployment */
-        $deployment = LaravelK8s::getDeploymentByName('echo-server-test');
+        $deployment = LaravelK8s::getDeploymentByName('pws-server-test');
 
         while (! $deployment->allPodsAreRunning()) {
             echo "Waiting for {$deployment->getName()} deployment to have pods running...";
@@ -102,7 +102,7 @@ public function test_signaling_should_incapacitate_the_pod()
 
         $pod = $this->makePodAcceptNewConnections($pod, true);
 
-        $this->assertEquals('yes', $pod->getLabel('echo.soketi.app/accepts-new-connections'));
+        $this->assertEquals('yes', $pod->getLabel('pws.soketi.app/accepts-new-connections'));
 
         /** @var WatchNetworkCommand $command */
         $command = app(WatchNetworkCommand::class);
@@ -115,7 +115,7 @@ public function test_signaling_should_incapacitate_the_pod()
 
         $pod->refresh();
 
-        $this->assertEquals('no', $pod->getLabel('echo.soketi.app/accepts-new-connections'));
+        $this->assertEquals('no', $pod->getLabel('pws.soketi.app/accepts-new-connections'));
 
         $event = $pod->getEvents()->reverse()->first(function ($event) use ($pod) {
             return $event->getAttribute('involvedObject.name') === $pod->getName() &&
@@ -135,7 +135,7 @@ public function test_signaling_should_incapacitate_the_pod()
     protected function makePodAcceptNewConnections(K8sPod $pod, $accept = true)
     {
         $labels = array_merge($pod->getLabels(), [
-            'echo.soketi.app/accepts-new-connections' => $accept ? 'yes' : 'no',
+            'pws.soketi.app/accepts-new-connections' => $accept ? 'yes' : 'no',
         ]);
 
         $pod->refresh()->setLabels($labels)->update();
diff --git a/tests/fixtures/pws.yaml b/tests/fixtures/pws.yaml
@@ -1,26 +1,26 @@
 apiVersion: apps/v1
 kind: Deployment
 metadata:
-  name: echo-server-test
+  name: pws-server-test
   labels:
-    app: echo-server-test
+    app: pws-server-test
     state: testing
 spec:
   replicas: 1
   selector:
     matchLabels:
-      app: echo-server-test
+      app: pws-server-test
       state: testing
   template:
     metadata:
       labels:
-        app: echo-server-test
+        app: pws-server-test
         state: testing
-        deployment-name: echo-server-test
+        deployment-name: pws-server-test
     spec:
       containers:
-        - name: echo
-          image: soketi/echo-server:5.3-14-alpine
+        - name: pws
+          image: soketi/pws-0.1-14-alpine
           env:
             - name: PRESENCE_STORAGE_DATABASE
               value: socket
