• This repository has been archived on 10/Sep/2022
  • Stars
    star
    140
  • Rank 261,473 (Top 6 %)
  • Language
    HTML
  • License
    Apache License 2.0
  • Created about 9 years ago
  • Updated almost 8 years ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Drop-in HTTP2 push on App Engine

HTTP 2.0 push on App Engine

This project contains a drop-in library for doing HTTP2 push on Google App Engine.

Demo test site: https://http2-push.appspot.com/

TL;DR how it works

  1. Generate a push_manifest.json using a node script, http2-push-manifest. See below.
  • Annotate your request handlers with the @http2push.push() decorator.

How this works

Requirements & Setup

  1. App Engine Python SDK. You'll want the dev server for testing.
  • Node

The example server is written in Python. If you'd like to see other App Engine runtimes feel free to submit a pull request or visit the EXPLAINER to read up on how to construct the Link rel=preload header yourself.

Run the example server(s)

Important the dev server does not support http2 push. An app needs to be deployed to production App Engine.

example/ contains a fully working example of an App Engine Python server and Go servers. This walk-through will use the Python server, which uses the http2push.py library. You'll also see an example examples/python/push_manifest.json in that folder.

To try the test server, start the App Engine dev server in the example folder:

cd example/python
dev_appserver.py --port 8080 .

Open http://localhost:8080/.

Installing in your project

  1. Get the drop-in library: git clone https://github.com/GoogleChrome/http2push-gae
  • Move http2push-gae/http2push.py into your project folder.
  • Install http2-push-manifest script: npm install http2-push-manifest --save-dev

Usage

Generating a push manifest

This project uses http2-push-manifest to generate the list of files to push. The JSON file is loaded by http2push.py to constructor the Link header.

Re-run the script whenever your list of resources changes. An easy way to do that is by adding a script to your project's package.json.

For example, assuming app/index.html is your main page, you could add:

"scripts": {
  "push": "http2-push-manifest -f app/index.html"
}

An run npm run push to re-generate the file.

Readhttp2-push-manifest's full documentation for more information on generating the manifest.

Drop in the http2push server module

The http2push.py module provides a base handler and decorator to use in your own server. The decorator is the simplest to integrate. Handlers which are annotated with the @http2push.push() decorator will server-push the resources in push_manifest.json.

Tip - when testing your pages, the ?nopush URL parameter disables push. Use this parameter to test the effectiveness of server push on your own resources or to run performance tests at webpagetest.org.

Example - using the decorator:

app.yaml:

runtime: python27
api_version: 1
threadsafe: yes

libraries:
- name: webapp2
  version: latest

handlers:

- url: /css
  static_dir: static/css
  secure: always

- url: /js
  static_dir: static/js
  secure: always

- url: .*
  script: main.app
  secure: always

main.py:

import os
import webapp2

from google.appengine.ext.webapp import template
import http2push as http2

class Handler(http2.PushHandler):

  @http2.push() # push_manifest.json is used by default.
  def get(self):
    # Resources in push_manifest.json will be server-pushed with index.html.
    path = os.path.join(os.path.dirname(__file__), 'static/index.html')
    return self.response.write(template.render(path, {}))

app = webapp2.WSGIApplication([('/', Handler)])

To use a custom manifest file name, use @http2push.push('FILENAME').

Example - using a custom manifest file:

import http2push

class Handler(http2push.PushHandler):

  @http2push.push('custom_manifest.json')
  def get(self):
    ...

For more control, you can also set the headers yourself.

Example - Explicitly set Link: rel=preload (no decorators):

import http2push

class Handler(http2push.PushHandler):

  def get(self):
    # Optional: use custom manifest file.
    # self.push_urls = http2push.use_push_manifest('custom_manifest.json')

    header = self._generate_link_preload_headers()
    self.response.headers.add_header('Link', header)

    path = os.path.join(os.path.dirname(__file__), 'static/index.html')
    return self.response.write(template.render(path, {}))

Pushing content from a static handler

If you don't have a dynamic script handler, you can still push resources from App Engine page by setting the http_headers on your static page handler in app.yaml.

app.yaml:

...

handlers:

- url: /css
  static_dir: static/css
  secure: always

- url: /js
  static_dir: static/js
  secure: always

- url: /$
  static_files: path/to/index.html
  upload: path/to/index.html
  http_headers:
    Link: '</js/app.js>; rel=preload; as=script, </css/app.css>; rel=preload; as=style'

Deployment (test site)

Note: this section is only for maintainers of this project.

Build it

There's a one-stop convenience script to vulcanize the app and generate push_manifest.json:

cd site
./scripts/build.sh

Deploy it

Run deploy.sh to deploy the demo site. Note: build.sh is ran as part of this process.

./scripts/deploy.sh <VERSION>

Where <VERSION> is the app version you'd like to deploy as.

More Repositories

1

squoosh

Make images smaller using best-in-class codecs, right in the browser.
TypeScript
21,605
star
2

comlink

Comlink makes WebWorkers enjoyable.
TypeScript
11,198
star
3

quicklink

