https://github.com/jonathantneal/http-client-hints

Hurray for server-side content negotiation
https://github.com/jonathantneal/http-client-hints

Last synced: 11 days ago
JSON representation

Hurray for server-side content negotiation

• Host: GitHub
• URL: https://github.com/jonathantneal/http-client-hints
• Owner: jonathantneal
• License: other
• Created: 2013-09-11T16:31:35.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2013-09-25T19:16:28.000Z (about 11 years ago)
• Last Synced: 2024-10-23T06:08:53.530Z (20 days ago)
• Language: PHP
• Homepage:
• Size: 152 KB
• Stars: 126
• Watchers: 17
• Forks: 7
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# HTTP Client Hints

The Client Hints (CH) header communicates device capabilities to the server, allowing the server to return the best possible experience back to the device.

This project aims to polyfill CH to the best abilities of the device and server.

[HTTP Client Hints Draft](//github.com/igrigorik/http-client-hints)

## How it works:

One line of JavaScript can make a variety of hints available to the server. For instance, if the following script is included at the top of the document, all future requests (even those made from that same document) can leverage these hints. The draft calls for 3 hints; device pixel ratio, device width, and device height.

```javascript

document.cookie = 'CH=dh=' + screen.height +

	',dpr=' + (window.devicePixelRatio || 1) +

	',dw=' + screen.width +

	',t' + ('ontouchstart' in window || 'msMaxTouchPoints' in navigator) +

	';expires=Fri, 31 Dec 9999 23:59:59 GMT;path=/';

```

Or as [separated hints](https://github.com/igrigorik/http-client-hints/issues/14).

```javascript

(function (p, e, k) {

	for (k in p) document.cookie = 'CH-' + k + '=' + p[k] + e;

})({

	DH: screen.height,

	DW: screen.width,

	DPR: window.devicePixelRatio || 1,

	T: 'ontouchstart' in window || 'msMaxTouchPoints' in navigator

}, ';expires=Fri, 31 Dec 9999 23:59:59 GMT;path=/');

```

Since these 3 CH are unlikely to change in a given session, the above snippet could be wrapped in a server-side conditional to load just once.

```php

	document.cookie = ...

```

The native implementation of CH works by sending hints through a request header, which the server could cache. This polyfill emulates the projected end-result — a server with a cache of hints.

## What is included:

### create.htaccess

An Apache configuration snippet for converting a CH cookie into a server environment variable.

### create.js

A JavaScript snippet for creating a CH cookie.

### create.php

A PHP snippet for conditionally creating a CH cookie when the server environment variable is not yet found.

## What the future holds:

An [issue on GitHub](//github.com/igrigorik/http-client-hints/issues/3) suggests including more dynamic data in CH, such as device orientation, viewport size, and zoom level as well.

Admittedly, these values [*change frequently and are difficult to cache*](//github.com/igrigorik/http-client-hints/issues/3#issuecomment-14573532), whereas the currently drafted hints are unlikely to change in the life of the device.

Since CH adoption is in its early stages, [Ilya Grigorik](//twitter.com/igrigorik), author of the [HTTP Client Hints Draft](//github.com/igrigorik/http-client-hints), argues that the [*CH header must be kept as small and as static as possible to prove its viability*](//github.com/igrigorik/http-client-hints/issues/3#issuecomment-14427978).

## Native implementation status:

* [Latest Client Hints draft on IETF tracker](//tools.ietf.org/html/draft-grigorik-http-client-hints)

* [Blink intent to implement thread](//groups.google.com/a/chromium.org/d/msg/blink-dev/c38s7y6dH-Q/bNFczRZj5MsJ) ([patch under review](//codereview.chromium.org/23654014))

---

All of these contributions to CH are dedicated to the [public domain with no copyright](//creativecommons.org/publicdomain/zero/1.0/).