New debug view #141

[abovedave]

New debug view for #141

• Changes config setting allowJsonView to allowDebugView
• Replaces ?json=true with ?debug=json
• Shows the Web and Node.js version

?debug

Shows the page data object, template and the output (prior to any postProcessors)

?debug=data

Shows the page data object

?debug=page

Shows the data used to the construct the page internally to Web

• Name
• Key
• hostKey
• Template (e.g., index.dust)
• resolvedTemplate (full path on disk)
• ContentType
• Datasources
• requiredDatasources
• Events
• globalEvents
• preloadedEvents
• Settings
• postProcessors
• globalPostProcessors
• passFilters (boolean)
• passHeaders (boolean)
• Routes

?debug=ds

Shows all the datasources attached to the page, including

• Schema
• Full endpoint URL
• endpointEvents
• filterEvents
• requestParams
• chained status

?debug=result

Shows the rendered template next to the output with postProcessors applied (if applicable)

?debug=stats

The data that used to be attached to the page data, with the addition of extra information e.g.,

seconds	:	0
nanoseconds	:	79435440
milliseconds	:	79.43544
startTime	:	1521572339526
endTime	:	1521572339605
time	:	0.079

• Auth timer
• Request timer (post, get etc)
• Load data timet
• Preload data timer
• Datasources timer

And some new additions:

• Total time to render output
• Size of data payload
• Size of rendered output (before any gzip/br compression)

?debug=route

Shows the list of routes and the current page pathname. The active route is highlighted and the user can change the pathname to see their proposed input matches any of this pages routes.

?debug=headers

Shows the request and response headers. The response headers are made from a new http call to the page so is not the full picture (e.g., http doesn’t send any accept-encoding headers)

?debug=json

What used to be ?json=true ie., the raw page data JSON.

Changing of default page data

• Added new url object which includes stuff from the native Node.js url.parse()
• pathname becomes url.pathname
• host becomes url.host
• title becomes page.name
• Removed stats which appeared when debug mode enabled
• checkValue becomes a more useful timestamp which is UNIX miliseconds (new Date().getTime())

Misc changes

• Single file for error pages and debug view (dadi/lib/debug/views.js)
• Removed some Controller.numInstances debug code put in my @jimlambie
• globalEvents now have access to page data. Closes Give globalEvents access to page data #258
• Standardised the order of req and res in functions
• Removed the old Dust.js related page.settings.keepWhitespace option. Closes Pass page.settings to the template engine #255
• Removed the deprecated code which mapped the pre-4.0(?) routing changes to the new, existing method.
• Changed the page module to no longer accept the ?json=true view (it is now handled in the controller)
• Closes Workspace folders created when using non-standard config.paths #262. Web now does not create new workspace folders on boot

[jimlambie]

@abovedave I like it! the datasource view (and anywhere datasources are listed) should include both the original endpoint as specified in the schema, and the actual endpoint fired

[jimlambie]

@abovedave this changes globalEvents to be run as part of the request lifecycle, rather than as preload, right?

[abovedave]

Yes, this guy 👉 #258

[jimlambie]

use const?

[abovedave]

could just change the next line to if (data.results && data.results.length > 0) {?

[jimlambie]

agreed!

[jimlambie]

this is likely a breaking change, is it documented as such?

[abovedave]

#255 (comment)

[jimlambie]

this is the breaking change, I mean 🥇

[jimlambie]

Could we keep json=true for backwards compatibility, translating it to debug=json?