Merge branch 'main' into patch-2

Author: abelbraaksma

.github/workflows/test-report.yaml

@@ -0,0 +1,31 @@
+name: ci-report
+
+# See Dorny instructions for why we need a separate yaml for creating a test report
+# for public repositories that accept forks:
+# https://github.com/dorny/test-reporter#recommended-setup-for-public-repositories
+
+on:
+  workflow_run:
+    workflows: ['ci-test']               # runs after CI workflow
+    types:
+      - completed
+jobs:
+  test-report-release:
+    runs-on: windows-latest
+    steps:
+    - uses: dorny/test-reporter@v1
+      with:
+        artifact: test-results-release    # artifact name
+        name: Report release tests         # Name of the check run which will be created
+        path: '*.trx'                     # Path to test results (inside artifact .zip)
+        reporter: dotnet-trx              # Format of test results
+
+  test-report-debug:
+    runs-on: windows-latest
+    steps:
+    - uses: dorny/test-reporter@v1
+      with:
+        artifact: test-results-debug      # artifact name
+        name: Report debug tests           # Name of the check run which will be created
+        path: '*.trx'                     # Path to test results (inside artifact .zip)
+        reporter: dotnet-trx              # Format of test results

.github/workflows/test.yaml

@@ -2,11 +2,6 @@ name: ci-test
 
 on: [pull_request]
 
-permissions:
-  id-token: write
-  contents: read
-  checks: write
-
 jobs:
   test-release:
     name: Test Release Build
@@ -17,20 +12,23 @@ jobs:
         uses: actions/checkout@v3
         with:
           fetch-depth: 0
+
       # setup dotnet based on global.json
       - name: setup-dotnet
         uses: actions/setup-dotnet@v3
+
       # build it, test it
       - name: Run dotnet test - release
         run: ./build.cmd ci -release
-      - name: Publish test results - release
-        uses: dorny/test-reporter@v1
-        if: always()
+
+      # upload test results
+      - uses: actions/upload-artifact@v2
+        if: success() || failure()
         with:
-          name: Report release tests
+          name: test-results-release
           # this path glob pattern requires forward slashes!
           path: ./src/FSharp.Control.TaskSeq.Test/TestResults/test-results-release.trx
-          reporter: dotnet-trx
+
 
   test-debug:
     name: Test Debug Build
@@ -41,17 +39,19 @@ jobs:
         uses: actions/checkout@v3
         with:
           fetch-depth: 0
+
       # setup dotnet based on global.json
       - name: setup-dotnet
         uses: actions/setup-dotnet@v3
+
       # build it, test it
       - name: Run dotnet test - debug
         run: ./build.cmd ci -debug
-      - name: Publish test results - debug
-        uses: dorny/test-reporter@v1
-        if: always()
+
+      # upload test results
+      - uses: actions/upload-artifact@v2
+        if: success() || failure()
         with:
-          name: Report debug tests
+          name: test-results-debug
           # this path glob pattern requires forward slashes!
           path: ./src/FSharp.Control.TaskSeq.Test/TestResults/test-results-debug.trx
-          reporter: dotnet-trx

src/FSharp.Control.TaskSeq.Test/FSharp.Control.TaskSeq.Test.fsproj

@@ -54,7 +54,7 @@
     <!-- align test project with minimal required version for TaskSeq -->
     <!-- we use 6.0.3 here and not 6.0.2 because TaskResult lib requires it-->
     <PackageReference Update="FSharp.Core" Version="6.0.3" />
-    <PackageReference Include="FsToolkit.ErrorHandling.TaskResult" Version="3.2.0" />
+    <PackageReference Include="FsToolkit.ErrorHandling.TaskResult" Version="4.0.0" />
     <PackageReference Include="FsUnit.xUnit" Version="5.1.0" />
     <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.4.0" />
     <PackageReference Include="xunit" Version="2.4.2" />

src/FSharp.Control.TaskSeq.Test/TaskSeq.Zip.Tests.fs

@@ -132,32 +132,3 @@ module Other =
 
         combined |> should equal [| ("one", 42L); ("two", 43L) |]
     }
