Skip to content

Log warning message for unsupported action with Java #4582

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 4 commits into from
Closed

Log warning message for unsupported action with Java #4582

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ca09285
initial commit
satvu Aug 6, 2025
03d9f9d
update message
satvu Aug 6, 2025
82454b6
move error message location
satvu Aug 6, 2025
37ea2e7
updates
satvu Aug 6, 2025
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
9 changes: 8 additions & 1 deletion src/Cli/func/Helpers/GlobalCoreToolsSettings.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright (c) .NET Foundation. All rights reserved.
// Copyright (c) .NET Foundation. All rights reserved.
// Licensed under the MIT License. See LICENSE in the project root for license information.

using Azure.Functions.Cli.Common;
Expand Down Expand Up @@ -99,6 +99,13 @@ public static void Init(ISecretsManager secretsManager, string[] args)
{
_currentWorkerRuntime = WorkerRuntime.None;
}

if (_currentWorkerRuntime == WorkerRuntime.Java || args.Any(arg => string.Equals(arg, WorkerRuntime.Java.ToString(), StringComparison.OrdinalIgnoreCase)))
Copy link
Member Author

@satvu satvu Aug 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The second check is necessary. Without it, commands that have java but do not have --java in it (such as func new --language java will be sent down this path and fail:

                else
                {
                    _currentWorkerRuntime = WorkerRuntimeLanguageHelper.GetCurrentWorkerRuntimeLanguage(secretsManager);
                }

Copy link
Contributor

@mattchenderson mattchenderson Aug 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this the right place for this check? It seems like this impacts all actions, perhaps not when intended. Even func host start --java would get this warning, which seems a little overly aggressive. Perhaps we could scope it to impacted actions?

Copy link
Member Author

@satvu satvu Aug 19, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we don't want customers to use Core Tools with Java at all (which was under discussion, but we were leaning that way), then I think this should show up for all actions (even if it works). We want to point users to other documented, supported tools.

We can definitely scope this to just impacted ones -- I guess we do "partially support" Java and we can continue to do so.

{
ColoredConsole
.WriteLine(WarningColor($"This action is not supported when using the core tools directly. Please use one of the supported environments to test {_currentWorkerRuntime} apps locally as specified by" +
Copy link
Contributor

@mattchenderson mattchenderson Aug 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Core Tools" capitalized.

Also, is this really about "supported environments" or even "testing"? It's more about scaffolding templates, right? Or I guess it could be multiple scenarios? It might be easier to just treat it as "work with".

Suggested change
.WriteLine(WarningColor($"This action is not supported when using the core tools directly. Please use one of the supported environments to test {_currentWorkerRuntime} apps locally as specified by" +
.WriteLine(WarningColor($"This action is not supported when using the Core Tools directly. Please see {link} for instructions on working with {_currentWorkerRuntime} apps locally." +

Copy link
Contributor

@mattchenderson mattchenderson Aug 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm also questioning if this should be warning level in all cases. It feels like this should be an error for some actions, right?

Copy link
Member Author

@satvu satvu Aug 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's definitely an error for some actions -- we could also conditionally log warnings/errors based on the type of action. This is just the file location we landed on during design since all of the impacted commands would come through here.

$"https://learn.microsoft.com/en-us/azure/azure-functions/functions-develop-local?pivots=programming-language-java"));
Copy link
Contributor

@mattchenderson mattchenderson Aug 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This needs to be a short link, without locale information.

Copy link
Member Author

@satvu satvu Aug 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yup, just a placeholder for now while we iterate. Will leave this comment unresolved until I fix it.

}
}

// Test helper method to set _currentWorkerRuntime for testing purpose
Expand Down
46 changes: 46 additions & 0 deletions test/Cli/Func.UnitTests/GlobalCoreToolsSettingsTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
// Copyright (c) .NET Foundation. All rights reserved.
// Licensed under the MIT License. See LICENSE in the project root for license information.

using Azure.Functions.Cli.Helpers;
using Azure.Functions.Cli.Interfaces;
using Moq;
using Xunit;

namespace Azure.Functions.Cli.UnitTests
{
public class GlobalCoreToolsSettingsTests
{
[Theory]
[InlineData("init", "--java")]
Copy link
Member Author

@satvu satvu Aug 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not the right way to test this (one will pass, others will fail because of how console is set up) but I don't know if checking the console output is correct - any suggestions on how to best this this with the existing core tools testing framework?

I need to test that these commands log a warning message and that a non-java language will not log any error message.

Copy link
Member

@liliankasem liliankasem Aug 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sub the console writer instead:

        public GlobalCoreToolsSettingsTests()
        {
            // Reset the static state before each test
            GlobalCoreToolsSettings.SetWorkerRuntime(WorkerRuntime.None);
        }

        [Theory]
        [InlineData("init", "--java")]
        [InlineData("init", "--worker-runtime", "java")]
        [InlineData("new", "--java")]
        [InlineData("new", "--language", "java")]
        public void Init_LogsWarning_ForJavaWorkerRuntime(params string[] args)
        {
            // Arrange
            var output = new StringBuilder();
            var secretsManager = new Mock<ISecretsManager>();
            var console = Substitute.For<IConsoleWriter>();
            console.WriteLine(Arg.Do<object>(o => output.AppendLine(o?.ToString()))).Returns(console);
            console.Write(Arg.Do<object>(o => output.Append(o.ToString()))).Returns(console);
            ColoredConsole.Out = console;
            ColoredConsole.Error = console;

            // Act
            GlobalCoreToolsSettings.Init(secretsManager.Object, args);

            // Assert
            Assert.Contains("This action is not supported when using the core tools directly", output.ToString());
            Assert.Contains("java", output.ToString(), StringComparison.OrdinalIgnoreCase);
        }

[InlineData("init", "--worker-runtime", "java")]
[InlineData("new", "--java")]
[InlineData("new", "--language", "java")]
public void Init_LogsWarning_ForJavaWorkerRuntime(params string[] args)
{
// Arrange
var secretsManager = new Mock<ISecretsManager>();

var stringWriter = new StringWriter();
var originalOut = Console.Out;
Console.SetOut(stringWriter);

try
{
// Act
GlobalCoreToolsSettings.Init(secretsManager.Object, args);

// Assert
var output = stringWriter.ToString();
Assert.Contains("This action is not supported when using the core tools directly", output);
Assert.Contains("java", output, StringComparison.OrdinalIgnoreCase);
}
finally
{
Console.SetOut(originalOut);

// Reset static state for other tests
GlobalCoreToolsSettings.SetWorkerRuntime(WorkerRuntime.None);
}
}
}
}
Loading