Merge pull request #77 from Workiva/put_relationship_indexing_behind_alpha

FEA-2357: Put relationship indexing behind a flag

Author: rmconsole5-wk

.github/workflows/tests.yaml

@@ -14,7 +14,7 @@ jobs:
       - uses: actions/checkout@v3
       - name: Install scip cli
         run: |
-          bash -c 'curl -L "https://github.com/sourcegraph/scip/releases/download/v0.2.3/scip-linux-amd64.tar.gz"' | tar xzf - scip
+          bash -c 'curl -L "https://github.com/sourcegraph/scip/releases/download/v0.3.0/scip-linux-amd64.tar.gz"' | tar xzf - scip
           ./scip --version
 
       - uses: dart-lang/setup-dart@v1
@@ -24,15 +24,22 @@ jobs:
       - name: pub get scip-dart package
         run: dart pub get
 
-      - name: pub get snapshots directory
+      - name: pub get basic-project directory
         run: dart pub get
         working-directory: ./snapshots/input/basic-project
 
+      - name: pub get relationships-project directory
+        run: dart pub get
+        working-directory: ./snapshots/input/relationships-project
+
       - name: Snapshots Diff Check
         run: |
           dart run scip_dart ./snapshots/input/basic-project
           ./scip snapshot --to ./snapshots/output/basic-project
 
+          dart run scip_dart --index-relationships ./snapshots/input/relationships-project
+          ./scip snapshot --to ./snapshots/output/relationships-project
+
           if [[ -z "$(git status --porcelain ./snapshots/output)" ]];
           then
             echo "No changes to snapshot files"

Makefile

@@ -1,7 +1,10 @@
 regen-snapshots:
-	dart run scip_dart ./snapshots/input/basic-project --verbose
+	dart run scip_dart ./snapshots/input/basic-project
 	scip snapshot --to ./snapshots/output/basic-project
 
+	dart run scip_dart --index-relationships ./snapshots/input/relationships-project
+	scip snapshot --to ./snapshots/output/relationships-project
+
 run:
 	dart run scip_dart ./snapshots/input/staging-project --verbose
 

bin/scip_dart.dart

@@ -10,6 +10,13 @@ import 'package:scip_dart/src/version.dart';
 
 Future<void> main(List<String> args) async {
   final result = (ArgParser()
+        ..addFlag(
+          'index-relationships',
+          defaultsTo: false,
+          help: 'Whether or not to index symbol relationships. '
+              'This functionality is currently in alpha, and should not be '
+              'considered stable and accurate.',
+        )
         ..addFlag(
           'performance',
           aliases: ['perf'],
@@ -22,8 +29,11 @@ Future<void> main(List<String> args) async {
           defaultsTo: false,
           help: 'Whether or not to display debugging text during indexing',
         )
-        ..addFlag('version',
-            defaultsTo: false, help: 'Display the current version of scip-dart')
+        ..addFlag(
+          'version',
+          defaultsTo: false,
+          help: 'Display the current version of scip-dart',
+        )
         ..addMultiOption(
           'path',
           abbr: 'p',

lib/src/flags.dart

@@ -7,9 +7,13 @@ class Flags {
   bool get performance => _performance;
   bool _performance = false;
 
+  bool get indexRelationships => _indexRelationships;
+  bool _indexRelationships = false;
+
   void init(ArgResults results) {
     _verbose = results['verbose'] as bool? ?? false;
     _performance = results['performance'] as bool? ?? false;
+    _indexRelationships = results['index-relationships'] as bool? ?? false;
   }
 
   static Flags get instance => _instance;

lib/src/scip_visitor.dart

@@ -4,6 +4,7 @@ import 'package:analyzer/dart/element/element.dart';
 import 'package:analyzer/source/line_info.dart';
 import 'package:package_config/package_config.dart';
 import 'package:pubspec_parse/pubspec_parse.dart';
+import 'package:scip_dart/src/flags.dart';
 import 'package:scip_dart/src/metadata.dart';
 import 'package:scip_dart/src/gen/scip.pb.dart';
 import 'package:scip_dart/src/relationship_generator.dart';
@@ -62,9 +63,15 @@ class ScipVisitor extends GeneralizingAstVisitor {
     if (node.declaredElement == null) return;
 
     final element = node.declaredElement!;
+
+    List<Relationship>? relationships;
+    if (Flags.instance.indexRelationships) {
+      relationships = relationshipsFor(node, element, _symbolGenerator);
+    }
+
     _registerAsDefinition(
       element,
-      relationships: relationshipsFor(node, element, _symbolGenerator),
+      relationships: relationships,
     );
   }
 

pubspec.lock

@@ -21,7 +21,7 @@ packages:
       name: args
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "2.4.2"
+    version: "2.4.1"
   async:
     dependency: transitive
     description:
@@ -175,7 +175,7 @@ packages:
       name: glob
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "2.1.2"
+    version: "2.1.1"
   graphs:
     dependency: transitive
     description:

snapshots/input/basic-project/lib/relationships.dart renamed to snapshots/input/relationships-project/lib/main.dart

@@ -0,0 +1,5 @@
+# Generated by pub
+# See https://dart.dev/tools/pub/glossary#lockfile
+packages: {}
+sdks:
+  dart: ">=2.18.0 <3.0.0"

snapshots/input/relationships-project/pubspec.lock

@@ -0,0 +1,5 @@
+name: dart_test
+version: 1.0.0
+
+environment:
+  sdk: ">=2.18.0 <3.0.0"

snapshots/input/relationships-project/pubspec.yaml

@@ -35,7 +35,6 @@
   class Animal with SleepMixin {
 //      ^^^^^^ definition scip-dart pub dart_test 1.0.0 lib/more.dart/Animal#
 //      documentation ```dart
-//      relationship scip-dart pub dart_test 1.0.0 lib/more.dart/SleepMixin# implementation
 //                  ^^^^^^^^^^ reference scip-dart pub dart_test 1.0.0 lib/more.dart/SleepMixin#
     String name;
 //  ^^^^^^ reference scip-dart pub dart:core 2.18.0 dart:core/string.dart/String#
@@ -103,7 +102,6 @@
 //  ^^^^^^ reference scip-dart pub dart:core 2.18.0 dart:core/string.dart/String#
 //         ^^^^^^^^ definition scip-dart pub dart_test 1.0.0 lib/more.dart/Animal#toString().
 //         documentation ```dart
-//         relationship scip-dart pub dart:core 2.18.0 dart:core/object.dart/Object#toString(). implementation reference
       return '$name the $type';
 //             ^^^^ reference scip-dart pub dart_test 1.0.0 lib/more.dart/Animal#name.
 //                       ^^^^ reference scip-dart pub dart_test 1.0.0 lib/more.dart/Animal#type.