Improve developer UX for using local evaluation in PHP client
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 38/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- php
- Domain
- developer-experience, documentation
Research direction
Review the PHP client's current local evaluation implementation and the documentation for setting up local evaluation with the environment document cache. Compare how other clients expose local evaluation and TTL behavior, then update the PHP behavior and setup guidance so the requested enableLocalEvaluation flow and exact working steps are covered.
Written by the indexing model from the issue text.
Description
As per the issues #99 & #101, there are a few developer UX issues when using local evaluation in our PHP client which we should try to resolve.
The key issue here is that it is currently required to create a separate cron job to update the environment document cache outside of the integration of the Flagsmith SDK into the customer application. It may not be possible to remove this, but there are improvements that we can make:
- The documentation is not overly clear - we should provide exact steps on how to achieve a working set up of local evaluation mode in PHP
- The functionality to enable local evaluation mode relies on the
environmentTtlproperty which, when set in the client itself and not in the cron job, seemingly has no effect other than to enable local evaluation mode. We should look to bring this functionality more in-line with the rest of the clients, and add anenableLocalEvaluationargument.
- Dominant language
- PHP
- Stars
- 18
- Forks
- 13
- Avg merge
- 28m
- Merged PRs (30d)
- 1
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from Flagsmith/flagsmith-php-client
-
Difficulty 4/5 3-5 days Newbie friendliness 55/100
-
Difficulty 4/5 3-5 days Newbie friendliness 48/100
-
Dependency Dashboard Open
Difficulty 4/5 3-5 days Newbie friendliness 20/100
-
Difficulty 4/5 3-5 days Newbie friendliness 58/100
-
tech-debt
Flagsmith/flagsmith-php-client#110 · 1 assignee ·
All issues in Flagsmith/flagsmith-php-client
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
pluginsGLPI/datainjection#673 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
octobercms/october#6130 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
getgrav/grav-plugin-form#656 ·
-
customer-support needs-triage Platform(Default)
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
sync-en
Difficulty 1/5 1-3 hours Newbie friendliness 88/100