Skip to content

v1.0.0

Latest

Choose a tag to compare

@niden niden released this 14 Nov 16:39
· 1 commit to master since this release
004ee0d

Added

  • A shared fixture, tests/support/assets/DebugBar/panel-contract.json, makes the PHP and JavaScript tests use the same payload. #62
  • Documentation and tests for the View and Cache panels in ADR applications. #46
  • Optional collector summaries show headline metrics above a panel. The database panel shows total queries, duplicate runs and SQL time.
  • Request history does not set its cookie when output started before the response, so setcookie() gives no warning. #32
  • Request history for each browser, at GET/DELETE /_debugbar/open. It is disabled by default and needs an absolute, writable history.path.
  • Request history in ADR applications, with the history.base_uri option. #43
  • The Database panel shows Phalcon\DataMapper queries in ADR applications (Phalcon v5.19.0 or later, or Phalcon 6). #16
  • The Route panel shows the Action class and the request attributes in ADR applications. #45
  • The debug_page option shows the debug page for a server error in ADR applications. #48
  • The database, view, cache and route collectors take data through public methods, with no events manager. #44
  • The debug page exceptions implement Phalcon\Debug\Contracts\DebugThrowable. #95
  • The documentation states that access.callback can run more than once for a request.
  • The documentation states that a browser in request history is one history cookie, so all its windows and tabs count as one for history.max_browsers. #32
  • The documentation states the effect of a long-lived worker on request history. #62
  • ADR\Provider boots the bar in Phalcon\ADR applications (Phalcon v5.18.0 or later, or Phalcon 6). #14
  • Core::createHistory() creates the request history from the history config, and History\HistoryRecorder holds its workflow. #62
  • Core::getBar() returns the bar that boot() created. #62
  • Core boots the bar with no MVC application and no DI container. #40
  • DebugBar::addCollector() subscribes a collector that implements Contracts\Subscriber. #15
  • History\HistoryEndpoint takes the request and the base URI with no DI container, and Mvc\HistoryListener selects the MVC controller. #41
  • History\HistoryHandler lists, reads and clears the request history with no MVC types. #42
  • Logger\ExceptionAdapter feeds the Exceptions panel from the logger in ADR applications. #47
  • Mvc\Bridge and ServiceBridge feed the built-in collectors, which no longer hold framework event names. #15
  • RequestContext holds the client address and the AJAX and HTTPS flags for each decision, and Injector::isHtml() tells if a response is an HTML page. #62
  • ResponseListener::handle() injects the bar with no event. #39
  • Security\Redactor::redactUri() applies the redaction rule to the query of a URI. #62
  • history.url cannot be /. The documentation states that the history endpoint wins over an application route with the same path, for each HTTP method. #32
  • memory collector for current and peak PHP memory use. Memory opens from an indicator on the right.
  • redact.unmask takes patterns for masked keys whose values show, and Security\Redactor takes them as an optional third argument. A pattern matches the whole key, and * matches zero or more characters. A hidden key stays hidden. #67

Changed

  • Breaking: LoggerCollector takes a Security\Redactor, and it redacts the log context. #62
  • Breaking: Logger\Adapter and Logger\ExceptionAdapter have no constructor argument. They read the active bar each time the logger writes, so you can create them before the bar boots. Replace new Adapter(Debug::getBar()) with new Adapter(). #62
  • Breaking: the built-in collectors no longer implement Contracts\Subscriber and have no subscribe() method. #15
  • A collector no longer sends widget.icon and AbstractCollector has no $icon property, because the browser client never read them. indicator.icon does not change. #62
  • The Time panel opens from an indicator on the right, not from a tab.
  • The bar sends meta.widgets, so each tab shows the label of its collector and each panel uses its declared type. The logger tab now reads "Logs", not "Logger".
  • The debug page in ADR applications uses Injector::isHtml() and no longer depends on the injection rules of the bar. #62
  • The providers validate the history config after they check for the events manager, and for the container or the router. An invalid history.path does not throw when history cannot run. #62
  • DebugBarTypes holds the wire contract and the config shapes, and it lists the panel names, so static analysis rejects an unknown panel name. #62
  • DebugBarTypes lists the icon names as icon_type, so static analysis rejects an unknown indicator.icon. A test keeps the list equal to the drawings in debugbar.js. An indicator with an unknown icon name now shows no icon, not the gears. #64
  • ResponseListener takes an optional History\HistoryRecorder as its last argument. #62
  • redact.mask and redact.hidden also match the word parts of a key. The redactor splits a key at _, -, . and camelCase, so token now masks reset_token and accessToken. Some values that showed before now show ***. #67