-
-    [<Theory; InlineData true; InlineData false>]
-    let ``TaskSeq-zip throws on unequal lengths, variant`` leftThrows = task {
-        let long = Gen.sideEffectTaskSeq 11
-        let short = Gen.sideEffectTaskSeq 10
-
-        let combined =
-            if leftThrows then
-                TaskSeq.zip short long
-            else
-                TaskSeq.zip long short
-
-        fun () -> TaskSeq.toArrayAsync combined |> Task.ignore
-        |> should throwAsyncExact typeof<ArgumentException>
-    }
-
-    [<Theory; InlineData true; InlineData false>]
-    let ``TaskSeq-zip throws on unequal lengths with empty seq`` leftThrows = task {
-        let one = Gen.sideEffectTaskSeq 1
-
-        let combined =
-            if leftThrows then
-                TaskSeq.zip TaskSeq.empty one
-            else
-                TaskSeq.zip one TaskSeq.empty
-
-        fun () -> TaskSeq.toArrayAsync combined |> Task.ignore
-        |> should throwAsyncExact typeof<ArgumentException>
-    }

src/FSharp.Control.TaskSeq.sln

@@ -21,6 +21,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "workflows", "workflows", "{
 		..\.github\dependabot.yml = ..\.github\dependabot.yml
 		..\.github\workflows\main.yaml = ..\.github\workflows\main.yaml
 		..\.github\workflows\publish.yaml = ..\.github\workflows\publish.yaml
+		..\.github\workflows\test-report.yaml = ..\.github\workflows\test-report.yaml
 		..\.github\workflows\test.yaml = ..\.github\workflows\test.yaml
 	EndProjectSection
 EndProject

src/FSharp.Control.TaskSeq/FSharp.Control.TaskSeq.fsproj

@@ -23,6 +23,9 @@ Generates optimized IL code through the new resumable state machines, and comes
     <PackageReadmeFile>nuget-package-readme.md</PackageReadmeFile>
     <PackageReleaseNotes>
       Release notes:
+      0.2.3
+       - improve TaskSeq.empty by not relying on resumable state, #89
+       - do not throw exception for unequal lengths in TaskSeq.zip, fixes #32
       0.2.2
        - removes TaskSeq.toSeqCachedAsync, which was incorrectly named. Use toSeq or toListAsync instead.
        - renames TaskSeq.toSeqCached to TaskSeq.toSeq, which was its actual operational behavior.

src/FSharp.Control.TaskSeq/TaskSeq.fs

@@ -11,11 +11,16 @@ module TaskSeq =
     // Just for convenience
     module Internal = TaskSeqInternal
 
-    let empty<'T> = taskSeq {
-        for c: 'T in [] do
-            yield c
-    }
-    
+    let empty<'T> =
+        { new IAsyncEnumerable<'T> with
+            member _.GetAsyncEnumerator(_) =
+                { new IAsyncEnumerator<'T> with
+                    member _.MoveNextAsync() = ValueTask.False
+                    member _.Current = Unchecked.defaultof<'T>
+                    member _.DisposeAsync() = ValueTask.CompletedTask
+                }
+        }
+
     let singleton (source: 'T) =
         { new IAsyncEnumerable<'T> with
             member _.GetAsyncEnumerator(_) =
@@ -27,8 +32,6 @@ module TaskSeq =
                         r                        
                     member _.get_Current () : 'T = if started then source else invalidOp "Enumeration has not started. Call MoveNextAsync."
                     member _.DisposeAsync () = ValueTask.CompletedTask
-                }
-        }
 
     let isEmpty source = Internal.isEmpty source
 

src/FSharp.Control.TaskSeq/TaskSeqBuilder.fs

@@ -13,6 +13,7 @@ open System.Threading.Tasks.Sources
 
 open FSharp.Core.CompilerServices
 open FSharp.Core.CompilerServices.StateMachineHelpers
+open FSharp.Control
 
 
 [<AutoOpen>]
