basic_messaging.dart 4.94 KB
Newer Older
Ian Hickson's avatar
Ian Hickson committed
1
// Copyright 2014 The Flutter Authors. All rights reserved.
2 3 4 5 6 7
// 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:typed_data';
import 'package:flutter/services.dart';
8 9
import 'package:flutter/foundation.dart' show ReadBuffer, WriteBuffer;
import 'pair.dart';
10 11
import 'test_step.dart';

12 13 14
class ExtendedStandardMessageCodec extends StandardMessageCodec {
  const ExtendedStandardMessageCodec();

15 16
  static const int _dateTime = 128;
  static const int _pair = 129;
17 18 19 20

  @override
  void writeValue(WriteBuffer buffer, dynamic value) {
    if (value is DateTime) {
21
      buffer.putUint8(_dateTime);
22 23
      buffer.putInt64(value.millisecondsSinceEpoch);
    } else if (value is Pair) {
24
      buffer.putUint8(_pair);
25 26 27 28 29 30 31 32 33 34
      writeValue(buffer, value.left);
      writeValue(buffer, value.right);
    } else {
      super.writeValue(buffer, value);
    }
  }

  @override
  dynamic readValueOfType(int type, ReadBuffer buffer) {
    switch (type) {
35
    case _dateTime:
36
      return DateTime.fromMillisecondsSinceEpoch(buffer.getInt64());
37
    case _pair:
38
      return Pair(readValue(buffer), readValue(buffer));
39 40 41 42 43
    default: return super.readValueOfType(type, buffer);
    }
  }
}

44 45
Future<TestStepResult> basicBinaryHandshake(ByteData message) async {
  const BasicMessageChannel<ByteData> channel =
46
      BasicMessageChannel<ByteData>(
47
    'binary-msg',
48
    BinaryCodec(),
49 50 51 52 53 54
  );
  return _basicMessageHandshake<ByteData>(
      'Binary >${toString(message)}<', channel, message);
}

Future<TestStepResult> basicStringHandshake(String message) async {
55
  const BasicMessageChannel<String> channel = BasicMessageChannel<String>(
56
    'string-msg',
57
    StringCodec(),
58 59 60 61 62 63
  );
  return _basicMessageHandshake<String>('String >$message<', channel, message);
}

Future<TestStepResult> basicJsonHandshake(dynamic message) async {
  const BasicMessageChannel<dynamic> channel =
64
      BasicMessageChannel<dynamic>(
65
    'json-msg',
66
    JSONMessageCodec(),
67 68 69 70 71 72
  );
  return _basicMessageHandshake<dynamic>('JSON >$message<', channel, message);
}

Future<TestStepResult> basicStandardHandshake(dynamic message) async {
  const BasicMessageChannel<dynamic> channel =
73
      BasicMessageChannel<dynamic>(
74
    'std-msg',
75
    ExtendedStandardMessageCodec(),
76 77 78 79 80 81 82
  );
  return _basicMessageHandshake<dynamic>(
      'Standard >${toString(message)}<', channel, message);
}

Future<TestStepResult> basicBinaryMessageToUnknownChannel() async {
  const BasicMessageChannel<ByteData> channel =
83
      BasicMessageChannel<ByteData>(
84
    'binary-unknown',
85
    BinaryCodec(),
86 87 88 89 90
  );
  return _basicMessageToUnknownChannel<ByteData>('Binary', channel);
}

Future<TestStepResult> basicStringMessageToUnknownChannel() async {
91
  const BasicMessageChannel<String> channel = BasicMessageChannel<String>(
92
    'string-unknown',
93
    StringCodec(),
94 95 96 97 98 99
  );
  return _basicMessageToUnknownChannel<String>('String', channel);
}

Future<TestStepResult> basicJsonMessageToUnknownChannel() async {
  const BasicMessageChannel<dynamic> channel =
100
      BasicMessageChannel<dynamic>(
101
    'json-unknown',
102
    JSONMessageCodec(),
103 104 105 106 107 108
  );
  return _basicMessageToUnknownChannel<dynamic>('JSON', channel);
}

Future<TestStepResult> basicStandardMessageToUnknownChannel() async {
  const BasicMessageChannel<dynamic> channel =
109
      BasicMessageChannel<dynamic>(
110
    'std-unknown',
111
    ExtendedStandardMessageCodec(),
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
  );
  return _basicMessageToUnknownChannel<dynamic>('Standard', channel);
}

/// Sends the specified message to the platform, doing a
/// receive message/send reply/receive reply echo handshake initiated by the
/// platform, then expecting a reply echo to the original message.
///
/// Fails, if an error occurs, or if any message seen is not deeply equal to
/// the original message.
Future<TestStepResult> _basicMessageHandshake<T>(
  String description,
  BasicMessageChannel<T> channel,
  T message,
) async {
  final List<dynamic> received = <dynamic>[];
  channel.setMessageHandler((T message) async {
    received.add(message);
    return message;
  });
  dynamic messageEcho = nothing;
  dynamic error = nothing;
  try {
    messageEcho = await channel.send(message);
  } catch (e) {
    error = e;
  }
  return resultOfHandshake(
    'Basic message handshake',
    description,
    message,
    received,
    messageEcho,
    error,
  );
}

/// Sends a message on a channel that no one listens on.
Future<TestStepResult> _basicMessageToUnknownChannel<T>(
  String description,
  BasicMessageChannel<T> channel,
) async {
  dynamic messageEcho = nothing;
  dynamic error = nothing;
  try {
    messageEcho = await channel.send(null);
  } catch (e) {
    error = e;
  }
  return resultOfHandshake(
    'Message on unknown channel',
    description,
    null,
    <dynamic>[null, null],
    messageEcho,
    error,
  );
}

String toString(dynamic message) {
  if (message is ByteData)
    return message.buffer
        .asUint8List(message.offsetInBytes, message.lengthInBytes)
        .toString();
  else
    return '$message';
}