chore: add setRemoveElement and tests (#66)

momentohq · Nov 17, 2022 · 60d0f03 · 60d0f03
1 parent f9bc2dc
commit 60d0f03
Show file tree

Hide file tree

Showing 5 changed files with 149 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -2,3 +2,4 @@
 .phpunit.cache
 .phpunit.result.cache
 .idea/
+.vscode/
diff --git a/src/Cache/CacheOperationTypes/CacheOperationTypes.php b/src/Cache/CacheOperationTypes/CacheOperationTypes.php
@@ -1222,3 +1222,31 @@ class CacheSetFetchResponseError extends CacheSetFetchResponse
 {
     use ErrorBody;
 }
+
+abstract class CacheSetRemoveElementResponse extends ResponseBase
+{
+    public function asSuccess(): CacheSetRemoveElementResponseSuccess|null
+    {
+        if ($this->isSuccess()) {
+            return $this;
+        }
+        return null;
+    }
+
+    public function asError(): CacheSetRemoveElementResponseError|null
+    {
+        if ($this->isError()) {
+            return $this;
+        }
+        return null;
+    }
+}
+
+class CacheSetRemoveElementResponseSuccess extends CacheSetRemoveElementResponse
+{
+}
+
+class CacheSetRemoveElementResponseError extends CacheSetRemoveElementResponse
+{
+    use ErrorBody;
+}
diff --git a/src/Cache/SimpleCacheClient.php b/src/Cache/SimpleCacheClient.php
@@ -24,6 +24,7 @@
 use Momento\Cache\CacheOperationTypes\CacheListRemoveValueResponse;
 use Momento\Cache\CacheOperationTypes\CacheSetAddElementResponse;
 use Momento\Cache\CacheOperationTypes\CacheSetFetchResponse;
+use Momento\Cache\CacheOperationTypes\CacheSetRemoveElementResponse;
 use Momento\Cache\CacheOperationTypes\CacheSetResponse;
 use Momento\Cache\CacheOperationTypes\CreateCacheResponse;
 use Momento\Cache\CacheOperationTypes\DeleteCacheResponse;
@@ -197,4 +198,9 @@ public function setFetch(string $cacheName, string $setName): CacheSetFetchRespo
     {
         return $this->dataClient->setFetch($cacheName, $setName);
     }
+
+    public function setRemoveElement(string $cacheName, string $setName, string $element): CacheSetRemoveElementResponse 
+    {
+        return $this->dataClient->setRemoveElement($cacheName, $setName, $element);
+    }
 }
diff --git a/src/Cache/_ScsDataClient.php b/src/Cache/_ScsDataClient.php
@@ -21,6 +21,9 @@
 use Cache_client\_ListPushFrontRequest;
 use Cache_client\_ListRange;
 use Cache_client\_ListRemoveRequest;
+use Cache_client\_SetDifferenceRequest;
+use Cache_client\_SetDifferenceRequest\_Subtrahend;
+use Cache_client\_SetDifferenceRequest\_Subtrahend\_Set;
 use Cache_client\_SetFetchRequest;
 use Cache_client\_SetRequest;
 use Cache_client\_SetUnionRequest;
@@ -97,6 +100,9 @@
 use Momento\Cache\CacheOperationTypes\CacheSetFetchResponseError;
 use Momento\Cache\CacheOperationTypes\CacheSetFetchResponseHit;
 use Momento\Cache\CacheOperationTypes\CacheSetFetchResponseMiss;
+use Momento\Cache\CacheOperationTypes\CacheSetRemoveElementResponse;
+use Momento\Cache\CacheOperationTypes\CacheSetRemoveElementResponseError;
+use Momento\Cache\CacheOperationTypes\CacheSetRemoveElementResponseSuccess;
 use Momento\Cache\CacheOperationTypes\CacheSetResponse;
 use Momento\Cache\CacheOperationTypes\CacheSetResponseError;
 use Momento\Cache\CacheOperationTypes\CacheSetResponseSuccess;
@@ -698,4 +704,26 @@ public function setFetch(string $cacheName, string $setName): CacheSetFetchRespo
         }
         return new CacheSetFetchResponseMiss();
     }
+
+    public function setRemoveElement(string $cacheName, string $setName, string $element): CacheSetRemoveElementResponse {
+        try {
+            validateCacheName($cacheName);
+            validateSetName($setName);
+            validateElement($element);
+            $setRemoveElementRequest = new _SetDifferenceRequest();
+            $setRemoveElementRequest->setSetName($setName);
+            $subtrahend = new _Subtrahend();
+            $set = new _Set();
+            $set->setElements([$element]);
+            $subtrahend->setSet($set);
+            $setRemoveElementRequest->setSubtrahend($subtrahend);
+            $call = $this->grpcManager->client->SetDifference($setRemoveElementRequest, ["cache" => [$cacheName]], ["timeout" => $this->timeout]);
+            $this->processCall($call);
+        } catch (SdkError $e) {
+            return new CacheSetRemoveElementResponseError($e);
+        } catch (Exception $e) {
+            return new CacheSetRemoveElementResponseError(new UnknownError($e->getMessage()));
+        }
+        return new CacheSetRemoveElementResponseSuccess();
+    }
 }
