devoncarew/analysis_server_lib

A library to access Dart's analysis server API.

analysis_server_lib's Issues

test issue 2

another test issue

Extension reference not found in search.findElementReferences

Hi,

The method search.findElementReferences doesn't find Extension's references, even though a member of that Extension is actually referenced. The extension's member reference is correctly found, but the extension itself is not.
The same thing doesn't happen with normal classes (maybe because the class constructor is explicitly called?).

Is this expected behaviour?

Code to reproduce the issue:

import 'dart:async';
import 'dart:io';

import 'package:analysis_server_lib/analysis_server_lib.dart';
import 'package:path/path.dart' as path;

class ServerHelper {
  static Future<ServerHelper> create() async {
    return ServerHelper(await AnalysisServer.create());
  }

  final AnalysisServer server;
  Directory tempDir;
  Map<String, List<AnalysisError>> errors = {};

  ServerHelper(this.server) : tempDir = Directory.systemTemp.createTempSync('tests');

  Future init() {
    server.analysis.onErrors.listen((AnalysisErrors e) {
      if (e.errors.isEmpty) {
        errors.remove(e.file);
      } else {
        errors[e.file] = e.errors;
      }
    });

    server.server.setSubscriptions(['STATUS']);
    return server.analysis.setAnalysisRoots([tempDir.path], []);
  }

  Stream get onAnalysisFinished {
    return server.server.onStatus.where((ServerStatus status) {
      return status.analysis != null && status.analysis!.isAnalyzing == false;
    });
  }

  Future<String> createFile(String filePath, String text) {
    String fullPath = path.join(tempDir.path, filePath);
    return server.analysis.updateContent(
      {fullPath: new AddContentOverlay(text)},
    ).then((_) => fullPath);
  }

  void dispose() {
    server.dispose();
    tempDir.deleteSync(recursive: true);
  }
}

Future<void> main() async {
  final helper = await ServerHelper.create();
  await helper.init();
  String main = await helper.createFile(
    'int_ext.dart',
    '''
extension FooExt on FooClass {
  bool get fooMemberExt => true;
}

class FooClass {
  bool get fooMember => true;
}

void fooBar() {
  FooClass().fooMember;
  FooClass().fooMemberExt;
}

void main(List<String> args) {
  fooBar();
}
''',
  );

  final member = await helper.server.search.getElementDeclarations(file: main);
  for (final res in member.declarations) {
    final id = await helper.server.search.findElementReferences(
      main,
      res.offset,
      true,
    );

    print('id: ${id.id} - ${id.element}');

    final sub = await helper.server.search.onResults.first;

    if (sub.results.isEmpty) {
      print('Not found: ${res.name}'); // FooExt not found, but I think it should be found
    }
  }

  helper.dispose();
}

Thanks,

Simone

update changelog, version, and re-publish

publish an initial version

Move file refactoring throwing exception

Hi,

The function edit.getRefactoring with kind 'MOVE_FILE' always throws a TypeError exception because the returned feedback is null but the RefactoringFeedback.parse function expect a Map<dynamic, dynamic>.
The exception thrown is: '_TypeError (type 'Null' is not a subtype of type 'Map<dynamic, dynamic>')', and it's thrown at line 1855 of file analysis_server_lib.dart.

Code that reproduces the issue (partially copied from your tests):

import 'dart:async';
import 'dart:io';

import 'package:analysis_server_lib/analysis_server_lib.dart';
import 'package:path/path.dart' as path;

class ServerHelper {
  static Future<ServerHelper> create() async {
    return ServerHelper(await AnalysisServer.create());
  }

  final AnalysisServer server;
  Directory tempDir;
  Map<String, List<AnalysisError>> errors = {};

  ServerHelper(this.server) : tempDir = Directory.systemTemp.createTempSync('tests');

  Future init() {
    server.analysis.onErrors.listen((AnalysisErrors e) {
      if (e.errors.isEmpty) {
        errors.remove(e.file);
      } else {
        errors[e.file] = e.errors;
      }
    });

    server.server.setSubscriptions(['STATUS']);
    return server.analysis.setAnalysisRoots([tempDir.path], []);
  }

