diff --git a/splitio/lib/channel/method_channel_manager.dart b/splitio/lib/channel/method_channel_manager.dart deleted file mode 100644 index 89ec677..0000000 --- a/splitio/lib/channel/method_channel_manager.dart +++ /dev/null @@ -1,38 +0,0 @@ -import 'package:flutter/services.dart'; -import 'package:splitio/method_call_handler.dart'; - -class MethodChannelManager { - final MethodChannel _channel; - - final Set _handlers = {}; - - MethodChannelManager(this._channel) { - _channel.setMethodCallHandler((call) => handle(call)); - } - - void addHandler(MethodCallHandler handler) { - _handlers.add(handler); - } - - void removeHandler(MethodCallHandler handler) { - _handlers.remove(handler); - } - - Future handle(MethodCall call) async { - for (MethodCallHandler handler in _handlers) { - handler.handle(call); - } - } - - Future invokeMethod(String method, [dynamic arguments]) { - return _channel.invokeMethod(method, arguments); - } - - Future?> invokeMapMethod(String method, [dynamic arguments]) { - return _channel.invokeMapMethod(method, arguments); - } - - Future?> invokeListMethod(String method, [dynamic arguments]) { - return _channel.invokeListMethod(method, arguments); - } -} diff --git a/splitio/lib/events/split_events_listener.dart b/splitio/lib/events/split_events_listener.dart deleted file mode 100644 index be9c9f6..0000000 --- a/splitio/lib/events/split_events_listener.dart +++ /dev/null @@ -1,53 +0,0 @@ -import 'dart:async'; - -import 'package:splitio/channel/method_channel_manager.dart'; -import 'package:splitio/events/split_method_call_handler.dart'; -import 'package:splitio/split_client.dart'; - -abstract class SplitEventsListener { - Future onReady(); - - Future onReadyFromCache(); - - Stream onUpdated(); - - Future onTimeout(); - - void destroy(); -} - -class DefaultEventsListener implements SplitEventsListener { - final MethodChannelManager _methodChannelManager; - - final SplitEventMethodCallHandler _methodCallHandler; - - DefaultEventsListener(this._methodChannelManager, this._methodCallHandler) { - _methodChannelManager.addHandler(_methodCallHandler); - } - - @override - Future onReady() { - return _methodCallHandler.onReady(); - } - - @override - Future onReadyFromCache() { - return _methodCallHandler.onReadyFromCache(); - } - - @override - Stream onUpdated() { - return _methodCallHandler.onUpdated(); - } - - @override - Future onTimeout() { - return _methodCallHandler.onTimeout(); - } - - @override - void destroy() { - _methodCallHandler.destroy(); - _methodChannelManager.removeHandler(_methodCallHandler); - } -} diff --git a/splitio/lib/events/split_method_call_handler.dart b/splitio/lib/events/split_method_call_handler.dart deleted file mode 100644 index 862017a..0000000 --- a/splitio/lib/events/split_method_call_handler.dart +++ /dev/null @@ -1,91 +0,0 @@ -import 'dart:async'; - -import 'package:flutter/services.dart'; -import 'package:splitio/events/split_events_listener.dart'; -import 'package:splitio/method_call_handler.dart'; -import 'package:splitio/split_client.dart'; - -class SplitEventMethodCallHandler - implements MethodCallHandler, SplitEventsListener { - static const String _eventClientReady = 'clientReady'; - static const String _eventClientReadyFromCache = 'clientReadyFromCache'; - static const String _eventClientTimeout = 'clientTimeout'; - static const String _eventClientUpdated = 'clientUpdated'; - - final String _matchingKey; - final String? _bucketingKey; - final SplitClient _splitClient; - final StreamController _updateStreamCompleter = - StreamController(); - - final Map> _clientEventCallbacks = { - _eventClientReady: Completer(), - _eventClientReadyFromCache: Completer(), - _eventClientTimeout: Completer(), - }; - - final Map _triggeredClientEvents = { - _eventClientReady: false, - _eventClientReadyFromCache: false, - _eventClientTimeout: false, - }; - - SplitEventMethodCallHandler( - this._matchingKey, this._bucketingKey, this._splitClient); - - @override - Future handle(MethodCall call) async { - if (_clientEventCallbacks.containsKey(call.method)) { - if (_matchingKey == call.arguments['matchingKey'] && - _bucketingKey == call.arguments['bucketingKey']) { - var clientEventCallback = _clientEventCallbacks[call.method]; - if (clientEventCallback != null && !clientEventCallback.isCompleted) { - clientEventCallback.complete(_splitClient); - } - - if (_triggeredClientEvents.containsKey(call.method)) { - _triggeredClientEvents[call.method] = true; - } - } - } else if (call.method == _eventClientUpdated && - _updateStreamCompleter.hasListener && - !_updateStreamCompleter.isPaused && - !_updateStreamCompleter.isClosed) { - _updateStreamCompleter.add(_splitClient); - } - } - - @override - Future onReady() { - return _onEvent(_eventClientReady); - } - - @override - Future onReadyFromCache() { - return _onEvent(_eventClientReadyFromCache); - } - - @override - Stream onUpdated() { - return _updateStreamCompleter.stream; - } - - @override - Future onTimeout() { - return _onEvent(_eventClientTimeout); - } - - @override - void destroy() { - _updateStreamCompleter.close(); - } - - Future _onEvent(String sdkEvent) { - if (_triggeredClientEvents.containsKey(sdkEvent) && - _triggeredClientEvents[sdkEvent] == true) { - return Future.value(_splitClient); - } - - return (_clientEventCallbacks[sdkEvent])?.future ?? Future.error(Object()); - } -} diff --git a/splitio/test/method_channel_manager_test.dart b/splitio/test/method_channel_manager_test.dart deleted file mode 100644 index 0c98d25..0000000 --- a/splitio/test/method_channel_manager_test.dart +++ /dev/null @@ -1,99 +0,0 @@ -import 'package:flutter/services.dart'; -import 'package:flutter_test/flutter_test.dart'; -import 'package:splitio/channel/method_channel_manager.dart'; -import 'package:splitio/method_call_handler.dart'; - -void main() { - late MethodChannelStub _channel; - late MethodChannelManager _methodChannelManager; - - setUp(() { - _channel = MethodChannelStub('mock'); - TestWidgetsFlutterBinding.ensureInitialized(); - _methodChannelManager = MethodChannelManager(_channel); - }); - - test('handle calls are delegated to each handler', () { - var mockMethodHandler1 = MethodCallHandlerStub(); - var mockMethodHandler2 = MethodCallHandlerStub(); - var mockMethodHandler3 = MethodCallHandlerStub(); - _methodChannelManager.addHandler(mockMethodHandler1); - _methodChannelManager.addHandler(mockMethodHandler2); - _methodChannelManager.addHandler(mockMethodHandler3); - - _methodChannelManager.handle(const MethodCall('test-method')); - - expect(mockMethodHandler1.handledCalls, {'test-method'}); - expect(mockMethodHandler2.handledCalls, {'test-method'}); - expect(mockMethodHandler3.handledCalls, {'test-method'}); - }); - - test('invokeMethod calls are delegated to channel', () { - _methodChannelManager.invokeMethod('any-method'); - - expect(_channel.calledMethods, {'invokeMethod'}); - }); - - test('invokeMapMethod calls are delegated to channel', () { - _methodChannelManager.invokeMapMethod('any-method'); - - expect(_channel.calledMethods, {'invokeMapMethod'}); - }); - - test('invokeListMethod calls are delegated to channel', () { - _methodChannelManager.invokeListMethod('any-method'); - - expect(_channel.calledMethods, {'invokeListMethod'}); - }); - - test('removed call handlers do not handle methods', () { - final MethodCallHandlerStub handler1 = MethodCallHandlerStub(); - final MethodCallHandlerStub handler2 = MethodCallHandlerStub(); - final MethodCallHandlerStub handler3 = MethodCallHandlerStub(); - _methodChannelManager.addHandler(handler1); - _methodChannelManager.addHandler(handler2); - _methodChannelManager.addHandler(handler3); - - _methodChannelManager.removeHandler(handler2); - - _methodChannelManager.handle(const MethodCall('test-method')); - - expect(handler1.handledCalls, {'test-method'}); - expect(handler2.handledCalls, isEmpty); - expect(handler3.handledCalls, {'test-method'}); - }); -} - -class MethodCallHandlerStub extends MethodCallHandler { - final Set handledCalls = {}; - - @override - Future handle(MethodCall call) async { - handledCalls.add(call.method); - } -} - -class MethodChannelStub extends MethodChannel { - MethodChannelStub(String name) : super(name); - Set calledMethods = {}; - - @override - Future invokeMethod(String method, [dynamic arguments]) async { - calledMethods.add('invokeMethod'); - return Future.value(null); - } - - @override - Future?> invokeMapMethod(String method, - [dynamic arguments]) async { - calledMethods.add('invokeMapMethod'); - return Future.value(null); - } - - @override - Future?> invokeListMethod(String method, - [dynamic arguments]) async { - calledMethods.add('invokeListMethod'); - return Future.value(null); - } -} diff --git a/splitio_platform_interface/.gitignore b/splitio_platform_interface/.gitignore new file mode 100644 index 0000000..9be145f --- /dev/null +++ b/splitio_platform_interface/.gitignore @@ -0,0 +1,29 @@ +# Miscellaneous +*.class +*.log +*.pyc +*.swp +.DS_Store +.atom/ +.buildlog/ +.history +.svn/ + +# IntelliJ related +*.iml +*.ipr +*.iws +.idea/ + +# The .vscode folder contains launch configuration and tasks you configure in +# VS Code which you may wish to be included in version control, so this line +# is commented out by default. +#.vscode/ + +# Flutter/Dart/Pub related +# Libraries should not include pubspec.lock, per https://dart.dev/guides/libraries/private-files#pubspeclock. +/pubspec.lock +**/doc/api/ +.dart_tool/ +.packages +build/ diff --git a/splitio_platform_interface/CHANGELOG.md b/splitio_platform_interface/CHANGELOG.md new file mode 100644 index 0000000..2dd7b16 --- /dev/null +++ b/splitio_platform_interface/CHANGELOG.md @@ -0,0 +1,3 @@ +# 1.0.0 + +Initial release. diff --git a/splitio_platform_interface/LICENSE b/splitio_platform_interface/LICENSE new file mode 100644 index 0000000..20e4bd8 --- /dev/null +++ b/splitio_platform_interface/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + https://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + https://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/splitio_platform_interface/README.md b/splitio_platform_interface/README.md new file mode 100644 index 0000000..e69de29 diff --git a/splitio_platform_interface/lib/events/split_method_call_handler.dart b/splitio_platform_interface/lib/events/split_method_call_handler.dart new file mode 100644 index 0000000..6a0db02 --- /dev/null +++ b/splitio_platform_interface/lib/events/split_method_call_handler.dart @@ -0,0 +1,79 @@ +import 'dart:async'; + +import 'package:splitio_platform_interface/method_call_handler.dart'; + +class SplitEventMethodCallHandler implements MethodCallHandler { + static const String _eventClientReady = 'clientReady'; + static const String _eventClientReadyFromCache = 'clientReadyFromCache'; + static const String _eventClientTimeout = 'clientTimeout'; + static const String _eventClientUpdated = 'clientUpdated'; + + final String _matchingKey; + final String? _bucketingKey; + final StreamController _updateStreamCompleter = StreamController(); + + final Map> _clientEventCallbacks = { + _eventClientReady: Completer(), + _eventClientReadyFromCache: Completer(), + _eventClientTimeout: Completer(), + }; + + final Map _triggeredClientEvents = { + _eventClientReady: false, + _eventClientReadyFromCache: false, + _eventClientTimeout: false, + }; + + SplitEventMethodCallHandler(this._matchingKey, this._bucketingKey); + + @override + Future handle(String methodName, dynamic methodArguments) async { + if (_clientEventCallbacks.containsKey(methodName)) { + if (_matchingKey == methodArguments['matchingKey'] && + _bucketingKey == methodArguments['bucketingKey']) { + var clientEventCallback = _clientEventCallbacks[methodName]; + if (clientEventCallback != null && !clientEventCallback.isCompleted) { + clientEventCallback.complete(); + } + + if (_triggeredClientEvents.containsKey(methodName)) { + _triggeredClientEvents[methodName] = true; + } + } + } else if (methodName == _eventClientUpdated && + _updateStreamCompleter.hasListener && + !_updateStreamCompleter.isPaused && + !_updateStreamCompleter.isClosed) { + _updateStreamCompleter.add(null); + } + } + + Future onReady() { + return _onEvent(_eventClientReady); + } + + Future onReadyFromCache() { + return _onEvent(_eventClientReadyFromCache); + } + + Stream onUpdated() { + return _updateStreamCompleter.stream; + } + + Future onTimeout() { + return _onEvent(_eventClientTimeout); + } + + void destroy() { + _updateStreamCompleter.close(); + } + + Future _onEvent(String sdkEvent) { + if (_triggeredClientEvents.containsKey(sdkEvent) && + _triggeredClientEvents[sdkEvent] == true) { + return Future.value(); + } + + return (_clientEventCallbacks[sdkEvent])?.future ?? Future.error(Object()); + } +} diff --git a/splitio/lib/impressions/impressions_method_call_handler.dart b/splitio_platform_interface/lib/impressions/impressions_method_call_handler.dart similarity index 59% rename from splitio/lib/impressions/impressions_method_call_handler.dart rename to splitio_platform_interface/lib/impressions/impressions_method_call_handler.dart index d09527a..ea4e4a4 100644 --- a/splitio/lib/impressions/impressions_method_call_handler.dart +++ b/splitio_platform_interface/lib/impressions/impressions_method_call_handler.dart @@ -1,20 +1,19 @@ import 'dart:async'; -import 'package:flutter/services.dart'; -import 'package:splitio/impressions/split_impression.dart'; -import 'package:splitio/method_call_handler.dart'; +import 'package:splitio_platform_interface/method_call_handler.dart'; +import 'package:splitio_platform_interface/split_impression.dart'; class ImpressionsMethodCallHandler extends StreamMethodCallHandler { final _streamController = StreamController(); @override - Future handle(MethodCall call) async { - if (call.method == 'impressionLog') { + Future handle(String methodName, dynamic methodArguments) async { + if (methodName == 'impressionLog') { if (_streamController.hasListener && !_streamController.isPaused && !_streamController.isClosed) { _streamController.add(Impression.fromMap( - Map.from(call.arguments ?? {}))); + Map.from(methodArguments ?? {}))); } } } diff --git a/splitio/lib/method_call_handler.dart b/splitio_platform_interface/lib/method_call_handler.dart similarity index 61% rename from splitio/lib/method_call_handler.dart rename to splitio_platform_interface/lib/method_call_handler.dart index 42c7c4f..6ef88ac 100644 --- a/splitio/lib/method_call_handler.dart +++ b/splitio_platform_interface/lib/method_call_handler.dart @@ -1,7 +1,5 @@ -import 'package:flutter/services.dart'; - abstract class MethodCallHandler { - Future handle(MethodCall call); + Future handle(String methodName, dynamic methodArguments); } abstract class StreamMethodCallHandler extends MethodCallHandler { diff --git a/splitio/lib/split_configuration.dart b/splitio_platform_interface/lib/split_configuration.dart similarity index 100% rename from splitio/lib/split_configuration.dart rename to splitio_platform_interface/lib/split_configuration.dart diff --git a/splitio/lib/impressions/split_impression.dart b/splitio_platform_interface/lib/split_impression.dart similarity index 100% rename from splitio/lib/impressions/split_impression.dart rename to splitio_platform_interface/lib/split_impression.dart diff --git a/splitio/lib/split_result.dart b/splitio_platform_interface/lib/split_result.dart similarity index 100% rename from splitio/lib/split_result.dart rename to splitio_platform_interface/lib/split_result.dart diff --git a/splitio/lib/split_sync_config.dart b/splitio_platform_interface/lib/split_sync_config.dart similarity index 100% rename from splitio/lib/split_sync_config.dart rename to splitio_platform_interface/lib/split_sync_config.dart diff --git a/splitio/lib/split_view.dart b/splitio_platform_interface/lib/split_view.dart similarity index 100% rename from splitio/lib/split_view.dart rename to splitio_platform_interface/lib/split_view.dart diff --git a/splitio_platform_interface/lib/splitio_platform_interface.dart b/splitio_platform_interface/lib/splitio_platform_interface.dart new file mode 100644 index 0000000..e368763 --- /dev/null +++ b/splitio_platform_interface/lib/splitio_platform_interface.dart @@ -0,0 +1,183 @@ +import 'dart:async'; + +import 'package:plugin_platform_interface/plugin_platform_interface.dart'; +import 'package:splitio_platform_interface/method_channel_platform.dart'; +import 'package:splitio_platform_interface/split_configuration.dart'; +import 'package:splitio_platform_interface/split_impression.dart'; +import 'package:splitio_platform_interface/split_result.dart'; +import 'package:splitio_platform_interface/split_view.dart'; + +abstract class _FactoryPlatform { + Future getClient( + {required String matchingKey, required String? bucketingKey}) { + throw UnimplementedError(); + } + + Future init({ + required String apiKey, + required String matchingKey, + required String? bucketingKey, + SplitConfiguration? sdkConfiguration, + }) { + throw UnimplementedError(); + } + + Future split( + {required String matchingKey, + required String? bucketingKey, + required String splitName}) { + throw UnimplementedError(); + } + + Future> splitNames( + {required String matchingKey, required String? bucketingKey}) { + throw UnimplementedError(); + } + + Future> splits( + {required String matchingKey, required String? bucketingKey}) { + throw UnimplementedError(); + } + + Stream impressionsStream() { + throw UnimplementedError(); + } +} + +abstract class _ClientPlatform { + Future getTreatment( + {required String matchingKey, + required String? bucketingKey, + required String splitName, + Map attributes = const {}}) { + throw UnimplementedError(); + } + + Future getTreatmentWithConfig( + {required String matchingKey, + required String? bucketingKey, + required String splitName, + Map attributes = const {}}) { + throw UnimplementedError(); + } + + Future> getTreatments( + {required String matchingKey, + required String? bucketingKey, + required List splitNames, + Map attributes = const {}}) { + throw UnimplementedError(); + } + + Future> getTreatmentsWithConfig( + {required String matchingKey, + required String? bucketingKey, + required List splitNames, + Map attributes = const {}}) { + throw UnimplementedError(); + } + + Future> getAllAttributes( + {required String matchingKey, required String? bucketingKey}) { + throw UnimplementedError(); + } + + Future setAttribute( + {required String matchingKey, + required String? bucketingKey, + required String attributeName, + required dynamic value}) { + throw UnimplementedError(); + } + + Future setAttributes( + {required String matchingKey, + required String? bucketingKey, + required Map attributes}) { + throw UnimplementedError(); + } + + Future getAttribute( + {required String matchingKey, + required String? bucketingKey, + required String attributeName}) { + throw UnimplementedError(); + } + + Future removeAttribute( + {required String matchingKey, + required String? bucketingKey, + required String attributeName}) { + throw UnimplementedError(); + } + + Future clearAttributes( + {required String matchingKey, required String? bucketingKey}) { + throw UnimplementedError(); + } + + Future flush( + {required String matchingKey, required String? bucketingKey}) { + throw UnimplementedError(); + } + + Future destroy( + {required String matchingKey, required String? bucketingKey}) { + throw UnimplementedError(); + } + + Future track( + {required String matchingKey, + required String? bucketingKey, + required String eventType, + String? trafficType, + double? value, + Map properties = const {}}) { + throw UnimplementedError(); + } + + Future? onReady( + {required String matchingKey, required String? bucketingKey}) { + throw UnimplementedError(); + } + + Future? onReadyFromCache( + {required String matchingKey, required String? bucketingKey}) { + throw UnimplementedError(); + } + + Stream? onUpdated( + {required String matchingKey, required String? bucketingKey}) { + throw UnimplementedError(); + } + + Future? onTimeout( + {required String matchingKey, required String? bucketingKey}) { + throw UnimplementedError(); + } +} + +/// The interface that implementations of splitio must implement. +/// +/// Platform implementations should extend this class rather than implement it as `splitio` +/// does not consider newly added methods to be breaking changes. Extending this class +/// (using `extends`) ensures that the subclass will get the default implementation, while +/// platform implementations that `implements` this interface will be broken by newly added +/// [SplitioPlatform] methods. +abstract class SplitioPlatform extends PlatformInterface + with _FactoryPlatform, _ClientPlatform { + SplitioPlatform() : super(token: _token); + + static SplitioPlatform _instance = MethodChannelPlatform(); + + static final Object _token = Object(); + + static SplitioPlatform get instance => _instance; + + /// Platform-specific plugins should set this with their own platform-specific + /// class that extends [SplitioPlatform] when they register themselves. + static set instance(SplitioPlatform instance) { + PlatformInterface.verify(instance, _token); + _instance = instance; + } +} diff --git a/splitio_platform_interface/pubspec.yaml b/splitio_platform_interface/pubspec.yaml new file mode 100644 index 0000000..0d43036 --- /dev/null +++ b/splitio_platform_interface/pubspec.yaml @@ -0,0 +1,23 @@ +name: splitio_platform_interface +description: Common platform interface for the splitio plugin. +# NOTE: We strongly prefer non-breaking changes, even at the expense of a +# less-clean API. See https://flutter.dev/go/platform-interface-breaking-changes +version: 1.0.0 +homepage: https://split.io/ +repository: https://github.com/splitio/flutter-sdk-plugin/splitio/splitio_platform_interface + +publish_to: none + +environment: + sdk: ">=2.16.2 <3.0.0" + flutter: ">=2.5.0" + +dependencies: + flutter: + sdk: flutter + plugin_platform_interface: ^2.1.2 + +dev_dependencies: + flutter_test: + sdk: flutter + flutter_lints: ^1.0.0 diff --git a/splitio/test/impressions_method_call_handler_test.dart b/splitio_platform_interface/test/impressions_method_call_handler_test.dart similarity index 100% rename from splitio/test/impressions_method_call_handler_test.dart rename to splitio_platform_interface/test/impressions_method_call_handler_test.dart diff --git a/splitio/test/split_event_listener_test.dart b/splitio_platform_interface/test/split_event_listener_test.dart similarity index 100% rename from splitio/test/split_event_listener_test.dart rename to splitio_platform_interface/test/split_event_listener_test.dart diff --git a/splitio/test/split_impression_test.dart b/splitio_platform_interface/test/split_impression_test.dart similarity index 100% rename from splitio/test/split_impression_test.dart rename to splitio_platform_interface/test/split_impression_test.dart diff --git a/splitio/test/split_view_test.dart b/splitio_platform_interface/test/split_view_test.dart similarity index 100% rename from splitio/test/split_view_test.dart rename to splitio_platform_interface/test/split_view_test.dart diff --git a/splitio/test/splitio_configuration_test.dart b/splitio_platform_interface/test/splitio_configuration_test.dart similarity index 100% rename from splitio/test/splitio_configuration_test.dart rename to splitio_platform_interface/test/splitio_configuration_test.dart