⚡️Faster subsequent page-loads by prefetching in-viewport links during idle time
JavaScript
11,024
star
4

ndb

ndb is an improved debugging experience for Node.js, enabled by Chrome DevTools
JavaScript
10,913
star
5

carlo

Web rendering surface for Node applications
JavaScript
9,313
star
6

ProjectVisBug

FireBug for designers › Edit any webpage, in any state https://a.nerdy.dev/gimme-visbug
JavaScript
5,452
star
7

sw-precache

[Deprecated] A node module to generate service worker code that will precache specific resources so they work offline.
JavaScript
5,236
star
8

react-adaptive-hooks

Deliver experiences best suited to a user's device and network constraints
JavaScript
5,097
star
9

ui-element-samples

A collection of prototyped UI elements
JavaScript
4,101
star
10

sw-toolbox

[Deprecated] A collection of service worker tools for offlining runtime requests
JavaScript
3,621
star
11

webpack-libs-optimizations

Using a library in your webpack project? Here’s how to optimize it
3,365
star
12

critters

🦔 A Webpack plugin to inline your critical CSS and lazy-load the rest.
JavaScript
3,330
star
13

psi

PageSpeed Insights Reporting for Node
JavaScript
3,100
star
14

bubblewrap

Bubblewrap is a Command Line Interface (CLI) that helps developers to create a Project for an Android application that launches an existing Progressive Web App (PWAs) using a Trusted Web Activity.
TypeScript
2,375
star
15

lighthousebot

Run Lighthouse in CI, as a web service, using Docker. Pass/Fail GH pull requests.
JavaScript
2,235
star
16

preload-webpack-plugin

Please use https://github.com/vuejs/preload-webpack-plugin instead.
JavaScript
2,162
star
17

worker-plugin

👩‍🏭 Adds native Web Worker bundling support to Webpack.
JavaScript
1,914
star
18

prerender-loader

📰 Painless universal pre-rendering for Webpack.
JavaScript
1,912
star
19

simplehttp2server

A simple HTTP/2 server for development
Go
1,735
star
20

jsvu

JavaScript (engine) Version Updater
JavaScript
1,698
star
21

size-plugin

Track compressed Webpack asset sizes over time.
JavaScript
1,672
star
22

clooney

Clooney is an actor library for the web. Use workers without thinking about workers.
JavaScript
1,419
star
23

browser-fs-access

File System Access API with legacy fallback in the browser
JavaScript
1,383
star
24

proxx

A game of proximity
TypeScript
1,315
star
25

dark-mode-toggle

A custom element that allows you to easily put a Dark Mode 🌒 toggle or switch on your site:
JavaScript
1,174
star
26

application-shell

Service Worker Application Shell Architecture
JavaScript
1,169
star
27

pwacompat

PWACompat to bring Web App Manifest to older browsers
JavaScript
1,130
star
28

container-query-polyfill

A polyfill for CSS Container Queries
TypeScript
1,127
star
29

idlize

Helper classes and methods for implementing the idle-until-urgent pattern
JavaScript
1,061
star
30

houdini-samples

Demos for different Houdini APIs
JavaScript
974
star
31

jsbi

JSBI is a pure-JavaScript implementation of the official ECMAScript BigInt proposal.
JavaScript
908
star
32

css-triggers

A reference for the render impact of mutating CSS properties.
JavaScript
893
star
33

howto-components

Literate code examples for common UI patterns.
JavaScript
851
star
34

tooling.report

tooling.report a quick way to determine the best build tool for your next web project, or if tooling migration is worth it, or how to adopt a tool's best practice into your existing configuration and code base.
JavaScript
848
star
35

page-lifecycle

PageLifecycle.js is a tiny JavaScript library that allows developers to easily observe Page Lifecycle API state changes cross browser
JavaScript
803
star
36

css-paint-polyfill

CSS Custom Paint / Paint Worklet polyfill with special browser optimizations.
JavaScript
709
star
37

web-audio-samples

Web Audio API samples by Chrome Web Audio Team
JavaScript
686
star
38

chrome-for-testing

JavaScript
667
star
39

picture-in-picture-chrome-extension

JavaScript
667
star
40

estimator.dev

🧮 Calculate the size and performance impact of switching to modern JavaScript syntax.
JavaScript
665
star
41

comlink-loader

Webpack loader to offload modules to Worker threads seamlessly using Comlink.
JavaScript
616
star
42

pwa-wp

WordPress feature plugin to bring Progressive Web Apps (PWA) to Core
PHP
615
star
43

ProgressiveWordPress

A Sample WordPress-based Progressive Web App
JavaScript
570
star
44

web-push-codelab

JavaScript
557
star
45

text-app

A text editor for ChromeOS and Chrome
JavaScript
552
star
46

gulliver

A PWA directory, focusing on collecting PWA best practices and examples.
JavaScript
549
star
47

wasm-feature-detect

A small library to detect which features of WebAssembly are supported.
JavaScript
546
star
48

progressive-tooling

A list of community-built, third-party tools that can be used to improve page performance
JavaScript
546
star
49

