buggregator / trap Goto Github PK

There is Psalm baseline. We need to resolve it.

Add support for secure connections

Print a random joke about PHP

Or print a joke of the day on start

Integrate infection with stryker

It is necessary to remove the replaces block, as it can conflict with other packages that have overlaps in the replaces section.
It would also be desirable to find or create a separate reliable package responsible for removing unnecessary polyfills.

Add CS checker and fixer that will:

• Check the code for compliance with PER-2 #67
• #68
• Take into account some custom aspects:
  • We use FQN for functions in the global namespace
  • We use FQN for classes in the global namespace

https://github.com/PHP-CS-Fixer/PHP-CS-Fixer

Helpers

Thoughts

• #41 (required to be prepared for adding trap()::profile() methods)
• SPX
• XHProf (supported by Buggregator Server and UI)
• XDebug (local files, cachegrind format, 1)

Parsing formats

• Parse XHProf content into XHProf events
• Parse XDebug content into XDebug events
• Parse SPX content into SPX events

Local profiling files

• #52

Rendering:

• #11

Summary

I propose integrating PestPHP into buggregator/trap.

PestPHP is known for its elegant syntax and pretty console outputs, enhancing both readability and debugging capabilities.

Reference Example

Please refer to this repository for a guide on integrating PestPHP with Laravel packages: Laravel Package Template with PestPHP.

Benefits

• Improved test readability and maintenance.
• Pretty console output for better debugging.
• Attracts a broader audience familiar with PestPHP.

I propose adding PHPStan to our development toolchain alongside Psalm.

Key benefits include:

• Widespread Adoption: PHPStan is widely used in PHP projects, making integration seamless for most developers.
• Complementary Tooling: Using both PHPStan and Psalm allows us to leverage their unique strengths in static analysis, enhancing code quality and reliability. See the discussion here for more insights: GitHub Discussion #8986.
• Minimal Impact on Dependencies: Adding PHPStan should not significantly affect our dev dependencies, as buggregator/trap is included as a dev dependency.

This tool setup would increase the robustness of our code analysis without major overhead.

It miht be useful for elimination of Docker requirement. In that case we shall use PHP only on backend

Checklist:

• Choose the format of the future configuration file (leaning towards XML when choosing between PHP, XML, JSON, and YAML).
• Determine what can be configured (including in the future).
• Design the file structure.
• Describe the schema.

It should be used in case if any dispatcher won't detect request type and will render data as is

When a user opens an SMTP event with images in the markup, the images do not display.

There are a few profiling options where profiling files may be stored:

xhprof.output_dir = ...
xdebug.output_dir = ...

Need to scan it sporadically and push events about new files

There are broken links because of CORS.

Need to move the logo into https://github.com/buggregator/trap/tree/master/resources/payloads and use it as a test payload and as a picture for the logo

Executed chmod +x ./bin/trap for more easy execution ./bin/trap without added php before command

Need to check that auto-push works well

It would be good to have ability to use TRAP_* env variables to configure /vendor/bin/trap

For example:

TRAP_SENDERS=console,server
TRAP_DEBUG_PORTS=9912,xxxx,yyyy
TRAP_UI_PORT=8000

Which would simplify usage in docker, here is current example:

  trap:
    image: wayofdev/php-dev:8.3-cli-alpine-latest
    container_name: ${COMPOSE_PROJECT_NAME}-trap
    restart: on-failure
    networks:
      - default
    ports:
      - '${TRAP_PORT:-9912}:9912'
      - '${TRAP_UI_PORT:-8000}:8000'
    volumes:
      - ./:/app:rw
      - ~/.composer:/.composer
    env_file:
      - .env
    entrypoint:
      - /app/vendor/bin/trap
      - --ui
      - --port=${TRAP_PORT:-9912}
      - --sender=server
      - --sender=console

Also, currently, there is no way to customize UI port number. 8000 port is used by many other applications, and it would be nice, to be able to customize it via console command attributes and also via ENV variables.

• dependencies
• phpunit
• coverage
• psalm
• #53
• security
• #56

Should be optional

For those who starts using trap for first time, it would be useful to list all available commands through console --help, inside README.md, so that developers could easily find documentation in one place.

I would propose to create table inside markdown with available options from console:

In the case when a user locks an event, a list of event identifiers for deletion is sent to the endpoint for clearing all events. This needs to be taken into account.
To do this, we need to consider passing additional parameters from the request payload.

• When calling RPC via a websocket, additional parameters are defined in the data field.
  #37
• When accessing via HTTP, parameters are passed in the request body, packed in JSON.
  #38

Need to config CI pipelines to build trap.phar

Make interactive CLI mode

It may be

• custom solution
• https://github.com/php-tui/php-tui

Add support for https://github.com/yiisoft/friendly-exception

Add the trap() function into ForgottenDebugOutputInspector there https://github.com/kalessil/phpinspectionsea

• https://blackfire.io/docs/up-and-running/installation?action=install&mode=full&version=latest&mode=quick&location=local&os=debian&language=php#installation-instructions
• https://github.com/blackfireio/php-sdk