service_worker_test.dart 8.42 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11
// 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 'dart:async';
import 'dart:io';

import 'package:path/path.dart' as path;
import 'package:meta/meta.dart';
import 'package:shelf/shelf.dart';

12 13 14
import 'browser.dart';
import 'run_command.dart';
import 'test/common.dart';
15

16 17 18 19 20 21 22
final String _bat = Platform.isWindows ? '.bat' : '';
final String _flutterRoot = path.dirname(path.dirname(path.dirname(path.fromUri(Platform.script))));
final String _flutter = path.join(_flutterRoot, 'bin', 'flutter$_bat');
final String _testAppDirectory = path.join(_flutterRoot, 'dev', 'integration_tests', 'web');
final String _appBuildDirectory = path.join(_testAppDirectory, 'build', 'web');
final String _target = path.join('lib', 'service_worker_test.dart');
final String _targetPath = path.join(_testAppDirectory, _target);
23

24
// Run a web service worker test as a standalone Dart program.
25
Future<void> main() async {
26
  await runWebServiceWorkerTest(headless: false);
27 28
}

29 30 31 32 33 34 35 36 37
Future<void> _setAppVersion(int version) async {
  final File targetFile = File(_targetPath);
  await targetFile.writeAsString(
    (await targetFile.readAsString()).replaceFirst(
      RegExp(r'CLOSE\?version=\d+'),
      'CLOSE?version=$version',
    )
  );
}
38

39 40 41 42
Future<void> _rebuildApp({ @required int version }) async {
  await _setAppVersion(version);
  await runCommand(
    _flutter,
43
    <String>[ 'clean' ],
44
    workingDirectory: _testAppDirectory,
45
  );
46 47 48 49
  await runCommand(
    _flutter,
    <String>['build', 'web', '--profile', '-t', _target],
    workingDirectory: _testAppDirectory,
50 51 52 53 54 55
    environment: <String, String>{
      'FLUTTER_WEB': 'true',
    },
  );
}

