compiler.js add in build instructions (ampproject#35170)

* bento-compiler: hook up to the compiler lib

* Make alias for #compiler, add unit test

* add extraGlobs

* bump compiler dep

* typecheck

* remove TODO

* fix test

* Update src/compiler/types.extern.js

Co-authored-by: Ryan Cebulko <[email protected]>

* type fixes

* rcebulko comments

Co-authored-by: Ryan Cebulko <[email protected]>

Author: samouri

build-system/compile/bundles.config.js

@@ -119,6 +119,7 @@ exports.jsBundles = {
     minifiedDestDir: './dist',
     options: {
       minifiedName: 'compiler.js',
+      extraGlobs: ['src/builtins/**/*.js', 'extensions/amp-fit-text/**/*.js'],
     },
   },
   'amp-viewer-host.max.js': {

build-system/compile/sources.js

@@ -55,6 +55,8 @@ const COMMON_GLOBS = [
   'node_modules/web-activities/activity-ports.js',
   'node_modules/@ampproject/animations/package.json',
   'node_modules/@ampproject/animations/dist/animations.mjs',
+  'node_modules/@ampproject/bento-compiler/package.json',
+  'node_modules/@ampproject/bento-compiler/dist/index.js',
   'node_modules/@ampproject/toolbox-cache-url/package.json',
   'node_modules/@ampproject/toolbox-cache-url/dist/amp-toolbox-cache-url.esm.js',
   'node_modules/@ampproject/viewer-messaging/package.json',

package-lock.json

@@ -16,6 +16,7 @@
   },
   "dependencies": {
     "@ampproject/animations": "0.2.2",
+    "@ampproject/bento-compiler": "0.0.2",
     "@ampproject/toolbox-cache-url": "2.8.0",
     "@ampproject/viewer-messaging": "1.1.2",
     "@ampproject/worker-dom": "0.30.1",

package.json

@@ -0,0 +1,47 @@
+/**
+ * Copyright 2021 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 {buildDom as ampLayoutClassic} from '#builtins/amp-layout/amp-layout';
+
+import {buildDom as ampFitTextClassic} from '../../extensions/amp-fit-text/0.1/amp-fit-text';
+
+const builderMap = {
+  'v0': {
+    'amp-layout': ampLayoutClassic,
+  },
+  '0.1': {
+    'amp-fit-text': ampFitTextClassic,
+  },
+};
+
+/**
+ * Returns the set of component builders needed to server-render an AMP Document.
+ *
+ * @param {!./types.VersionsDef} versions
+ * @return {Object<string, !./types.BuildDomDef>} builders
+ */
+export function getBuilders(versions) {
+  const builders = {};
+
+  for (const tag of Object.keys(versions)) {
+    const version = versions[tag];
+    const builder = builderMap?.[version]?.[tag];
+    if (builder) {
+      builders[tag] = builder;
+    }
+  }
+
+  return builders;
+}

src/compiler/builders.js

@@ -14,25 +14,19 @@
  * limitations under the License.
  */
 
-/**
- * Returns the HTML for an AMP Document with eligible components server-rendered.
- *
- * @param {string} html
- * @return {string}
- */
-function compileHtml(html) {
-  return html;
-}
+import * as compiler from '@ampproject/bento-compiler';
+
+import {getBuilders} from './builders';
 
 /**
  * Returns the AST for an AMP Document with eligible components server-rendered.
  *
- * @param {*} ast
- * @return {*}
+ * @param {!./types.TreeProtoDef} ast
+ * @param {!./types.VersionsDef} versions
+ * @return {!./types.TreeProtoDef}
  */
-function compileAst(ast) {
-  return ast;
+function compileAst(ast, versions) {
+  return compiler.renderAst(ast, getBuilders(versions));
 }
 
-globalThis.compileHtml = compileHtml;
-globalThis.compileAst = compileAst;
+globalThis['compileAst'] = compileAst;

src/compiler/index.js

@@ -0,0 +1,39 @@
+/**
+ * Copyright 2021 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.
+ */
+
+/**
+ * @fileoverview The junk-drawer of externs that haven't yet been sorted well.
+ * Shame! Shame! Shame! Avoid adding to this.
+ *
+ * It's okay for some things to start off here, since moving them doesn't
+ * require any other file changes (unlike real code, which requires updating)
+ * imports throughout the repo).
+ *
+ * @externs
+ */
+
+/**
+ * @type {!./types.BuildDomDef}
+ */
+var buildDom$$module$src$builtins$amp_layout$amp_layout;
+
+/**
+ * @type {!./types.BuildDomDef}
+ */
+var buildDom$$module$extensions$amp_fit_text$0_1$amp_fit_text;
+
+/** @type {{renderAst: function(!./types.TreeProtoDef, Object<string, !./types.BuildDomDef>): !./types.TreeProtoDef}} */
+var module$$ampproject$bento_compiler;

src/compiler/shame.extern.js

@@ -25,5 +25,19 @@
  * The return value is set to *, so that we may optionally return any DOM nodes
  * created during a client-side render. These nodes are often needed for ivars.
  *
- * @typedef {function(!Element):*} BuildDom
+ * @typedef {function(!Element):*}
  */
+export let BuildDomDef;
+
+/**
+ * See @ampproject/bento-compiler for the definition.
+ * @typedef {*}
+ */
+export let TreeProtoDef;
+
+/**
+ * Contains component versioning data via a map from tagName --> version.
+ *
+ * @typedef {Object<string, string>}}
+ */
+export let VersionsDef;

src/compiler/types.js

@@ -0,0 +1,41 @@
+/**
+ * Copyright 2021 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 {getBuilders} from '#compiler/builders';
+
+describes.sandboxed('getBuilders', {}, () => {
+  it('should return an empty list for empty component list', () => {
+    const components = {};
+    expect(getBuilders(components)).to.eql({});
+  });
+
+  it('should return eligible builtins when provided them as components', () => {
+    const components = {'amp-layout': 'v0'};
+    const builders = getBuilders(components);
+    expect(builders).have.all.keys(['amp-layout']);
+  });
+
+  it('eligible component with ineligible version is not used', () => {
+    const components = {'amp-fit-text': '1.0'};
+    const builders = getBuilders(components);
+    expect(builders).to.eql({});
+  });
+
+  it('should return eligible components', () => {
+    const components = {'amp-fit-text': '0.1', 'amp-layout': 'v0'};
+    const builders = getBuilders(components);
+    expect(builders).have.all.keys(['amp-layout', 'amp-fit-text']);
+  });
+});

test/unit/compiler/test-builders.js

@@ -10,6 +10,7 @@
       "#build/*": ["./build/*"],
 
       "#builtins/*": ["./src/builtins/*"],
+      "#compiler/*": ["./src/compiler/*"],
       "#core/*": ["./src/core/*"],
       "#experiments/*": ["./src/experiments/*"],
       "#inabox/*": ["./src/inabox/*"],