add console error about bad packages paths in html imports

lib/src/mirror_initializer.dart

 // Copyright (c) 2014, the Dart project authors.  Please see the AUTHORS file
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
 /// Contains logic to initialize web_components apps during development. This
 /// implementation uses dart:mirrors to load each library as they are discovered
 /// through HTML imports. This is only meant to be used during development in
 /// dartium, and the web_components transformers replace this implementation
 /// for deployment.
 library web_components.src.mirror_initializer;
 
 import 'dart:async';
 import 'dart:collection' show LinkedHashMap;
 import 'dart:mirrors';
 import 'dart:html';
 import 'package:initialize/initialize.dart' as init;
+import 'package:path/path.dart' show url;
 
 const bool deployMode = false;
 
 Future run({List<Type> typeFilter, init.InitializerFilter customFilter}) async {
-  var libraryUris = _discoverLibrariesToLoad(document, window.location.href)
-      .map(Uri.parse);
+  var libraryUris =
+      _discoverLibrariesToLoad(document, window.location.href).map(Uri.parse);
 
   for (var uri in libraryUris) {
     await init.run(
         typeFilter: typeFilter, customFilter: customFilter, from: uri);
   }
+
+  _validatePackageImports(document);
   return null;
 }
 
 /// Walks the HTML import structure to discover all script tags that are
 /// implicitly loaded. This code is only used in Dartium and should only be
 /// called after all HTML imports are resolved. Polymer ensures this by asking
 /// users to put their Dart script tags after all HTML imports (this is checked
 /// by the linter, and Dartium will otherwise show an error message).
