DYN-7925: make access token accessible to all package authors using static method (#15868)

mjkkirschner · web-flow · commit 62fc583e1e9d · 2025-03-03T20:11:24.000-05:00
diff --git a/src/DynamoCore/Configuration/ExecutionSession.cs b/src/DynamoCore/Configuration/ExecutionSession.cs
@@ -1,4 +1,4 @@
-﻿using System;
+using System;
 using System.Collections.Generic;
 using System.IO;
 using Dynamo.Interfaces;
diff --git a/src/DynamoCore/Models/DynamoModel.cs b/src/DynamoCore/Models/DynamoModel.cs
@@ -991,6 +991,11 @@ protected DynamoModel(IStartConfiguration config)
 
             LogWarningMessageEvents.LogWarningMessage += LogWarningMessage;
             LogWarningMessageEvents.LogInfoMessage += LogInfoMessage;
+
+#pragma warning disable AUTH_SERVICES
+            AuthServices.RequestAuthProvider += AuthServicesEvents_AuthProviderRequested;
+#pragma warning restore AUTH_SERVICES
+
             DynamoConsoleLogger.LogMessageToDynamoConsole += LogMessageWrapper;
             DynamoConsoleLogger.LogErrorToDynamoConsole += LogErrorMessageWrapper;
             if (!IsServiceMode)
@@ -1020,6 +1025,11 @@ protected DynamoModel(IStartConfiguration config)
             DynamoReady(new ReadyParams(this));
         }
 
+        private void AuthServicesEvents_AuthProviderRequested(RequestAuthProviderEventArgs args)
+        {
+            args.AuthProvider = AuthenticationManager.AuthProvider;
+        }
+
         /// <summary>
         /// When feature flags received, handle them and make changes 
         /// </summary>
@@ -1461,6 +1471,11 @@ public void Dispose()
 
             LogWarningMessageEvents.LogWarningMessage -= LogWarningMessage;
             LogWarningMessageEvents.LogInfoMessage -= LogInfoMessage;
+
+#pragma warning disable AUTH_SERVICES
+            AuthServices.RequestAuthProvider -= AuthServicesEvents_AuthProviderRequested;
+#pragma warning restore AUTH_SERVICES
+
             DynamoConsoleLogger.LogMessageToDynamoConsole -= LogMessageWrapper;
             DynamoConsoleLogger.LogErrorToDynamoConsole -= LogErrorMessageWrapper;
             foreach (var ws in _workspaces)
diff --git a/src/NodeServices/AuthServices.cs b/src/NodeServices/AuthServices.cs
@@ -0,0 +1,62 @@
+using System;
+using System.Collections.Generic;
+using System.Text;
+
+namespace DynamoServices
+{
+
+    /// <summary>
+    /// Event arguments for the RequestAuthProvider event.
+    /// </summary>
+    internal class RequestAuthProviderEventArgs : EventArgs
+    {
+        /// <summary>
+        /// Gets or sets the found auth provider, if one is found. It's possible that
+        /// this willl be null.
+        /// </summary>
+        internal object AuthProvider { get; set; }
+    }
+
+    /// <summary>
+    /// Delegate for handling the RequestAuthProvider event.
+    /// </summary>
+    /// <param name="args">The event arguments.</param>
+    internal delegate void RequestAuthProviderEventHandler(RequestAuthProviderEventArgs args);
+
+
+    /// <summary>
+    /// Static class containing authentication service events. Useful if you want to make authenticated requests from your nodes.
+    /// </summary>
+    #if NET8_0_OR_GREATER
+        [System.Diagnostics.CodeAnalysis.Experimental("AUTH_SERVICES")]
+#else
+        [Obsolete("This method is for evaluation purposes only and is subject to change or removal in future updates.")]
+#endif
+    public static class AuthServices
+    {
+        /// <summary>
+        /// Event triggered to request an authentication provider.
+        /// </summary>
+        internal static event RequestAuthProviderEventHandler RequestAuthProvider;
+
+        /// <summary>
+        /// Returns the active DynamoModel's AuthProvider.
+        /// </summary>
+        /// <returns>The IOAuth2AccessTokenProvider associated with the active DynamoModel.
+        /// It's possible this property might be null.</returns>
+#if NET8_0_OR_GREATER
+        [System.Diagnostics.CodeAnalysis.Experimental("REQUEST_AUTHPROVIDER")]
+#else
+        [Obsolete("This property is for evaluation purposes only and is subject to change or removal in future updates.")]
+#endif
+        public static object AuthProvider
+        {
+            get
+            {
+                var args = new RequestAuthProviderEventArgs();
+                RequestAuthProvider?.Invoke(args);
+                return args.AuthProvider;
+            }
+        }
+    }
+}
diff --git a/src/NodeServices/DynamoServices.csproj b/src/NodeServices/DynamoServices.csproj
@@ -11,7 +11,7 @@
     <RootNamespace>DynamoServices</RootNamespace>
     <AssemblyName>DynamoServices</AssemblyName>
     <DocumentationFile>$(OutputPath)\DynamoServices.XML</DocumentationFile>
