Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions packages/config/lib/src/command/command_middleware.dart
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ class CommandMiddlewareComposer<O extends OptionDefinition, T>
super.onRun,
super.onReturn,
super.onError,
super.onFinally,
});
}

Expand All @@ -33,11 +34,13 @@ abstract class Middlewares {
final OnRun<CommandContext<O, T>>? onRun,
final OnReturn<T?, CommandContext<O, T>>? onReturn,
final OnError<T?, CommandContext<O, T>>? onError,
final OnFinally<CommandContext<O, T>>? onFinally,
}) {
return CommandMiddlewareComposer<O, T>(
onRun: onRun,
onReturn: onReturn,
onError: onError,
onFinally: onFinally,
).middleware;
}

Expand Down Expand Up @@ -81,4 +84,13 @@ abstract class Middlewares {
) {
return withHooks(onError: onError);
}

/// Creates a [CommandMiddleware] with the given [onFinally] hook.
///
/// See [MiddlewareHooks.onFinally].
static CommandMiddleware<O, T> onFinally<O extends OptionDefinition, T>(
final OnFinally<CommandContext<O, T>> onFinally,
) {
return withHooks(onFinally: onFinally);
}
}
51 changes: 35 additions & 16 deletions packages/config/lib/src/middleware/middleware_hooks.dart
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,19 @@ class MiddlewareHooks<R, A> {
Handler<FutureOr<R>, A> middleware(final Handler<FutureOr<R>, A> next) {
return (final A arg) async {
final useArg = await onRun(arg);
final R response;
try {
response = await next(useArg);
} catch (error, stackTrace) {
return await onError(error, stackTrace, useArg);
final R response;
try {
response = await next(useArg);
} catch (error, stackTrace) {
return await onError(error, stackTrace, useArg);
}
return await onReturn(useArg, response);
} finally {
try {
await onFinally(useArg);
} catch (_) {}
}
return await onReturn(useArg, response);
};
}

Expand All @@ -49,23 +55,28 @@ class MiddlewareHooks<R, A> {

/// Hook method that is called if the next handler throws.
///
/// Returns the same type as the next handler's return type.
///
/// If it throws, the call chain is aborted
/// and the exception propagates to the caller.
/// If it returns a value, this handler completes normally with that value.
/// Otherwise the exception propagates to the caller.
FutureOr<R> onError(
final Object error,
final StackTrace stackTrace,
final A arg,
) {
Error.throwWithStackTrace(error, stackTrace);
}

/// Hook method that is called after the next handler returns or throws,
/// after the [onReturn] / [onError] hook has run.
///
/// Errors thrown from this method are ignored.
FutureOr<void> onFinally(final A arg) {}
}

typedef OnRun<A> = FutureOr<A> Function(A arg);
typedef OnReturn<R, A> = FutureOr<R> Function(A arg, R response);
typedef OnError<R, A> =
FutureOr<R> Function(Object error, StackTrace stackTrace, A arg);
typedef OnFinally<A> = FutureOr<void> Function(A arg);

/// Helper class for easy composition with hook functions.
///
Expand All @@ -82,28 +93,29 @@ class MiddlewareComposer<R, A> extends MiddlewareHooks<R, A> {
final OnRun<A>? _onRun;
final OnReturn<R, A>? _onReturn;
final OnError<R, A>? _onError;
final OnFinally<A>? _onFinally;

/// Compose a middleware with one or more hook functions.
const MiddlewareComposer({
final OnRun<A>? onRun,
final OnReturn<R, A>? onReturn,
final OnError<R, A>? onError,
final OnFinally<A>? onFinally,
}) : _onRun = onRun,
_onReturn = onReturn,
_onError = onError;
_onError = onError,
_onFinally = onFinally;

@override
FutureOr<A> onRun(final A arg) {
final onRun = _onRun;
if (onRun == null) return arg;
return onRun(arg);
if (_onRun == null) return arg;
return _onRun(arg);
}

@override
FutureOr<R> onReturn(final A arg, final R response) {
final onReturn = _onReturn;
if (onReturn == null) return response;
return onReturn(arg, response);
if (_onReturn == null) return response;
return _onReturn(arg, response);
}

@override
Expand All @@ -117,4 +129,11 @@ class MiddlewareComposer<R, A> extends MiddlewareHooks<R, A> {
}
Error.throwWithStackTrace(error, stackTrace);
}

@override
FutureOr<void> onFinally(final A arg) {
if (_onFinally != null) {
return _onFinally(arg);
}
}
}
Loading
Loading