  Stream get onAnalysisFinished {
    return server.server.onStatus.where((ServerStatus status) {
      return status.analysis != null && status.analysis!.isAnalyzing == false;
    });
  }

  Future<String> createFile(String filePath, String text) {
    String fullPath = path.join(tempDir.path, filePath);
    return server.analysis.updateContent(
      {fullPath: new AddContentOverlay(text)},
    ).then((_) => fullPath);
  }

  void dispose() {
    server.dispose();
    tempDir.deleteSync(recursive: true);
  }
}

Future<void> main() async {
  final helper = await ServerHelper.create();
  await helper.init();
  String main = await helper.createFile('old_main.dart', "foo() { }");
  RefactoringResult? result = await helper.server.edit.getRefactoring(
    Refactorings.MOVE_FILE,
    main,
    0,
    0,
    false,
    options: MoveFileRefactoringOptions(
      newFile: 'new_main.dart',
    ),
  );
  print(result);
}

Thanks,

Simone

improve readme docs

test issue

seeing if the triage bot will pick this up

test issue

test three

test issue 2

Consider using enum (or fake enum) for enumerated strings

It's easier to avoid typos if we have enums or static class fields representing things like the analysis error severities, types, etc.

publish 0.2.3

test two

any way to receive info from analysis server and send an info to analysis server?

I'm making a plugin base on analyzer_plugin, but it seems that analyzer_plugin can't receive info completion.getSuggestions2.

dart-lang/sdk#50449, this is an issue to dart team.

could analysis_server_lib support to receive and send info to analysis server? thanks

Found 23 files excluded from sound null safety

