packages/flutter/test/widgets/text_semantics_test.dart

// Copyright 2014 The Flutter Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

import 'package:flutter/gestures.dart';
import 'package:flutter/material.dart';
import 'package:flutter/rendering.dart';
import 'package:flutter_test/flutter_test.dart';

import 'semantics_tester.dart';

void main() {
  testWidgets('SemanticsNode ids are stable', (WidgetTester tester) async {
    // Regression test for b/151732341.
    final semantics = SemanticsTester(tester);
    final recognizer1 = TapGestureRecognizer();
    addTearDown(recognizer1.dispose);
    final recognizer2 = TapGestureRecognizer();
    addTearDown(recognizer2.dispose);
    final recognizer3 = TapGestureRecognizer();
    addTearDown(recognizer3.dispose);

    await tester.pumpWidget(
      Directionality(
        textDirection: TextDirection.ltr,
        child: Text.rich(
          TextSpan(
            text: 'Hallo ',
            recognizer: recognizer1..onTap = () {},
            children: <TextSpan>[
              TextSpan(text: 'Welt ', recognizer: recognizer2..onTap = () {}),
              TextSpan(text: '!!!', recognizer: recognizer3..onTap = () {}),
            ],
          ),
        ),
      ),
    );
    expect(find.text('Hallo Welt !!!'), findsOneWidget);
    final SemanticsNode node = tester.getSemantics(find.text('Hallo Welt !!!'));
    final labelToNodeId = <String, int>{};
    node.visitChildren((SemanticsNode node) {
      labelToNodeId[node.label] = node.id;
      return true;
    });
    expect(node.id, 1);
    expect(labelToNodeId['Hallo '], 2);
    expect(labelToNodeId['Welt '], 3);
    expect(labelToNodeId['!!!'], 4);
    expect(labelToNodeId.length, 3);

    // Rebuild semantics.
    tester.renderObject(find.text('Hallo Welt !!!')).markNeedsSemanticsUpdate();
    await tester.pump();

    final SemanticsNode nodeAfterRebuild = tester.getSemantics(find.text('Hallo Welt !!!'));
    final labelToNodeIdAfterRebuild = <String, int>{};
    nodeAfterRebuild.visitChildren((SemanticsNode node) {
      labelToNodeIdAfterRebuild[node.label] = node.id;
      return true;
    });

    // Node IDs are stable.
    expect(nodeAfterRebuild.id, node.id);
    expect(labelToNodeIdAfterRebuild['Hallo '], labelToNodeId['Hallo ']);
    expect(labelToNodeIdAfterRebuild['Welt '], labelToNodeId['Welt ']);
    expect(labelToNodeIdAfterRebuild['!!!'], labelToNodeId['!!!']);
    expect(labelToNodeIdAfterRebuild.length, 3);

    final recognizer4 = TapGestureRecognizer();
    addTearDown(recognizer4.dispose);
    final recognizer5 = TapGestureRecognizer();
    addTearDown(recognizer5.dispose);

    // Remove one node.
    await tester.pumpWidget(
      Directionality(
        textDirection: TextDirection.ltr,
        child: Text.rich(
          TextSpan(
            text: 'Hallo ',
            recognizer: recognizer4..onTap = () {},
            children: <TextSpan>[TextSpan(text: 'Welt ', recognizer: recognizer5..onTap = () {})],
          ),
        ),
      ),
    );

    final SemanticsNode nodeAfterRemoval = tester.getSemantics(find.text('Hallo Welt '));
    final labelToNodeIdAfterRemoval = <String, int>{};
    nodeAfterRemoval.visitChildren((SemanticsNode node) {
      labelToNodeIdAfterRemoval[node.label] = node.id;
      return true;
    });

    // Node IDs are stable.
    expect(nodeAfterRemoval.id, node.id);
    expect(labelToNodeIdAfterRemoval['Hallo '], labelToNodeId['Hallo ']);
    expect(labelToNodeIdAfterRemoval['Welt '], labelToNodeId['Welt ']);
    expect(labelToNodeIdAfterRemoval.length, 2);

    final recognizer6 = TapGestureRecognizer();
    addTearDown(recognizer6.dispose);
    final recognizer7 = TapGestureRecognizer();
    addTearDown(recognizer7.dispose);
    final recognizer8 = TapGestureRecognizer();
    addTearDown(recognizer8.dispose);

    await tester.pumpWidget(
      Directionality(
        textDirection: TextDirection.ltr,
        child: Text.rich(
          TextSpan(
            text: 'Hallo ',
            recognizer: recognizer6..onTap = () {},
            children: <TextSpan>[
              TextSpan(text: 'Welt ', recognizer: recognizer7..onTap = () {}),
              TextSpan(text: '!!!', recognizer: recognizer8..onTap = () {}),
            ],
          ),
        ),
      ),
    );
    expect(find.text('Hallo Welt !!!'), findsOneWidget);
    final SemanticsNode nodeAfterAddition = tester.getSemantics(find.text('Hallo Welt !!!'));
    final labelToNodeIdAfterAddition = <String, int>{};
    nodeAfterAddition.visitChildren((SemanticsNode node) {
      labelToNodeIdAfterAddition[node.label] = node.id;
      return true;
    });

    // New node gets a new ID.
    expect(nodeAfterAddition.id, node.id);
    expect(labelToNodeIdAfterAddition['Hallo '], labelToNodeId['Hallo ']);
    expect(labelToNodeIdAfterAddition['Welt '], labelToNodeId['Welt ']);
    expect(labelToNodeIdAfterAddition['!!!'], isNot(labelToNodeId['!!!']));
    expect(labelToNodeIdAfterAddition['!!!'], isNotNull);
    expect(labelToNodeIdAfterAddition.length, 3);

    semantics.dispose();
  });

  testWidgets('SemanticsIdentifier creates a functional SemanticsNode', (
    WidgetTester tester,
  ) async {
    await tester.pumpWidget(
      const Directionality(
        textDirection: TextDirection.ltr,
        child: Text.rich(
          TextSpan(
            text: 'Hello, ',
            children: <TextSpan>[
              TextSpan(text: '1 new '),
              TextSpan(text: 'semantics node ', semanticsIdentifier: 'new_semantics_node'),
              TextSpan(text: 'has been '),
              TextSpan(text: 'created.'),
            ],
          ),
        ),
      ),
    );
    expect(find.text('Hello, 1 new semantics node has been created.'), findsOneWidget);
    final SemanticsNode node = tester.getSemantics(
      find.text('Hello, 1 new semantics node has been created.'),
    );
    final labelToNodeId = <String, String>{};
    node.visitChildren((SemanticsNode node) {
      labelToNodeId[node.label] = node.identifier;
      return true;
    });
    expect(node.id, 1);
    expect(labelToNodeId['Hello, 1 new '], '');
    expect(labelToNodeId['semantics node '], 'new_semantics_node');
    expect(labelToNodeId['has been created.'], '');
    expect(labelToNodeId.length, 3);
  });

  testWidgets('GIVEN a Text widget with a locale '
      'WHEN semantics are built '
      'THEN the SemanticsNode contains the correct language tag', (WidgetTester tester) async {
    const locale = Locale('de', 'DE');

    await tester.pumpWidget(
      const Directionality(
        textDirection: TextDirection.ltr,
        child: Text('Flutter 2050', locale: locale),
      ),
    );

    final SemanticsNode node = tester.getSemantics(find.byType(Directionality));
    final localeStringAttribute = node.attributedLabel.attributes[0] as LocaleStringAttribute;

    expect(node.label, 'Flutter 2050');
    expect(localeStringAttribute.locale.toLanguageTag(), 'de-DE');
  });

  testWidgets('GIVEN a Text with a locale is within a SelectionContainer '
      'WHEN semantics are built '
      'THEN the SemanticsNode contains the correct language tag', (WidgetTester tester) async {
    const locale = Locale('de', 'DE');
    const text = 'Flutter 2050';
    await tester.pumpWidget(
      const MaterialApp(
        home: SelectionArea(child: Text(text, locale: locale)),
      ),
    );
    await tester.pumpAndSettle();

    final SemanticsNode root = tester.binding.pipelineOwner.semanticsOwner!.rootSemanticsNode!;
    final queue = <SemanticsNode>[root];
    SemanticsNode? targetNode;
    while (queue.isNotEmpty) {
      final SemanticsNode node = queue.removeAt(0);
      if (node.label == text) {
        targetNode = node;
        break;
      }
      queue.addAll(node.debugListChildrenInOrder(DebugSemanticsDumpOrder.traversalOrder));
    }
    final localeStringAttribute =
        targetNode!.attributedLabel.attributes[0] as LocaleStringAttribute;

    expect(targetNode.label, text);
    expect(localeStringAttribute.locale.toLanguageTag(), 'de-DE');
  });
}