libdot: convert to ES6 module

Replace the generated index.js with an actual ES6 module that loads
all the rest of the hterm code on the fly.  This avoids the compile
step when testing locally.

This is structured as the minimal effort to convert libdot to an ES6
module.  We still have a global "lib" object that all the imported
files extend with their APIs.  This avoids a lot of disruption in
the tree and makes it easier to review.  This also avoids confusing
closure-compiler as it doesn't handle ES6 modules great where the
declared types use the full `lib.xxx` namespace.  Rectifying this
will take some effort, and perhaps writing custom externs, neither
of which is exactly great.

Change-Id: Id90c8206803b52e4c301ae84e33e4fed3807a850
Reviewed-on: https://chromium-review.googlesource.com/c/apps/libapps/+/4801578
Tested-by: kokoro <[email protected]>
Reviewed-by: Joel Hockey <[email protected]>

Author: vapier

libdot/.gitignore

@@ -5,7 +5,5 @@ dist
 *.min.js
 *.js.map
 
-/index.js
-
 # npm related dirs.
 node_modules

libdot/bin/lint

@@ -151,6 +151,7 @@ def _get_default_paths(basedir: Path) -> List[Path]:
     # Sort to ensure lib.js comes before lib_array.js, etc.
     js_files = sorted(
         list((libdot.DIR / "html").glob("*.html"))
+        + [libdot.DIR / "index.js"]
         + list((libdot.DIR / "js").glob("*.js"))
     )
 

libdot/bin/load_tests

@@ -192,9 +192,14 @@ def test_runner_main(argv, path, serve=False, mkdeps=None):
     logging.info("Tests took %s", delta)
 
 
+def _mkdeps(_opts) -> None:
+    """Build the required deps for the test suite."""
+    subprocess.check_call([libdot.BIN_DIR / "mkdist"])
+
+
 def main(argv):
     """The main func!"""
-    return test_runner_main(argv, TEST_PAGE, serve=True)
+    return test_runner_main(argv, TEST_PAGE, serve=True, mkdeps=_mkdeps)
 
 
 if __name__ == "__main__":

libdot/externs/rollup-package-json.js

@@ -19,3 +19,15 @@ default$$module$package_json.gitDate;
 
 /** @type {string} */
 default$$module$package_json.version;
+
+/** @const */
+const module$__$libdot$dist$js$libdot_resources = {};
+
+/** @type {string} */
+module$__$libdot$dist$js$libdot_resources.gitCommitHash;
+
+/** @type {string} */
+module$__$libdot$dist$js$libdot_resources.gitDate;
+
+/** @type {string} */
+module$__$libdot$dist$js$libdot_resources.version;

libdot/html/lib_test.html

@@ -10,22 +10,6 @@
     <!-- initialize the test framework; this must come first -->
     <script src='../js/lib_test.js'></script>
 
-    <!-- libdot js files under test; keep in dep order -->
-    <script src='../js/lib.js'></script>
-    <script src='../js/lib_polyfill.js'></script>
-    <script src='../js/lib_codec.js'></script>
-    <script src='../js/lib_f.js'></script>
-    <script src='../js/lib_colors.js'></script>
-    <script src='../js/lib_event.js'></script>
-    <script src='../js/lib_i18n.js'></script>
-    <script src='../js/lib_message_manager.js'></script>
-    <script src='../js/lib_storage.js'></script>
-    <script src='../js/lib_storage_chrome.js'></script>
-    <script src='../js/lib_storage_local.js'></script>
-    <script src='../js/lib_storage_memory.js'></script>
-    <script src='../js/lib_storage_terminal_private.js'></script>
-    <script src='../js/lib_preference_manager.js'></script>
-
     <!-- libdot js tests -->
     <script type='module' src='../js/lib_codec_tests.js'></script>
     <script type='module' src='../js/lib_colors_tests.js'></script>

libdot/index.js