Fixed

  • Accept only true from the access callback, and leave the response without a bar when the callback or a collector fails. #96
  • Apply the debug page blacklist to nested keys too. #84
  • Debug page: copy on http:// pages, show "Copy failed" when a copy fails, and encode the paths in the PhpStorm and VS Code links. #101
  • Debug page: show the previous exceptions, fix the API links, read each file one time, drop the arguments from the debugVar() backtrace, match \vendor\, and end the line of a skipped Dump key. #100
  • Discard all output buffers that start after Debug is created, not only one. #85
  • Enable a history row again when its request fails after another row was clicked. #89
  • Escape array keys and property names in the debug page. #70
  • Escape quotes, invalid UTF-8, the class name and file paths in the debug page. #80
  • Evict another browser from request history only after the new request is stored. #79
  • Explain in Provider why the boot request uses get() and the history request uses getShared(). #98
  • Hide the CSRF token in the session panel when the session has a uniqueId. #73
  • Inject the bar only into HTML pages that have a </body> tag. #76
  • Inline the shipped minified assets instead of minifying them for each response, escape the nonce, and remove defer from the inline script. #97
  • Keep at most max_rows rows (default 1000) in the cache, database, exceptions, logger, messages and view collectors, and show the number of dropped rows. #92
  • Keep host CSS out of the bar tables, code blocks and buttons, stop history requests after 10 seconds, and show "Unable to load" in a history row that fails. #102
  • Mask the Php-Auth-* headers and the pw, pwd and passwd keys by default. #71
  • Name the collapse toggle and the tabs for screen readers, close the open panel or the history with Escape, and fix two Phalcon\Debug docblocks. #106
  • Open the ADR debug page only for an exception logged at error level or higher, and show a lower-level exception only in the exceptions panel. #107
  • Pin pie.phar to a release with a sha256 check, build the PHP 8.1 Docker image, declare ext-mbstring, and list the Phalcon version that each feature needs. #104
  • Print *RECURSION* in Dump for an object or an array that contains itself. #82
  • Print [uninitialized] in Dump, and skip a dump() method that the debug page cannot call. #83
  • Redact objects in the log context. #72
  • Redact the ADR request attributes in the route panel. #93
  • Render a string panel as text unless the collector sets the html panel type. #75
  • Replace invalid UTF-8 with U+FFFD, so the bar and request history keep the data. #78
  • Require phalcon/traits, and document Phalcon v5.17.0 as the minimum Phalcon 5 version. #86
  • Share one renderer and one CSS block for the exceptions and logs panels, and show an exception with no trace as a plain line. #108
  • Show true and false for booleans in messages, show [], null and the class name of an object in the grid, and time each query from its own start (0 when there is no start). #99
  • Stop the request control from showing [object Object] when there is no request panel. #88
  • Stop warnings while the debug page renders, and escape its fallback message. #81
  • Test HTML writes, the collapse state and localStorage errors in the JS tests, and keep every listener in the fake DOM. #103
  • The request panel and request history no longer show or store a query value under a masked key in the URI. #62
  • Throw InvalidConfig and StorageNotWritable for history errors, so every exception of the bar implements DebugBarThrowable. #87
  • Update Content-Length after injection, and skip compressed responses. #77
  • Use the name constants of the collectors and the history controller, and inject the Injector into the ADR debug page listener. #94
  • Use the same JSON flags in each panel, show a Throwable in a log context, and keep the context when one value cannot be encoded. #91
  • env.blocked always blocks production and prod, and ignores case and spaces. #74

Removed

  • HistoryController::clearAction() and indexAction(), Phalcon\DebugBar\Version and CodeFragment::getMode(), which nothing used. #95