svgomg-twa

A sample that project Trusted Web Activities technology to wrap SVGOMG in an Android Application
Shell
519
star
50

web-vitals-report

Measure and report on your Web Vitals data in Google Analytics
JavaScript
503
star
51

text-editor

A text editor build on the Native File System APIs
JavaScript
501
star
52

pptraas.com

Puppeteer as a service
JavaScript
455
star
53

progressive-rendering-frameworks-samples

Samples and demos from the Progressive Rendering I/O talk
JavaScript
411
star
54

wasm-bindgen-rayon

An adapter for enabling Rayon-based concurrency on the Web with WebAssembly.
JavaScript
403
star
55

MiniMobileDeviceLab

A mini mobile web device lab
Objective-C
396
star
56

webm-wasm

webm-wasm lets you create webm videos in JavaScript via WebAssembly.
C++
394
star
57

link-to-text-fragment

Browser extension that allows for linking to arbitrary text fragments.
JavaScript
390
star
58

cronet-sample

A sample for the Cronet library
Java
390
star
59

buffer-backed-object

Buffer-backed objects in JavaScript.
JavaScript
372
star
60

pinch-zoom

TypeScript
370
star
61

webpack-training-project

A training project for learning Webpack optimizations
JavaScript
368
star
62

samesite-examples

Examples of using the SameSite cookie attribute in a variety of language, libraries, and frameworks.
HTML
366
star
63

airhorn

Air horn
JavaScript
361
star
64

AutoWebPerf

AutoWebPerf provides a flexible and scalable framework for running web performance audits with arbitrary audit tools including PageSpeedInsights, WebPageTest and more.
JavaScript
353
star
65

first-input-delay

A JavaScript library for measuring First Input Delay (FID) in the browser.
JavaScript
347
star
66

tti-polyfill

Time-to-interactive polyfill
JavaScript
333
star
67

react-shrine

"Shrine" Progressive Web App sample built with React
JavaScript
330
star
68

dynamic-import-polyfill

A fast, tiny polyfill for dynamic import() that works in all module-supporting browsers
JavaScript
320
star
69

wasi-fs-access

This is a demo shell powered by WebAssembly, WASI, Asyncify and File System Access API.
TypeScript
312
star
70

native-url

Node's url module implemented using the built-in URL API.
JavaScript
284
star
71

two-up

TypeScript
281
star
72

adaptive-loading

Demos for Adaptive Loading - differentially deliver fast, lighter experiences for users on slow networks & devices
JavaScript
264
star
73

so-pwa

A progressive web app to read Stack Overflow content.
JavaScript
255
star
74

import-from-worker

It’s like import(), but runs the module in a worker.
JavaScript
249
star
75

sample-pie-shop

Example e-commerce site to explore PWA (Progressive Web App) use cases.
JavaScript
237
star
76

file-drop

A simple file drag and drop custom-element
TypeScript
232
star
77

serial-terminal

Demo application for the Web Serial API.
TypeScript
226
star
78

form-troubleshooter

TypeScript
215
star
79

postcss-jit-props

A CSS custom property helper based on PostCSS. Supply a pool of variables and this plugin will add them to the stylesheet as they are used.
JavaScript
215
star
80

audioworklet-polyfill

🔊 Polyfill AudioWorklet using the legacy ScriptProcessor API.
JavaScript
190
star
81

http2-push-manifest

Generate a list of static resources for http2 push.
JavaScript
187
star
82

pointer-tracker

Track mouse/touch/pointer events for a given element.
TypeScript
184
star
83

pr-bot

🤖 Compare your base branch to a pull request and run plugins over it to view differences
JavaScript
179
star
84

discovery

Discoveries on Sustainable Loading research
177
star
85

imagecapture-polyfill

MediaStream ImageCapture polyfill. Take photos from the browser as easy as .takePhoto().then(processPhoto)
JavaScript
176
star
86

tasklets

JavaScript
176
star
87

telnet-client

TypeScript
166
star
88

extension-manifest-converter

Python
164
star
89

credential-management-sample

Credential Management Sample
HTML
157
star
90

wadb

A TypeScript implementation of the Android Debug Bridge(ADB) protocol over WebUSB
TypeScript
156
star
91

extension-update-testing-tool

Tool for testing the update flow for Chrome Extensions during development, including permission grants.
JavaScript
154
star
92

wasm-av1

Port of the AV1 Video codec to WebAssembly
C
154
star
93

houdini.how

A community-driven gathering place for CSS Houdini worklets and resources.
JavaScript
152
star
94

pwa-workshop-codelab

JavaScript
152
star
95

perf-track

Tracking framework performance and usage at scale
Svelte
150
star
96

kv-storage-polyfill

A polyfill for the kv-storage built-in module.
JavaScript
146
star
97

chromeos_smart_card_connector

Smart Card Connector App for Chrome OS
C++
135
star
98

snapshot

TypeScript
133
star
99

devwebfeed

Firehose of team++ resources
JavaScript
130
star
100

sample-currency-converter

A sample currency conversion Progressive Web App
JavaScript
129
star