Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Cache SW manual test infrastructure #6532

Merged
merged 8 commits into from
Dec 12, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 43 additions & 0 deletions build-system/server.js
Original file line number Diff line number Diff line change
Expand Up @@ -502,6 +502,49 @@ app.get('/extensions/amp-ad-network-fake-impl/0.1/data/fake_amp.json.html', func
});
});



/*
* Start Cache SW LOCALDEV section
*/
app.get(['/dist/sw.js', '/dist/sw.max.js'], function(req, res, next) {
var filePath = req.path;
fs.readFileAsync(process.cwd() + filePath, 'utf8').then(file => {
var n = new Date();
// Round down to the nearest 5 minutes.
n -= ((n.getMinutes() % 5) * 1000 * 60) + (n.getSeconds() * 1000) + n.getMilliseconds();
res.setHeader('Content-Type', 'application/javascript');
file = 'self.AMP_CONFIG = {v: "99' + n + '",' +
'cdnUrl: "http://localhost:8000/dist"};'
+ file;
res.end(file);
}).catch(next);
});

app.get('/dist/rtv/99*/*.js', function(req, res, next) {
var filePath = req.path.replace(/\/rtv\/\d{15}/, '');
fs.readFileAsync(process.cwd() + filePath, 'utf8').then(file => {
// Cause a delay, to show the "stale-while-revalidate"
setTimeout(() => {
res.setHeader('Content-Type', 'application/javascript');
res.end(file);
}, 2000);
}).catch(next);
});

app.get(['/dist/cache-sw.min.html', '/dist/cache-sw.max.html'], function(req, res, next) {
var filePath = '/test/manual/cache-sw.html';
fs.readFileAsync(process.cwd() + filePath, 'utf8').then(file => {
res.setHeader('Content-Type', 'text/html');
res.end(file);
}).catch(next);
});
/*
* End Cache SW LOCALDEV section
*/



/**
* @param {string} mode
* @param {string} file
Expand Down
5 changes: 2 additions & 3 deletions src/service-worker/core.js
Original file line number Diff line number Diff line change
Expand Up @@ -142,9 +142,8 @@ export function urlWithVersion(url, version) {
if (currentVersion) {
return url.replace(currentVersion, version);
}
const location = new URL(url);
location.pathname = `/rtv/${version}${location.pathname}`;
return location.href;
const oldPath = pathname(url);
return url.replace(oldPath, `/rtv/${version}${oldPath}`);
}

/**
Expand Down
8 changes: 4 additions & 4 deletions src/service-worker/install.js
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
* limitations under the License.
*/

