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

Warn instead of crashing for bad URLs #63

Merged
merged 5 commits into from
Jun 19, 2019
Merged
Show file tree
Hide file tree
Changes from 4 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
22 changes: 17 additions & 5 deletions lib/src/migration_visitor.dart
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ import 'package:sass/src/ast/sass.dart';
import 'package:sass/src/visitor/recursive_ast.dart';

import 'package:meta/meta.dart';
import 'package:source_span/source_span.dart';

import 'patch.dart';
import 'utils.dart';
Expand All @@ -34,6 +35,11 @@ abstract class MigrationVisitor extends RecursiveAstVisitor {
/// True if dependencies should be migrated as well.
final bool migrateDependencies;

/// Map of missing dependency URLs to the spans that import/use them.
UnmodifiableMapView<Uri, FileSpan> get missingDependencies =>
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
UnmodifiableMapView<Uri, FileSpan> get missingDependencies =>
Map<Uri, FileSpan> get missingDependencies =>

UnmodifiableMapView(_missingDependencies);
final _missingDependencies = <Uri, FileSpan>{};

/// The patches to be applied to the stylesheet being migrated.
UnmodifiableListView<Patch> get patches => UnmodifiableListView(_patches);
List<Patch> _patches;
Expand Down Expand Up @@ -67,9 +73,14 @@ abstract class MigrationVisitor extends RecursiveAstVisitor {

/// Visits the stylesheet at [dependency], resolved relative to [source].
@protected
void visitDependency(Uri dependency, Uri source) {
var stylesheet = parseStylesheet(source.resolveUri(dependency));
visitStylesheet(stylesheet);
void visitDependency(Uri dependency, Uri source, [FileSpan context]) {
var url = source.resolveUri(dependency);
var stylesheet = parseStylesheet(url);
if (stylesheet != null) {
visitStylesheet(stylesheet);
} else {
_missingDependencies[url] = context;
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
_missingDependencies[url] = context;
_missingDependencies.putIfAbsent(url, () => context);

This is minor, but I think it's more likely that an earlier import is more relevant to the user.

}
}

/// Returns the migrated contents of this file, or null if the file does not
Expand All @@ -96,7 +107,8 @@ abstract class MigrationVisitor extends RecursiveAstVisitor {
if (migrateDependencies) {
for (var import in node.imports) {
if (import is DynamicImport) {
visitDependency(Uri.parse(import.url), node.span.sourceUrl);
visitDependency(
Uri.parse(import.url), node.span.sourceUrl, import.span);
}
}
}
Expand All @@ -108,7 +120,7 @@ abstract class MigrationVisitor extends RecursiveAstVisitor {
visitUseRule(UseRule node) {
super.visitUseRule(node);
if (migrateDependencies) {
visitDependency(node.url, node.span.sourceUrl);
visitDependency(node.url, node.span.sourceUrl, node.span);
}
}
}
40 changes: 39 additions & 1 deletion lib/src/migrator.dart
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@

import 'package:args/command_runner.dart';
import 'package:meta/meta.dart';
import 'package:path/path.dart' as p;
import 'package:source_span/source_span.dart';

import 'utils.dart';

Expand All @@ -26,6 +28,9 @@ abstract class Migrator extends Command<Map<Uri, String>> {
/// If true, dependencies will be migrated in addition to the entrypoints.
bool get migrateDependencies => globalResults['migrate-deps'] as bool;

/// Map of missing dependency URLs to the spans that import/use them.
final missingDependencies = <Uri, FileSpan>{};
Copy link
Contributor

Choose a reason for hiding this comment

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

Document how subclasses are intended to interact with this.


/// Runs this migrator on [entrypoint] (and its dependencies, if the
/// --migrate-deps flag is passed).
///
Expand All @@ -45,7 +50,13 @@ abstract class Migrator extends Command<Map<Uri, String>> {
Map<Uri, String> run() {
var allMigrated = Map<Uri, String>();
for (var entrypoint in argResults.rest) {
var migrated = migrateFile(canonicalize(Uri.parse(entrypoint)));
var canonicalUrl = canonicalize(Uri.parse(entrypoint));
if (canonicalUrl == null) {
throw MigrationException(
"Error: Could not find Sass file at '$entrypoint'.");
nex3 marked this conversation as resolved.
Show resolved Hide resolved
}
jathak marked this conversation as resolved.
Show resolved Hide resolved

var migrated = migrateFile(canonicalUrl);
for (var file in migrated.keys) {
if (allMigrated.containsKey(file) &&
migrated[file] != allMigrated[file]) {
Expand All @@ -55,6 +66,33 @@ abstract class Migrator extends Command<Map<Uri, String>> {
allMigrated[file] = migrated[file];
}
}

if (missingDependencies.isNotEmpty) _warnForMissingDependencies();
return allMigrated;
}

/// Prints warnings for any missing dependencies encountered during migration.
///
/// By default, this prints a short warning with one line per missing
/// dependency.
///
/// In verbose mode, this instead prints a full warning with the source span
/// for each missing dependency.
void _warnForMissingDependencies() {
if (globalResults['verbose'] as bool) {
for (var uri in missingDependencies.keys) {
emitWarning("Could not find Sass file at '${p.prettyUri(uri)}'.",
missingDependencies[uri]);
}
} else {
var count = missingDependencies.length;
emitWarning(
"$count dependenc${count == 1 ? 'y' : 'ies'} could not be found.");
jathak marked this conversation as resolved.
Show resolved Hide resolved
for (var uri in missingDependencies.keys) {
var context = missingDependencies[uri];
print(' ${p.prettyUri(uri)} '
'@${p.prettyUri(context.sourceUrl)}:${context.start.line + 1}');
}
}
jathak marked this conversation as resolved.
Show resolved Hide resolved
}
}
10 changes: 7 additions & 3 deletions lib/src/migrators/division.dart
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,13 @@ More info: https://sass-lang.com/d/slash-div""";
bool get isPessimistic => argResults['pessimistic'] as bool;

@override
Map<Uri, String> migrateFile(Uri entrypoint) =>
_DivisionMigrationVisitor(this.isPessimistic, migrateDependencies)
.run(entrypoint);
Map<Uri, String> migrateFile(Uri entrypoint) {
var visitor =
_DivisionMigrationVisitor(this.isPessimistic, migrateDependencies);
var result = visitor.run(entrypoint);
missingDependencies.addAll(visitor.missingDependencies);
Copy link
Contributor

Choose a reason for hiding this comment

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

Bleh, it sucks that each subclass has to do this manually rather than just having "warn for missing dependencies" be the automatic default behavior. It's not something that needs to happen in this PR, but it's worth thinking about how you could make this more automatic.

Copy link
Member Author

Choose a reason for hiding this comment

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

Yeah, that's why I originally passed in the list for the visitor to add to, but this is probably cleaner than that, particularly right now when there's only one migrator that actually uses missingDependencies. Created #64 for this.

return result;
}
}

class _DivisionMigrationVisitor extends MigrationVisitor {
Expand Down
16 changes: 15 additions & 1 deletion lib/src/migrators/module.dart
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,20 @@ class _ModuleMigrationVisitor extends MigrationVisitor {
return uses.join() + results;
}

/// Visits the stylesheet at [dependency], resolved relative to [source].
@override
void visitDependency(Uri dependency, Uri source, [FileSpan context]) {
var url = source.resolveUri(dependency);
var stylesheet = parseStylesheet(url);
if (stylesheet == null) {
throw MigrationException(
"Error: Could not find Sass file at '${p.prettyUri(url)}'.",
span: context);
}

visitStylesheet(stylesheet);
}

/// Stores per-file state before visiting [node] and restores it afterwards.
@override
void visitStylesheet(Stylesheet node) {
Expand Down Expand Up @@ -270,7 +284,7 @@ class _ModuleMigrationVisitor extends MigrationVisitor {

var oldConfiguredVariables = _configuredVariables;
_configuredVariables = Set();
visitDependency(Uri.parse(import.url), _currentUrl);
visitDependency(Uri.parse(import.url), _currentUrl, import.span);
_namespaces[_lastUrl] = namespaceForPath(import.url);

// Pass the variables that were configured by the importing file to `with`,
Expand Down
13 changes: 10 additions & 3 deletions lib/src/runner.dart
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ import 'package:term_glyph/term_glyph.dart' as glyph;
import 'io.dart';
import 'migrators/division.dart';
import 'migrators/module.dart';
import 'utils.dart';

/// A command runner that runs a migrator based on provided arguments.
class MigratorRunner extends CommandRunner<Map<Uri, String>> {
Expand Down Expand Up @@ -55,8 +56,14 @@ class MigratorRunner extends CommandRunner<Map<Uri, String>> {
if (argResults.wasParsed('unicode')) {
glyph.ascii = !(argResults['unicode'] as bool);
}

var migrated = await runCommand(argResults);
Map<Uri, String> migrated;
try {
migrated = await runCommand(argResults);
} on MigrationException catch (e) {
print(e);
print('Migration failed!');
return;
}
if (migrated == null) return;

if (migrated.isEmpty) {
Expand All @@ -78,7 +85,7 @@ class MigratorRunner extends CommandRunner<Map<Uri, String>> {
for (var url in migrated.keys) {
assert(url.scheme == null || url.scheme == "file",
"$url is not a file path.");
if (argResults['verbose']) print("Mirating ${p.prettyUri(url)}");
if (argResults['verbose']) print("Migrating ${p.prettyUri(url)}");
File(url.toFilePath()).writeAsStringSync(migrated[url]);
}
}
Expand Down
13 changes: 9 additions & 4 deletions lib/src/utils.dart
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,8 @@ Uri canonicalize(Uri url) => _filesystemImporter.canonicalize(url);

/// Parses the file at [url] into a stylesheet.
Stylesheet parseStylesheet(Uri url) {
var canonicalUrl = _filesystemImporter.canonicalize(url);
var canonicalUrl = canonicalize(url);
if (canonicalUrl == null) return null;
var result = _filesystemImporter.load(canonicalUrl);
return Stylesheet.parse(result.contents, result.syntax, url: canonicalUrl);
}
Expand Down Expand Up @@ -58,9 +59,13 @@ Patch patchDelete(FileSpan span, {int start = 0, int end}) {
span.file.span(span.start.offset + start, span.start.offset + end), "");
}

/// Emits a warning with [message] and [context];
void emitWarning(String message, FileSpan context) {
print(context.message("WARNING - $message"));
/// Emits a warning with [message] and optionally [context];
void emitWarning(String message, [FileSpan context]) {
if (context == null) {
print("WARNING - $message");
} else {
print(context.message("WARNING - $message"));
}
}

/// An exception thrown by a migrator.
Expand Down
12 changes: 12 additions & 0 deletions test/migrators/division/bad_paths.hrx
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
<==> arguments
--migrate-deps

<==> input/entrypoint.scss
@import "does_not_exist";
@import "does_not_exist2";

<==> log.txt
WARNING - 2 dependencies could not be found.
does_not_exist @entrypoint.scss:1
does_not_exist2 @entrypoint.scss:2
Nothing to migrate!
19 changes: 19 additions & 0 deletions test/migrators/division/bad_paths_verbose.hrx
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
<==> arguments
--migrate-deps --verbose

<==> input/entrypoint.scss
@import "does_not_exist";
@import "does_not_exist2";

<==> log.txt
line 1, column 9 of entrypoint.scss: WARNING - Could not find Sass file at 'does_not_exist'.
,
1 | @import "does_not_exist";
| ^^^^^^^^^^^^^^^^
'
line 2, column 9 of entrypoint.scss: WARNING - Could not find Sass file at 'does_not_exist2'.
,
2 | @import "does_not_exist2";
| ^^^^^^^^^^^^^^^^^
'
Nothing to migrate!
11 changes: 11 additions & 0 deletions test/migrators/module/bad_paths.hrx
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<==> input/entrypoint.scss
@import "does_not_exist";
@import "does_not_exist2";

<==> log.txt
line 1, column 9 of entrypoint.scss: Error: Could not find Sass file at 'does_not_exist'.
,
1 | @import "does_not_exist";
| ^^^^^^^^^^^^^^^^
'
Migration failed!