`RuleVisitorRegistry.afterLibrary` not running for plugins(?)

[FMorschel]

I may be doing something wrong, but I did this change FMorschel/essential_lints@0f33417:

  @override
  void registerNodeProcessors(
    RuleVisitorRegistry registry,
    RuleContext context,
  ) {
    final visitor = _PendingListenerVisitor(this, context);
    var file =
        File(
          '${context.definingUnit.file.parent.path}/debug.txt',
        )..writeAsStringSync(
          'Evaluating ${context.definingUnit.file.path}\n',
          mode: FileMode.append,
        );
    registry
      ..addMethodInvocation(this, visitor)
      ..afterLibrary(this, () {
        file.writeAsStringSync(
          'Completed evaluation of ${context.definingUnit.file.path}\n',
          mode: FileMode.append,
        );
        var addedListeners = visitor.addedListeners;
        var removedListeners = visitor.removedListeners;
        file.writeAsStringSync(
          'Added Listeners: $addedListeners\n'
          'Removed Listeners: $removedListeners\n',
          mode: FileMode.append,
        );
        _reportFor(addedListeners, removedListeners, rule);
        _reportFor(
          removedListeners,
          addedListeners,
          PendingListener.unnecessaryRemove,
        );
      });
  }

And on my analyzed project, I have many locations that trigger on my tests, but the outputted file is:

Evaluating D:\dev\flutter\bug\lib\main.dart
Evaluating D:\dev\flutter\bug\lib\main.dart
Evaluating D:\dev\flutter\bug\lib\other.dart
Evaluating D:\dev\flutter\bug\lib\main.dart
Evaluating D:\dev\flutter\bug\lib\main.dart
Evaluating D:\dev\flutter\bug\lib\main.dart
Evaluating D:\dev\flutter\bug\lib\main.dart
Evaluating D:\dev\flutter\bug\lib\main.dart
Evaluating D:\dev\flutter\bug\lib\main.dart
Evaluating D:\dev\flutter\bug\lib\main.dart
Evaluating D:\dev\flutter\bug\lib\main.dart
Evaluating D:\dev\flutter\bug\lib\main.dart
Evaluating D:\dev\flutter\bug\lib\main.dart
Evaluating D:\dev\flutter\bug\lib\main.dart
Evaluating D:\dev\flutter\bug\lib\main.dart
Evaluating D:\dev\flutter\bug\lib\main.dart
Evaluating D:\dev\flutter\bug\lib\other.dart
Evaluating D:\dev\flutter\bug\lib\other.dart
Evaluating D:\dev\flutter\bug\lib\other.dart
Evaluating D:\dev\flutter\bug\lib\other.dart

So I never get to Completed evaluation of or Added Listeners, and I evaluate main.dart many times, even though I did not open it once (everything there is commented out), all my code is on other.dart.

The question mark in the title is because it works fine on my tests, but I'm guessing that the code isn't running the exact same path there.

Any idea what is happening here @srawlins?

CC @bwilkerson

[srawlins]

Ah yeah, in plugin_server.dart, we need to call AnalysisRuleVisitor.afterLibrary, after analyzing the units, like we do in library_analyzer.dart:

// Now that all lint rules have visited the code in each of the compilation
// units, we can accept each lint rule's `afterLibrary` hook.
AnalysisRuleVisitor(
  nodeRegistry,
  shouldPropagateExceptions: _analysisOptions.propagateLinterExceptions,
).afterLibrary();

I missed that somehow.

[FMorschel]

I thought I was going mad, hahaha.

Any idea about why it triggers Evaluating main.dart so many times? I mean, 15x against only 5x for other.dart.

[srawlins]

Does other.dart import main.dart or vice versa? Indirectly as well.

[FMorschel]

No. main.dart is fully commented out and other.dart only imports package:flutter/material.dart. This is why I did not understand.

I would expect it to run at least evenly, if the analysis had to run more times, but (if needed) more times with other.dart since I'm opening it on the editor. But there is no other file under lib/ here and I've not edited any of the Flutter default folders (maybe some of those request this? IDK). There isn't even an example or test folder in this project so I have no clue here.

[srawlins]

OK thanks for the info.

[bwilkerson]

Ah yeah, in plugin_server.dart, we need to call AnalysisRuleVisitor.afterLibrary, after analyzing the units, like we do in library_analyzer.dart:

I'm surprised by this. Why are lint rules being run outside of library_analyzer.dart? I would have expected that. plugin-provided lints would be enabled before analysis was run and that the analyzer would just run them the way it runs first-party lints.

[srawlins]

I'm surprised by this. Why are lint rules being run outside of library_analyzer.dart?

I'm not sure why lint rules (from analyzer plugins) would be run via library_analyzer.dart. That code primarily resolves code and computes errors. And then warnings and lints are computed at the end. Anyways, they're run in PluginServer.

I would have expected that. plugin-provided lints would be enabled before analysis was run and that the analyzer would just run them the way it runs first-party lints.

It's an interesting idea. It's not currently how plugin lint rules are run.