lib/services_gae.dart

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

library services_gae;

import 'dart:async';
import 'dart:io' as io;

import 'package:appengine/appengine.dart' as ae;
import 'package:logging/logging.dart';
import 'package:rpc/rpc.dart' as rpc;

import 'src/common.dart';
import 'src/common_server.dart';
import 'src/dartpad_support_server.dart';
import 'src/flutter_web.dart';

const String _API = '/api';

const String _journalctlBinary = '/bin/journalctl';
const String _sudoBinary = '/usr/bin/sudo';

final Logger _logger = Logger('gae_server');

void main(List<String> args) {
  int gaePort = 8080;
  if (args.isNotEmpty) gaePort = int.parse(args[0]);

  String sdk = sdkPath;

  if (sdk == null) {
    throw 'No Dart SDK is available; set the DART_SDK env var.';
  }

  _logger.onRecord.listen((LogRecord rec) {
    String out = ('${rec.level.name}: ${rec.time}: ${rec.message}\n');

    // TODO(domesticmouse): Improve mapping between rec.level and GAE levels
    if (rec.level > Level.INFO) {
      ae.context.services.logging.error(out);
    } else {
      ae.context.services.logging.info(out);
    }
  });
  log.info('''Initializing dart-services: 
    port: $gaePort
    sdkPath: $sdkPath
    REDIS_SERVER_URI: ${io.Platform.environment['REDIS_SERVER_URI']}
    GAE_VERSION: ${io.Platform.environment['GAE_VERSION']}
  ''');

  GaeServer server =
      GaeServer(sdk, io.Platform.environment['REDIS_SERVER_URI']);
  server.start(gaePort);
}

class GaeServer {
  final String sdkPath;
  final String redisServerUri;

  bool discoveryEnabled;
  rpc.ApiServer apiServer;
  FlutterWebManager flutterWebManager;
  CommonServer commonServer;
  FileRelayServer fileRelayServer;
  Timer journalRotator;

  GaeServer(this.sdkPath, this.redisServerUri) {
    hierarchicalLoggingEnabled = true;
    _logger.level = Level.ALL;

    discoveryEnabled = false;
    fileRelayServer = FileRelayServer();
    flutterWebManager = FlutterWebManager(sdkPath);
    commonServer = CommonServer(
        sdkPath,
        flutterWebManager,
        GaeServerContainer(),
        redisServerUri == null
            ? InMemoryCache()
            : RedisCache(
                redisServerUri, io.Platform.environment['GAE_VERSION']));
    // Enabled pretty printing of returned json for debuggability.
    apiServer = rpc.ApiServer(apiPrefix: _API, prettyPrint: true)
      ..addApi(commonServer)
      ..addApi(fileRelayServer);

    // Rotate the journal log files, as we don't have journal rotation in a 
    // Docker image without running init and systemd
    final rotationTime = Duration(hours: 1);
    journalRotator = Timer.periodic(rotationTime, (timer) async {
      final rotationResults =
          await io.Process.run(_sudoBinary, [_journalctlBinary, '--rotate']);
      if (rotationResults.exitCode != 0) {
        _logger.severe(
            '''sudo journalctl --rotate failed:
            ${rotationResults.stdout}
            ${rotationResults.stderr}''');
      } else {
        _logger.info(
            'sudo journalctl --rotate succeeded: ${rotationResults.stdout}');

        // Trim to 256mb of journal logs
        final vacuumResults = await io.Process.run(
            _sudoBinary, [_journalctlBinary, '--vacuum-size=268435456']);
        if (vacuumResults.exitCode != 0) {
          _logger.severe(
              '''sudo journalctl --vacuum-size failed:
              ${rotationResults.stdout}
              ${rotationResults.stderr}''');
        } else {
          _logger.info(
              '''sudo journalctl --vacuum-size succeeded:
              ${rotationResults.stdout}''');

          // Log journal disk usage report
          final usageResults = await io.Process.run(
              _sudoBinary, [_journalctlBinary, '--disk-usage']);
          _logger.info(
            '''sudo journalctl --disk-usage:
            ${usageResults.stdout}''');
        }
      }
    });
  }

  Future<dynamic> start([int gaePort = 8080]) async {
    await commonServer.init();
    return ae.runAppEngine(requestHandler, port: gaePort);
  }

  void requestHandler(io.HttpRequest request) {
    request.response.headers
        .add('Access-Control-Allow-Methods', 'POST, OPTIONS');
    request.response.headers.add('Access-Control-Allow-Headers',
        'Origin, X-Requested-With, Content-Type, Accept');

    // Explicitly handle an OPTIONS requests.
    if (request.method == 'OPTIONS') {
      String requestedMethod =
          request.headers.value('access-control-request-method');
      int statusCode;
      if (requestedMethod != null && requestedMethod.toUpperCase() == 'POST') {
        statusCode = io.HttpStatus.ok;
      } else {
        statusCode = io.HttpStatus.badRequest;
      }
      request.response
        ..statusCode = statusCode
        ..close();
      return;
    }

    if (request.uri.path.startsWith(_API)) {
      if (!discoveryEnabled) {
        apiServer.enableDiscoveryApi();
        discoveryEnabled = true;
      }
      // NOTE: We could read in the request body here and parse it similar to
      // the _parseRequest method to determine content-type and dispatch to e.g.
      // a plain text handler if we want to support that.
      rpc.HttpApiRequest apiRequest =
          rpc.HttpApiRequest.fromHttpRequest(request);

      // Dartpad sends data as plain text, we need to promote this to
      // application/json to ensure that the rpc library processes it correctly
      apiRequest.headers['content-type'] = 'application/json; charset=utf-8';
      apiServer
          .handleHttpApiRequest(apiRequest)
          .then((rpc.HttpApiResponse apiResponse) {
        return rpc.sendApiResponse(apiResponse, request.response);
      }).catchError((dynamic e) {
        // This should only happen in the case where there is a bug in the rpc
        // package. Otherwise it always returns an HttpApiResponse.
        _logger.warning('Failed with error: $e when trying to call '
            'method at \'${request.uri.path}\'.');
        request.response
          ..statusCode = io.HttpStatus.internalServerError
          ..close();
      });
    } else {
      request.response
        ..statusCode = io.HttpStatus.notFound
        ..close();
    }
  }
}

class GaeServerContainer implements ServerContainer {
  @override
  String get version => io.Platform.version;
}