@@ -279,14 +280,14 @@ and [<NoComparison; NoEquality>] TaskSeq<'Machine, 'T
             if this._machine.ResumptionPoint = -1 then // can't use as IAsyncEnumerator before IAsyncEnumerable
                 logInfo "at MoveNextAsync: Resumption point = -1"
 
-                ValueTask<bool>()
+                ValueTask.False
 
             elif this._machine.Data.completed then
                 logInfo "at MoveNextAsync: completed = true"
 
                 // return False when beyond the last item
                 this._machine.Data.promiseOfValueOrEnd.Reset()
-                ValueTask<bool>()
+                ValueTask.False
 
             else
                 logInfo "at MoveNextAsync: normal resumption scenario"
@@ -343,18 +344,18 @@ and [<NoComparison; NoEquality>] TaskSeq<'Machine, 'T
                 // the Current value
                 data.current <- ValueNone
 
-            ValueTask<bool>(result)
+            ValueTask.FromResult result
 
         | ValueTaskSourceStatus.Faulted
         | ValueTaskSourceStatus.Canceled
         | ValueTaskSourceStatus.Pending as state ->
             logInfo ("at MoveNextAsyncResult: case ", state)
 
-            ValueTask<bool>(this, version) // uses IValueTaskSource<'T>
+            ValueTask.ofIValueTaskSource this version
         | _ ->
             logInfo "at MoveNextAsyncResult: Unexpected state"
             // assume it's a possibly new, not yet supported case, treat as default
-            ValueTask<bool>(this, version) // uses IValueTaskSource<'T>
+            ValueTask.ofIValueTaskSource this version
 
 and TaskSeqCode<'T> = ResumableCode<TaskSeqStateMachineData<'T>, unit>
 and TaskSeqStateMachine<'T> = ResumableStateMachine<TaskSeqStateMachineData<'T>>

src/FSharp.Control.TaskSeq/TaskSeqInternal.fs

@@ -272,28 +272,17 @@ module internal TaskSeqInternal =
           }
 
     let zip (source1: taskSeq<_>) (source2: taskSeq<_>) = taskSeq {
-        let inline validate step1 step2 =
-            if step1 <> step2 then
-                if step1 then
-                    invalidArg "taskSequence1" "The task sequences have different lengths."
-
-                if step2 then
-                    invalidArg "taskSequence2" "The task sequences have different lengths."
-
-
         use e1 = source1.GetAsyncEnumerator(CancellationToken())
         use e2 = source2.GetAsyncEnumerator(CancellationToken())
         let mutable go = true
         let! step1 = e1.MoveNextAsync()
         let! step2 = e2.MoveNextAsync()
         go <- step1 && step2
-        validate step1 step2
 
         while go do
             yield e1.Current, e2.Current
             let! step1 = e1.MoveNextAsync()
             let! step2 = e2.MoveNextAsync()
-            validate step1 step2
             go <- step1 && step2
     }
 

src/FSharp.Control.TaskSeq/Utils.fs

@@ -5,12 +5,26 @@ open System.Threading.Tasks
 [<AutoOpen>]
 module ValueTaskExtensions =
     /// Extensions for ValueTask that are not available in NetStandard 2.1, but are
-    /// available in .NET 5+.
+    /// available in .NET 5+. We put them in Extension space to mimic the behavior of NetStandard 2.1
     type ValueTask with
 
         /// (Extension member) Gets a task that has already completed successfully.
         static member inline CompletedTask = Unchecked.defaultof<ValueTask>
 
+
+module ValueTask =
+    /// A successfully completed ValueTask of boolean that has the value false.
+    let False = ValueTask<bool>()
+
+    /// A successfully completed ValueTask of boolean that has the value true.
+    let True = ValueTask<bool> true
+
+    /// Creates a ValueTask with the supplied result of the successful operation.
+    let inline FromResult (x: 'T) = ValueTask<'T> x
+
+    /// Creates a ValueTask with an IValueTaskSource representing the operation
+    let inline ofIValueTaskSource taskSource version = ValueTask<bool>(taskSource, version)
+
 module Task =
     /// Convert an Async<'T> into a Task<'T>
     let inline ofAsync (async: Async<'T>) = task { return! async }