Skip to content

Commit

Permalink
add version parameter to AMP.extension signature
Browse files Browse the repository at this point in the history
  • Loading branch information
erwinmombay committed Nov 3, 2016
1 parent e9c309c commit eeed48d
Show file tree
Hide file tree
Showing 8 changed files with 28 additions and 13 deletions.
Binary file modified build-system/runner/dist/runner.jar
Binary file not shown.
17 changes: 12 additions & 5 deletions build-system/runner/src/org/ampproject/AmpPass.java
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,8 @@ class AmpPass extends AbstractPostOrderCallback implements HotSwapCompilerPass {
private final Map<String, Node> prodAssignmentReplacements;
final boolean isProd;

final Integer ampExtensionCallbackPosition = 4;

public AmpPass(AbstractCompiler compiler, boolean isProd,
Map<String, Set<String>> stripTypeSuffixes,
Map<String, Node> assignmentReplacements, Map<String, Node> prodAssignmentReplacements) {
Expand Down Expand Up @@ -99,12 +101,12 @@ public AmpPass(AbstractCompiler compiler, boolean isProd,
* NAME self 3 [length: 4] [source_file: input0]
* STRING someproperty 3 [length: 15] [source_file: input0]
* STRING AMP 3 [length: 3] [source_file: input0]
* STRING etension 3 [length: 12] [source_file: input0]
* STRING extension 3 [length: 12] [source_file: input0]
* STRING some-string 3 [length: 9] [source_file: input0]
* FUNCTION 3 [length: 46] [source_file: input0]
*/
private boolean isAmpExtensionCall(Node n) {
if (n != null && n.isCall() && n.getChildCount() == 3) {
if (n != null && n.isCall() && n.getChildCount() == ampExtensionCallbackPosition) {
Node getprop = n.getFirstChild();

// The AST has the last getprop higher in the hierarchy.
Expand All @@ -115,7 +117,7 @@ private boolean isAmpExtensionCall(Node n) {
firstChild.getString() == "AMP") ||
isGetPropName(firstChild, "AMP")) {
// Child at index 1 should be the "string" value (first argument)
Node func = n.getChildAtIndex(2);
Node func = getAmpExtensionCallback(n);
return func != null && func.isFunction();
}
}
Expand All @@ -136,7 +138,7 @@ private boolean isGetPropName(Node n, String name) {
* This operation should be guarded stringently by `isAmpExtensionCall`
* predicate.
*
* AMP.extension('some-name', function(AMP) {
* AMP.extension('some-name', '0.1', function(AMP) {
* // BODY...
* });
*
Expand All @@ -149,7 +151,7 @@ private void inlineAmpExtensionCall(Node n, Node expr) {
if (expr == null || !expr.isExprResult()) {
return;
}
Node func = n.getChildAtIndex(2);
Node func = getAmpExtensionCallback(n);
func.detachFromParent();
Node arg1 = IR.getprop(IR.name("self"), IR.string("AMP"));
arg1.setLength("self.AMP".length());
Expand All @@ -161,6 +163,11 @@ private void inlineAmpExtensionCall(Node n, Node expr) {
compiler.reportCodeChange();
}

private Node getAmpExtensionCallback(Node n) {
// 0 index based
return n.getChildAtIndex(ampExtensionCallbackPosition - 1);
}

/**
* For a function that looks like:
* function fun(val) {
Expand Down
4 changes: 2 additions & 2 deletions build-system/runner/test/org/ampproject/AmpPassTest.java
Original file line number Diff line number Diff line change
Expand Up @@ -324,7 +324,7 @@ public void testRemoveAmpAddExtensionCallWithExplicitContext() throws Exception
testEs6(
LINE_JOINER.join(
"var a = 'hello';",
"self.AMP.extension('hello', function(AMP) {",
"self.AMP.extension('hello', '0.1', function(AMP) {",
" var a = 'world';",
" console.log(a);",
"});",
Expand All @@ -342,7 +342,7 @@ public void testRemoveAmpAddExtensionCallWithNoContext() throws Exception {
testEs6(
LINE_JOINER.join(
"var a = 'hello';",
"AMP.extension('hello', function(AMP) {",
"AMP.extension('hello', '0.1', function(AMP) {",
" var a = 'world';",
" console.log(a);",
"});",
Expand Down
2 changes: 1 addition & 1 deletion extensions/amp-sticky-ad/0.1/amp-sticky-ad.js
Original file line number Diff line number Diff line change
Expand Up @@ -238,6 +238,6 @@ class AmpStickyAd extends AMP.BaseElement {
}
}

AMP.extension('amp-sticky-ad:0.1', AMP => {
AMP.extension('amp-sticky-ad', '0.1', AMP => {
AMP.registerElement('amp-sticky-ad', AmpStickyAd, CSS);
});
2 changes: 1 addition & 1 deletion extensions/amp-sticky-ad/1.0/amp-sticky-ad.js
Original file line number Diff line number Diff line change
Expand Up @@ -222,6 +222,6 @@ class AmpStickyAd extends AMP.BaseElement {
}
}

AMP.extension('amp-sticky-ad:1.0', AMP => {
AMP.extension('amp-sticky-ad', '1.0', AMP => {
AMP.registerElement('amp-sticky-ad', AmpStickyAd, CSS);
});
3 changes: 2 additions & 1 deletion src/runtime.js
Original file line number Diff line number Diff line change
Expand Up @@ -179,10 +179,11 @@ function adoptShared(global, opts, callback) {
if (!global.AMP.extension) {
/**
* @param {string} unusedName
* @param {string} unusedVersion
* @param {function(!Object)} installer
* @const
*/
global.AMP.extension = function(unusedName, installer) {
global.AMP.extension = function(unusedName, unusedVersion, installer) {
installer(global.AMP);
};
}
Expand Down
5 changes: 3 additions & 2 deletions test/_init_tests.js
Original file line number Diff line number Diff line change
Expand Up @@ -44,11 +44,12 @@ adopt(window);
// Override AMP.extension to buffer extension installers.
/**
* @param {string} name
* @param {string} version
* @param {function(!Object)} installer
* @const
*/
global.AMP.extension = function(name, installer) {
describes.bufferExtension(name, installer);
global.AMP.extension = function(name, version, installer) {
describes.bufferExtension(`${name}:${version}`, installer);
};


Expand Down
8 changes: 7 additions & 1 deletion testing/describes.js
Original file line number Diff line number Diff line change
Expand Up @@ -429,7 +429,13 @@ class AmpFixture {
}
if (spec.extensions) {
spec.extensions.forEach(extensionId => {
const installer = extensionsBuffer[extensionId];
let bufferId = extensionId;
if (extensionId.indexOf(':') == -1) {
// We default to 0.1 if the user did not give an explicit
// version.
bufferId = `${extensionId}:0.1`;
}
const installer = extensionsBuffer[bufferId];
if (installer) {
installer(win.AMP);
} else {
Expand Down

0 comments on commit eeed48d

Please sign in to comment.