-    <TargetFramework>netstandard2.0</TargetFramework>
+    <TargetFrameworks>netstandard2.0;net8.0</TargetFrameworks>
   </PropertyGroup>
   <PropertyGroup>
     <NoWarn>MSB3539;CS1591;NUnit2005;NUnit2007;CS0618;CS0612;CS0672</NoWarn>
diff --git a/src/NodeServices/ExecutionSession.cs b/src/NodeServices/ExecutionSession.cs
@@ -81,6 +81,5 @@ public class ParameterKeys
         /// The return value is an ILogger
         /// </summary>
         public static readonly string Logger = nameof(Logger);
-        
     }
 }
diff --git a/test/DynamoCoreTests/AuthenticationManagerTests.cs b/test/DynamoCoreTests/AuthenticationManagerTests.cs
@@ -1,7 +1,10 @@
 using Dynamo.Core;
-
+using Dynamo.Interfaces;
+using Dynamo.Models;
+using Dynamo.Scheduler;
+using DynamoServices;
 using Greg;
-
+using Greg.AuthProviders;
 using Moq;
 
 using NUnit.Framework;
@@ -31,7 +34,7 @@ public void Logout_CausesLogoutMethodToBeInvokedOnAuthProvider()
 
             Assert.IsTrue(logoutCalled);
         }
-        
+
         #endregion
 
         #region Login
@@ -118,4 +121,39 @@ public void Property_LoginState()
 
         #endregion
     }
+
+    [TestFixture]
+    public class AuthServicesTests : DynamoModelTestBase
+    {
+
+        protected override DynamoModel.IStartConfiguration CreateStartConfiguration(IPreferences settings)
+        {
+            var authProviderMock = new Mock<IAuthProvider>();
+            authProviderMock.Setup(x => x.LoginState).Returns(LoginState.LoggedIn);
+            authProviderMock.As<IOAuth2AccessTokenProvider>().Setup(x => x.GetAccessToken()).Returns("faketoken");
+
+
+            return new DynamoModel.DefaultStartConfiguration()
+            {
+                PathResolver = pathResolver,
+                StartInTestMode = true,
+                GeometryFactoryPath = preloader.GeometryFactoryPath,
+                Preferences = settings,
+                ProcessMode = TaskProcessMode.Synchronous,
+                AuthProvider = authProviderMock.Object
+            };
+        }
+
+        [Test]
+        public void Test_OnRequestAuthProvider_FindsAuthProvider()
+        {
+#pragma warning disable AUTH_SERVICES
+#pragma warning disable REQUEST_AUTHPROVIDER
+            var result = AuthServices.AuthProvider;
+#pragma warning restore REQUEST_AUTHPROVIDER
+#pragma warning restore AUTH_SERVICES
+
+            Assert.AreEqual((result as IOAuth2AccessTokenProvider).GetAccessToken(), "faketoken");
+        }
+    }
 }
diff --git a/tools/NuGet/template-nuget/DynamoVisualProgramming.DynamoServices.nuspec b/tools/NuGet/template-nuget/DynamoVisualProgramming.DynamoServices.nuspec
@@ -25,8 +25,13 @@
         </dependencies>
     </metadata>
     <files>
-        <file src="DynamoServices.dll" target="lib\netstandard2.0" />
+        <file src="..\..\..\src\NodeServices\obj\netstandard2.0\DynamoServices.dll" target="lib\netstandard2.0" />
         <file src="DynamoServices.xml" target="lib\netstandard2.0" />
+
+        <file src="..\..\..\src\NodeServices\obj\net8.0\DynamoServices.dll" target="lib\net8.0" />
+        <file src="DynamoServices.xml" target="lib\net8.0" />
+
+        
         <file src="..\..\..\doc\distrib\Images\logo_square_32x32.png" target="content\images\logo.png" />
     </files>
 </package>

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-using System;`
	`1`	`+using System;`
`2`	`2`	`using System.Collections.Generic;`
`3`	`3`	`using System.IO;`
`4`	`4`	`using Dynamo.Interfaces;`
Original file line number	Diff line number	Diff line change
`@@ -81,6 +81,5 @@ public class ParameterKeys`
`81`	`81`	`/// The return value is an ILogger`
`82`	`82`	`/// </summary>`
`83`	`83`	`public static readonly string Logger = nameof(Logger);`
`84`		`-`
`85`	`84`	`}`
`86`	`85`	`}`