shampine / sequence Goto Github PK

Similar to post and patch the need for pagination support, the fields should be

• limit
• cursor (for the where greater than query)

• allow instantiation of nested pipelines
• define sub-pipeline class
  • contains pre / post hydration routines
  • toggle whether to fatal on exception
  • support custom arguments

Upgrade to php8.2

• support a transaction state on a payload
• if enabled this will trigger a rollback on failure

Current diagram on the readme does not match by type.

Support searching by parameter with HasPatch.

The error response wrapper is named ErrorResponseWrapperWrapper and should only have one wrapper.

• allow customization of json response (fields etc)
• allow renaming or overwriting of names, maybe by config?

Instead of defining add a magical getter to be used by the formatter:

• none of this code is type hinted
• all of it is handled by magic getter creation in format

See an issue with setCursor(). Likely due to the "self" declaration on the return.

$responde should be $response. Need to find and replace.

Use more inclusive language.

Currently actions are locked to support php 7.4. Also unsure if the minimal packages included will support php 8.

Probably should update the autoload-dev to:

    "autoload-dev": {
        "psr-4": {
            "Tests\\": "tests/"
        }
    },

Then will need to namespace all the dirs/classes to live under Tests.

todo:

• installation
• usage (more examples)
• testing
• license

Run: ./test/run.sh

Shampine\Sequence\Entity\ChildPipelineEntity
  Methods:  92.86% (13/14)   Lines:  95.24% ( 20/ 21)

Action steps:

1. composer install
2. run phpstan
3. run phpunit

Add phpstan to run static analysis on the project

https://github.com/phpstan/phpstan

Few renames before v1.0

• rename Request Payloads to Payloads
• rename Response Payloads to Response
• rename Error & Success Response to be ResponseWrappers

Currently there is a lot of confusion with Request + Response Payloads.

This will require a lot of documentation updates as well.

• callout that under the hood the league pipelines is used
• add a link to the pipelines for further documentation

• need to add documentation on how to use subpipelines