You are here

Home » API reference » Resource Hints 7.2

README.txt in Resource Hints 7.2

Same filename and directory in other branches
  1. 7 README.txt
# Resource Hints

Configure resource hints for better user agent performance

https://www.w3.org/TR/resource-hints/

## Instructions

Unpack in the *modules* folder (currently in the root of your Drupal installation) and enable in `/admin/modules`.

Then, visit `/admin/config/development/resource-hints` and enter your own set of configurations for the various resource hint types.

## Contributing

Please follow the standards as explained in the Examples for Developers module:

http://cgit.drupalcode.org/examples/tree/STANDARDS.md

### PHPCS using Drupal standard

```shell
# From drupal root - please adjust to your environment
$ vendor/bin/phpcs -p -s --standard=Drupal sites/all/modules/resource_hints/*.{install,module,inc}
..

Time: 97ms; Memory: 8Mb
```

### Tests

```shell
# From drupal root - please adjust to your environment
$ php ./scripts/run-tests.sh --color --verbose --url http://127.0.0.1:8081/ --class ResourceHintsWebTestCase

Drupal test run
---------------

Tests to be run:
 - Resources Hints Web Test Case (ResourceHintsWebTestCase)

Test run started:
 Sunday, January 15, 2017 - 21:10

Test summary
------------

Resources Hints Web Test Case 48 passes, 1 fail, 0 exceptions, and 18 debug messages

Test run duration: 3 sec

Detailed test results
---------------------


---- ResourceHintsWebTestCase ----


Status    Group      Filename          Line Function
--------------------------------------------------------------------------------
Pass      Other      resource_hints.te   29 ResourceHintsWebTestCase->setUp()
    Enabled modules: resource_hints
Pass      Role       resource_hints.te   36 ResourceHintsWebTestCase->setUp()
    Created role of name: tYCFctQh, id: 3
Pass      Role       resource_hints.te   36 ResourceHintsWebTestCase->setUp()
    Created permissions: access administration pages, administer nodes,
    administer site configuration, administer resource hints
Pass      User login resource_hints.te   36 ResourceHintsWebTestCase->setUp()
    User created with name zq8zLLzP and pass mRde6J6oES
Pass      Browser    resource_hints.te   38 ResourceHintsWebTestCase->setUp()
    GET http://127.0.0.1:8081/user returned 200 (5.89 KB).
Pass      Browser    resource_hints.te   38 ResourceHintsWebTestCase->setUp()
    Valid HTML found on "http://127.0.0.1:8081/user"
Pass      Browser    resource_hints.te   38 ResourceHintsWebTestCase->setUp()
    GET http://127.0.0.1:8081/user/2 returned 200 (5.14 KB).
Pass      Browser    resource_hints.te   38 ResourceHintsWebTestCase->setUp()
    Valid HTML found on "http://127.0.0.1:8081/user/2"
Pass      User login resource_hints.te   38 ResourceHintsWebTestCase->setUp()
    User zq8zLLzP successfully logged in.
Pass      Browser    resource_hints.te   49 ResourceHintsWebTestCase->testResou
    GET http://127.0.0.1:8081/admin/config/development/resources-hints returned
    200 (11.48 KB).
Pass      Browser    resource_hints.te   49 ResourceHintsWebTestCase->testResou
    Valid HTML found on
    "http://127.0.0.1:8081/admin/config/development/resources-hints"
Pass      Browser    resource_hints.te   49 ResourceHintsWebTestCase->testResou
    GET http://127.0.0.1:8081/admin/config/development/resources-hints returned
    200 (11.77 KB).
Pass      Browser    resource_hints.te   49 ResourceHintsWebTestCase->testResou
    Valid HTML found on
    "http://127.0.0.1:8081/admin/config/development/resources-hints"
Pass      Browser    resource_hints.te   53 ResourceHintsWebTestCase->testResou
    GET http://127.0.0.1:8081/admin/config/development/resources-hints returned
    200 (11.54 KB).
Pass      Browser    resource_hints.te   53 ResourceHintsWebTestCase->testResou
    Valid HTML found on
    "http://127.0.0.1:8081/admin/config/development/resources-hints"
Pass      Browser    resource_hints.te   53 ResourceHintsWebTestCase->testResou
    GET http://127.0.0.1:8081/admin/config/development/resources-hints returned
    200 (11.72 KB).
Pass      Browser    resource_hints.te   53 ResourceHintsWebTestCase->testResou
    Valid HTML found on
    "http://127.0.0.1:8081/admin/config/development/resources-hints"
Pass      Other      resource_hints.te   54 ResourceHintsWebTestCase->testResou
    Value '<//drupal.org>; rel=dns-prefetch' is TRUE.
Pass      Browser    resource_hints.te   58 ResourceHintsWebTestCase->testResou
    GET http://127.0.0.1:8081/admin/config/development/resources-hints returned
    200 (11.49 KB).
Pass      Browser    resource_hints.te   58 ResourceHintsWebTestCase->testResou
    Valid HTML found on
    "http://127.0.0.1:8081/admin/config/development/resources-hints"
Pass      Browser    resource_hints.te   58 ResourceHintsWebTestCase->testResou
    GET http://127.0.0.1:8081/admin/config/development/resources-hints returned
    200 (11.78 KB).
Pass      Browser    resource_hints.te   58 ResourceHintsWebTestCase->testResou
    Valid HTML found on
    "http://127.0.0.1:8081/admin/config/development/resources-hints"
Pass      Other      resource_hints.te   59 ResourceHintsWebTestCase->testResou
    Raw "<link rel="preconnect" href="//drupal.org"
    />" found
Pass      Browser    resource_hints.te   62 ResourceHintsWebTestCase->testResou
    GET http://127.0.0.1:8081/admin/config/development/resources-hints returned
    200 (11.55 KB).
Pass      Browser    resource_hints.te   62 ResourceHintsWebTestCase->testResou
    Valid HTML found on
    "http://127.0.0.1:8081/admin/config/development/resources-hints"
Pass      Browser    resource_hints.te   62 ResourceHintsWebTestCase->testResou
    GET http://127.0.0.1:8081/admin/config/development/resources-hints returned
    200 (11.74 KB).
Pass      Browser    resource_hints.te   62 ResourceHintsWebTestCase->testResou
    Valid HTML found on
    "http://127.0.0.1:8081/admin/config/development/resources-hints"
Pass      Other      resource_hints.te   63 ResourceHintsWebTestCase->testResou
    Value '<//drupal.org>; rel=preconnect' is TRUE.
Pass      Browser    resource_hints.te   67 ResourceHintsWebTestCase->testResou
    GET http://127.0.0.1:8081/admin/config/development/resources-hints returned
    200 (11.5 KB).
Pass      Browser    resource_hints.te   67 ResourceHintsWebTestCase->testResou
    Valid HTML found on
    "http://127.0.0.1:8081/admin/config/development/resources-hints"
Pass      Browser    resource_hints.te   67 ResourceHintsWebTestCase->testResou
    GET http://127.0.0.1:8081/admin/config/development/resources-hints returned
    200 (11.79 KB).
Pass      Browser    resource_hints.te   67 ResourceHintsWebTestCase->testResou
    Valid HTML found on
    "http://127.0.0.1:8081/admin/config/development/resources-hints"
Pass      Other      resource_hints.te   68 ResourceHintsWebTestCase->testResou
    Raw "<link rel="prefetch" href="//drupal.org" />"
    found
Pass      Browser    resource_hints.te   71 ResourceHintsWebTestCase->testResou
    GET http://127.0.0.1:8081/admin/config/development/resources-hints returned
    200 (11.56 KB).
Pass      Browser    resource_hints.te   71 ResourceHintsWebTestCase->testResou
    Valid HTML found on
    "http://127.0.0.1:8081/admin/config/development/resources-hints"
Pass      Browser    resource_hints.te   71 ResourceHintsWebTestCase->testResou
    GET http://127.0.0.1:8081/admin/config/development/resources-hints returned
    200 (11.75 KB).
Pass      Browser    resource_hints.te   71 ResourceHintsWebTestCase->testResou
    Valid HTML found on
    "http://127.0.0.1:8081/admin/config/development/resources-hints"
Pass      Other      resource_hints.te   72 ResourceHintsWebTestCase->testResou
    Value '<//drupal.org>; rel=prefetch' is TRUE.
Pass      Browser    resource_hints.te   76 ResourceHintsWebTestCase->testResou
    GET http://127.0.0.1:8081/admin/config/development/resources-hints returned
    200 (11.51 KB).
Pass      Browser    resource_hints.te   76 ResourceHintsWebTestCase->testResou
    Valid HTML found on
    "http://127.0.0.1:8081/admin/config/development/resources-hints"
Pass      Browser    resource_hints.te   76 ResourceHintsWebTestCase->testResou
    GET http://127.0.0.1:8081/admin/config/development/resources-hints returned
    200 (11.8 KB).
Pass      Browser    resource_hints.te   76 ResourceHintsWebTestCase->testResou
    Valid HTML found on
    "http://127.0.0.1:8081/admin/config/development/resources-hints"
Pass      Other      resource_hints.te   77 ResourceHintsWebTestCase->testResou
    Raw "<link rel="prerender" href="//drupal.org" />"
    found
Pass      Browser    resource_hints.te   80 ResourceHintsWebTestCase->testResou
    GET http://127.0.0.1:8081/admin/config/development/resources-hints returned
    200 (11.57 KB).
Pass      Browser    resource_hints.te   80 ResourceHintsWebTestCase->testResou
    Valid HTML found on
    "http://127.0.0.1:8081/admin/config/development/resources-hints"
Pass      Browser    resource_hints.te   80 ResourceHintsWebTestCase->testResou
    GET http://127.0.0.1:8081/admin/config/development/resources-hints returned
    200 (11.76 KB).
Pass      Browser    resource_hints.te   80 ResourceHintsWebTestCase->testResou
    Valid HTML found on
    "http://127.0.0.1:8081/admin/config/development/resources-hints"
Pass      Other      resource_hints.te   81 ResourceHintsWebTestCase->testResou
    Value '<//drupal.org>; rel=prerender' is TRUE.
Fail      Other      run-tests.sh       386 simpletest_script_run_one_test()
    Failed to find test tables to drop.
```

