update LocalEvaluationClient - add getFlagConfigs method, change meth…

…od name of 'start' to 'refreshFlagConfigs'
amplitude · Jan 24, 2024 · 505c633 · 505c633
1 parent 48f682a
commit 505c633
Show file tree

Hide file tree

Showing 4 changed files with 26 additions and 13 deletions.
diff --git a/README.md b/README.md
@@ -48,8 +48,8 @@ if ($variant) {
 $experiment = new \AmplitudeExperiment\Experiment();
 $client = $experiment->initializeLocal('<DEPLOYMENT_KEY>');
 
-// (2) Start the local evaluation client.
-$client->start();
+// (2) Fetch latest flag configurations for the local evaluation client.
+$client->refreshFlagConfigs();
 
 // (3) Evaluate a user.
 $user = \AmplitudeExperiment\User::builder()

diff --git a/src/Flag/FlagConfigService.php b/src/Flag/FlagConfigService.php
@@ -25,13 +25,7 @@ public function __construct(FlagConfigFetcher $fetcher, LoggerInterface $logger,
         $this->cache = $bootstrap;
     }
 
-    public function start(): void
-    {
-        $this->logger->debug('[Experiment] Flag service - start');
-        $this->refresh();
-    }
-
-    private function refresh(): void
+    public function refresh(): void
     {
         $this->logger->debug('[Experiment] Flag config update');
         try {

diff --git a/src/Local/LocalEvaluationClient.php b/src/Local/LocalEvaluationClient.php
@@ -44,11 +44,11 @@ public function __construct(string $apiKey, ?LocalEvaluationConfig $config = nul
     }
 
     /**
-     * Fetch initial flag configurations.
+     * Fetch latest flag configurations.
      */
-    public function start(): void
+    public function refreshFlagConfigs(): void
     {
-        $this->flagConfigService->start();
+        $this->flagConfigService->refresh();
     }
 
     /**
@@ -80,6 +80,15 @@ public function evaluate(User $user, array $flagKeys = []): array
         return $results;
     }
 
+
+    /**
+     * @return array<string, mixed> flag configurations.
+     */
+    public function getFlagConfigs(): array
+    {
+        return $this->flagConfigService->getFlagConfigs();
+    }
+
     private function initializeAssignmentService(?AssignmentConfig $config): void
     {
         if ($config) {

diff --git a/tests/Local/LocalEvaluationClientTest.php b/tests/Local/LocalEvaluationClientTest.php
@@ -29,7 +29,7 @@ public function __construct()
 
     public function setUp(): void
     {
-        $this->client->start();
+        $this->client->refreshFlagConfigs();
     }
 
     public function testEvaluateAllFlags()
@@ -70,4 +70,14 @@ public function testEvaluateWithDependenciesVariantHeldOut()
         $this->assertEquals(null, $variant->payload);
         $this->assertTrue($variant->metadata["default"]);
     }
+
+    public function testGetFlagConfigs()
+    {
+        $flagConfigs = $this->client->getFlagConfigs();
+        $bootstrapClient = new LocalEvaluationClient('', LocalEvaluationConfig::builder()->bootstrap($flagConfigs)->build());
+        $variants = $bootstrapClient->evaluate($this->testUser);
+        $variant = $variants['sdk-local-evaluation-ci-test'];
+        $this->assertEquals("on", $variant->key);
+        $this->assertEquals("payload", $variant->payload);
+    }
 }