diff --git a/tests/Cache/CacheClientTest.php b/tests/Cache/CacheClientTest.php
@@ -1933,4 +1933,90 @@ public function testSetAddElementSetFetch_RefreshTtl()
         $this->assertNotNull($response->asHit(), "Expected a hit but got: $response");
         $this->assertEquals($element, $response->asHit()->valueArray()[0]);
     }
+
+    public function testSetRemoveElementWithNullCacheName_ThrowsException()
+    {
+        $this->expectException(TypeError::class);
+        $setName = uniqid();
+        $element = uniqid();
+        $this->client->setRemoveElement(null, $setName, $element);
+    }
+
+    public function testSetRemoveElementWithEmptyCacheName_ThrowsException()
+    {
+        $setName = uniqid();
+        $element = uniqid();
+        $response = $this->client->setRemoveElement("", $setName, $element);
+        $this->assertNotNull($response->asError(), "Expected error but got: $response");
+        $this->assertEquals(MomentoErrorCode::INVALID_ARGUMENT_ERROR, $response->asError()->errorCode());
+    }
+
+    public function testSetRemoveElementWithNullSetName_ThrowsException()
+    {
+        $this->expectException(TypeError::class);
+        $element = uniqid();
+        $this->client->setRemoveElement($this->TEST_CACHE_NAME, null, $element);
+    }
+
+    public function testSetRemoveElementWithEmptySetName_ThrowsException()
+    {
+        $element = uniqid();
+        $response = $this->client->setRemoveElement($this->TEST_CACHE_NAME, "", $element);
+        $this->assertNotNull($response->asError(), "Expected error but got: $response");
+        $this->assertEquals(MomentoErrorCode::INVALID_ARGUMENT_ERROR, $response->asError()->errorCode());
+    }
+
+    public function testSetRemoveElementWithNullElement_ThrowsException()
+    {
+        $this->expectException(TypeError::class);
+        $setName = uniqid();
+        $this->client->setRemoveElement($this->TEST_CACHE_NAME, $setName, null);
+    }
+
+    public function testSetRemoveElementWithEmptyElement_ThrowsException()
+    {
+        $setName = uniqid();
+        $response = $this->client->setRemoveElement($this->TEST_CACHE_NAME, $setName, "");
+        $this->assertNotNull($response->asError(), "Expected error but got: $response");
+        $this->assertEquals(MomentoErrorCode::INVALID_ARGUMENT_ERROR, $response->asError()->errorCode());
+    }
+
+    public function testSetRemoveElement_HappyPath() 
+    {
+        $setName = uniqid();
+        $element = uniqid();
+        $response = $this->client->setAddElement($this->TEST_CACHE_NAME, $setName, $element, false);
+        $this->assertNull($response->asError());
+        $this->assertNotNull($response->asSuccess(), "Expected a success but got: $response");
+
+        $response = $this->client->setRemoveElement($this->TEST_CACHE_NAME, $setName, uniqid());
+        $this->assertNull($response->asError());
+        $this->assertNotNull($response->asSuccess(), "Expected a success but got: $response");
+
+        $response = $this->client->setFetch($this->TEST_CACHE_NAME, $setName);
+        $this->assertNotNull($response->asHit(), "Expected a hit but got: $response");
+        $this->assertEquals($element, $response->asHit()->valueArray()[0]);
+
+        $response = $this->client->setRemoveElement($this->TEST_CACHE_NAME, $setName, $element);
+        $this->assertNull($response->asError());
+        $this->assertNotNull($response->asSuccess(), "Expected a success but got: $response");
+
+        $response = $this->client->setFetch($this->TEST_CACHE_NAME, $setName);
+        $this->assertNotNull($response->asMiss(), "Expected a miss but got: $response");
+    }
+
+    public function testSetRemoveElement_SetIsMissingElement_Noop()
+    {
+        $setName = uniqid();
+
+        $response = $this->client->setFetch($this->TEST_CACHE_NAME, $setName);
+        $this->assertNotNull($response->asMiss(), "Expected a miss but got: $response");
+
+        $response = $this->client->setRemoveElement($this->TEST_CACHE_NAME, $setName, uniqid());
+        $this->assertNull($response->asError());
+        $this->assertNotNull($response->asSuccess(), "Expected a success but got: $response");
+
+        $response = $this->client->setFetch($this->TEST_CACHE_NAME, $setName);
+        $this->assertNotNull($response->asMiss(), "Expected a miss but got: $response");
+    }
 }