56 57
Future<void> runWebServiceWorkerTest({
  @required bool headless,
58
}) async {
59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266
  test('flutter_service_worker.js', () async {
    await _rebuildApp(version: 1);

    final Map<String, int> requestedPathCounts = <String, int>{};
    void expectRequestCounts(Map<String, int> expectedCounts) {
      expect(requestedPathCounts, expectedCounts);
      requestedPathCounts.clear();
    }

    AppServer server;
    Future<void> waitForAppToLoad(Map<String, int> waitForCounts) async {
      print('Waiting for app to load $waitForCounts');
      await Future.any(<Future<void>>[
        () async {
          while (!waitForCounts.entries.every((MapEntry<String, int> entry) => (requestedPathCounts[entry.key] ?? 0) >= entry.value)) {
            await Future<void>.delayed(const Duration(milliseconds: 100));
          }
        }(),
        server.onChromeError.then((String error) {
          throw Exception('Chrome error: $error');
        }),
      ]);
    }

    String reportedVersion;

    Future<void> startAppServer({
      @required String cacheControl,
    }) async {
      server = await AppServer.start(
        headless: headless,
        cacheControl: cacheControl,
        appUrl: 'http://localhost:8080/index.html',
        appDirectory: _appBuildDirectory,
        additionalRequestHandlers: <Handler>[
          (Request request) {
            final String requestedPath = request.url.path;
            requestedPathCounts.putIfAbsent(requestedPath, () => 0);
            requestedPathCounts[requestedPath] += 1;
            if (requestedPath == 'CLOSE') {
              reportedVersion = request.url.queryParameters['version'];
              return Response.ok('OK');
            }
            return Response.notFound('');
          },
        ],
      );
    }

    try {
      //////////////////////////////////////////////////////
      // Caching server
      //////////////////////////////////////////////////////
      print('With cache: test first page load');
      await startAppServer(cacheControl: 'max-age=3600');
      await waitForAppToLoad(<String, int>{
        'CLOSE': 1,
        'flutter_service_worker.js': 1,
      });

      expectRequestCounts(<String, int>{
        '': 1,
        // Even though the server is caching index.html is downloaded twice,
        // once by the initial page load, and once by the service worker.
        // Other resources are loaded once only by the service worker.
        'index.html': 2,
        'main.dart.js': 1,
        'flutter_service_worker.js': 1,
        'assets/FontManifest.json': 1,
        'assets/NOTICES': 1,
        'assets/AssetManifest.json': 1,
        'CLOSE': 1,
        // In headless mode Chrome does not load 'manifest.json' and 'favicon.ico'.
        if (!headless)
          ...<String, int>{
            'manifest.json': 1,
            'favicon.ico': 1,
          }
      });
      expect(reportedVersion, '1');
      reportedVersion = null;

      print('With cache: test page reload');
      await server.chrome.reloadPage();
      await waitForAppToLoad(<String, int>{
        'CLOSE': 1,
        'flutter_service_worker.js': 1,
      });

      expectRequestCounts(<String, int>{
        'flutter_service_worker.js': 1,
        'CLOSE': 1,
      });
      expect(reportedVersion, '1');
      reportedVersion = null;

      print('With cache: test page reload after rebuild');
      await _rebuildApp(version: 2);

      // Since we're caching, we need to ignore cache when reloading the page.
      await server.chrome.reloadPage(ignoreCache: true);
      await waitForAppToLoad(<String, int>{
        'CLOSE': 1,
        'flutter_service_worker.js': 2,
      });
      expectRequestCounts(<String, int>{
        'index.html': 2,
        'flutter_service_worker.js': 2,
        '': 1,
        'main.dart.js': 1,
        'assets/NOTICES': 1,
        'assets/AssetManifest.json': 1,
        'assets/FontManifest.json': 1,
        'CLOSE': 1,
        if (!headless)
          'favicon.ico': 1,
      });

      expect(reportedVersion, '2');
      reportedVersion = null;
      await server.stop();


      //////////////////////////////////////////////////////
      // Non-caching server
      //////////////////////////////////////////////////////
      print('No cache: test first page load');
      await _rebuildApp(version: 3);
      await startAppServer(cacheControl: 'max-age=0');
      await waitForAppToLoad(<String, int>{
        'CLOSE': 1,
        'flutter_service_worker.js': 1,
      });

      expectRequestCounts(<String, int>{
        '': 1,
        'index.html': 2,
        // We still download some resources multiple times if the server is non-caching.
        'main.dart.js': 2,
        'assets/FontManifest.json': 2,
        'flutter_service_worker.js': 1,
        'assets/NOTICES': 1,
        'assets/AssetManifest.json': 1,
        'CLOSE': 1,
        // In headless mode Chrome does not load 'manifest.json' and 'favicon.ico'.
        if (!headless)
          ...<String, int>{
            'manifest.json': 1,
            'favicon.ico': 1,
          }
      });

      expect(reportedVersion, '3');
      reportedVersion = null;

      print('No cache: test page reload');
      await server.chrome.reloadPage();
      await waitForAppToLoad(<String, int>{
        'CLOSE': 1,
        'flutter_service_worker.js': 1,
      });

      expectRequestCounts(<String, int>{
        'flutter_service_worker.js': 1,
        'CLOSE': 1,
        if (!headless)
          'manifest.json': 1,
      });
      expect(reportedVersion, '3');
      reportedVersion = null;

      print('No cache: test page reload after rebuild');
      await _rebuildApp(version: 4);

      // TODO(yjbanov): when running Chrome with DevTools protocol, for some
      // reason a hard refresh is still required. This works without a hard
      // refresh when running Chrome manually as normal. At the time of writing
      // this test I wasn't able to figure out what's wrong with the way we run
      // Chrome from tests.
      await server.chrome.reloadPage(ignoreCache: true);
      await waitForAppToLoad(<String, int>{
        'CLOSE': 1,
        'flutter_service_worker.js': 1,
      });
      expectRequestCounts(<String, int>{
        '': 1,
        'index.html': 2,
        'flutter_service_worker.js': 2,
        'main.dart.js': 2,
        'assets/NOTICES': 1,
        'assets/AssetManifest.json': 1,
        'assets/FontManifest.json': 2,
        'CLOSE': 1,
        if (!headless)
          ...<String, int>{
            'manifest.json': 1,
            'favicon.ico': 1,
          }
      });

      expect(reportedVersion, '4');
      reportedVersion = null;
    } finally {
      await _setAppVersion(1);
      await server?.stop();
    }
    // This is a long test. The default 30 seconds is not enough.
  }, timeout: const Timeout(Duration(minutes: 10)));
267
}