mrpastewart/platform
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Publish websocket

Browse source
This commit is contained in:
thomashii 2021-05-15 15:19:35 +08:00
parent b1d580fdd2
commit e5acc33350
18 changed files with 85 additions and 114 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

31
packages/websocket/README.md
View file

@ -1,6 +1,9 @@
# angel_websocket # angel3_websocket
[![Pub](https://img.shields.io/pub/v/angel_websocket.svg)](https://pub.dartlang.org/packages/angel_websocket) [![version](https://img.shields.io/badge/pub-v4.0.0-brightgreen)](https://pub.dartlang.org/packages/angel3_websocket)
[![build status](https://travis-ci.org/angel-dart/websocket.svg)](https://travis-ci.org/angel-dart/websocket) [![Null Safety](https://img.shields.io/badge/null-safety-brightgreen)](https://dart.dev/null-safety)
[![Gitter](https://img.shields.io/gitter/room/angel_dart/discussion)](https://gitter.im/angel_dart/discussion)
[![License](https://img.shields.io/github/license/dukefirehawk/angel)](https://github.com/dukefirehawk/angel/tree/angel3/packages/websocket/LICENSE)
WebSocket plugin for Angel. WebSocket plugin for Angel.
@ -17,13 +20,13 @@ WebSocket contexts are add to `req.properties` as `'socket'`.
**Server-side** **Server-side**
```dart ```dart
import "package:angel_framework/angel_framework.dart"; import "package:angel3_framework/angel3_framework.dart";
import "package:angel_websocket/server.dart"; import "package:angel3_websocket/server.dart";
main() async { main() async {
var app = new Angel(); var app = Angel();
var ws = new AngelWebSocket(); var ws = AngelWebSocket();
// This is a plug-in. It hooks all your services, // This is a plug-in. It hooks all your services,
// to automatically broadcast events. // to automatically broadcast events.
@ -78,7 +81,7 @@ class MyController extends WebSocketController {
// Event filtering // Event filtering
@ExposeWs("foo") @ExposeWs("foo")
void foo() { void foo() {
broadcast(new WebSocketEvent(...), filter: (socket) async => ...); broadcast( WebSocketEvent(...), filter: (socket) async => ...);
} }
} }
``` ```
@ -86,7 +89,7 @@ class MyController extends WebSocketController {
**Client Use** **Client Use**
This repo also provides two client libraries `browser` and `io` that extend the base This repo also provides two client libraries `browser` and `io` that extend the base
`angel_client` interface, and allow you to use a very similar API on the client to that of `angel3_client` interface, and allow you to use a very similar API on the client to that of
the server. the server.
The provided clients also automatically try to reconnect their WebSockets when disconnected, The provided clients also automatically try to reconnect their WebSockets when disconnected,
@ -99,10 +102,10 @@ Clients can even perform authentication over WebSockets.
**In the Browser** **In the Browser**
```dart ```dart
import "package:angel_websocket/browser.dart"; import "package:angel3_websocket/browser.dart";
main() async { main() async {
Angel app = new WebSockets("/ws"); Angel app = WebSockets("/ws");
await app.connect(); await app.connect();
var Cars = app.service("api/cars"); var Cars = app.service("api/cars");
@ -127,8 +130,8 @@ main() async {
**CLI Client** **CLI Client**
```dart ```dart
import "package:angel_framework/common.dart"; import "package:angel3_framework/common.dart";
import "package:angel_websocket/io.dart"; import "package:angel3_websocket/io.dart";
// You can include these in a shared file and access on both client and server // You can include these in a shared file and access on both client and server
class Car extends Model { class Car extends Model {
@ -141,7 +144,7 @@ class Car extends Model {
} }
main() async { main() async {
Angel app = new WebSockets("/ws"); Angel app = WebSockets("/ws");
// Wait for WebSocket connection... // Wait for WebSocket connection...
await app.connect(); await app.connect();

8
packages/websocket/example/main.dart
View file

@ -1,8 +1,8 @@
import 'dart:io'; import 'dart:io';
import 'package:angel_framework/angel_framework.dart'; import 'package:angel3_framework/angel3_framework.dart';
import 'package:angel_framework/http.dart'; import 'package:angel3_framework/http.dart';
import 'package:angel_framework/http2.dart'; import 'package:angel3_framework/http2.dart';
import 'package:angel_websocket/server.dart'; import 'package:angel3_websocket/server.dart';
import 'package:file/local.dart'; import 'package:file/local.dart';
import 'package:logging/logging.dart'; import 'package:logging/logging.dart';

2
packages/websocket/lib/angel_websocket.dart → packages/websocket/lib/angel3_websocket.dart
View file

@ -1,5 +1,5 @@
/// WebSocket plugin for Angel. /// WebSocket plugin for Angel.
library angel_websocket; library angel3_websocket;
/// A notification from the server that something has occurred. /// A notification from the server that something has occurred.
class WebSocketEvent<Data> { class WebSocketEvent<Data> {

8
packages/websocket/lib/base_websocket_client.dart
View file

@ -1,13 +1,13 @@
import 'dart:async'; import 'dart:async';
import 'dart:collection'; import 'dart:collection';
import 'dart:convert'; import 'dart:convert';
import 'package:angel_client/angel_client.dart'; import 'package:angel3_client/angel3_client.dart';
import 'package:angel_client/base_angel_client.dart'; import 'package:angel3_client/base_angel_client.dart';
import 'package:angel_http_exception/angel_http_exception.dart'; import 'package:angel3_http_exception/angel3_http_exception.dart';
import 'package:http/src/base_client.dart' as http; import 'package:http/src/base_client.dart' as http;
import 'package:web_socket_channel/web_socket_channel.dart'; import 'package:web_socket_channel/web_socket_channel.dart';
import 'package:web_socket_channel/status.dart' as status; import 'package:web_socket_channel/status.dart' as status;
import 'angel_websocket.dart'; import 'angel3_websocket.dart';
import 'constants.dart'; import 'constants.dart';
final RegExp _straySlashes = RegExp(r'(^/)|(/+$)'); final RegExp _straySlashes = RegExp(r'(^/)|(/+$)');

8
packages/websocket/lib/browser.dart
View file

@ -1,15 +1,15 @@
/// Browser WebSocket client library for the Angel framework. /// Browser WebSocket client library for the Angel framework.
library angel_websocket.browser; library angel3_websocket.browser;
import 'dart:async'; import 'dart:async';
import 'dart:html'; import 'dart:html';
import 'package:angel_client/angel_client.dart'; import 'package:angel3_client/angel3_client.dart';
import 'package:angel_http_exception/angel_http_exception.dart'; import 'package:angel3_http_exception/angel3_http_exception.dart';
import 'package:http/browser_client.dart' as http; import 'package:http/browser_client.dart' as http;
import 'package:web_socket_channel/web_socket_channel.dart'; import 'package:web_socket_channel/web_socket_channel.dart';
import 'package:web_socket_channel/html.dart'; import 'package:web_socket_channel/html.dart';
import 'base_websocket_client.dart'; import 'base_websocket_client.dart';
export 'angel_websocket.dart'; export 'angel3_websocket.dart';
final RegExp _straySlashes = RegExp(r'(^/)|(/+$)'); final RegExp _straySlashes = RegExp(r'(^/)|(/+$)');

6
packages/websocket/lib/flutter.dart
View file

@ -7,10 +7,10 @@ import 'package:http/io_client.dart' as http;
import 'package:web_socket_channel/web_socket_channel.dart'; import 'package:web_socket_channel/web_socket_channel.dart';
import 'package:web_socket_channel/io.dart'; import 'package:web_socket_channel/io.dart';
import 'base_websocket_client.dart'; import 'base_websocket_client.dart';
export 'package:angel_client/angel_client.dart'; export 'package:angel3_client/angel3_client.dart';
export 'angel_websocket.dart'; export 'angel3_websocket.dart';
// final RegExp _straySlashes = new RegExp(r"(^/)|(/+$)"); // final RegExp _straySlashes = RegExp(r"(^/)|(/+$)");
/// Queries an Angel server via WebSockets. /// Queries an Angel server via WebSockets.
class WebSockets extends BaseWebSocketClient { class WebSockets extends BaseWebSocketClient {

2
packages/websocket/lib/hooks.dart
View file

@ -1,4 +1,4 @@
import 'package:angel_framework/angel_framework.dart'; import 'package:angel3_framework/angel3_framework.dart';
/// Prevents a WebSocket event from being broadcasted, to any client from the given [provider]. /// Prevents a WebSocket event from being broadcasted, to any client from the given [provider].
/// ///

8
packages/websocket/lib/io.dart
View file

@ -1,15 +1,15 @@
/// Command-line WebSocket client library for the Angel framework. /// Command-line WebSocket client library for the Angel framework.
library angel_websocket.io; library angel3_websocket.io;
import 'dart:async'; import 'dart:async';
import 'dart:io'; import 'dart:io';
import 'package:angel_client/angel_client.dart'; import 'package:angel3_client/angel3_client.dart';
import 'package:http/io_client.dart' as http; import 'package:http/io_client.dart' as http;
import 'package:web_socket_channel/web_socket_channel.dart'; import 'package:web_socket_channel/web_socket_channel.dart';
import 'package:web_socket_channel/io.dart'; import 'package:web_socket_channel/io.dart';
import 'base_websocket_client.dart'; import 'base_websocket_client.dart';
export 'package:angel_client/angel_client.dart'; export 'package:angel3_client/angel3_client.dart';
export 'angel_websocket.dart'; export 'angel3_websocket.dart';
final RegExp _straySlashes = RegExp(r'(^/)|(/+$)'); final RegExp _straySlashes = RegExp(r'(^/)|(/+$)');

22
packages/websocket/lib/server.dart
View file

@ -1,22 +1,22 @@
/// Server-side support for WebSockets. /// Server-side support for WebSockets.
library angel_websocket.server; library angel3_websocket.server;
import 'dart:async'; import 'dart:async';
import 'dart:convert'; import 'dart:convert';
import 'dart:io'; import 'dart:io';
import 'dart:mirrors'; import 'dart:mirrors';
import 'package:angel_auth/angel_auth.dart'; import 'package:angel3_auth/angel3_auth.dart';
import 'package:angel_framework/angel_framework.dart'; import 'package:angel3_framework/angel3_framework.dart';
import 'package:angel_framework/http.dart'; import 'package:angel3_framework/http.dart';
import 'package:angel_framework/http2.dart'; import 'package:angel3_framework/http2.dart';
import 'package:merge_map/merge_map.dart'; import 'package:angel3_merge_map/angel3_merge_map.dart';
import 'package:stream_channel/stream_channel.dart'; import 'package:stream_channel/stream_channel.dart';
import 'package:web_socket_channel/io.dart'; import 'package:web_socket_channel/io.dart';
import 'package:web_socket_channel/web_socket_channel.dart'; import 'package:web_socket_channel/web_socket_channel.dart';
import 'package:collection/collection.dart' show IterableExtension; import 'package:collection/collection.dart' show IterableExtension;
import 'angel_websocket.dart'; import 'angel3_websocket.dart';
import 'constants.dart'; import 'constants.dart';
export 'angel_websocket.dart'; export 'angel3_websocket.dart';
part 'websocket_context.dart'; part 'websocket_context.dart';
@ -249,14 +249,14 @@ class AngelWebSocket {
var jwt = action.params!['query']['jwt'] as String; var jwt = action.params!['query']['jwt'] as String;
AuthToken token; AuthToken token;
token = AuthToken.validate(jwt, auth.hmac!); token = AuthToken.validate(jwt, auth.hmac);
var user = await auth.deserializer!(token.userId); var user = await auth.deserializer!(token.userId as Object);
socket.request socket.request
..container!.registerSingleton<AuthToken>(token) ..container!.registerSingleton<AuthToken>(token)
..container!.registerSingleton(user, as: user.runtimeType); ..container!.registerSingleton(user, as: user.runtimeType);
socket._onAuthenticated.add(null); socket._onAuthenticated.add(null);
socket.send(authenticatedEvent, socket.send(authenticatedEvent,
{'token': token.serialize(auth.hmac!), 'data': user}); {'token': token.serialize(auth.hmac), 'data': user});
} catch (e, st) { } catch (e, st) {
catchError(e, st, socket); catchError(e, st, socket);
} }

2
packages/websocket/lib/websocket_context.dart
View file

@ -1,4 +1,4 @@
part of angel_websocket.server; part of angel3_websocket.server;
/// Represents a WebSocket session, with the original /// Represents a WebSocket session, with the original
/// [RequestContext] and [ResponseContext] attached. /// [RequestContext] and [ResponseContext] attached.

2
packages/websocket/lib/websocket_controller.dart
View file

@ -1,4 +1,4 @@
part of angel_websocket.server; part of angel3_websocket.server;
/// Marks a method as available to WebSockets. /// Marks a method as available to WebSockets.
class ExposeWs { class ExposeWs {

54
packages/websocket/pubspec.yaml
View file

@ -1,56 +1,24 @@
name: angel_websocket name: angel3_websocket
description: Support for using pkg:angel_client with WebSockets. Designed for Angel. description: Support for using pkg:angel_client with WebSockets. Designed for Angel.
version: 4.0.0 version: 4.0.0
homepage: https://github.com/dukefirehawk/angel homepage: https://github.com/dukefirehawk/angel/tree/angel3/packages/websocket
publish_to: none
environment: environment:
sdk: '>=2.12.0 <3.0.0' sdk: '>=2.12.0 <3.0.0'
dependencies: dependencies:
angel_auth: angel3_auth: ^4.0.0
git: angel3_client: ^4.0.0
url: https://github.com/dukefirehawk/angel.git angel3_framework: ^4.0.0
ref: sdk-2.12.x_nnbd angel3_http_exception: ^3.0.0
path: packages/auth angel3_merge_map: ^2.0.0
angel_client:
git:
url: https://github.com/dukefirehawk/angel.git
ref: sdk-2.12.x_nnbd
path: packages/client
angel_framework:
git:
url: https://github.com/dukefirehawk/angel.git
ref: sdk-2.12.x_nnbd
path: packages/framework
angel_http_exception:
git:
url: https://github.com/dukefirehawk/angel.git
ref: sdk-2.12.x_nnbd
path: packages/http_exception
http: ^0.13.1 http: ^0.13.1
merge_map:
git:
url: https://github.com/dukefirehawk/angel.git
ref: sdk-2.12.x_nnbd
path: packages/merge_map
meta: ^1.3.0 meta: ^1.3.0
stream_channel: ^2.1.0 stream_channel: ^2.1.0
web_socket_channel: ^2.0.0 web_socket_channel: ^2.1.0
collection: ^1.15.0 collection: ^1.15.0
dev_dependencies: dev_dependencies:
angel_container: angel3_container: ^3.0.0
git: angel3_model: ^3.0.0
url: https://github.com/dukefirehawk/angel.git
ref: sdk-2.12.x_nnbd
path: packages/container/angel_container
angel_model:
git:
url: https://github.com/dukefirehawk/angel.git
ref: sdk-2.12.x_nnbd
path: packages/model
# logging: ^0.11.0 # logging: ^0.11.0
pedantic: ^1.11.0 pedantic: ^1.11.0
test: ^1.17.3 test: ^1.17.4
#dependency_overrides:
# angel_framework:
# path: ../framework

12
packages/websocket/test/auth_test.dart
View file

@ -1,9 +1,9 @@
import 'package:angel_auth/angel_auth.dart'; import 'package:angel3_auth/angel3_auth.dart';
import 'package:angel_client/io.dart' as c; import 'package:angel3_client/io.dart' as c;
import 'package:angel_framework/angel_framework.dart'; import 'package:angel3_framework/angel3_framework.dart';
import 'package:angel_framework/http.dart'; import 'package:angel3_framework/http.dart';
import 'package:angel_websocket/io.dart' as c; import 'package:angel3_websocket/io.dart' as c;
import 'package:angel_websocket/server.dart'; import 'package:angel3_websocket/server.dart';
import 'package:logging/logging.dart'; import 'package:logging/logging.dart';
import 'package:test/test.dart'; import 'package:test/test.dart';

4
packages/websocket/test/controller/common.dart
View file

@ -1,5 +1,5 @@
import 'package:angel_framework/angel_framework.dart'; import 'package:angel3_framework/angel3_framework.dart';
import 'package:angel_websocket/server.dart'; import 'package:angel3_websocket/server.dart';
class Game { class Game {
final String? playerOne, playerTwo; final String? playerOne, playerTwo;

10
packages/websocket/test/controller/io_test.dart
View file

@ -1,9 +1,9 @@
import 'dart:io'; import 'dart:io';
import 'package:angel_container/mirrors.dart'; import 'package:angel3_container/mirrors.dart';
import 'package:angel_framework/angel_framework.dart' as srv; import 'package:angel3_framework/angel3_framework.dart' as srv;
import 'package:angel_framework/http.dart' as srv; import 'package:angel3_framework/http.dart' as srv;
import 'package:angel_websocket/io.dart' as ws; import 'package:angel3_websocket/io.dart' as ws;
import 'package:angel_websocket/server.dart' as srv; import 'package:angel3_websocket/server.dart' as srv;
import 'package:logging/logging.dart'; import 'package:logging/logging.dart';
import 'package:test/test.dart'; import 'package:test/test.dart';
import 'common.dart'; import 'common.dart';

8
packages/websocket/test/service/common.dart
View file

@ -1,9 +1,9 @@
import 'dart:async'; import 'dart:async';
import 'package:angel_framework/angel_framework.dart'; import 'package:angel3_framework/angel3_framework.dart';
import 'package:angel_model/angel_model.dart'; import 'package:angel3_model/angel3_model.dart';
import 'package:angel_websocket/base_websocket_client.dart'; import 'package:angel3_websocket/base_websocket_client.dart';
import 'package:angel_websocket/server.dart'; import 'package:angel3_websocket/server.dart';
import 'package:test/test.dart'; import 'package:test/test.dart';
class Todo extends Model { class Todo extends Model {

10
packages/websocket/test/service/io_test.dart
View file

@ -1,9 +1,9 @@
import 'dart:io'; import 'dart:io';
import 'package:angel_container/mirrors.dart'; import 'package:angel3_container/mirrors.dart';
import 'package:angel_framework/angel_framework.dart' as srv; import 'package:angel3_framework/angel3_framework.dart' as srv;
import 'package:angel_framework/http.dart' as srv; import 'package:angel3_framework/http.dart' as srv;
import 'package:angel_websocket/io.dart' as ws; import 'package:angel3_websocket/io.dart' as ws;
import 'package:angel_websocket/server.dart' as srv; import 'package:angel3_websocket/server.dart' as srv;
import 'package:logging/logging.dart'; import 'package:logging/logging.dart';
import 'package:test/test.dart'; import 'package:test/test.dart';
import 'common.dart'; import 'common.dart';

2
packages/websocket/web/main.dart
View file

@ -1,5 +1,5 @@
import 'dart:html'; import 'dart:html';
import 'package:angel_websocket/browser.dart'; import 'package:angel3_websocket/browser.dart';
/// Dummy app to ensure client works with DDC. /// Dummy app to ensure client works with DDC.
void main() { void main() {