pkg/front_end/test/id_tests/exhaustiveness_test.dart

// Copyright (c) 2023, 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.

import 'dart:io' show Directory, Platform;

import 'package:_fe_analyzer_shared/src/exhaustiveness/exhaustive.dart';
import 'package:_fe_analyzer_shared/src/exhaustiveness/key.dart';
import 'package:_fe_analyzer_shared/src/exhaustiveness/space.dart';
import 'package:_fe_analyzer_shared/src/exhaustiveness/test_helper.dart';
import 'package:_fe_analyzer_shared/src/testing/features.dart';
import 'package:_fe_analyzer_shared/src/testing/id.dart'
    show ActualData, Id, IdKind, NodeId;
import 'package:_fe_analyzer_shared/src/testing/id_testing.dart'
    show DataInterpreter, cfeMarker, runTests;
import 'package:front_end/src/api_prototype/experimental_flags.dart';
import 'package:front_end/src/kernel/exhaustiveness.dart';
import 'package:front_end/src/testing/id_testing_helper.dart';
import 'package:kernel/ast.dart';

Future<void> main(List<String> args) async {
  Directory dataDir = new Directory.fromUri(
    Platform.script.resolve(
      '../../../_fe_analyzer_shared/test/exhaustiveness/data',
    ),
  );
  await runTests<Features>(
    dataDir,
    args: args,
    createUriForFileName: createUriForFileName,
    onFailure: onFailure,
    runTest: runTestFor<Features>(const ExhaustivenessDataComputer(), [
      const CfeTestConfig(
        cfeMarker,
        'cfe with experiments',
        explicitExperimentalFlags: const {
          ExperimentalFlag.patterns: true,
          ExperimentalFlag.records: true,
          ExperimentalFlag.sealedClass: true,
          ExperimentalFlag.inlineClass: true,
        },
      ),
    ]),
  );
}

class ExhaustivenessDataComputer extends CfeDataComputer<Features> {
  const ExhaustivenessDataComputer();

  @override
  DataInterpreter<Features> get dataValidator =>
      const FeaturesDataInterpreter();

  /// Function that computes a data mapping for [member].
  ///
  /// Fills [actualMap] with the data.
  @override
  void computeMemberData(
    CfeTestResultData testResultData,
    Member member,
    Map<Id, ActualData<Features>> actualMap, {
    bool? verbose,
  }) {
    member.accept(
      new ExhaustivenessDataExtractor(testResultData.compilerResult, actualMap),
    );
  }

  @override
  bool get supportsErrors => true;
}

class ExhaustivenessDataExtractor extends CfeDataExtractor<Features> {
  final ExhaustivenessDataForTesting _exhaustivenessData;

  ExhaustivenessDataExtractor(
    InternalCompilerResult compilerResult,
    Map<Id, ActualData<Features>> actualMap,
  ) : _exhaustivenessData = compilerResult
          .kernelTargetForTesting!
          .loader
          .dataForTesting!
          .exhaustivenessData,
      super(compilerResult, actualMap);

  Features? computeExhaustivenessData(TreeNode node) {
    ExhaustivenessResult? result = _exhaustivenessData.switchResults[node];
    if (result != null) {
      Features features = new Features();
      features[Tags.scrutineeType] = staticTypeToText(result.scrutineeType);
      Set<Key> keysOfInterest = {};
      Set<Key> fieldsOfInterest = {};
      for (Space caseSpace in result.caseSpaces) {
        for (SingleSpace singleSpace in caseSpace.singleSpaces) {
          fieldsOfInterest.addAll(singleSpace.properties.keys);
          keysOfInterest.addAll(singleSpace.additionalProperties.keys);
        }
      }
      String? subtypes = typesToText(
        result.scrutineeType.getSubtypes(keysOfInterest),
      );
      if (subtypes != null) {
        features[Tags.subtypes] = subtypes;
      }
      if (result.scrutineeType.isSealed) {
        String? expandedSubtypes = typesToText(
          expandSealedSubtypes(result.scrutineeType, keysOfInterest),
        );
        if (subtypes != expandedSubtypes && expandedSubtypes != null) {
          features[Tags.expandedSubtypes] = expandedSubtypes;
        }
        String? order = typesToText(
          checkingOrder(result.scrutineeType, keysOfInterest),
        );
        if (order != null) {
          features[Tags.checkingOrder] = order;
        }
      }
      if (fieldsOfInterest.isNotEmpty) {
        features[Tags.scrutineeFields] = fieldsToText(
          result.scrutineeType,
          _exhaustivenessData.objectFieldLookup!,
          fieldsOfInterest,
        );
      }
      if (result.nonExhaustiveness case NonExhaustiveness nonExhaustiveness) {
        features[Tags.error] = nonExhaustivenessToText(nonExhaustiveness);
      }
      Uri uri = node.location!.file;
      for (int i = 0; i < result.caseSpaces.length; i++) {
        int offset = result.caseOffsets[i];
        Features caseFeatures = new Features();
        caseFeatures[Tags.space] = spacesToText(result.caseSpaces[i]);
        if (result.unreachableCases.contains(i)) {
          caseFeatures[Tags.error] = 'unreachable';
        }
        registerValue(
          uri,
          offset,
          new NodeId(offset, IdKind.node),
          caseFeatures,
          node,
        );
      }
      return features;
    }
    return null;
  }

  @override
  Features? computeNodeValue(Id id, TreeNode node) {
    if (node is SwitchStatement || node is Block || node is BlockExpression) {
      return computeExhaustivenessData(node);
    }
    return null;
  }
}