Production Reference: Actors

Running PHP actors in production

Proxy modes

There are four different modes actor proxies are handled. Each mode presents different trade-offs that you’ll need to weigh during development and in production.

  1. <?php
  2. \Dapr\Actors\Generators\ProxyFactory::GENERATED;
  3. \Dapr\Actors\Generators\ProxyFactory::GENERATED_CACHED;
  4. \Dapr\Actors\Generators\ProxyFactory::ONLY_EXISTING;
  5. \Dapr\Actors\Generators\ProxyFactory::DYNAMIC;

It can be set with dapr.actors.proxy.generation configuration key.

This is the default mode. In this mode, a class is generated and eval’d on every request. It’s mostly for development and shouldn’t be used in production.

This is the same as ProxyModes::GENERATED except the class is stored in a tmp file so it doesn’t need to be regenerated on every request. It doesn’t know when to update the cached class, so using it in development is discouraged but is offered for when manually generating the files isn’t possible.

In this mode, an exception is thrown if the proxy class doesn’t exist. This is useful for when you don’t want to generate code in production. You’ll have to make sure the class is generated and pre-/autoloaded.

Generating proxies

You can create a composer script to generate proxies on demand to take advantage of the ONLY_EXISTING mode.

Create a ProxyCompiler.php

  1. <?php
  3. class ProxyCompiler {
  4.     private const PROXIES = [
  5.         MyActorInterface::class,
  6.         MyOtherActorInterface::class,
  7.     ];
  9.     private const PROXY_LOCATION = __DIR__.'/proxies/';
  11.     public static function compile() {
  12.         try {
  13.             $app = \Dapr\App::create();
  14.             foreach(self::PROXIES as $interface) {
  15.                 $output = $app->run(function(\DI\FactoryInterface $factory) use ($interface) {
  16.                     return \Dapr\Actors\Generators\FileGenerator::generate($interface, $factory);
  17.                 });
  18.                 $reflection = new ReflectionClass($interface);
  19.                 $dapr_type = $reflection->getAttributes(\Dapr\Actors\Attributes\DaprType::class)[0]->newInstance()->type;
  20.                 $filename = 'dapr_proxy_'.$dapr_type.'.php';
  21.                 file_put_contents(self::PROXY_LOCATION.$filename, $output);
  22.                 echo "Compiled: $interface";
  23.             }
  24.         } catch (Exception $ex) {
  25.             echo "Failed to generate proxy for $interface\n{$ex->getMessage()} on line {$ex->getLine()} in {$ex->getFile()}\n";
  26.         }
  27.     }
  28. }

Then add a psr-4 autoloader for the generated proxies and a script in composer.json:

  1. {
  2.   "autoload": {
  3.     "psr-4": {
  4.       "Dapr\\Proxies\\": "path/to/proxies"
  5.     }
  6.   },
  7.   "scripts": {
  8.     "compile-proxies": "ProxyCompiler::compile"
  9.   }
  10. }

And finally, configure dapr to only use the generated proxies:

  1. <?php
  2. // in config.php
  4. return [
  5.     'dapr.actors.proxy.generation' => ProxyFactory::ONLY_EXISTING,
  6. ];

In this mode, the proxy satisfies the interface contract, however, it does not actually implement the interface itself (meaning instanceof will be false). This mode takes advantage of a few quirks in PHP to work and exists for cases where code cannot be eval’d or generated.

Requests

Creating an actor proxy is very inexpensive for any mode. There are no requests made when creating an actor proxy object.

When you call a method on a proxy object, only methods that you implemented are serviced by your actor implementation. get_id() is handled locally, and get_reminder(), delete_reminder(), etc. are handled by the daprd.

Actor implementation

Every actor implementation in PHP must implement \Dapr\Actors\IActor and use the \Dapr\Actors\ActorTrait trait. This allows for fast reflection and some shortcuts. Using the \Dapr\Actors\Actor abstract base class does this for you, but if you need to override the default behavior, you can do so by implementing the interface and using the trait.

Activation and deactivation