Found 23 files excluded from sound null safety (see dart-lang/sdk#49169 for context):

test/rules/null_closures_test.dart:23:// @dart=2.9
test/rules/null_closures_test.dart:31:// @dart=2.9
test/rules/null_closures_test.dart:41:// @dart=2.9
test/rules/null_closures_test.dart:51:// @dart=2.9
test/rules/prefer_collection_literals_test.dart:23:// @dart=2.9    
test/rules/prefer_collection_literals_test.dart:32:// @dart=2.9    
test/rules/prefer_collection_literals_test.dart:41:// @dart=2.9    
test_data/integration/always_require_non_null_named_parameters/lib.dart:5:// @dart=2.9
test_data/integration/avoid_private_typedef_functions/lib.dart:5:// @dart=2.9
test_data/integration/avoid_private_typedef_functions/part.dart:5:// @dart=2.9
test_data/integration/cancel_subscriptions/cancel_subscriptions.dart:5:// @dart=2.9
test_data/integration/close_sinks/src/a.dart:5:// @dart=2.9
test_data/integration/only_throw_errors/only_throw_errors.dart:5:// @dart=2.9
test_data/integration/overridden_fields/src/a.dart:5:// @dart=2.9
test_data/integration/overridden_fields/src/b.dart:5:// @dart=2.9
test_data/integration/public_member_api_docs/test/b.dart:5:// @dart=2.9
test_data/integration/use_build_context_synchronously/lib/unmigrated.dart:5:// @dart=2.9
test_data/rules/always_require_non_null_named_parameters.dart:7:// @dart=2.9
test_data/rules/avoid_init_to_null.dart:5:// @dart=2.9
test_data/rules/avoid_returning_null.dart:7:// @dart=2.9
test_data/rules/avoid_returning_null_for_future.dart:7:// @dart=2.8
test_data/rules/prefer_bool_in_asserts.dart:5:// @dart=2.9
test_data/rules/void_checks.dart:7:// @dart=2.9

test one

Document code generation approach

The lib/analysis_server_lib.dart file contains the warning that this file is code generated. However, I can't see how to regenerate the code nor the template used to generate this file from.

The reason I ask is that I'd like to add error handling to the create method. Currently this code dies silently if run from a Flutter app, presumably on a failure to find the Dart SDK.

expose the refactoring classes

Found files excluded from sound null safety

Found files excluded from sound null safety (see
also dart-lang/sdk#49169):

test/rules/null_closures_test.dart:23:// @dart=2.9
test/rules/null_closures_test.dart:31:// @dart=2.9
test/rules/null_closures_test.dart:41:// @dart=2.9
test/rules/null_closures_test.dart:51:// @dart=2.9
test/rules/prefer_collection_literals_test.dart:23:// @dart=2.9    
test/rules/prefer_collection_literals_test.dart:32:// @dart=2.9    
test/rules/prefer_collection_literals_test.dart:41:// @dart=2.9    
test_data/integration/always_require_non_null_named_parameters/lib.dart:5:// @dart=2.9
test_data/integration/avoid_private_typedef_functions/lib.dart:5:// @dart=2.9
test_data/integration/avoid_private_typedef_functions/part.dart:5:// @dart=2.9
test_data/integration/cancel_subscriptions/cancel_subscriptions.dart:5:// @dart=2.9
test_data/integration/close_sinks/src/a.dart:5:// @dart=2.9
test_data/integration/only_throw_errors/only_throw_errors.dart:5:// @dart=2.9
test_data/integration/overridden_fields/src/a.dart:5:// @dart=2.9
test_data/integration/overridden_fields/src/b.dart:5:// @dart=2.9
test_data/integration/public_member_api_docs/test/b.dart:5:// @dart=2.9
test_data/integration/use_build_context_synchronously/lib/unmigrated.dart:5:// @dart=2.9
test_data/rules/always_require_non_null_named_parameters.dart:7:// @dart=2.9
test_data/rules/avoid_init_to_null.dart:5:// @dart=2.9
test_data/rules/avoid_returning_null.dart:7:// @dart=2.9
test_data/rules/avoid_returning_null_for_future.dart:7:// @dart=2.8
test_data/rules/prefer_bool_in_asserts.dart:5:// @dart=2.9
test_data/rules/void_checks.dart:7:// @dart=2.9

test issue 3

upgrade this library to support dart 2 at runtime

--preview-dart-2

test issue 3

improve tests

Extension has kind CLASS in search.getElementDeclarations

Hi,

The method search.getElementDeclarations returns kind CLASS for Extensions, but I think it should return kind EXTENSION.
Code to reproduce the issue:

import 'dart:async';
import 'dart:io';

import 'package:analysis_server_lib/analysis_server_lib.dart';
import 'package:path/path.dart' as path;

class ServerHelper {
  static Future<ServerHelper> create() async {
    return ServerHelper(await AnalysisServer.create());
  }

  final AnalysisServer server;
  Directory tempDir;
  Map<String, List<AnalysisError>> errors = {};

  ServerHelper(this.server) : tempDir = Directory.systemTemp.createTempSync('tests');

  Future init() {
    server.analysis.onErrors.listen((AnalysisErrors e) {
      if (e.errors.isEmpty) {
        errors.remove(e.file);
      } else {
        errors[e.file] = e.errors;
      }
    });

    server.server.setSubscriptions(['STATUS']);
    return server.analysis.setAnalysisRoots([tempDir.path], []);
  }

  Stream get onAnalysisFinished {
    return server.server.onStatus.where((ServerStatus status) {
      return status.analysis != null && status.analysis!.isAnalyzing == false;
    });
  }

  Future<String> createFile(String filePath, String text) {
    String fullPath = path.join(tempDir.path, filePath);
    return server.analysis.updateContent(
      {fullPath: new AddContentOverlay(text)},
    ).then((_) => fullPath);
  }

  void dispose() {
    server.dispose();
    tempDir.deleteSync(recursive: true);
  }
}

Future<void> main() async {
  final helper = await ServerHelper.create();
  await helper.init();
  String main = await helper.createFile('int_ext.dart', 'extension IntExt on int {}');

  final member = await helper.server.search.getElementDeclarations(file: main);
  for (final res in member.declarations) {
    print('${res.name} - ${res.kind}'); // prints IntExt - CLASS, but it should print IntExt - EXTENSION
  }

  helper.dispose();
}

Thanks,

Simone