-Iterable<_ScriptInfo> _discoverScripts(
-    Document doc, String baseUri, [_State state]) {
+Iterable<_ScriptInfo> _discoverScripts(Document doc, String baseUri,
+    [_State state]) {
   if (state == null) state = new _State();
   if (doc == null) {
     print('warning: $baseUri not found.');
     return state.scripts.values;
   }
   if (!state.seen.add(doc)) return state.scripts.values;
 
   for (var node in doc.querySelectorAll('script,link[rel="import"]')) {
     if (node is LinkElement) {
       _discoverScripts(node.import, node.href, state);
@@ skipping 27 matching lines @@
 
   /// Whether it seems to be a 'package:' URL (starts with the package-root).
   bool get isPackage => packageUrl != null;
 
   /// The equivalent 'package:' URL, if any.
   final String packageUrl;
 
   _ScriptInfo(this.resolvedUrl, {this.packageUrl});
 }
 
-
 // TODO(sigmund): explore other (cheaper) ways to resolve URIs relative to the
 // root library (see dartbug.com/12612)
 final _rootUri = currentMirrorSystem().isolate.rootLibrary.uri;
 
 /// Returns [_ScriptInfo] for [script] which was seen in [baseUri].
 _ScriptInfo _scriptInfoFor(script, baseUri) {
   var uriString = script.src;
   if (uriString != '') {
     var uri = _rootUri.resolve(uriString);
     if (!_isHttpStylePackageUrl(uri)) return new _ScriptInfo('$uri');
     // Use package: urls if available. This rule here is more permissive than
     // how we translate urls in polymer-build, but we expect Dartium to limit
     // the cases where there are differences. The polymer-build issues an error
     // when using packages/ inside lib without properly stepping out all the way
     // to the packages folder. If users don't create symlinks in the source
     // tree, then Dartium will also complain because it won't find the file seen
     // in an HTML import.
-    var packagePath = uri.path.substring(
-        uri.path.lastIndexOf('packages/') + 'packages/'.length);
+    var packagePath = uri.path
+        .substring(uri.path.lastIndexOf('packages/') + 'packages/'.length);
     return new _ScriptInfo('$uri', packageUrl: 'package:$packagePath');
   }
 
   // Even in the case of inline scripts its ok to just use the baseUri since
   // there can only be one per page.
   return new _ScriptInfo(baseUri);
 }
 
 /// Whether [uri] is an http URI that contains a 'packages' segment, and
 /// therefore could be converted into a 'package:' URI.
 bool _isHttpStylePackageUrl(Uri uri) {
   var uriPath = uri.path;
   return uri.scheme == _rootUri.scheme &&
       // Don't process cross-domain uris.
       uri.authority == _rootUri.authority &&
       uriPath.endsWith('.dart') &&
       (uriPath.contains('/packages/') || uriPath.startsWith('packages/'));
 }
 
 Iterable<String> _discoverLibrariesToLoad(Document doc, String baseUri) =>
     _discoverScripts(doc, baseUri).map(
         (info) => _packageUrlExists(info) ? info.packageUrl : info.resolvedUrl);
 
 /// All libraries in the current isolate.
 final _libs = currentMirrorSystem().libraries;
 
 bool _packageUrlExists(_ScriptInfo info) =>
     info.isPackage && _libs[Uri.parse(info.packageUrl)] != null;
+
+/// All the imports that we have checked for package path validation.
+final _importsSeen = new Set<LinkElement>();
+
+/// All the documents that we have crawled for import validation.
+final _documentsSeen = new Set<Document>();
+
+/// Validates that all html imports to packages urls point to the right packages
+/// symlink (the one next to the entry point).
+void _validatePackageImports(Document doc) {
+  var imports = doc.querySelectorAll('link[rel="import"]');
+  for (LinkElement import in imports) {
+    // Don't re-validate imports.
+    if (!_importsSeen.add(import)) continue;
+
+    // Check that the href points to the right packages path. If it doesn't we
+    // don't continue checking as it will print extraneous errors.
+    if (import.href.contains('packages/') && !_checkPackagePath(import)) {
+      continue;
+    }
+
+    // Validate any imports contained in this import, if the document hasn't yet
+    // been seen.
+    var importDoc = import.import;
+    if (!_documentsSeen.add(importDoc)) continue;
+    _validatePackageImports(importDoc);
+  }
+}
+
+/// The path to the entry document.
+final entryPath = document.baseUri;
+
+/// Checks that the relative path from the entry point to all packages imports
+/// starts with `packages/`.
+bool _checkPackagePath(LinkElement import) {
+  var pathFromEntryPoint =
+      url.relative(import.href, from: url.dirname(entryPath));

[Siggi Cherem (dart-lang), 2015/04/01 21:37:05]

just to double check, is import.href resolved to be an absolute url? If so,
let's add a little comment about it - if not, then I imagine here we would need
to know what is the path of the containing document so we can compute the joined
path.

[jakemac, 2015/04/02 14:34:06]

Yes its the absolute url

+  if (pathFromEntryPoint.startsWith('packages/')) return true;
+
+  LinkElement correctedImport = import.clone(false);
+
+  var pathToEntryPoint = '../' *
+      (url.split(url.relative(import.ownerDocument.baseUri,
+              from: url.dirname(entryPath))).length -
+          1);

[Siggi Cherem (dart-lang), 2015/04/01 21:37:05]

the format here looks really strange. formatter bug? maybe add a tmp var to help

[jakemac, 2015/04/02 14:34:06]

done

+  var packagePath = import.href.substring(import.href.indexOf('packages/'));
+  correctedImport.href = '$pathToEntryPoint$packagePath';
+
+  // TODO(jakemac): Throw an exception here at the next breaking change, and add
+  // a test at that point (no easy way to test console.error).
+  window.console.error('''
+Found bad packages uri in html import. All packages uris should point to the
+packages symlink in the same folder as the entry point.
+
+Entry point: $entryPath
+Owner document: ${import.ownerDocument.baseUri}
+Current import: ${import.outerHtml}
+Corrected import: ${correctedImport.outerHtml}
+
+For more information, please see:
+https://www.dartlang.org/polymer/app-directories.html#into-a-non-dart-non-entry-point
+''');
+  return false;
+}