[4.0] Add a preload manager #15880
Merged
[4.0] Add a preload manager #15880
Conversation
This file contains 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
brianteeman
reviewed
May 7, 2017
| * Joomla! Content Management System | ||
| * | ||
| * @copyright Copyright (C) 2005 - 2016 Open Source Matters, Inc. All rights reserved. | ||
| * @license GNU General Public License version 2 or later; see LICENSE |
There was a problem hiding this comment.
- @license GNU General Public License version 2 or later; see LICENSE**.txt**
There was a problem hiding this comment.
Why do we have so many inconsistent file headers in the repo? (Fixed)
brianteeman
reviewed
May 7, 2017
| * Joomla! Content Management System | ||
| * | ||
| * @copyright Copyright (C) 2005 - 2016 Open Source Matters, Inc. All rights reserved. | ||
| * @license GNU General Public License version 2 or later; see LICENSE |
|
Can you fix conflicts please |
|
Rebased |
added 6 commits
June 16, 2017 19:48
|
@wilsonge Just rebased this again. Please have this one tested/reviewed/merged before I re-sync the FW database PR (the less Composer related conflicts I can deal with, the better). |
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.
Summary of Changes
To support HTTP preloading, a new
PreloadManagerservice is introduced and hooked intoJDocumentto allow developers to register preload links.Testing Instructions
In
JHtmlJquery, change the line actually loading the jQuery file to read this:With this patch applied, the base response should have a
Link:</media/vendor/jquery/js/jquery.min.js>; rel="preload"header.Documentation Changes Required
To use this API to preload stylesheet and JavaScript assets through either
JHtmlorJDocumentdirectly, a newpreloadkey is added to the$optionsarray. This is an array of the preload types that should be used for an item. So'preload' => array('preload')would only add the resource withrel="preload"and'preload' => array('preload', 'prefetch')would add a value for bothrel="preload"andrel="prefetch".The
Linkheader is computed as the last step ofJDocument::render(), meaning this happens after theonBeforeCompileHeadevent has been run and the<head>element generated, but will be before theonAfterRenderevent. So this is hookable until pretty late in the request, but afterwards you would need to get the header and manually edit that.The preload support is not limited to stylesheets and JavaScripts loaded through
JDocumentorJHtml. In fact, there is a newJDocument::getPreloadManager()method which will fetch the newPreloadManagerservice and through this you can add preloading requests for any supported reference type.JDocumentwill support anyJoomla\CMS\Document\PreloadManagerInterfaceimplementation, allowing developers to create their own objects if desired. This can be injected through the options array or through the public set method.Internally, the default
Joomla\CMS\Document\PreloadManagerimplementation usesFig\Link\GenericLinkProvideras the internal link provider but any provider implementing PSR-13'sPsr\Link\EvolvableLinkProviderInterfacecan be set using the preload manager'ssetLinkProvidermethod.Lastly, I am only doing this for 4.0 because all of the code required to make an API supporting this is already written elsewhere (Symfony's new WebLink component and the PHP-FIG's Link utilities package) and the dependencies aren't PHP 5.3 compatible. Sure, we can write all of the logic ourselves and get it into 3.x, but frankly I'd rather not do the work to sort out how to internally track these resources or build the
Linkheader with the correct structure.TODO
JDocument