open-feature / php-sdk Goto Github PK

We return a No-op provider if none has been provided by the user. This is not validated by unit testing. Add a unit test for this scenario.

There a base hook classes for each flag type.

These are not individually tested so account for missing lines in our Codecov. Additionally, they should have a basic test to ensure they behave as expected.

These should ensure that the shouldResolveFlag only triggers for the specific flag type for the respective hook.

Requirements

Add a CONTRIBUTING.md file for interested developers to get started 🚀

Requirements

Codecov integrated into our CI processes

Requirements

Integrate OpenSSF similarly to other packages

js-sdk example

Requirements

Execution of integration tests utilizing the test-harness repository, the BDD tests, and the flagd provider.

This utility class needs more coverage for decapitalize

Requirements

There isn't any work really for this besides updating the docstrings in the SDK to properly annotate the requirement target numbers

Implement specification v0.7.0 changes

See changes since last release.

Please note there's no need to complete all these tasks in a single PR (in fact, that's not recommended).

Functional requirements:

• implement flag metadata: open-feature/spec@74c373e
• implement named client support: open-feature/spec@4cf8229
• implement initialization/shutdown: open-feature/spec@a4ffec3
• implement events: open-feature/spec@bf9e45b

Non-functional requirements:

• add relevant tests
• add examples and documentation, see template README
• update specification badge to v0.7.0:

Keep in mind:

• backwards compatibility is highly encouraged
  • take every precaution to ensure existing code written by application authors and existing providers implementations, do not break
• it's recommended these features are released together

You can set hooks and evaluation context but these are non-actionable, since they don't truly impact the return values. Add unit tests to cover these.

Please see the open discussion here for more information: open-feature/spec#164

Essentially, some SDKs simply reverse the calculated before hooks (API, Client, Invocation, Provider), and others generate the list with the original lists of Provider, Invocation, Client, and API.

This can result in varying behavior between SDKs.

The preference in the JS SDK is reversal. The Python SDK has also been updated to do reversal. PHP should likely do the same, but there is continuing discussion on the issue linked.

Depending on what PHP runtime is used, we cannot expect the $_SESSION to exist, and we don't want to reduce compatibility with other runtimes.

Remove the commented code considering use of $_SESSION for global singleton.

If an error is thrown while generating the OpenFeatureClient, we return a No-op client in its stead. Add a unit test to validate this scenario.

Change in the documentation

Update the readme to follow the new template. Once this is ready, the documentation can be configured to pull from the repo automatically.

Examples from other repos:

• https://github.com/open-feature/java-sdk
• https://github.com/open-feature/js-sdk/tree/main/packages/client

This includes upgrading to newer language offerings like native enums

• Drop support for PHP 8.0
• Refactor to utilize native enums
• Refactor to read-only properties
• Refactor to intersection types
• Refactor to final class constants
• Refactor to object array unpacking
• Ensure null parameters are marked as such

Reference: https://www.php.net/releases/8.1/en.php

Using something like ReadTheDocs or similar, provide documentation for usage of the PHP SDK.

Requirements

We don't need to import a package to provide enum functionality, we can use them once we're on PHP ^8.1

Update the SDK to be compliant with the v0.5.0 spec.

What's Changed

⚠ BREAKING CHANGES

• open-feature/spec#142 Error codes must be a constrained set of values (e.g. enum).

Additional changes

• open-feature/spec#140 Clarify that reason must be a string in the flag resolution details and evaluation details.
• open-feature/spec#142 Add optional error message to flag resolution details.

General

• Add/update a spec version badge on the readme.

Full Changelog: open-feature/spec@v0.4.0...v0.5.0

Observed behavior

AbstractHook helper class for implementing hooks (and the shared super class of various helpers like BooleanHook) defines an abstract finallyAfter method.

Expected Behavior

AbstractHook should define an abstract method finally conforming to the Hook interface

Steps to reproduce

Look at the source code

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• chore(deps): update dependency php to v8.3.4
• chore(deps): update dependency psalm/plugin-phpunit to ^0.19.0
• chore(deps): update dependency vimeo/psalm to ~5.23.0
• chore(deps): update codecov/codecov-action action to v4
• chore(deps): update dependency phpunit/phpunit to v11
• chore(deps): update dependency spatie/phpunit-snapshot-assertions to v5
• Click on this checkbox to rebase all open PRs at once

Ignored or Blocked

These are blocked by an existing closed PR and will not be recreated unless you click a checkbox below.

• fix(deps): update dependency open-feature/flagd-provider to ^0.8.0

Detected dependencies

• Check this box to trigger a request for Renovate to run again on this repository

There are no scenarios we expect this error to occur, but should an invalid flag type be provided to resolve in the client, an error is thrown. Add a unit test to cover this case.

Requirements

Support for the latest test-harness with the Flagd provider

Observed behavior

Merging the release-please PR failed to tag and relase on GitHub

Expected Behavior

A new GitHub release is created along with a tag

Steps to reproduce

Merge a standard release-please PR

Requirements

It would be nice if the SDK would support caching of the flag requests.
For example add a psr/simple-cache compatible cache storage and then store the results for better performance.
This way not every provider has to implement its own caching.

I looked into hooks but as far as I understand its not possible to implement a caching hook.
The return type is always just an EvaluationContext so its not possible to prevent requesting within a hook.

There is no unit test written to cover retrieving the version from the client. This is a standard accessor method that is trivial to implement for the OpenFeatureClient.

Requirements

The PHP 7.4 version is end of life and is not receiving further security updates. We will no longer support this version. Deprecate the target for 7.4.

This also frees up package updates such as psr/log (#41)