Skip to content

[Microsoft.Android.Build.BaseTasks] Guard LogCodedError overloads #12093

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

Merged
simonrozsival merged 1 commit into from
Jul 14, 2026
+25 −12
Merged

[Microsoft.Android.Build.BaseTasks] Guard LogCodedError overloads #12093

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
33 changes: 23 additions & 10 deletions external/xamarin-android-tools/src/Microsoft.Android.Build.BaseTasks/AsyncTask.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,21 +152,25 @@ public void LogMessage (string message, MessageImportance importance = MessageIm
}

public void LogError (string message)
=> LogCodedError (code: null, message: message, file: null, lineNumber: 0);
=> LogCodedErrorCore (code: null, message: message, file: null, lineNumber: 0);

public void LogError (string message, params object [] messageArgs)
=> LogCodedError (code: null, message: string.Format (message, messageArgs));
=> LogCodedErrorCore (code: null, message: FormatMessage (message, messageArgs), file: null, lineNumber: 0);

public void LogCodedError (string? code, string message)
=> LogCodedError (code: code, message: message, file: null, lineNumber: 0);
=> LogCodedErrorCore (code: code, message: message, file: null, lineNumber: 0);

public void LogCodedError (string? code, string message, params object [] messageArgs)
=> LogCodedError (code: code, message: string.Format (message, messageArgs), file: null, lineNumber: 0);
=> LogCodedErrorCore (code: code, message: FormatMessage (message, messageArgs), file: null, lineNumber: 0);

public void LogCodedError (string? code, string? file, int lineNumber, string message, params object [] messageArgs)
=> LogCodedError (code: code, message: string.Format (message, messageArgs), file: file, lineNumber: lineNumber);
=> LogCodedErrorCore (code: code, message: FormatMessage (message, messageArgs), file: file, lineNumber: lineNumber);

[Obsolete ("This overload binds ambiguously when the trailing arguments are (string, int): a call meant to format the message, e.g. LogCodedError (\"XA0000\", Resources.XA0000, someString, someInt), silently binds here and treats the arguments as a source file and line number instead of substituting them into the message. To format the message use LogCodedError (code, message, params object[]); to attach a source location use LogCodedError (code, file, lineNumber, message, params object[]).", error: true)]
public void LogCodedError (string? code, string message, string? file, int lineNumber)
=> LogCodedErrorCore (code: code, message: message, file: file, lineNumber: lineNumber);

void LogCodedErrorCore (string? code, string message, string? file, int lineNumber)
{
if (uiThreadId == Thread.CurrentThread.ManagedThreadId) {
#pragma warning disable 618
Expand Down Expand Up @@ -201,21 +205,25 @@ public void LogCodedError (string? code, string message, string? file, int lineN
}

public void LogWarning (string message)
=> LogCodedWarning (code: null, message: message, file: null, lineNumber: 0);
=> LogCodedWarningCore (code: null, message: message, file: null, lineNumber: 0);

public void LogWarning (string message, params object [] messageArgs)
=> LogCodedWarning (code: null, message: string.Format (message, messageArgs));
=> LogCodedWarningCore (code: null, message: FormatMessage (message, messageArgs), file: null, lineNumber: 0);

public void LogCodedWarning (string? code, string message)
=> LogCodedWarning (code: code, message: message, file: null, lineNumber: 0);
=> LogCodedWarningCore (code: code, message: message, file: null, lineNumber: 0);

public void LogCodedWarning (string? code, string message, params object [] messageArgs)
=> LogCodedWarning (code: code, message: string.Format (message, messageArgs), file: null, lineNumber: 0);
=> LogCodedWarningCore (code: code, message: FormatMessage (message, messageArgs), file: null, lineNumber: 0);

public void LogCodedWarning (string? code, string? file, int lineNumber, string message, params object [] messageArgs)
=> LogCodedWarning (code: code, message: string.Format (message, messageArgs), file: file, lineNumber: lineNumber);
=> LogCodedWarningCore (code: code, message: FormatMessage (message, messageArgs), file: file, lineNumber: lineNumber);

[Obsolete ("This overload binds ambiguously when the trailing arguments are (string, int): a call meant to format the message, e.g. LogCodedWarning (\"XA0000\", Resources.XA0000, someString, someInt), silently binds here and treats the arguments as a source file and line number instead of substituting them into the message. To format the message use LogCodedWarning (code, message, params object[]); to attach a source location use LogCodedWarning (code, file, lineNumber, message, params object[]).", error: true)]
public void LogCodedWarning (string? code, string message, string? file, int lineNumber)
=> LogCodedWarningCore (code: code, message: message, file: file, lineNumber: lineNumber);

void LogCodedWarningCore (string? code, string message, string? file, int lineNumber)
{
if (uiThreadId == Thread.CurrentThread.ManagedThreadId) {
#pragma warning disable 618
Expand Down Expand Up @@ -248,6 +256,11 @@ public void LogCodedWarning (string? code, string message, string? file, int lin
EnqueueMessage (warningMessageQueue, data, warningDataAvailable);
}

// Returns the message verbatim when there are no arguments, so pre-formatted messages
// that contain literal '{' or '}' characters are not passed through string.Format.
static string FormatMessage (string message, object [] messageArgs)
=> messageArgs is null || messageArgs.Length == 0 ? message : string.Format (message, messageArgs);

public void LogCustomBuildEvent (CustomBuildEventArgs e)
{
if (uiThreadId == Thread.CurrentThread.ManagedThreadId) {
Expand Down
4 changes: 2 additions & 2 deletions src/Xamarin.Android.Build.Tasks/Tasks/Aapt2.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,9 +186,9 @@ protected bool LogAapt2EventsFromOutput (string singleLine, MessageImportance me
if (level.Contains ("error") || (line != 0 && !file.IsNullOrEmpty ())) {
var errorCode = GetErrorCodeForFile (message, file);
if (manifestError)
LogCodedError (errorCode, string.Format (Xamarin.Android.Tasks.Properties.Resources.AAPTManifestError, message.TrimEnd('.')), AndroidManifestFile?.ItemSpec ?? "", 0);
LogCodedError (errorCode, AndroidManifestFile?.ItemSpec ?? "", 0, string.Format (Xamarin.Android.Tasks.Properties.Resources.AAPTManifestError, message.TrimEnd('.')));
else
LogCodedError (errorCode, AddAdditionalErrorText (errorCode, message), file, line);
LogCodedError (errorCode, file, line, AddAdditionalErrorText (errorCode, message));
return true;
}
}
Expand Down
Loading