Merge pull request #425 from timcassell/develop

Merge v3.0.1 to master

DeveloperNotes.txt

@@ -1,7 +1,5 @@
 For each new release:
 
-Before releasing, test the demo scene in Unity 5.5 to make sure it works (no need to run tests as the test runner didn't exist back then).
-
 Update the version in `ProtoPromise.csproj`, `ProtoPromise.UnityHelpers/**.csproj`s, and `package.json`.
 
 

Docs/Changelog/v3.0.1.md

@@ -0,0 +1,7 @@
+# Change Log
+
+## v3.0.1 - April 6, 2024
+
+Fixes:
+
+- `Fixed Promise<T>.IsValid` when it was completed synchronously.

Package/Core/Promises/Promise.cs

@@ -47,15 +47,8 @@ public static implicit operator System.Threading.Tasks.ValueTask(in Promise rhs)
         /// Gets whether this instance is valid to be awaited.
         /// </summary>
         public bool IsValid
-        {
-            [MethodImpl(Internal.InlineOption)]
-            get
-            {
-                // I would prefer to have a null ref only valid if the promise was created from Promise.Resolved, but it's more efficient to allow default values to be valid.
-                var r = _ref;
-                return r == null || r.GetIsValid(_id);
-            }
-        }
+            // I would prefer to have a null ref only valid if the promise was created from Promise.Resolved, but it's more efficient to allow default values to be valid.
+            => _ref?.GetIsValid(_id) != false;
 
         /// <summary>
         /// Mark this as awaited and get a new <see cref="Promise"/> that inherits the state of this and can be awaited multiple times until <see cref="Forget"/> is called on it.

Package/Core/Promises/PromiseStaticRace.cs

@@ -657,7 +657,7 @@ public static Promise<T> First<T, TEnumerator>(TEnumerator promises) where TEnum
         /// Returns a <see cref="Promise{T}"/> of <see cref="ValueTuple{T1, T2}"/> that will resolve when the first of the promises has resolved with the index and result of that promise.
         /// If any promise is rejected or canceled, the returned <see cref="Promise{T}"/> will immediately be canceled or rejected with the same reason.
         /// </summary>
-        public static Promise<(int, T)> RaceWithIndex<T, TEnumerator>(TEnumerator promises) where TEnumerator : IEnumerator<Promise<T>>
+        public static Promise<(int winIndex, T result)> RaceWithIndex<T, TEnumerator>(TEnumerator promises) where TEnumerator : IEnumerator<Promise<T>>
         {
             ValidateArgument(promises, nameof(promises), 1);
 
@@ -780,7 +780,7 @@ public static Promise<T> First<T, TEnumerator>(TEnumerator promises) where TEnum
         /// Returns a <see cref="Promise{T}"/> of <see cref="ValueTuple{T1, T2}"/> that will resolve when the first of the promises has resolved with the index and result of that promise.
         /// If all promises are rejected or canceled, the returned <see cref="Promise{T}"/> will be canceled or rejected with the same reason as the last <see cref="Promise{T}"/> that is rejected or canceled.
         /// </summary>
-        public static Promise<(int, T)> FirstWithIndex<T, TEnumerator>(TEnumerator promises) where TEnumerator : IEnumerator<Promise<T>>
+        public static Promise<(int winIndex, T result)> FirstWithIndex<T, TEnumerator>(TEnumerator promises) where TEnumerator : IEnumerator<Promise<T>>
         {
             ValidateArgument(promises, nameof(promises), 1);
 

Package/Core/Promises/PromiseT.cs

@@ -68,7 +68,7 @@ public static implicit operator System.Threading.Tasks.ValueTask(in Promise<T> r
         /// </summary>
         public bool IsValid
             // I would prefer to have a null ref only valid if the promise was created from Promise.Resolved, but it's more efficient to allow default values to be valid.
-            => _ref?.GetIsValid(_id) == true;
+            => _ref?.GetIsValid(_id) != false;
 
         /// <summary>
         /// Cast to <see cref="Promise"/>.

Package/README.md

@@ -49,13 +49,9 @@ See the [C# Asynchronous Benchmarks Repo](https://github.com/timcassell/CSharpAs
 
 ## Latest Updates
 
-### v3.0.0 - March 18, 2024
+### v3.0.1 - April 6, 2024
 
-- Added `UnityEngine.Awaitable` extensions to convert to `Promise`.
-- Added API overloads accepting `ReadOnlySpan<T>` parameter.
-- Improved performance and reduced memory.
-- Removed support for runtimes older than .Net Standard 2.0.
-- Removed deprecated and useless APIs.
+- `Fixed Promise<T>.IsValid` when it was completed synchronously.
 
 See [ChangeLog](https://github.com/timcassell/ProtoPromise/tree/master/Docs/Changelog) for the full changelog.
 

Package/Tests/CoreTests/APIs/MiscellaneousTests.cs

@@ -29,6 +29,22 @@ public void Teardown()
             TestHelper.s_expectedUncaughtRejectValue = null;
         }
 
+        [Test]
+        public void PromiseIsValidBeforeAwaited_void()
+        {
+            var promise = Promise.Resolved();
+            Assert.IsTrue(promise.IsValid);
+            promise.Forget();
+        }
+
+        [Test]
+        public void PromiseIsValidBeforeAwaited_T()
+        {
+            var promise = Promise.Resolved(42);
+            Assert.IsTrue(promise.IsValid);
+            promise.Forget();
+        }
+
         [Test]
         public void PromiseIsInvalidAfterAwaited_void()
         {

Package/Tests/CoreTests/APIs/ParallelForEachAsyncTests.cs

@@ -548,8 +548,10 @@ public void ParallelForEachAsync_ExecutionContextFlowsToWorkerBodies(
             {
                 await Promise.SwitchToForegroundAwait(forceAsync: true);
                 Assert.AreEqual(42, al.Value);
-            })
+                al.Value = 43;
+            }, context)
                 .WaitWithTimeoutWhileExecutingForegroundContext(TimeSpan.FromSeconds(Environment.ProcessorCount));
+            Assert.AreEqual(42, al.Value);
         }
 
 #if UNITY_2021_2_OR_NEWER || !UNITY_2018_3_OR_NEWER

Package/Tests/CoreTests/APIs/ParallelForTests.cs

@@ -547,8 +547,10 @@ public void ParallelFor_ExecutionContextFlowsToWorkerBodies(
             {
                 await Promise.SwitchToForegroundAwait(forceAsync: true);
                 Assert.AreEqual(42, al.Value);
-            })
+                al.Value = 43;
+            }, context)
                 .WaitWithTimeoutWhileExecutingForegroundContext(TimeSpan.FromSeconds(Environment.ProcessorCount));
+            Assert.AreEqual(42, al.Value);
         }
 
         private static IEnumerable<int> Iterate100()