When an actor activates, a token file is written to a temporary directory (by default this is in '/tmp/dapr_' + sha256(concat(Dapr type, id)) in linux and '%temp%/dapr_' + sha256(concat(Dapr type, id)) on Windows). This is persisted until the actor deactivates, or the host shuts down. This allows for on_activation to be called once and only once when Dapr activates the actor on the host.

Performance

Actor method invocation is very fast on a production setup with php-fpm and nginx, or IIS on Windows. Even though the actor is constructed on every request, actor state keys are only loaded on-demand and not during each request. However, there is some overhead in loading each key individually. This can be mitigated by storing an array of data in state, trading some usability for speed. It is not recommended doing this from the start, but as an optimization when needed.

Versioning state

The names of the variables in the ActorState object directly correspond to key names in the store. This means that if you change the type or name of a variable, you may run into errors. To get around this, you may need to version your state object. In order to do this, you’ll need to override how state is loaded and stored. There are many ways to approach this, one such solution might be something like this:

  1. <?php
  3. class VersionedState extends \Dapr\Actors\ActorState {
  4.     /**
  5.      * @var int The current version of the state in the store. We give a default value of the current version. 
  6.      * However, it may be in the store with a different value. 
  7.      */
  8.     public int $state_version = self::VERSION;
  10.     /**
  11.      * @var int The current version of the data
  12.      */
  13.     private const VERSION = 3;
  15.     /**
  16.      * Call when your actor activates.
  17.      */
  18.     public function upgrade() {
  19.         if($this->state_version < self::VERSION) {
  20.             $value = parent::__get($this->get_versioned_key('key', $this->state_version));
  21.             // update the value after updating the data structure
  22.             parent::__set($this->get_versioned_key('key', self::VERSION), $value);
  23.             $this->state_version = self::VERSION;
  24.             $this->save_state();
  25.         }
  26.     }
  28.     // if you upgrade all keys as needed in the method above, you don't need to walk the previous
  29.     // keys when loading/saving and you can just get the current version of the key.
  31.     private function get_previous_version(int $version): int {
  32.         return $this->has_previous_version($version) ? $version - 1 : $version;
  33.     }
  35.     private function has_previous_version(int $version): bool {
  36.         return $version >= 0;
  37.     }
  39.     private function walk_versions(int $version, callable $callback, callable $predicate): mixed {
  40.         $value = $callback($version);
  41.         if($predicate($value) || !$this->has_previous_version($version)) {
  42.             return $value;
  43.         }
  44.         return $this->walk_versions($this->get_previous_version($version), $callback, $predicate);
  45.     }
  47.     private function get_versioned_key(string $key, int $version) {
  48.         return $this->has_previous_version($version) ? $version.$key : $key;
  49.     }
  51.     public function __get(string $key): mixed {
  52.         return $this->walk_versions(
  53.             self::VERSION, 
  54.             fn($version) => parent::__get($this->get_versioned_key($key, $version)),
  55.             fn($value) => isset($value)
  56.         );
  57.     }
  59.     public function __isset(string $key): bool {
  60.         return $this->walk_versions(
  61.             self::VERSION,
  62.             fn($version) => parent::__isset($this->get_versioned_key($key, $version)),
  63.             fn($isset) => $isset
  64.         );
  65.     }
  67.     public function __set(string $key,mixed $value): void {
  68.         // optional: you can unset previous versions of the key
  69.         parent::__set($this->get_versioned_key($key, self::VERSION), $value);
  70.     }
  72.     public function __unset(string $key) : void {
  73.         // unset this version and all previous versions
  74.         $this->walk_versions(
  75.             self::VERSION, 
  76.             fn($version) => parent::__unset($this->get_versioned_key($key, $version)), 
  77.             fn() => false
  78.         );
  79.     }
  80. }

There’s a lot to be optimized, and it wouldn’t be a good idea to use this verbatim in production, but you can get the gist of how it would work. A lot of it will depend on your use case which is why there’s not something like this in the SDK. For instance, in this example implementation, the previous value is kept for where there may be a bug during an upgrade; keeping the previous value allows for running the upgrade again, but you may wish to delete the previous value.