dapr / php-sdk Goto Github PK

Expected Behavior

Publishing Cloud Events should work.

Actual Behavior

Cloud Events do not work.

Steps to Reproduce the Problem

Run integration tests on latest release candidate.

See: dapr/docs#1130

Release Note

RELEASE NOTE: FIX Cloud Events shouldn't be wrapped in a Cloud Event

Update the SDK for the following breaking changes:

1. Service invocation now handles queryparams as string and not Map of string->string. Get the latest proto and fix any code in the SDK that refers to that. I assume there is no need to handle this in the PHP SDK because it does not use gRPC.

2. When content type is "application/octet-stream", CloudEvent's data will now be in data_base64 and that should be exposed as byte[] to the application.

The Configuration API feature has been implemented in Dapr runtime: dapr/dapr#3606
It needs to be accessible via the SDK.

Per work items below, the syntax of the state query JSON has been slightly changed, to make it more intuitive:
dapr/components-contrib#1490
dapr/components-contrib#1491
dapr/components-contrib#1500
dapr/docs#2195

Please validate this change in the SDK, and fix if necessary.

Describe the feature

Add examples with laravel/symfony integration

Most of us use laravel/symfony in real world applications.

Currently, the developer may replace the serializer/deserializer with their own implementation, however, this is the same serializer and deserializer that the SDK uses for communicating with the sidecar. This is a simple configuration change to fix and not a breaking change.

Describe the feature

SDK change required to fully support dapr/dapr#2889

This requires an optional integer value to be specified in the Actor Runtime Config.

https://github.com/dapr/dapr/blob/6aede40905a6f37b1e27d1816447606eb0770ac5/pkg/config/app_configuration.go#L19

Describe the proposal

Runtime has added support for ISO 8601 intervals for reminders as per dapr/dapr#2513.
Make changes to SDK to support accordingly

Bugs and security issues result from data being unexpected and the code still continuing anyway.

• configure Infection
• address issues

This feature is implemented in dapr runtime: dapr/dapr#3662

It should be available via the SDK

Expected Behavior

Given the dotnet classes:

public class WeatherForecastWithPOCOs
{
    public DateTimeOffset Date { get; set; }
    public int TemperatureCelsius { get; set; }
    public string Summary { get; set; }
    public string SummaryField;
    public IList<DateTimeOffset> DatesAvailable { get; set; }
    public Dictionary<string, HighLowTemps> TemperatureRanges { get; set; }
    public string[] SummaryWords { get; set; }
}

public class HighLowTemps
{
    public int High { get; set; }
    public int Low { get; set; }
}

results in the following json object:

{
  "Date": "2019-08-01T00:00:00-07:00",
  "TemperatureCelsius": 25,
  "Summary": "Hot",
  "DatesAvailable": [
    "2019-08-01T00:00:00-07:00",
    "2019-08-02T00:00:00-07:00"
  ],
  "TemperatureRanges": {
    "Cold": {
      "High": 20,
      "Low": -10
    },
    "Hot": {
      "High": 60,
      "Low": 20
    }
  },
  "SummaryWords": [
    "Cool",
    "Windy",
    "Humid"
  ]
}

Which should be handled with the following PHP classes:

class WeatherForecastWithPOPOs
{
    public DateTime $Date;
    public int $TemperatureCelsius;
    public string $Summary;
    public string $SummaryField;
    #[CastValues(DateTime::class)]
    public array $DatesAvailable;
    #[CastValues(HighLowTemps::class)]
    public array $TemperatureRanges;
    public array $SummaryWords;
}

class HighLowTemps
{
    public int $High;
    public int $Low;
}

Actual Behavior

Deserialized as an array.

Steps to Reproduce the Problem

See above

Release Note

RELEASE NOTE: Fix Deserialization of complex types from other SDKs

Describe the feature

SDK version 1.2 includes a new dapr client and begins the deprecation of few classes. The changes need to be documented in dapr docs site and in the readme.

Migration from 1.1 to 1.2 needs to be documented, though it is pretty straightforward.

Release Note

RELEASE NOTE: ADD documentation for 1.2