@@ -0,0 +1,29 @@
+// Copyright 2012 The ChromiumOS Authors
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+/**
+ * @fileoverview libdot main library entry point.
+ * @suppress {moduleLoad} Don't try and load dist/js/libdot_resources.js.
+ */
+
+import {lib} from './js/lib.js';
+import './js/lib_polyfill.js';
+import './js/lib_codec.js';
+import './js/lib_colors.js';
+import './js/lib_event.js';
+import './js/lib_f.js';
+import './js/lib_i18n.js';
+import './js/lib_message_manager.js';
+import './js/lib_preference_manager.js';
+import './js/lib_resource.js';
+import './js/lib_storage.js';
+import './js/lib_storage_chrome.js';
+import './js/lib_storage_local.js';
+import './js/lib_storage_memory.js';
+import './js/lib_storage_terminal_private.js';
+import * as resources from './dist/js/libdot_resources.js';
+export {lib};
+
+lib.resource.add('libdot/changelog/version', 'text/plain', resources.version);
+lib.resource.add('libdot/changelog/date', 'text/plain', resources.gitDate);

libdot/js/deps_resources.shim.js

@@ -7,7 +7,9 @@
  * @suppress {moduleLoad,undefinedVars} closure compiler can't handle this.
  */
 
-import pkg from '../package.json';
+import {gitDate, version} from '../package.json';
 
-lib.resource.add('libdot/changelog/version', 'text/plain', pkg.version);
-lib.resource.add('libdot/changelog/date', 'text/plain', pkg.gitDate);
+export {
+  gitDate as gitDate,
+  version as version,
+};

libdot/js/lib.js

@@ -2,8 +2,11 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
-'use strict';
+/**
+ * @fileoverview Core namespace.
+ */
 
+/** @const */
 const lib = {};
 
 /**
@@ -54,3 +57,5 @@ lib.notUndefined = function(value) {
   lib.assert(value !== undefined);
   return value;
 };
+
+export {lib};

libdot/js/lib_codec.js

@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
-'use strict';
+import {lib} from '../index.js';
 
 /** @const */
 lib.codec = {};

libdot/js/lib_codec_tests.js

@@ -6,6 +6,8 @@
  * @fileoverview Various codec test suites.
  */
 