import {calculateScriptBaseUrl} from '../service/extensions-impl';
import {calculateEntryPointScriptUrl} from '../service/extension-location';
import {isExperimentOn} from '../experiments';
import {dev} from '../log';
import {getMode} from '../mode';
Expand All @@ -40,12 +40,12 @@ export function installCacheServiceWorker(win) {
win.location.hostname !== parseUrl(urls.cdn).hostname) {
return;
}
const base = calculateScriptBaseUrl(win.location, getMode().localDev,
getMode().test);
// The kill experiment is really just a configuration that allows us to
// quickly kill the cache service worker without cutting a new version.
const kill = isExperimentOn(win, `${TAG}-kill`);
const url = `${base}/sw${kill ? '-kill' : ''}.js`;
const entryPoint = `sw${kill ? '-kill' : ''}`;
const url = calculateEntryPointScriptUrl(location, entryPoint,
getMode().localDev);
navigator.serviceWorker.register(url).then(reg => {
dev().info(TAG, 'ServiceWorker registration successful: ', reg);
}, err => {
Expand Down
6 changes: 4 additions & 2 deletions src/service-worker/shell.js
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,15 @@
* limitations under the License.
*/

import {calculateExtensionScriptUrl} from '../service/extensions-impl';
import {getMode} from '../mode';
import {calculateExtensionScriptUrl} from '../service/extension-location';
import './error-reporting';

/**
* Import the "core" entry point for the AMP CDN Service Worker. This shell
* file is kept intentionally small, so that checking if it has changed (and
* thus, if a new SW must be installed) will be very fast.
*/
const url = calculateExtensionScriptUrl(self.location, 'cache-service-worker');
const url = calculateExtensionScriptUrl(self.location, 'cache-service-worker',
getMode().localDev);
importScripts(url);
90 changes: 90 additions & 0 deletions src/service/extension-location.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
/**
* Copyright 2016 The AMP HTML Authors. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS-IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

import {urls} from '../config';
import {getMode} from '../mode';

/**
* Calculate the base url for any scripts.
* @param {!Location} location The window's location
* @param {boolean=} isLocalDev
* @param {boolean=} isTest
* @return {string}
*/
function calculateScriptBaseUrl(location, isLocalDev, isTest) {
if (isLocalDev) {
if (isTest || isMax(location) || isMin(location)) {
return `${location.protocol}//${location.host}/dist`;
}
}
return urls.cdn;
}

/**
* Calculate script url for an extension.
* @param {!Location} location The window's location
* @param {string} extensionId
* @param {boolean=} isLocalDev
* @param {boolean=} isTest
* @param {boolean=} isUsingCompiledJs
* @return {string}
*/
export function calculateExtensionScriptUrl(location, extensionId, isLocalDev,
isTest, isUsingCompiledJs) {
const base = calculateScriptBaseUrl(location, isLocalDev, isTest);
if (isLocalDev) {
if ((isTest && !isUsingCompiledJs) || isMax(location)) {
return `${base}/v0/${extensionId}-0.1.max.js`;
}
return `${base}/v0/${extensionId}-0.1.js`;
}
return `${base}/rtv/${getMode().rtvVersion}/v0/${extensionId}-0.1.js`;
}

/**
* Calculate script url for an entry point.
* @param {!Location} location The window's location
* @param {string} entryPoint
* @param {boolean=} isLocalDev
* @param {boolean=} isTest
* @return {string}
*/
export function calculateEntryPointScriptUrl(location, entryPoint, isLocalDev,
isTest) {
const base = calculateScriptBaseUrl(location, isLocalDev, isTest);
const serveMax = isLocalDev && isMax(location);
return `${base}/${entryPoint}${serveMax ? '.max' : ''}.js`;
}

/**
* Is this path to a max (unminified) version?
* @param {!Location} location
* @return {boolean}
*/
function isMax(location) {
const path = location.pathname;
return path.indexOf('.max') >= 0 || path.substr(0, 5) == '/max/';
}

/**
* Is this path to a minified version?
* @param {!Location} location
* @return {boolean}
*/
function isMin(location) {
const path = location.pathname;
return path.indexOf('.min') >= 0 || path.substr(0, 5) == '/min/';
}
61 changes: 1 addition & 60 deletions src/service/extensions-impl.js
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ import {installImg} from '../../builtins/amp-img';
import {installPixel} from '../../builtins/amp-pixel';
import {installStyles} from '../style-installer';
import {installVideo} from '../../builtins/amp-video';
import {urls} from '../config';
import {calculateExtensionScriptUrl} from './extension-location';


const TAG = 'extensions';
Expand Down Expand Up @@ -552,65 +552,6 @@ export class Extensions {
}


/**
* Calculate the base url for any scripts.
* @param {!Location} location The window's location
* @param {boolean=} isLocalDev
* @param {boolean=} isTest
* @return {string}
*/
export function calculateScriptBaseUrl(location, isLocalDev, isTest) {
if (isLocalDev) {
if (isTest || isMax(location) || isMin(location)) {
return `${location.protocol}//${location.host}/dist`;
}
}
return urls.cdn;
}

/**
* Calculate script url for amp-ad.
* @param {!Location} location The window's location
* @param {string} extensionId
* @param {boolean=} isLocalDev
* @param {boolean=} isTest
* @param {boolean=} isUsingCompiledJs
* @return {string}
*/
export function calculateExtensionScriptUrl(location, extensionId, isLocalDev,
isTest, isUsingCompiledJs) {
const base = calculateScriptBaseUrl(location, isLocalDev, isTest);
if (isLocalDev) {
if ((isTest && !isUsingCompiledJs) || isMax(location)) {
return `${base}/v0/${extensionId}-0.1.max.js`;
}
return `${base}/v0/${extensionId}-0.1.js`;
}
return `${base}/rtv/${getMode().rtvVersion}/v0/${extensionId}-0.1.js`;
}


/**
* Is this path to a max (unminified) version?
* @param {!Location} location
* @return {boolean}
*/
function isMax(location) {
const path = location.pathname;
return path.indexOf('.max') >= 0 || path.substr(0, 5) == '/max/';
}

/**
* Is this path to a minified version?
* @param {!Location} location
* @return {boolean}
*/
function isMin(location) {
const path = location.pathname;
return path.indexOf('.min') >= 0 || path.substr(0, 5) == '/min/';
}


/**
* @return {boolean}
*/
Expand Down
4 changes: 2 additions & 2 deletions test/functional/test-cache-sw-core.js
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ runner.run('Cache SW', () => {
'https://cdn.ampproject.org/rtv/123/v0.js');
});

it('rewrites v1 to versioned v1', () => {
it.skip('rewrites v1 to versioned v1', () => {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Because we don't match v1 right now, only v0.

expect(sw.urlWithVersion(v1, '123')).to.equal(
'https://cdn.ampproject.org/rtv/123/v1.js');
});
Expand All @@ -118,7 +118,7 @@ runner.run('Cache SW', () => {
'https://cdn.ampproject.org/rtv/123/v0/amp-comp-0.1.js');
});

it('rewrites v1 comp to versioned v1 comp', () => {
it.skip('rewrites v1 comp to versioned v1 comp', () => {
expect(sw.urlWithVersion(v1comp, '123')).to.equal(
'https://cdn.ampproject.org/rtv/123/v1/amp-comp-0.1.js');
});
Expand Down
Loading