@@ -574,8 +576,10 @@ public void ParallelForEach_ExecutionContextFlowsToWorkerBodies(
             {
                 await Promise.SwitchToForegroundAwait(forceAsync: true);
                 Assert.AreEqual(42, al.Value);
-            })
+                al.Value = 43;
+            }, context)
                 .WaitWithTimeoutWhileExecutingForegroundContext(TimeSpan.FromSeconds(Environment.ProcessorCount));
+            Assert.AreEqual(42, al.Value);
         }
     }
 #endif // !UNITY_WEBGL

Package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "com.timcassell.protopromise",
-    "version": "3.0.0",
+    "version": "3.0.1",
     "displayName": "ProtoPromise",
     "description": "Robust and efficient library for management of asynchronous operations.",
     "changelogUrl": "https://github.com/timcassell/ProtoPromise/tree/master/Docs/Changelog",

ProtoPromise.UnityHelpers/2018.3/ProtoPromise.UnityHelpers.2018.3.csproj

@@ -3,7 +3,7 @@
   <PropertyGroup>
     <!--We target .Net Standard 2.0 to support old Unity versions, and we also target .Net Standard 2.1 to use function pointers.-->
     <TargetFrameworks>netstandard2.0;netstandard2.1</TargetFrameworks>
-    <Version>3.0.0</Version>
+    <Version>3.0.1</Version>
     <!--In case any IL2CPP issues need to be resolved like in the core library.-->
     <DefineConstants>$(DefineConstants);ENABLE_IL2CPP</DefineConstants>
   </PropertyGroup>

ProtoPromise.UnityHelpers/2023.1/ProtoPromise.UnityHelpers.2023.1.csproj

@@ -2,7 +2,7 @@
 
   <PropertyGroup>
     <TargetFrameworks>netstandard2.1</TargetFrameworks>
-    <Version>3.0.0</Version>
+    <Version>3.0.1</Version>
     <!-- The language version Unity supports in 2023.1. -->
     <LangVersion>9</LangVersion>
     <!--In case any IL2CPP issues need to be resolved like in the core library.-->

ProtoPromise/ProtoPromise.csproj

@@ -2,7 +2,7 @@
 
   <PropertyGroup>
     <TargetFrameworks>netstandard2.0;netstandard2.1;net6.0</TargetFrameworks>
-    <Version>3.0.0</Version>
+    <Version>3.0.1</Version>
     <!--Set true to help debug internal promise code (allows the debugger to step into the code and includes internal stacktraces).-->
     <DeveloperMode>false</DeveloperMode>
   </PropertyGroup>