Describe the feature

Sometimes when calling an actor method, you need the response. Other times, you don't.

It would be nice if there was some way to say that you don't want to call wait for the response. In languages like C#, you can choose to wait for the response, or you can "fire and forget it" by not awaiting the async call.

In PHP, this is not possible because it's a synchronous language by default. This should mostly be considered when optimizing time spent in functions or when something needs to be started that takes a long time to run.

Proposal

Add a function nowait() that accepts a callable, the function sets a "magic variable" which lets the proxy know not to wait for the response, only while executing the callable.

Alternatively, we could create an await() function that does the opposite, and method calls are normally "fire and forget." I don't really like this idea because it seems to be counter-intuitive in PHP.

This could also be a configuration argument when getting an actor proxy.

Release Note

RELEASE NOTE: ADD Fire and forget API calls

This feature has been implemented in Dapr runtime: dapr/dapr#2906

It needed to be available via the SDK.

Describe the feature

The Dapr Client should send the DAPR_API_TOKEN if it is set.

Release Note

RELEASE NOTE: ADD Dapr API token support

Describe the proposal

During yesterday's community call, I was inspired by the dotnet-sdk's use of attributes to define where data comes from in API calls. I think something like this would be really handy:

$method = #[HttpMethod('GET', 'POST') function myMethod(#[FromUrl('/d+')] $id, #[FromBody] $data) {
 return 'ok';
}
Runtime::register_method($method);

Describe the feature

Add deeper documentation on using the SDK and any details.

Release Note

RELEASE NOTE: ADD Documentation

We have a few guarantees from the Actor system, for example, we know there's no other instance of an actor running elsewhere in the cluster and no other instance of PHP is being called.

That being said, we can use the filesystem to cache state between requests. That way we can avoid reading the same state from the store when it hasn't changed.

The general flow will look like this:

1. Activation: if there is a filesystem cache, delete it (unclean deactivation)
2. If there is a filesystem cache, read it
3. Commit the transaction
4. Commit state to filesystem cache
5. Deactivation: delete the filesystem cache

Describe the feature

Release Note

RELEASE NOTE:

Describe the feature

• Should support monolog.
• Review all logging output and ensure it adds usefulness.

Release Note

RELEASE NOTE: ADD monolog

Currently, in the readme, we have composer require dapr/php-sdk. However, we don't currently have a composer org.

We should create it. Also, I'm not sure on the name of the package. php-sdk seems kinda redundant.

Expected Behavior

Actors should work

Actual Behavior

The SDK isn't using the single get endpoint, but rather using the more generic bulk state endpoint. This causes an issue with cosmos db (and potentially other components) because the component uses the name of the key as the partition key, however, the actor identity should be the partition key.

Steps to Reproduce the Problem

1. Set up cosmosdb component
2. Use ngrok to proxy the component, for example: ngrok http -hostname=ENDPOINT.eu.ngrok.io -region eu -host-header=rewrite https://COSMOS_DB.documents.azure.com:443/
3. See the X-Ms-Documentdb-Partitionkey header set on loading keys be set to the full key. It should be the actor id, or not set at all and be a cross partition query.

Release Note

RELEASE NOTE: FIX actors with cosmosdb

Describe the feature

We can use attributes instead of consts in actors.

Release Note

RELEASE NOTE: Add Attributes in actors

Due to how the error handler is registered, it skips the middleware to handle tracing. The middleware needs to be universal.

Related to #47

Right now, it's injecting the "default" logger, however, the logger in use should be one specific to the SDK.

Expected Behavior

Exceptions should be more transparent about what happened to allow for better debugging.

Actual Behavior

Exceptions are vague and don't contain any detail.

Steps to Reproduce the Problem

Invoke a stateful method without configuring state.

Release Note

RELEASE NOTE: FIX Make exceptions more transparent.

Actor References come from the dotnet sdk and Orleans. It's a very handy structure for identifying an actor and can be safely stored.

Expected Behavior

To be able to use the php-sdk with PHP 8.0.1

Actual Behavior

The required PHP version is too strict.

Steps to Reproduce the Problem