## Helpful resources

https://www.w3.org/TR/resource-hints/
https://www.igvita.com/2015/08/17/eliminating-roundtrips-with-preconnect/
https://css-tricks.com/prefetching-preloading-prebrowsing/
https://medium.com/@luisvieira_gmr/html5-prefetch-1e54f6dda15d#.liri85j7v
https://developer.mozilla.org/en-US/docs/Web/HTTP/Link_prefetching_FAQ
https://developer.mozilla.org/en-US/docs/Web/HTML/Link_types
https://www.w3.org/TR/html4/types.html#type-links

File

README.txt
View source 
  1. # Resource Hints

  2. 

  3. Configure resource hints for better user agent performance

  4. 

  5. https://www.w3.org/TR/resource-hints/

  6. 

  7. ## Instructions

  8. 

  9. Unpack in the *modules* folder (currently in the root of your Drupal installation) and enable in `/admin/modules`.

  10. 

  11. Then, visit `/admin/config/development/resource-hints` and enter your own set of configurations for the various resource hint types.

  12. 

  13. ## Contributing

  14. 

  15. Please follow the standards as explained in the Examples for Developers module:

  16. 

  17. http://cgit.drupalcode.org/examples/tree/STANDARDS.md

  18. 

  19. ### PHPCS using Drupal standard

  20. 

  21. ```shell

  22. # From drupal root - please adjust to your environment

  23. $ vendor/bin/phpcs -p -s --standard=Drupal sites/all/modules/resource_hints/*.{install,module,inc}

  24. ..

  25. 

  26. Time: 97ms; Memory: 8Mb

  27. ```

  28. 

  29. ### Tests

  30. 

  31. ```shell

  32. # From drupal root - please adjust to your environment

  33. $ php ./scripts/run-tests.sh --color --verbose --url http://127.0.0.1:8081/ --class ResourceHintsWebTestCase

  34. 

  35. Drupal test run

  36. ---------------

  37. 

  38. Tests to be run:

  39.  - Resources Hints Web Test Case (ResourceHintsWebTestCase)

  40. 

  41. Test run started:

  42.  Sunday, January 15, 2017 - 21:10

  43. 

  44. Test summary

  45. ------------

  46. 

  47. Resources Hints Web Test Case 48 passes, 1 fail, 0 exceptions, and 18 debug messages

  48. 

  49. Test run duration: 3 sec

  50. 

  51. Detailed test results

  52. ---------------------

  53. 

  54. 

  55. ---- ResourceHintsWebTestCase ----

  56. 

  57. 

  58. Status    Group      Filename          Line Function

  59. --------------------------------------------------------------------------------

  60. Pass      Other      resource_hints.te   29 ResourceHintsWebTestCase->setUp()

  61.     Enabled modules: resource_hints

  62. Pass      Role       resource_hints.te   36 ResourceHintsWebTestCase->setUp()

  63.     Created role of name: tYCFctQh, id: 3

  64. Pass      Role       resource_hints.te   36 ResourceHintsWebTestCase->setUp()

  65.     Created permissions: access administration pages, administer nodes,

  66.     administer site configuration, administer resource hints

  67. Pass      User login resource_hints.te   36 ResourceHintsWebTestCase->setUp()

  68.     User created with name zq8zLLzP and pass mRde6J6oES

  69. Pass      Browser    resource_hints.te   38 ResourceHintsWebTestCase->setUp()

  70.     GET http://127.0.0.1:8081/user returned 200 (5.89 KB).

  71. Pass      Browser    resource_hints.te   38 ResourceHintsWebTestCase->setUp()

  72.     Valid HTML found on "http://127.0.0.1:8081/user"

  73. Pass      Browser    resource_hints.te   38 ResourceHintsWebTestCase->setUp()

  74.     GET http://127.0.0.1:8081/user/2 returned 200 (5.14 KB).

  75. Pass      Browser    resource_hints.te   38 ResourceHintsWebTestCase->setUp()

  76.     Valid HTML found on "http://127.0.0.1:8081/user/2"

  77. Pass      User login resource_hints.te   38 ResourceHintsWebTestCase->setUp()

  78.     User zq8zLLzP successfully logged in.

  79. Pass      Browser    resource_hints.te   49 ResourceHintsWebTestCase->testResou

  80.     GET http://127.0.0.1:8081/admin/config/development/resources-hints returned

  81.     200 (11.48 KB).

  82. Pass      Browser    resource_hints.te   49 ResourceHintsWebTestCase->testResou

  83.     Valid HTML found on

  84.     "http://127.0.0.1:8081/admin/config/development/resources-hints"

  85. Pass      Browser    resource_hints.te   49 ResourceHintsWebTestCase->testResou

  86.     GET http://127.0.0.1:8081/admin/config/development/resources-hints returned

  87.     200 (11.77 KB).

  88. Pass      Browser    resource_hints.te   49 ResourceHintsWebTestCase->testResou

  89.     Valid HTML found on

  90.     "http://127.0.0.1:8081/admin/config/development/resources-hints"

  91. Pass      Browser    resource_hints.te   53 ResourceHintsWebTestCase->testResou

  92.     GET http://127.0.0.1:8081/admin/config/development/resources-hints returned

  93.     200 (11.54 KB).

  94. Pass      Browser    resource_hints.te   53 ResourceHintsWebTestCase->testResou

  95.     Valid HTML found on

  96.     "http://127.0.0.1:8081/admin/config/development/resources-hints"

  97. Pass      Browser    resource_hints.te   53 ResourceHintsWebTestCase->testResou

  98.     GET http://127.0.0.1:8081/admin/config/development/resources-hints returned

  99.     200 (11.72 KB).

  100. Pass      Browser    resource_hints.te   53 ResourceHintsWebTestCase->testResou

  101.     Valid HTML found on

  102.     "http://127.0.0.1:8081/admin/config/development/resources-hints"

  103. Pass      Other      resource_hints.te   54 ResourceHintsWebTestCase->testResou

  104.     Value '<//drupal.org>; rel=dns-prefetch' is TRUE.

  105. Pass      Browser    resource_hints.te   58 ResourceHintsWebTestCase->testResou

  106.     GET http://127.0.0.1:8081/admin/config/development/resources-hints returned

  107.     200 (11.49 KB).

  108. Pass      Browser    resource_hints.te   58 ResourceHintsWebTestCase->testResou

  109.     Valid HTML found on

  110.     "http://127.0.0.1:8081/admin/config/development/resources-hints"

  111. Pass      Browser    resource_hints.te   58 ResourceHintsWebTestCase->testResou

  112.     GET http://127.0.0.1:8081/admin/config/development/resources-hints returned

  113.     200 (11.78 KB).

  114. Pass      Browser    resource_hints.te   58 ResourceHintsWebTestCase->testResou

  115.     Valid HTML found on

  116.     "http://127.0.0.1:8081/admin/config/development/resources-hints"

  117. Pass      Other      resource_hints.te   59 ResourceHintsWebTestCase->testResou

  118.     Raw "<link rel="preconnect" href="//drupal.org"

  119.     />" found

  120. Pass      Browser    resource_hints.te   62 ResourceHintsWebTestCase->testResou

  121.     GET http://127.0.0.1:8081/admin/config/development/resources-hints returned

  122.     200 (11.55 KB).

  123. Pass      Browser    resource_hints.te   62 ResourceHintsWebTestCase->testResou

  124.     Valid HTML found on

  125.     "http://127.0.0.1:8081/admin/config/development/resources-hints"

  126. Pass      Browser    resource_hints.te   62 ResourceHintsWebTestCase->testResou

  127.     GET http://127.0.0.1:8081/admin/config/development/resources-hints returned

  128.     200 (11.74 KB).

  129. Pass      Browser    resource_hints.te   62 ResourceHintsWebTestCase->testResou

  130.     Valid HTML found on

  131.     "http://127.0.0.1:8081/admin/config/development/resources-hints"

  132. Pass      Other      resource_hints.te   63 ResourceHintsWebTestCase->testResou

  133.     Value '<//drupal.org>; rel=preconnect' is TRUE.

  134. Pass      Browser    resource_hints.te   67 ResourceHintsWebTestCase->testResou

  135.     GET http://127.0.0.1:8081/admin/config/development/resources-hints returned

  136.     200 (11.5 KB).

  137. Pass      Browser    resource_hints.te   67 ResourceHintsWebTestCase->testResou

  138.     Valid HTML found on

  139.     "http://127.0.0.1:8081/admin/config/development/resources-hints"

  140. Pass      Browser    resource_hints.te   67 ResourceHintsWebTestCase->testResou

  141.     GET http://127.0.0.1:8081/admin/config/development/resources-hints returned

  142.     200 (11.79 KB).

  143. Pass      Browser    resource_hints.te   67 ResourceHintsWebTestCase->testResou

  144.     Valid HTML found on

  145.     "http://127.0.0.1:8081/admin/config/development/resources-hints"

  146. Pass      Other      resource_hints.te   68 ResourceHintsWebTestCase->testResou

  147.     Raw "<link rel="prefetch" href="//drupal.org" />"

  148.     found

  149. Pass      Browser    resource_hints.te   71 ResourceHintsWebTestCase->testResou

  150.     GET http://127.0.0.1:8081/admin/config/development/resources-hints returned

  151.     200 (11.56 KB).

  152. Pass      Browser    resource_hints.te   71 ResourceHintsWebTestCase->testResou

  153.     Valid HTML found on

  154.     "http://127.0.0.1:8081/admin/config/development/resources-hints"

  155. Pass      Browser    resource_hints.te   71 ResourceHintsWebTestCase->testResou

  156.     GET http://127.0.0.1:8081/admin/config/development/resources-hints returned

  157.     200 (11.75 KB).

  158. Pass      Browser    resource_hints.te   71 ResourceHintsWebTestCase->testResou

  159.     Valid HTML found on

  160.     "http://127.0.0.1:8081/admin/config/development/resources-hints"

  161. Pass      Other      resource_hints.te   72 ResourceHintsWebTestCase->testResou

  162.     Value '<//drupal.org>; rel=prefetch' is TRUE.

  163. Pass      Browser    resource_hints.te   76 ResourceHintsWebTestCase->testResou

  164.     GET http://127.0.0.1:8081/admin/config/development/resources-hints returned

  165.     200 (11.51 KB).

  166. Pass      Browser    resource_hints.te   76 ResourceHintsWebTestCase->testResou

  167.     Valid HTML found on

  168.     "http://127.0.0.1:8081/admin/config/development/resources-hints"

  169. Pass      Browser    resource_hints.te   76 ResourceHintsWebTestCase->testResou

  170.     GET http://127.0.0.1:8081/admin/config/development/resources-hints returned

  171.     200 (11.8 KB).

  172. Pass      Browser    resource_hints.te   76 ResourceHintsWebTestCase->testResou

  173.     Valid HTML found on

  174.     "http://127.0.0.1:8081/admin/config/development/resources-hints"

  175. Pass      Other      resource_hints.te   77 ResourceHintsWebTestCase->testResou

  176.     Raw "<link rel="prerender" href="//drupal.org" />"

  177.     found

  178. Pass      Browser    resource_hints.te   80 ResourceHintsWebTestCase->testResou

  179.     GET http://127.0.0.1:8081/admin/config/development/resources-hints returned

  180.     200 (11.57 KB).

  181. Pass      Browser    resource_hints.te   80 ResourceHintsWebTestCase->testResou

  182.     Valid HTML found on

  183.     "http://127.0.0.1:8081/admin/config/development/resources-hints"

  184. Pass      Browser    resource_hints.te   80 ResourceHintsWebTestCase->testResou

  185.     GET http://127.0.0.1:8081/admin/config/development/resources-hints returned

  186.     200 (11.76 KB).

  187. Pass      Browser    resource_hints.te   80 ResourceHintsWebTestCase->testResou

  188.     Valid HTML found on

  189.     "http://127.0.0.1:8081/admin/config/development/resources-hints"

  190. Pass      Other      resource_hints.te   81 ResourceHintsWebTestCase->testResou

  191.     Value '<//drupal.org>; rel=prerender' is TRUE.

  192. Fail      Other      run-tests.sh       386 simpletest_script_run_one_test()

  193.     Failed to find test tables to drop.

  194. ```

  195. 

  196. ## Helpful resources

  197. 

  198. https://www.w3.org/TR/resource-hints/

  199. https://www.igvita.com/2015/08/17/eliminating-roundtrips-with-preconnect/

  200. https://css-tricks.com/prefetching-preloading-prebrowsing/

  201. https://medium.com/@luisvieira_gmr/html5-prefetch-1e54f6dda15d#.liri85j7v

  202. https://developer.mozilla.org/en-US/docs/Web/HTTP/Link_prefetching_FAQ

  203. https://developer.mozilla.org/en-US/docs/Web/HTML/Link_types

  204. https://www.w3.org/TR/html4/types.html#type-links