+import {lib} from '../index.js';
+
 describe('lib_codec_tests.js', () => {
 
 /**

libdot/js/lib_colors.js

@@ -2,12 +2,12 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
-'use strict';
-
 /**
  * @fileoverview Color utilities.
  */
 
+import {lib} from '../index.js';
+
 /** @const */
 lib.colors = {};
 

libdot/js/lib_colors_tests.js

@@ -8,6 +8,8 @@
  * Verify color parsing logic.
  */
 
+import {lib} from '../index.js';
+
 describe('lib_color_tests.js', () => {
 
 it('rgbToX11', () => {

libdot/js/lib_event.js

@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
-'use strict';
+import {lib} from '../index.js';
 
 /**
  * An event is a JavaScript function with addListener and removeListener

libdot/js/lib_event_tests.js

@@ -7,6 +7,8 @@
  * @suppress {missingProperties} https://github.com/google/closure-compiler/issues/946
  */
 
+import {lib} from '../index.js';
+
 describe('lib_event_tests.js', () => {
 
 it('complete', () => {

libdot/js/lib_f.js

@@ -2,12 +2,12 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
-'use strict';
-
 /**
  * @fileoverview Grab bag of utility functions.
  */
 
+import {lib} from '../index.js';
+
 /** @const */
 lib.f = {};
 

libdot/js/lib_f_tests.js

@@ -6,6 +6,8 @@
  * @fileoverview Utility functions test suite.
  */
 
+import {lib} from '../index.js';
+
 describe('lib_f_tests.js', () => {
 
 it('replaceVars', () => {

libdot/js/lib_i18n.js

@@ -2,14 +2,14 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
-'use strict';
-
 /**
  * @fileoverview Wrappers over the browser i18n helpers.
  *
  * Arguably some of these functions should be l10n, but oh well.
  */
 
+import {lib} from '../index.js';
+
 /** @const */
 lib.i18n = {};
 

libdot/js/lib_i18n_tests.js

@@ -6,6 +6,8 @@
  * @fileoverview i18n functions test suite.
  */
 
+import {lib} from '../index.js';
+
 describe('lib_i18n_tests.js', () => {
 
 /**

libdot/js/lib_message_manager.js

@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
-'use strict';
+import {lib} from '../index.js';
 
 /**
  * MessageManager class handles internationalized strings.

libdot/js/lib_message_manager_tests.js

@@ -6,6 +6,8 @@
  * @fileoverview Message manager test suite.
  */
 
+import {lib} from '../index.js';
+
 describe('lib_message_manager_tests.js', () => {
 
 /**

libdot/js/lib_polyfill.js

@@ -2,12 +2,12 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
-'use strict';
-
 /**
  * @fileoverview Polyfills for ES2020+ features we want to use.
  * @suppress {duplicate} This file redefines many functions.
  */
 
+import {lib} from './lib.js';
+
 /** @const */
 lib.polyfill = {};

libdot/js/lib_preference_manager.js

@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
-'use strict';
+import {lib} from '../index.js';
 
 /**
  * Constructor for lib.PreferenceManager objects.

libdot/js/lib_preference_manager_tests.js

@@ -6,6 +6,8 @@
  * @fileoverview Unit tests for lib.PreferenceManager.
  */
 
+import {lib} from '../index.js';
+
 describe('lib_preference_manager_tests.js', () => {
 
 /**

libdot/js/lib_resource.js

@@ -2,8 +2,6 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
-'use strict';
-
 /**
  * @fileoverview Storage for canned resources.
  *
@@ -14,6 +12,8 @@
  * collisions.
  */
 
+import {lib} from '../index.js';
+
 /** @const */
 lib.resource = {};
 

libdot/js/lib_storage.js

@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
-'use strict';
+import {lib} from '../index.js';
 
 /**
  * Namespace for implementations of persistent, possibly cloud-backed

libdot/js/lib_storage_chrome.js

@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
-'use strict';
+import {lib} from '../index.js';
 
 /**
  * chrome.storage based class with an async interface that is interchangeable

libdot/js/lib_storage_chrome_tests.js

@@ -6,6 +6,7 @@
  * @fileoverview Test suite for Chrome storage.
  */
 
+import {lib} from '../index.js';
 import {storageApiTest} from './lib_storage_tests.js';
 
 describe('lib_storage_chrome_tests.js', () => {

libdot/js/lib_storage_local.js

@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
-'use strict';
+import {lib} from '../index.js';
 
 /**
  * window.localStorage based class with an async interface that is

libdot/js/lib_storage_local_tests.js

@@ -6,6 +6,7 @@
  * @fileoverview Test suite for local storage.
  */
 
+import {lib} from '../index.js';
 import {storageApiTest} from './lib_storage_tests.js';
 
 describe('lib_storage_local_tests.js', () => {

libdot/js/lib_storage_memory.js

@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
-'use strict';
+import {lib} from '../index.js';
 
 /**
  * In-memory storage class with an async interface that is interchangeable with

libdot/js/lib_storage_memory_tests.js

@@ -6,6 +6,7 @@
  * @fileoverview Test suite for memory storage.
  */
 
+import {lib} from '../index.js';
 import {storageApiTest} from './lib_storage_tests.js';
 
 describe('lib_storage_memory_tests.js', () => {

libdot/js/lib_storage_terminal_private.js

@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
-'use strict';
+import {lib} from '../index.js';
 
 /**
  * Storage implementation using chrome.terminalPrivate.

libdot/js/lib_storage_terminal_private_tests.js

@@ -6,6 +6,7 @@
  * @fileoverview Test suite for Terminal private storage.
  */
 
+import {lib} from '../index.js';
 import {storageApiTest} from './lib_storage_tests.js';
 
 describe('lib_storage_terminal_private_tests.js', () => {

libdot/js/lib_storage_tests.js

@@ -6,6 +6,8 @@
  * @fileoverview Common storage API tests.
  */
 
+import {lib} from '../index.js';
+
 /**
  * Testsuite for the generic storage API.
  *