1. Install PHP 8.0.1
2. Run composer install

Release Note

RELEASE NOTE: FIX PHP version too strict

After learning the hard way, file_put_contents may not flush the file to disk (it's a very old bug). Caches are written using this function, which may cause intermittent race conditions. The file writing needs to use lower-level functions to write files and ensure it is flushed to disk.

Describe the feature

Examples provide a fairly good surface for providing e2e tests. I wonder if we can use the examples directory to provide those tests.

Release Note

RELEASE NOTE: ADD examples as e2e tests

Expected Behavior

dapr runtime changes the error code returned by the state apis for etag mismatch related errors and other errors. Check if the sdk needs a change. dapr/dapr#2647

Actual Behavior

Check if sdk needs a change to distinguish between etag mismatch and other state api issues

Steps to Reproduce the Problem

Error code internal is returned when state api fails due to etag mismatch error

Release Note

RELEASE NOTE:

Describe the feature

1.2 is in RC, it just needs documentation

Release Note

RELEASE NOTE:

If an app doesn't have any subscriptions, it should return an empty array and not an empty response.

Migrate from pure-markdown docs to hugo based documentation so it can be served by Dapr docs uri.

Describe the feature

The dapr core runtime is planning on supporting actor reentrancy. The bulk of this logic will be handled in dapr's runtime but the SDK will be responsible for:

• Preserving the header dapr-reentrant-id
• Providing the new config fields required by dapr/config

For more context on actor reentrancy, the design proposal can be found here: actor reentrancy

Release Note

RELEASE NOTE: ADD Support for actor reentrancy

The code is frozen until after 1.0.

Only bug-fixes and documentation updates will be merged to main.

Symfony integration

Do you plan to describe how to integrate DAPR into Symfony properly?

Describe the feature

There'll be some new features in 1.1, and a guide needs to be written specifically explaining how to upgrade the code to take advantage of those features.

Release Note

RELEASE NOTE:

Due to the single-threaded nature of the dev server, it's possible the actor tests can hang forever.

• use docker-compose to start the servers
• output the logs when there is an error

Describe the feature

Dapr supports GPRC which the PHP SDK could benefit from.

Release Note

RELEASE NOTE: ADD GPRC client

Release the candidate for 1.2, for testing with production.

Describe the proposal

Ref dapr/dapr#2864

Release Note

RELEASE NOTE: ADD support domain socket.

Describe the feature

The title explains it all!

• Add a simple counter actor example
• Binding example
• Invocation example
• Pubsub example
• Secret store example
• W3C tracing example
• Examples in docs repo
• Laravel support and example (#82)
• Symfony support and example (#88)

Release Note

RELEASE NOTE: ADD Examples

There are two proxy types:

1. ActorProxy
2. TransactionalState

In older versions of PHP, this is probably ok. However, in PHP 8, which has a much richer type system, this can get in the way.

For example, with an actor's constructor, we must not specify a type for the state because it's being proxied by the TransactionalState proxy. Also, when getting an ActorProxy, we cannot specify the type because it doesn't have one.

Describe the feature

Currently, code generation is home-brewed, it would be a good idea to rely on a library for that.

Release Note

RELEASE NOTE: UPDATE better code generation

Describe the feature

The bulk secrets API needs to be included from dapr/docs#1089

Release Note

RELEASE NOTE: ADD bulk secrets API

Describe the feature

Currently, integration tests can only be run manually. They should be automated.

Release Note

RELEASE NOTE: ADD automated integration tests

Describe the feature

Ensure there are tests that assert serialization works as described in https://v1-rc2.docs.dapr.io/developing-applications/sdks/serialization/.

There need to be tests that assert that serialization is compatible with other SDKs.

• state serialization
• pubsub
• bindings

Release Note

RELEASE NOTE: UPDATE Add serialization unit tests.

Formatting is kind-of spotty and inconsistent. It'd be good to have some consistency and have formatting be enforced in PRs.

Describe the feature

Now that dapr/dapr#3095 is merged, we can support native DateInterval instead of constructing a time golang time span

Release Note

RELEASE NOTE: ADD native DateInterval support