lib/web_ui/test/engine/configuration_test.dart

// Copyright 2013 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.

@TestOn('browser')
library;

import 'package:js/js_util.dart' as js_util;

import 'package:test/bootstrap/browser.dart';
import 'package:test/test.dart';
import 'package:ui/src/engine.dart';

import '../common/matchers.dart';

void main() {
  internalBootstrapBrowserTest(() => testMain);
}

void testMain() {
  group('FlutterConfiguration', () {
    test('initializes with null', () async {
      final FlutterConfiguration config = FlutterConfiguration.legacy(null);

      expect(config.canvasKitBaseUrl, 'canvaskit/'); // _defaultCanvasKitBaseUrl
    });

    test('legacy constructor initializes with a Js Object', () async {
      final FlutterConfiguration config = FlutterConfiguration.legacy(
        js_util.jsify(<String, Object?>{
          'canvasKitBaseUrl': 'some_other_url/',
        }) as JsFlutterConfiguration);

      expect(config.canvasKitBaseUrl, 'some_other_url/');
    });
  });

  group('setUserConfiguration', () {
    test('throws assertion error if already initialized from JS', () async {
      final FlutterConfiguration config = FlutterConfiguration.legacy(
        js_util.jsify(<String, Object?>{
          'canvasKitBaseUrl': 'some_other_url/',
        }) as JsFlutterConfiguration);

      expect(() {
        config.setUserConfiguration(
          js_util.jsify(<String, Object?>{
            'canvasKitBaseUrl': 'yet_another_url/',
          }) as JsFlutterConfiguration);
      }, throwsAssertionError);
    });

    test('stores config if JS configuration was null', () async {
      final FlutterConfiguration config = FlutterConfiguration.legacy(null);

      config.setUserConfiguration(
        js_util.jsify(<String, Object?>{
          'canvasKitBaseUrl': 'one_more_url/',
        }) as JsFlutterConfiguration);

      expect(config.canvasKitBaseUrl, 'one_more_url/');
    });

    test('can receive non-existing properties without crashing', () async {
      final FlutterConfiguration config = FlutterConfiguration.legacy(null);

      expect(() {
        config.setUserConfiguration(
          js_util.jsify(<String, Object?>{
            'canvasKitMaximumSurfaces': 32.0,
          }) as JsFlutterConfiguration);
      }, returnsNormally);
    });
  });

  group('Default configuration values', () {
    late FlutterConfiguration defaultConfig;
    setUp(() {
      defaultConfig = FlutterConfiguration();
      defaultConfig.setUserConfiguration(
        js_util.jsify(<String, Object?>{}) as JsFlutterConfiguration,
      );
    });

    test('canvasKitVariant', () {
      expect(defaultConfig.canvasKitVariant, CanvasKitVariant.auto);
    });

    test('useColorEmoji', () {
      expect(defaultConfig.useColorEmoji, isFalse);
    });

    test('multiViewEnabled', () {
      expect(defaultConfig.multiViewEnabled, isFalse);
    });

  });

  group('setUserConfiguration (values)', () {
    group('canvasKitVariant', () {
      test('value undefined - defaults to "auto"', () {
        final FlutterConfiguration config = FlutterConfiguration();
        config.setUserConfiguration(
          // With an empty map, the canvasKitVariant is undefined in JS.
          js_util.jsify(<String, Object?>{}) as JsFlutterConfiguration,
        );

        expect(config.canvasKitVariant, CanvasKitVariant.auto);
      });

      test('value - converts to CanvasKitVariant enum (or throw)', () {
        final FlutterConfiguration config = FlutterConfiguration();

        config.setUserConfiguration(
          js_util.jsify(<String, Object?>{'canvasKitVariant': 'foo'}) as JsFlutterConfiguration,
        );
        expect(() => config.canvasKitVariant, throwsArgumentError);

        config.setUserConfiguration(
          js_util.jsify(<String, Object?>{'canvasKitVariant': 'auto'}) as JsFlutterConfiguration,
        );
        expect(config.canvasKitVariant, CanvasKitVariant.auto);

        config.setUserConfiguration(
          js_util.jsify(<String, Object?>{'canvasKitVariant': 'full'}) as JsFlutterConfiguration,
        );
        expect(config.canvasKitVariant, CanvasKitVariant.full);

        config.setUserConfiguration(
          js_util.jsify(<String, Object?>{'canvasKitVariant': 'chromium'}) as JsFlutterConfiguration,
        );
        expect(config.canvasKitVariant, CanvasKitVariant.chromium);
      });
    });

    test('useColorEmoji', () {
      final FlutterConfiguration config = FlutterConfiguration();
      config.setUserConfiguration(
        js_util.jsify(<String, Object?>{'useColorEmoji': true}) as JsFlutterConfiguration,
      );
      expect(config.useColorEmoji, isTrue);
    });

    test('multiViewEnabled', () {
      final FlutterConfiguration config = FlutterConfiguration();
      config.setUserConfiguration(
        js_util.jsify(<String, Object?>{'multiViewEnabled': true}) as JsFlutterConfiguration,
      );
      expect(config.multiViewEnabled, isTrue);
    });
  });
}