diff options
| -rw-r--r-- | core/java/com/android/internal/protolog/PerfettoProtoLogImpl.java | 10 | ||||
| -rw-r--r-- | core/java/com/android/internal/protolog/common/LogDataType.java | 4 | ||||
| -rw-r--r-- | tools/protologtool/src/com/android/protolog/tool/Exceptions.kt (renamed from tools/protologtool/src/com/android/protolog/tool/exceptions.kt) | 25 | ||||
| -rw-r--r-- | tools/protologtool/src/com/android/protolog/tool/ProtoLogCallProcessorImpl.kt | 14 | ||||
| -rw-r--r-- | tools/protologtool/tests/com/android/protolog/tool/ProtoLogCallProcessorImplTest.kt | 37 |
5 files changed, 72 insertions, 18 deletions
diff --git a/core/java/com/android/internal/protolog/PerfettoProtoLogImpl.java b/core/java/com/android/internal/protolog/PerfettoProtoLogImpl.java index 6f7e5ad51b89..7cecc39dacde 100644 --- a/core/java/com/android/internal/protolog/PerfettoProtoLogImpl.java +++ b/core/java/com/android/internal/protolog/PerfettoProtoLogImpl.java @@ -66,6 +66,7 @@ import com.android.internal.protolog.IProtoLogConfigurationService.RegisterClien import com.android.internal.protolog.common.ILogger; import com.android.internal.protolog.common.IProtoLog; import com.android.internal.protolog.common.IProtoLogGroup; +import com.android.internal.protolog.common.InvalidFormatStringException; import com.android.internal.protolog.common.LogDataType; import com.android.internal.protolog.common.LogLevel; @@ -207,7 +208,12 @@ public abstract class PerfettoProtoLogImpl extends IProtoLogClient.Stub implemen @Override public void log(LogLevel logLevel, IProtoLogGroup group, String messageString, Object... args) { - log(logLevel, group, new Message(messageString), args); + try { + log(logLevel, group, new Message(messageString), args); + } catch (InvalidFormatStringException e) { + Slog.e(LOG_TAG, "Invalid protolog string format", e); + log(logLevel, group, new Message("INVALID MESSAGE"), new Object[0]); + } } /** @@ -831,7 +837,7 @@ public abstract class PerfettoProtoLogImpl extends IProtoLogClient.Stub implemen this.mMessageString = null; } - private Message(@NonNull String messageString) { + private Message(@NonNull String messageString) throws InvalidFormatStringException { this.mMessageHash = null; final List<Integer> argTypes = LogDataType.parseFormatString(messageString); this.mMessageMask = LogDataType.logDataTypesToBitMask(argTypes); diff --git a/core/java/com/android/internal/protolog/common/LogDataType.java b/core/java/com/android/internal/protolog/common/LogDataType.java index c05824a58a77..10b07d9387de 100644 --- a/core/java/com/android/internal/protolog/common/LogDataType.java +++ b/core/java/com/android/internal/protolog/common/LogDataType.java @@ -86,8 +86,8 @@ public class LogDataType { case '%': break; default: - throw new InvalidFormatStringException("Invalid format string field" - + " %${messageString[i + 1]}"); + throw new InvalidFormatStringException("Invalid Protolog message format in " + + "\"" + messageString + "\" at index " + i + "."); } i += 2; } else { diff --git a/tools/protologtool/src/com/android/protolog/tool/exceptions.kt b/tools/protologtool/src/com/android/protolog/tool/Exceptions.kt index ae00df123353..4f7e8d13c4ba 100644 --- a/tools/protologtool/src/com/android/protolog/tool/exceptions.kt +++ b/tools/protologtool/src/com/android/protolog/tool/Exceptions.kt @@ -18,21 +18,24 @@ package com.android.protolog.tool import java.lang.Exception -open class CodeProcessingException(message: String, context: ParsingContext) - : Exception("Code processing error in ${context.filePath}:${context.lineNumber}:\n" + - " $message") +open class CodeProcessingException( + message: String, context: ParsingContext, cause: Throwable? = null +) : Exception("Code processing error in ${context.filePath}:${context.lineNumber}:\n" + + " $message", cause) -class HashCollisionException(message: String, context: ParsingContext) : - CodeProcessingException(message, context) +class HashCollisionException( + message: String, context: ParsingContext, cause: Throwable? = null +) : CodeProcessingException(message, context, cause) -class IllegalImportException(message: String, context: ParsingContext) : - CodeProcessingException("Illegal import: $message", context) +class IllegalImportException(message: String, context: ParsingContext, cause: Throwable? = null) : + CodeProcessingException("Illegal import: $message", context, cause) -class InvalidProtoLogCallException(message: String, context: ParsingContext) - : CodeProcessingException("InvalidProtoLogCall: $message", context) +class InvalidProtoLogCallException( + message: String, context: ParsingContext, cause: Throwable? = null +) : CodeProcessingException("InvalidProtoLogCall: $message", context, cause) -class ParsingException(message: String, context: ParsingContext) - : CodeProcessingException(message, context) +class ParsingException(message: String, context: ParsingContext, cause: Throwable? = null) : + CodeProcessingException(message, context, cause) class InvalidViewerConfigException(message: String) : Exception(message) diff --git a/tools/protologtool/src/com/android/protolog/tool/ProtoLogCallProcessorImpl.kt b/tools/protologtool/src/com/android/protolog/tool/ProtoLogCallProcessorImpl.kt index 272d8bb1793d..1f6db5fe2d37 100644 --- a/tools/protologtool/src/com/android/protolog/tool/ProtoLogCallProcessorImpl.kt +++ b/tools/protologtool/src/com/android/protolog/tool/ProtoLogCallProcessorImpl.kt @@ -118,9 +118,17 @@ class ProtoLogCallProcessorImpl( "- not a ProtoLogGroup enum member: $call", context) } - logCallVisitor?.processCall(call, messageString, getLevelForMethodName( - call.name.toString(), call, context), groupMap.getValue(groupName), - context.lineNumber) + try { + logCallVisitor?.processCall( + call, messageString, getLevelForMethodName( + call.name.toString(), call, context + ), groupMap.getValue(groupName), + context.lineNumber + ) + } catch (e: Throwable) { + throw InvalidProtoLogCallException("Error processing log call: $call", + context, e) + } } else if (call.name.id == "init") { // No processing } else { diff --git a/tools/protologtool/tests/com/android/protolog/tool/ProtoLogCallProcessorImplTest.kt b/tools/protologtool/tests/com/android/protolog/tool/ProtoLogCallProcessorImplTest.kt index 004d97babbad..732824ae841c 100644 --- a/tools/protologtool/tests/com/android/protolog/tool/ProtoLogCallProcessorImplTest.kt +++ b/tools/protologtool/tests/com/android/protolog/tool/ProtoLogCallProcessorImplTest.kt @@ -16,11 +16,14 @@ package com.android.protolog.tool +import com.android.internal.protolog.common.InvalidFormatStringException import com.android.internal.protolog.common.LogLevel import com.github.javaparser.StaticJavaParser import com.github.javaparser.ast.expr.MethodCallExpr import org.junit.Assert.assertEquals +import org.junit.Assert.assertThrows import org.junit.Test +import com.google.common.truth.Truth class ProtoLogCallProcessorImplTest { private data class LogCall( @@ -228,4 +231,38 @@ class ProtoLogCallProcessorImplTest { visitor.process(StaticJavaParser.parse(code), processor, "") checkCalls() } + + @Test + fun throws_clear_error_message_on_invalid_format_exception() { + val code = """ + package org.example; + + class Test { + void test() { + ProtoLog.d(ProtoLogGroup.TEST, "Invalid message %9 %"); + } + } + """ + groupMap["TEST"] = LogGroup("TEST", false, true, "WindowManager") + + val processor = object : ProtoLogCallVisitor { + override fun processCall( + call: MethodCallExpr, + messageString: String, + level: LogLevel, + group: LogGroup, + lineNumber: Int, + ) { + throw InvalidFormatStringException("Invalid Protolog message format") + } + } + + val exception = assertThrows(InvalidProtoLogCallException::class.java) { + visitor.process(StaticJavaParser.parse(code), processor, "MyTestFile.java") + } + Truth.assertThat(exception).hasMessageThat() + .contains("Code processing error in MyTestFile.java:6") + Truth.assertThat(exception.cause).hasMessageThat() + .contains("Invalid Protolog message format") + } } |