b9c3d99f44
Summary: Background for this diff: https://fb.quip.com/KqEfAlKYlgme Some plugins don't respect that stuff (livefeed and graphql), but for others it seems to work fine. This is just a PoC, there are some present bugs concerning the combination of selecting and bg plugins Questions to investigate: - [x] make sure that LiveFeed and GraphQL disconnect properly. There might be more plugins that need that - [x] verifiy that we don't loose one of the original goals of background plugins, e.g. QPL collecting and sending data from device start. Does this still work as intended after this change? - [x] how can we observe / measure improvements? Are dev builds more responsive after this? Is the layout inspector smoother for example because no QPL plugins are interweaved? - [x] how is forward and backward compatibility? - If Flipper is updated, but device not: No change I think, as getBackgroundPlugins() will return an empty set, and background plugins are initiated as usual, so old behavior - If device is updated, but Flipper not, background plugins won't be started until they are selected. This is a degradation, but hopefully explainable. - [x] Verify QPL buffer is not unbounded - [x] Share architecutre changes with team For Graphql updates: D20943455 Added runtime stats to monitor network traffic (sadly had to redo that since scuba couldn't handle the data format used at first, so probably will hold of landing this diff a week to make sure we can see some effects) Follow up work: [x] wait until we released the stat tracking before we release this, to be able to measure the effect? [x] make sure graphql fix lands [ ] use side effects abstraction [ ] fix other background plugins (android only) or fix it in a generic way: {F234394286} Changelog: Background plugins will no longer receive a Flipper connection if they are disabled. This should significantly reduce the overall load of Flipper both on the device and desktop when unused plugins are disabled used, which could otherwise generate 10MB/s of network traffic certain scenarios. All plugins *should* be able to handle to this gracefully, but since this is quite a fundamental change, reach out to the Flipper team when in doubt! Reviewed By: jknoxville Differential Revision: D20942453 fbshipit-source-id: b699199cb95c1b3e4c36e026b6dfaee7d1652e1f
362 lines
13 KiB
Plaintext
362 lines
13 KiB
Plaintext
/*
|
|
* Copyright (c) Facebook, Inc. and its affiliates.
|
|
*
|
|
* This source code is licensed under the MIT license found in the
|
|
* LICENSE file in the root directory of this source tree.
|
|
*/
|
|
|
|
#import <XCTest/XCTest.h>
|
|
#if FB_SONARKIT_ENABLED
|
|
|
|
#import <FlipperKit/FlipperClient+Testing.h>
|
|
#import <FlipperKit/FlipperClient.h>
|
|
#import <FlipperKit/FlipperConnection.h>
|
|
#import <FlipperKit/FlipperPlugin.h>
|
|
#import <FlipperKitTestUtils/BlockBasedSonarPlugin.h>
|
|
#import <FlipperTestLib/FlipperConnectionManagerMock.h>
|
|
#import <FlipperTestLib/FlipperPluginMock.h>
|
|
#import <FlipperTestLib/FlipperResponderMock.h>
|
|
#import <folly/json.h>
|
|
#import <vector>
|
|
|
|
@interface FlipperClientTests : XCTestCase
|
|
|
|
@end
|
|
|
|
@implementation FlipperClientTests
|
|
facebook::flipper::FlipperClient* client;
|
|
facebook::flipper::test::FlipperConnectionManagerMock* socket;
|
|
FlipperClient* objcClient;
|
|
|
|
- (void)setUp {
|
|
// Put setup code here. This method is called before the invocation of each
|
|
// test method in the class.
|
|
socket = new facebook::flipper::test::FlipperConnectionManagerMock;
|
|
auto state = std::make_shared<FlipperState>();
|
|
|
|
client = new facebook::flipper::FlipperClient(
|
|
std::unique_ptr<facebook::flipper::test::FlipperConnectionManagerMock>{
|
|
socket},
|
|
state);
|
|
objcClient = [[FlipperClient alloc] initWithCppClient:client];
|
|
}
|
|
|
|
- (void)tearDown {
|
|
// Put teardown code here. This method is called after the invocation of each
|
|
// test method in the class.
|
|
delete client;
|
|
}
|
|
|
|
- (void)testGetPlugin {
|
|
BlockBasedSonarPlugin* cat =
|
|
[[BlockBasedSonarPlugin alloc] initIdentifier:@"cat"
|
|
connect:nil
|
|
disconnect:nil];
|
|
BlockBasedSonarPlugin* dog =
|
|
[[BlockBasedSonarPlugin alloc] initIdentifier:@"dog"
|
|
connect:nil
|
|
disconnect:nil];
|
|
|
|
[objcClient addPlugin:cat];
|
|
[objcClient addPlugin:dog];
|
|
|
|
NSObject<FlipperPlugin>* retrievedPlugin =
|
|
[objcClient pluginWithIdentifier:@"cat"];
|
|
XCTAssertEqual(retrievedPlugin, cat);
|
|
retrievedPlugin = [objcClient pluginWithIdentifier:@"dog"];
|
|
XCTAssertEqual(retrievedPlugin, dog);
|
|
}
|
|
|
|
- (void)testRemovePlugin {
|
|
BlockBasedSonarPlugin* cat =
|
|
[[BlockBasedSonarPlugin alloc] initIdentifier:@"cat"
|
|
connect:nil
|
|
disconnect:nil];
|
|
|
|
[objcClient addPlugin:cat];
|
|
[objcClient removePlugin:cat];
|
|
|
|
folly::dynamic message =
|
|
folly::dynamic::object("id", 1)("method", "getPlugins");
|
|
|
|
std::vector<folly::dynamic> successes = std::vector<folly::dynamic>();
|
|
std::vector<folly::dynamic> errors = std::vector<folly::dynamic>();
|
|
std::unique_ptr<facebook::flipper::FlipperResponderMock> responder =
|
|
std::make_unique<facebook::flipper::FlipperResponderMock>(
|
|
&successes, &errors);
|
|
socket->callbacks->onMessageReceived(message, std::move(responder));
|
|
folly::dynamic expected =
|
|
folly::dynamic::object("plugins", folly::dynamic::array());
|
|
XCTAssertEqual(successes.size(), 1);
|
|
XCTAssertEqual(errors.size(), 0);
|
|
XCTAssertEqual(successes[0], expected);
|
|
}
|
|
|
|
- (void)testPluginNotActivatedInBackgroundMode {
|
|
__block BOOL pluginConnected = NO;
|
|
BlockBasedSonarPlugin* cat =
|
|
[[BlockBasedSonarPlugin alloc] initIdentifier:@"cat"
|
|
connect:^(id<FlipperConnection>) {
|
|
pluginConnected = YES;
|
|
}
|
|
disconnect:^{
|
|
pluginConnected = NO;
|
|
}
|
|
runInBackground:YES];
|
|
|
|
[objcClient addPlugin:cat];
|
|
[objcClient start];
|
|
XCTAssertFalse(pluginConnected);
|
|
}
|
|
|
|
- (void)testPluginNotActivatedInNonBackgroundMode {
|
|
__block BOOL pluginConnected = NO;
|
|
BlockBasedSonarPlugin* cat =
|
|
[[BlockBasedSonarPlugin alloc] initIdentifier:@"cat"
|
|
connect:^(id<FlipperConnection>) {
|
|
pluginConnected = YES;
|
|
}
|
|
disconnect:^{
|
|
pluginConnected = NO;
|
|
}
|
|
runInBackground:NO];
|
|
|
|
[objcClient addPlugin:cat];
|
|
[objcClient start];
|
|
XCTAssertFalse(pluginConnected);
|
|
}
|
|
|
|
- (void)testConnectAndDisconnectCallbackForNonBackgroundCase {
|
|
__block BOOL pluginConnected = NO;
|
|
BlockBasedSonarPlugin* cat =
|
|
[[BlockBasedSonarPlugin alloc] initIdentifier:@"cat"
|
|
connect:^(id<FlipperConnection>) {
|
|
pluginConnected = YES;
|
|
}
|
|
disconnect:^{
|
|
pluginConnected = NO;
|
|
}
|
|
runInBackground:NO];
|
|
|
|
[objcClient addPlugin:cat];
|
|
[objcClient start];
|
|
|
|
folly::dynamic messageInit = folly::dynamic::object("method", "init")(
|
|
"params", folly::dynamic::object("plugin", "cat"));
|
|
std::unique_ptr<facebook::flipper::FlipperResponder> responder =
|
|
std::make_unique<facebook::flipper::FlipperResponderMock>();
|
|
|
|
socket->callbacks->onMessageReceived(messageInit, std::move(responder));
|
|
XCTAssertTrue(pluginConnected);
|
|
[objcClient stop];
|
|
XCTAssertFalse(pluginConnected);
|
|
}
|
|
|
|
- (void)testConnectAndDisconnectCallbackForBackgroundCase {
|
|
__block BOOL pluginConnected = NO;
|
|
BlockBasedSonarPlugin* cat =
|
|
[[BlockBasedSonarPlugin alloc] initIdentifier:@"cat"
|
|
connect:^(id<FlipperConnection>) {
|
|
pluginConnected = YES;
|
|
}
|
|
disconnect:^{
|
|
pluginConnected = NO;
|
|
}
|
|
runInBackground:YES];
|
|
|
|
[objcClient addPlugin:cat];
|
|
[objcClient start];
|
|
XCTAssertFalse(pluginConnected);
|
|
|
|
folly::dynamic messageInit = folly::dynamic::object("method", "init")(
|
|
"params", folly::dynamic::object("plugin", "cat"));
|
|
std::unique_ptr<facebook::flipper::FlipperResponder> responder =
|
|
std::make_unique<facebook::flipper::FlipperResponderMock>();
|
|
socket->callbacks->onMessageReceived(messageInit, std::move(responder));
|
|
XCTAssertTrue(pluginConnected);
|
|
|
|
folly::dynamic messageDeInit = folly::dynamic::object("method", "deinit")(
|
|
"params", folly::dynamic::object("plugin", "cat"));
|
|
std::unique_ptr<facebook::flipper::FlipperResponder> responder2 =
|
|
std::make_unique<facebook::flipper::FlipperResponderMock>();
|
|
socket->callbacks->onMessageReceived(messageDeInit, std::move(responder2));
|
|
XCTAssertFalse(pluginConnected);
|
|
|
|
std::unique_ptr<facebook::flipper::FlipperResponder> responder3 =
|
|
std::make_unique<facebook::flipper::FlipperResponderMock>();
|
|
socket->callbacks->onMessageReceived(messageInit, std::move(responder3));
|
|
XCTAssertTrue(pluginConnected);
|
|
|
|
[objcClient stop];
|
|
XCTAssertFalse(pluginConnected);
|
|
}
|
|
|
|
- (void)testCrashSuppressionInDidConnectCallback {
|
|
__block BOOL pluginConnected = NO;
|
|
BlockBasedSonarPlugin* cat = [[BlockBasedSonarPlugin alloc]
|
|
initIdentifier:@"cat"
|
|
connect:^(id<FlipperConnection>) {
|
|
pluginConnected = YES;
|
|
NSArray* array = @[];
|
|
[array objectAtIndex:10]; // This will throw an exception
|
|
}
|
|
disconnect:nil
|
|
runInBackground:YES];
|
|
|
|
[objcClient addPlugin:cat];
|
|
XCTAssertNoThrow([objcClient start]);
|
|
XCTAssertFalse(pluginConnected);
|
|
|
|
folly::dynamic messageInit = folly::dynamic::object("method", "init")(
|
|
"params", folly::dynamic::object("plugin", "cat"));
|
|
std::unique_ptr<facebook::flipper::FlipperResponder> responder =
|
|
std::make_unique<facebook::flipper::FlipperResponderMock>();
|
|
XCTAssertNoThrow(
|
|
socket->callbacks->onMessageReceived(messageInit, std::move(responder)));
|
|
XCTAssertTrue(pluginConnected);
|
|
}
|
|
|
|
- (void)testCrashSuppressionInDisconnectCallback {
|
|
__block BOOL isCalled = NO;
|
|
BlockBasedSonarPlugin* cat = [[BlockBasedSonarPlugin alloc]
|
|
initIdentifier:@"cat"
|
|
connect:nil
|
|
disconnect:^{
|
|
isCalled = YES;
|
|
NSArray* array = @[];
|
|
[array objectAtIndex:10]; // This will throw an exception
|
|
}
|
|
runInBackground:YES];
|
|
|
|
[objcClient addPlugin:cat];
|
|
[objcClient start];
|
|
|
|
folly::dynamic messageInit = folly::dynamic::object("method", "init")(
|
|
"params", folly::dynamic::object("plugin", "cat"));
|
|
std::unique_ptr<facebook::flipper::FlipperResponder> responder =
|
|
std::make_unique<facebook::flipper::FlipperResponderMock>();
|
|
socket->callbacks->onMessageReceived(messageInit, std::move(responder));
|
|
|
|
XCTAssertNoThrow(
|
|
[objcClient stop]); // Stopping client will call disconnect of the plugin
|
|
XCTAssertTrue(isCalled); // To be sure that connect block is called
|
|
}
|
|
|
|
- (void)testMethodBlockIsCalledNonBackgroundCase {
|
|
__block BOOL isCalled = NO;
|
|
|
|
BlockBasedSonarPlugin* cat = [[BlockBasedSonarPlugin alloc]
|
|
initIdentifier:@"PluginIdentifier"
|
|
connect:^(id<FlipperConnection> connection) {
|
|
[connection
|
|
receive:@"MethodName"
|
|
withBlock:^(
|
|
NSDictionary* dict, id<FlipperResponder> responder) {
|
|
isCalled = YES;
|
|
}];
|
|
}
|
|
disconnect:nil];
|
|
|
|
[objcClient addPlugin:cat];
|
|
[objcClient start];
|
|
|
|
folly::dynamic messageInit = folly::dynamic::object("method", "init")(
|
|
"params", folly::dynamic::object("plugin", "PluginIdentifier"));
|
|
std::unique_ptr<facebook::flipper::FlipperResponder> responder1 =
|
|
std::make_unique<facebook::flipper::FlipperResponderMock>();
|
|
socket->callbacks->onMessageReceived(messageInit, std::move(responder1));
|
|
folly::dynamic message = folly::dynamic::object("id", 1)("method", "execute")(
|
|
"params",
|
|
folly::dynamic::object("api", "PluginIdentifier")(
|
|
"method", "MethodName"));
|
|
std::unique_ptr<facebook::flipper::FlipperResponder> responder2 =
|
|
std::make_unique<facebook::flipper::FlipperResponderMock>();
|
|
|
|
socket->callbacks->onMessageReceived(message, std::move(responder2));
|
|
|
|
XCTAssertTrue(isCalled);
|
|
}
|
|
|
|
- (void)testMethodBlockIsCalledBackgroundCase {
|
|
__block BOOL isCalled = NO;
|
|
|
|
BlockBasedSonarPlugin* cat = [[BlockBasedSonarPlugin alloc]
|
|
initIdentifier:@"PluginIdentifier"
|
|
connect:^(id<FlipperConnection> connection) {
|
|
[connection
|
|
receive:@"MethodName"
|
|
withBlock:^(
|
|
NSDictionary* dict, id<FlipperResponder> responder) {
|
|
isCalled = YES;
|
|
}];
|
|
}
|
|
disconnect:nil
|
|
runInBackground:YES];
|
|
|
|
[objcClient addPlugin:cat];
|
|
[objcClient start];
|
|
|
|
folly::dynamic messageInit = folly::dynamic::object("method", "init")(
|
|
"params", folly::dynamic::object("plugin", "PluginIdentifier"));
|
|
std::unique_ptr<facebook::flipper::FlipperResponder> responder =
|
|
std::make_unique<facebook::flipper::FlipperResponderMock>();
|
|
socket->callbacks->onMessageReceived(messageInit, std::move(responder));
|
|
|
|
folly::dynamic message = folly::dynamic::object("id", 1)("method", "execute")(
|
|
"params",
|
|
folly::dynamic::object("api", "PluginIdentifier")(
|
|
"method", "MethodName"));
|
|
std::unique_ptr<facebook::flipper::FlipperResponder> responder2 =
|
|
std::make_unique<facebook::flipper::FlipperResponderMock>();
|
|
socket->callbacks->onMessageReceived(message, std::move(responder2));
|
|
|
|
XCTAssertTrue(isCalled);
|
|
}
|
|
|
|
- (void)testExceptionSuppressionInMethodBlock {
|
|
__block BOOL isCalled = NO;
|
|
|
|
BlockBasedSonarPlugin* cat = [[BlockBasedSonarPlugin alloc]
|
|
initIdentifier:@"PluginIdentifier"
|
|
connect:^(id<FlipperConnection> connection) {
|
|
[connection
|
|
receive:@"MethodName"
|
|
withBlock:^(
|
|
NSDictionary* dict, id<FlipperResponder> responder) {
|
|
isCalled = YES;
|
|
NSArray* array = @[];
|
|
[array objectAtIndex:10]; // This will throw an exception
|
|
}];
|
|
}
|
|
disconnect:nil
|
|
runInBackground:YES];
|
|
|
|
[objcClient addPlugin:cat];
|
|
[objcClient start];
|
|
|
|
folly::dynamic messageInit = folly::dynamic::object("method", "init")(
|
|
"params", folly::dynamic::object("plugin", "PluginIdentifier"));
|
|
std::unique_ptr<facebook::flipper::FlipperResponder> responder =
|
|
std::make_unique<facebook::flipper::FlipperResponderMock>();
|
|
socket->callbacks->onMessageReceived(messageInit, std::move(responder));
|
|
|
|
folly::dynamic message = folly::dynamic::object("id", 1)("method", "execute")(
|
|
"params",
|
|
folly::dynamic::object("api", "PluginIdentifier")(
|
|
"method", "MethodName"));
|
|
std::vector<folly::dynamic> successes = std::vector<folly::dynamic>();
|
|
std::vector<folly::dynamic> errors = std::vector<folly::dynamic>();
|
|
std::unique_ptr<facebook::flipper::FlipperResponderMock> responder2 =
|
|
std::make_unique<facebook::flipper::FlipperResponderMock>(
|
|
&successes, &errors);
|
|
|
|
XCTAssertNoThrow(
|
|
socket->callbacks->onMessageReceived(message, std::move(responder2)));
|
|
XCTAssertTrue(isCalled);
|
|
XCTAssertEqual(successes.size(), 0);
|
|
XCTAssertEqual(errors.size(), 1);
|
|
}
|
|
|
|
@end
|
|
#endif
|