Repository navigation
Document the debugbar reading its data when the toolbar renders - #144
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documents taking the debugbar out of the app flow and the packages that feed it, as in quantum-php/framework#592 (#539).
What changed
packages/debugger/architecture.md: rewritten around reading the tabs when the toolbar renders: the render flow, a table of where each tab's data comes from and when, an exampleroutesentry, the store holding only direct writes, and why a secondrender()duplicates entries.packages/debugger/overview.md,usage.md,contracts.md,helpers.md: no boot step (InitDebuggerStageis gone,initStore()is optional);addToStoreCell()is the way to add an entry to any tab;getStoreCell()returns only direct writes; the store guarantee; the layouts are the only caller ofdebugbar()outside the package. Corrects the level contract:MessagesCollector::log()accepts any level string.packages/logger/*: the debug-modemessageadapter keeps messages in memory (getMessages()) and ignores the context, so atabkey no longer routes a message; "Route debug messages into a custom debugger tab" becomes "Check what was logged in debug mode". Also corrects thereport()signature (string|Stringable) and when the logging config loads (during boot, for the error handler).packages/mailer/*: new "Transport log" contract (getTransportLog()onMailerInterface: errors of failed sends and, in debug mode, the SMTP exchange); the "mirrored into the mails tab" sentences point there. Corrects the failure contract: a failed SMTP send throws, only the API adapters returnfalse.packages/app/architecture.md,overview.md,adapters.md,advanced-features/request-lifecycle.md: no debugger stage in the web boot, and preparing a request no longer writes to the debug bar.packages/view/contracts.md,architecture.md,overview.md: newgetViewFile(); the View no longer updates the debugger.packages/event/architecture.md: the toolbar readsgetRegistered()when it renders.Changed paths
v3.0/packages/debugger/architecture.mdv3.0/packages/debugger/overview.mdv3.0/packages/debugger/usage.mdv3.0/packages/debugger/contracts.mdv3.0/packages/debugger/helpers.mdv3.0/packages/logger/overview.mdv3.0/packages/logger/usage.mdv3.0/packages/logger/contracts.mdv3.0/packages/logger/architecture.mdv3.0/packages/logger/adapters.mdv3.0/packages/logger/helpers.mdv3.0/packages/mailer/overview.mdv3.0/packages/mailer/usage.mdv3.0/packages/mailer/contracts.mdv3.0/packages/mailer/adapters.mdv3.0/packages/app/architecture.mdv3.0/packages/app/overview.mdv3.0/packages/app/adapters.mdv3.0/advanced-features/request-lifecycle.mdv3.0/packages/view/contracts.mdv3.0/packages/view/architecture.mdv3.0/packages/view/overview.mdv3.0/packages/event/architecture.mdSUMMARY.md: no change.