Reorder Source/FlowWithContext type parameters (#5648)

Co-authored-by: Aaron Stannard <aaron@petabridge.com>

src/core/Akka.Streams.Tests/Dsl/FlowWithContextSpec.cs

@@ -0,0 +1,80 @@
+//-----------------------------------------------------------------------
+// <copyright file="FlowWithContextSpec.cs" company="Akka.NET Project">
+//     Copyright (C) 2009-2021 Lightbend Inc. <http://www.lightbend.com>
+//     Copyright (C) 2013-2021 .NET Foundation <https://github.com/akkadotnet/akka.net>
+// </copyright>
+//-----------------------------------------------------------------------
+
+using System;
+using System.Linq;
+using Akka.Streams.Dsl;
+using Akka.Streams.TestKit;
+using Akka.TestKit;
+using Xunit;
+using Xunit.Abstractions;
+
+namespace Akka.Streams.Tests.Dsl
+{
+    public class FlowWithContextSpec : AkkaSpec
+    {
+        private ActorMaterializer Materializer { get; }
+
+        public FlowWithContextSpec(ITestOutputHelper helper) : base(helper)
+        {
+            var settings = ActorMaterializerSettings.Create(Sys);
+            Materializer = ActorMaterializer.Create(Sys, settings);
+        }
+
+        [Fact]
+        public void A_FlowWithContext_must_get_created_from_FlowAsFlowWithContext()
+        {
+            var flow = Flow.Create<Message>().Select(m => m.Copy(data: m.Data + "z"));
+            var flowWithContext = flow.AsFlowWithContext<Message, long, Message, long, NotUsed, Message>((m, o) => new Message(m.Data, o), m => m.Offset);
+
+            Source.From(new[] { new Message("a", 1L) })
+                .AsSourceWithContext(m => m.Offset)
+                .Via(flowWithContext)
+                .AsSource()
+                .RunWith(this.SinkProbe<(Message, long)>(), Materializer)
+                .Request(1)
+                .ExpectNext((new Message("az", 1L), 1L))
+                .ExpectComplete();
+        }
+    }
+
+    sealed class Message : IEquatable<Message>
+    {
+        public string Data { get; }
+        public long Offset { get; }
+
+        public Message(string data, long offset)
+        {
+            Data = data;
+            Offset = offset;
+        }
+
+        public Message Copy(string data = null, long? offset = null) => new Message(data ?? Data, offset ?? Offset);
+
+        public bool Equals(Message other)
+        {
+            if (other is null) return false;
+            if (ReferenceEquals(this, other)) return true;
+            return string.Equals(Data, other.Data) && Offset == other.Offset;
+        }
+
+        public override bool Equals(object obj)
+        {
+            if (obj is null) return false;
+            if (ReferenceEquals(this, obj)) return true;
+            return obj is Message other && Equals(other);
+        }
+
+        public override int GetHashCode()
+        {
+            unchecked
+            {
+                return ((Data != null ? Data.GetHashCode() : 0) * 397) ^ Offset.GetHashCode();
+            }
+        }
+    }
+}

src/core/Akka.Streams.Tests/Dsl/SourceWithContextSpec.cs

@@ -126,17 +126,14 @@ public void SourceWithContext_must_pass_through_context_using_Select_and_Where()
         [Fact]
         public void SourceWithContext_must_pass_through_context_using_FlowWithContext()
         {
-            var flowWithContext = FlowWithContext.Create<long, string>();
-
-            var msg = new Message("a", 1);
+            var flowWithContext = FlowWithContext.Create<string, long>();
 
             var sink = this.CreateSubscriberProbe<(string, long)>();
 
-            Source.From(new[] { msg })
+            Source.From(new[] { new Message("a", 1L) })
                 .AsSourceWithContext(x => x.Offset)
                 .Select(x => x.Data)
                 .Via(flowWithContext.Select(s => s + "b"))
-                .AsSource()
                 .RunWith(Sink.FromSubscriber(sink), Materializer);
 
             var sub = sink.ExpectSubscription();

src/core/Akka.Streams.Tests/Dsl/WithContextUsageSpec.cs

@@ -214,7 +214,7 @@ private static CommittableMessage<Record>[] GenInput(int start, int end) =>
                     new CommittableMessage<Record>(new Record(GenKey(i), GenValue(i)), new CommittableOffsetImpl(i)))
                 .ToArray();
 
-        private static SourceWithContext<Offset, Record, NotUsed> CreateSourceWithContext(
+        private static SourceWithContext<Record, Offset, NotUsed> CreateSourceWithContext(
             params CommittableMessage<Record>[] messages) =>
             CommittableConsumer.CommittableSource(messages)
                 .AsSourceWithContext(m => new Offset(m.Offset.Offset))

src/core/Akka.Streams/Dsl/FlowOperations.cs

@@ -2399,7 +2399,7 @@ public static Flow<T, T, TMat> Watch<T, TMat>(this Flow<T, T, TMat> flow, IActor
         /// <typeparam name="TCtxOut">Resulting context type</typeparam>
         /// <typeparam name="TMat">Materialized value type</typeparam>
         /// <typeparam name="TIn2">Type of passed flow elements</typeparam>
-        public static FlowWithContext<TCtxIn, TIn, TCtxOut, TOut, TMat> AsFlowWithContext<TCtxIn, TIn, TCtxOut, TOut, TMat, TIn2>(
+        public static FlowWithContext<TIn, TCtxIn, TOut, TCtxOut, TMat> AsFlowWithContext<TIn, TCtxIn, TOut, TCtxOut, TMat, TIn2>(
             this Flow<TIn2, TOut, TMat> flow,
             Func<TIn, TCtxIn, TIn2> collapseContext,
             Func<TOut, TCtxOut> extractContext)

src/core/Akka.Streams/Dsl/FlowWithContext.cs

@@ -7,6 +7,7 @@
 
 using System;
 using System.Runtime.CompilerServices;
+using Akka.Annotations;
 
 namespace Akka.Streams.Dsl
 {
@@ -17,28 +18,27 @@ namespace Akka.Streams.Dsl
     /// operations.
     /// 
     /// An "empty" flow can be created by calling <see cref="FlowWithContext.Create{TCtx,TIn}"/>.
-    /// 
-    /// API MAY CHANGE
-    ///</summary> 
-    public sealed class FlowWithContext<TCtxIn, TIn, TCtxOut, TOut, TMat>
+    ///</summary>
+    [ApiMayChange]
+    public sealed class FlowWithContext<TIn, TCtxIn, TOut, TCtxOut, TMat>
         : GraphDelegate<FlowShape<(TIn, TCtxIn), (TOut, TCtxOut)>, TMat>
     {
-        internal FlowWithContext(Flow<(TIn, TCtxIn), (TOut, TCtxOut), TMat> flow) 
+        internal FlowWithContext(Flow<(TIn, TCtxIn), (TOut, TCtxOut), TMat> flow)
             : base(flow)
         {
         }
-        
+
         ///<summary>
         /// Transform this flow by the regular flow. The given flow must support manual context propagation by
         /// taking and producing tuples of (data, context).
         /// 
         /// This can be used as an escape hatch for operations that are not (yet) provided with automatic
         /// context propagation here.
         ///</summary>
-        public FlowWithContext<TCtxIn, TIn, TCtx2, TOut2, TMat> Via<TCtx2, TOut2, TMat2>(
+        public FlowWithContext<TIn, TCtxIn, TOut2, TCtx2, TMat> Via<TOut2, TCtx2, TMat2>(
             IGraph<FlowShape<(TOut, TCtxOut), (TOut2, TCtx2)>, TMat2> viaFlow) =>
             FlowWithContext.From(Flow.FromGraph(Inner).Via(viaFlow));
-        
+
         ///<summary>
         /// Transform this flow by the regular flow. The given flow must support manual context propagation by
         /// taking and producing tuples of (data, context).
@@ -49,7 +49,7 @@ public FlowWithContext<TCtxIn, TIn, TCtx2, TOut2, TMat> Via<TCtx2, TOut2, TMat2>
         /// The <paramref name="combine"/> function is used to compose the materialized values of this flow and that
         /// flow into the materialized value of the resulting Flow.
         ///</summary>
-        public FlowWithContext<TCtxIn, TIn, TCtx2, TOut2, TMat3> ViaMaterialized<TCtx2, TOut2, TMat2, TMat3>(
+        public FlowWithContext<TIn, TCtxIn, TOut2, TCtx2, TMat3> ViaMaterialized<TOut2, TCtx2, TMat2, TMat3>(
             IGraph<FlowShape<(TOut, TCtxOut), (TOut2, TCtx2)>, TMat2> viaFlow, Func<TMat, TMat2, TMat3> combine) =>
             FlowWithContext.From(Flow.FromGraph(Inner).ViaMaterialized(viaFlow, combine));
 
@@ -60,17 +60,17 @@ public FlowWithContext<TCtxIn, TIn, TCtx2, TOut2, TMat3> ViaMaterialized<TCtx2,
     public static class FlowWithContext
     {
         /// <summary>
-        /// Creates an "empty" <see cref="FlowWithContext{TCtxIn,TIn,TCtxOut,TOut,TMat}"/> that passes elements through with their context unchanged.
+        /// Creates an "empty" <see cref="FlowWithContext{TIn,TCtxIn,TOut,TCtxOut,TMat}"/> that passes elements through with their context unchanged.
         /// </summary>
-        /// <typeparam name="TCtx"></typeparam>
         /// <typeparam name="TIn"></typeparam>
+        /// <typeparam name="TCtx"></typeparam>
         /// <returns></returns>
-        public static FlowWithContext<TCtx, TIn, TCtx, TIn, NotUsed> Create<TCtx, TIn>()
+        public static FlowWithContext<TIn, TCtx, TIn, TCtx, NotUsed> Create<TIn, TCtx>()
         {
             var under = Flow.Create<(TIn, TCtx), NotUsed>();
-            return new FlowWithContext<TCtx, TIn, TCtx, TIn, NotUsed>(under);
+            return new FlowWithContext<TIn, TCtx, TIn, TCtx, NotUsed>(under);
         }
-        
+
         /// <summary>
         /// Creates a FlowWithContext from a regular flow that operates on a pair of `(data, context)` elements.
         /// </summary>
@@ -81,8 +81,8 @@ public static FlowWithContext<TCtx, TIn, TCtx, TIn, NotUsed> Create<TCtx, TIn>()
         /// <typeparam name="TOut"></typeparam>
         /// <typeparam name="TMat"></typeparam>
         /// <returns></returns>
-        public static FlowWithContext<TCtxIn, TIn, TCtxOut, TOut, TMat> From<TCtxIn, TIn, TCtxOut, TOut, TMat>(
-            Flow<(TIn, TCtxIn), (TOut, TCtxOut), TMat> flow) => 
-            new FlowWithContext<TCtxIn, TIn, TCtxOut, TOut, TMat>(flow);
+        public static FlowWithContext<TIn, TCtxIn, TOut, TCtxOut, TMat> From<TIn, TCtxIn, TOut, TCtxOut, TMat>(
+            Flow<(TIn, TCtxIn), (TOut, TCtxOut), TMat> flow) =>
+            new FlowWithContext<TIn, TCtxIn, TOut, TCtxOut, TMat>(flow);
     }
 }