Skip to content

Commit 9868b86

Browse files
Dennis TuGerrit Code Review
Dennis Tu
authored and
Gerrit Code Review
committed
Merge "wrap external exceptions" into androidx-main
2 parents 79c6bf9 + f232c48 commit 9868b86

File tree

6 files changed

+118
-29
lines changed

6 files changed

+118
-29
lines changed

‎appactions/interaction/interaction-capabilities-core/src/main/java/androidx/appactions/interaction/capabilities/core/impl/SingleTurnCapabilitySession.kt

+5-1
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ import androidx.annotation.RestrictTo
2020
import androidx.appactions.interaction.capabilities.core.ExecutionCallback
2121
import androidx.appactions.interaction.capabilities.core.ExecutionResult
2222
import androidx.appactions.interaction.capabilities.core.impl.spec.ActionSpec
23+
import androidx.appactions.interaction.capabilities.core.impl.utils.invokeExternalSuspendBlock
2324
import androidx.appactions.interaction.proto.AppActionsContext.AppDialogState
2425
import androidx.appactions.interaction.proto.FulfillmentResponse
2526
import androidx.appactions.interaction.proto.ParamValue
@@ -75,9 +76,12 @@ internal class SingleTurnCapabilitySession<
7576
try {
7677
mutex.lock(owner = this@SingleTurnCapabilitySession)
7778
UiHandleRegistry.registerUiHandle(uiHandle, sessionId)
78-
val output = executionCallback.onExecute(arguments)
79+
val output = invokeExternalSuspendBlock("onExecute") {
80+
executionCallback.onExecute(arguments)
81+
}
7982
callback.onSuccess(convertToFulfillmentResponse(output))
8083
} catch (t: Throwable) {
84+
// TODO(b/276354491) add fine-grained error handling
8185
callback.onError(ErrorStatusInternal.CANCELLED)
8286
} finally {
8387
UiHandleRegistry.unregisterUiHandle(uiHandle)

‎appactions/interaction/interaction-capabilities-core/src/main/java/androidx/appactions/interaction/capabilities/core/impl/exceptions/ExternalException.kt

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
/*
2+
* Copyright 2023 The Android Open Source Project
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
package androidx.appactions.interaction.capabilities.core.impl.exceptions
18+
19+
/**
20+
* This exception wraps an externally thrown exception.
21+
*
22+
* For example, an exception occurred in a listener or some method implemented as part
23+
* of some Session interface.
24+
*/
25+
class ExternalException(message: String, cause: Throwable) : Exception(message, cause)

‎appactions/interaction/interaction-capabilities-core/src/main/java/androidx/appactions/interaction/capabilities/core/impl/task/GenericResolverInternal.kt

+33-22
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,14 @@ import androidx.appactions.interaction.capabilities.core.AppEntityListener
2020
import androidx.appactions.interaction.capabilities.core.EntitySearchResult
2121
import androidx.appactions.interaction.capabilities.core.InventoryListListener
2222
import androidx.appactions.interaction.capabilities.core.InventoryListener
23+
import androidx.appactions.interaction.capabilities.core.SearchAction
2324
import androidx.appactions.interaction.capabilities.core.ValidationResult
2425
import androidx.appactions.interaction.capabilities.core.ValueListener
2526
import androidx.appactions.interaction.capabilities.core.impl.converters.ParamValueConverter
2627
import androidx.appactions.interaction.capabilities.core.impl.converters.SlotTypeConverter
2728
import androidx.appactions.interaction.capabilities.core.impl.exceptions.StructConversionException
2829
import androidx.appactions.interaction.capabilities.core.impl.task.exceptions.InvalidResolverException
29-
import androidx.appactions.interaction.capabilities.core.SearchAction
30+
import androidx.appactions.interaction.capabilities.core.impl.utils.invokeExternalSuspendBlock
3031
import androidx.appactions.interaction.proto.ParamValue
3132

3233
/**
@@ -44,18 +45,22 @@ private constructor(
4445
val appEntity: AppEntityListener<ValueTypeT>? = null,
4546
val appEntityList: AppEntityListListener<ValueTypeT>? = null,
4647
val inventory: InventoryListener<ValueTypeT>? = null,
47-
val inventoryList: InventoryListListener<ValueTypeT>? = null,
48+
val inventoryList: InventoryListListener<ValueTypeT>? = null
4849
) {
4950

5051
/** Wrapper which should invoke the `lookupAndRender` provided by the developer. */
5152
@Throws(InvalidResolverException::class)
5253
suspend fun invokeLookup(
53-
searchAction: SearchAction<ValueTypeT>,
54+
searchAction: SearchAction<ValueTypeT>
5455
): EntitySearchResult<ValueTypeT> {
5556
return if (appEntity != null) {
56-
appEntity.lookupAndRender(searchAction)
57+
invokeExternalSuspendBlock("lookupAndRender") {
58+
appEntity.lookupAndRender(searchAction)
59+
}
5760
} else if (appEntityList != null) {
58-
appEntityList.lookupAndRender(searchAction)
61+
invokeExternalSuspendBlock("lookupAndRender") {
62+
appEntityList.lookupAndRender(searchAction)
63+
}
5964
} else {
6065
throw InvalidResolverException("invokeLookup is not supported on this resolver")
6166
}
@@ -68,9 +73,13 @@ private constructor(
6873
@Throws(InvalidResolverException::class)
6974
suspend fun invokeEntityRender(entityIds: List<String>) {
7075
if (inventory != null) {
71-
inventory.renderChoices(entityIds)
76+
invokeExternalSuspendBlock("renderChoices") {
77+
inventory.renderChoices(entityIds)
78+
}
7279
} else if (inventoryList != null) {
73-
inventoryList.renderChoices(entityIds)
80+
invokeExternalSuspendBlock("renderChoices") {
81+
inventoryList.renderChoices(entityIds)
82+
}
7483
} else {
7584
throw InvalidResolverException("invokeEntityRender is not supported on this resolver")
7685
}
@@ -83,22 +92,24 @@ private constructor(
8392
@Throws(StructConversionException::class)
8493
suspend fun notifyValueChange(
8594
paramValues: List<ParamValue>,
86-
converter: ParamValueConverter<ValueTypeT>,
95+
converter: ParamValueConverter<ValueTypeT>
8796
): ValidationResult {
8897
val singularConverter = SlotTypeConverter.ofSingular(converter)
8998
val repeatedConverter = SlotTypeConverter.ofRepeated(converter)
90-
return when {
91-
value != null -> value.onReceived(singularConverter.convert(paramValues))
92-
valueList != null -> valueList.onReceived(repeatedConverter.convert(paramValues))
93-
appEntity != null ->
94-
appEntity.onReceived(singularConverter.convert(paramValues))
95-
appEntityList != null ->
96-
appEntityList.onReceived(repeatedConverter.convert(paramValues))
97-
inventory != null ->
98-
inventory.onReceived(singularConverter.convert(paramValues))
99-
inventoryList != null ->
100-
inventoryList.onReceived(repeatedConverter.convert(paramValues))
101-
else -> throw IllegalStateException("unreachable")
99+
return invokeExternalSuspendBlock("onReceived") {
100+
when {
101+
value != null -> value.onReceived(singularConverter.convert(paramValues))
102+
valueList != null -> valueList.onReceived(repeatedConverter.convert(paramValues))
103+
appEntity != null ->
104+
appEntity.onReceived(singularConverter.convert(paramValues))
105+
appEntityList != null ->
106+
appEntityList.onReceived(repeatedConverter.convert(paramValues))
107+
inventory != null ->
108+
inventory.onReceived(singularConverter.convert(paramValues))
109+
inventoryList != null ->
110+
inventoryList.onReceived(repeatedConverter.convert(paramValues))
111+
else -> throw IllegalStateException("unreachable")
112+
}
102113
}
103114
}
104115

@@ -113,14 +124,14 @@ private constructor(
113124
GenericResolverInternal(appEntity = appEntity)
114125

115126
fun <ValueTypeT> fromAppEntityListListener(
116-
appEntityList: AppEntityListListener<ValueTypeT>,
127+
appEntityList: AppEntityListListener<ValueTypeT>
117128
) = GenericResolverInternal(appEntityList = appEntityList)
118129

119130
fun <ValueTypeT> fromInventoryListener(inventory: InventoryListener<ValueTypeT>) =
120131
GenericResolverInternal(inventory = inventory)
121132

122133
fun <ValueTypeT> fromInventoryListListener(
123-
inventoryList: InventoryListListener<ValueTypeT>,
134+
inventoryList: InventoryListListener<ValueTypeT>
124135
) = GenericResolverInternal(inventoryList = inventoryList)
125136
}
126137
}

‎appactions/interaction/interaction-capabilities-core/src/main/java/androidx/appactions/interaction/capabilities/core/impl/task/TaskCapabilitySession.kt

-1
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,6 @@ internal class TaskCapabilitySession<
5757
}
5858

5959
override fun destroy() {
60-
// TODO(b/270751989): cancel current processing request immediately
6160
this.sessionOrchestrator.terminate()
6261
scope.cancel()
6362
}

‎appactions/interaction/interaction-capabilities-core/src/main/java/androidx/appactions/interaction/capabilities/core/impl/task/TaskOrchestrator.kt

+15-5
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,8 @@ import androidx.appactions.interaction.capabilities.core.impl.task.exceptions.Mi
3333
import androidx.appactions.interaction.capabilities.core.impl.task.exceptions.MissingSearchActionConverterException
3434
import androidx.appactions.interaction.capabilities.core.impl.utils.CapabilityLogger
3535
import androidx.appactions.interaction.capabilities.core.impl.utils.LoggerInternal
36+
import androidx.appactions.interaction.capabilities.core.impl.utils.invokeExternalBlock
37+
import androidx.appactions.interaction.capabilities.core.impl.utils.invokeExternalSuspendBlock
3638
import androidx.appactions.interaction.proto.AppActionsContext
3739
import androidx.appactions.interaction.proto.CurrentValue
3840
import androidx.appactions.interaction.proto.FulfillmentRequest
@@ -281,7 +283,9 @@ internal class TaskOrchestrator<ArgumentsT, OutputT, ConfirmationT>(
281283

282284
private fun maybeInitializeTask() {
283285
if (status === Status.UNINITIATED) {
284-
externalSession.onCreate(SessionConfig())
286+
invokeExternalBlock("onCreate") {
287+
externalSession.onCreate(SessionConfig())
288+
}
285289
}
286290
status = Status.IN_PROGRESS
287291
}
@@ -293,14 +297,15 @@ internal class TaskOrchestrator<ArgumentsT, OutputT, ConfirmationT>(
293297
* turn, so the logic should include onEnter, arg validation, and onExit.
294298
*/
295299
private suspend fun handleSync(argumentsWrapper: ArgumentsWrapper): FulfillmentResult {
296-
maybeInitializeTask()
297-
clearMissingArgs(argumentsWrapper)
298300
return try {
301+
maybeInitializeTask()
302+
clearMissingArgs(argumentsWrapper)
299303
processFulfillmentValues(argumentsWrapper.paramValues)
300304
val fulfillmentResponse = maybeConfirmOrExecute()
301305
LoggerInternal.log(CapabilityLogger.LogLevel.INFO, LOG_TAG, "Task sync success")
302306
FulfillmentResult(fulfillmentResponse)
303307
} catch (t: Throwable) {
308+
// TODO(b/276354491) implement fine-grained exception handling
304309
LoggerInternal.log(CapabilityLogger.LogLevel.ERROR, LOG_TAG, "Task sync fail", t)
305310
FulfillmentResult(ErrorStatusInternal.SYNC_REQUEST_FAILURE)
306311
}
@@ -317,6 +322,7 @@ internal class TaskOrchestrator<ArgumentsT, OutputT, ConfirmationT>(
317322
LoggerInternal.log(CapabilityLogger.LogLevel.INFO, LOG_TAG, "Task confirm success")
318323
FulfillmentResult(fulfillmentResponse)
319324
} catch (t: Throwable) {
325+
// TODO(b/276354491) implement fine-grained exception handling
320326
LoggerInternal.log(CapabilityLogger.LogLevel.ERROR, LOG_TAG, "Task confirm fail")
321327
FulfillmentResult(ErrorStatusInternal.CONFIRMATION_REQUEST_FAILURE)
322328
}
@@ -450,7 +456,9 @@ internal class TaskOrchestrator<ArgumentsT, OutputT, ConfirmationT>(
450456
private suspend fun getFulfillmentResponseForConfirmation(
451457
finalArguments: Map<String, List<ParamValue>>,
452458
): FulfillmentResponse {
453-
val result = taskHandler.onReadyToConfirmListener!!.onReadyToConfirm(finalArguments)
459+
val result = invokeExternalSuspendBlock("onReadyToConfirm") {
460+
taskHandler.onReadyToConfirmListener!!.onReadyToConfirm(finalArguments)
461+
}
454462
val fulfillmentResponse = FulfillmentResponse.newBuilder()
455463
convertToConfirmationOutput(result)?.let { fulfillmentResponse.confirmationData = it }
456464
return fulfillmentResponse.build()
@@ -460,7 +468,9 @@ internal class TaskOrchestrator<ArgumentsT, OutputT, ConfirmationT>(
460468
private suspend fun getFulfillmentResponseForExecution(
461469
finalArguments: Map<String, List<ParamValue>>,
462470
): FulfillmentResponse {
463-
val result = externalSession.onExecute(actionSpec.buildArguments(finalArguments))
471+
val result = invokeExternalSuspendBlock("onExecute") {
472+
externalSession.onExecute(actionSpec.buildArguments(finalArguments))
473+
}
464474
status = Status.COMPLETED
465475
val fulfillmentResponse =
466476
FulfillmentResponse.newBuilder().setStartDictation(result.shouldStartDictation)

‎appactions/interaction/interaction-capabilities-core/src/main/java/androidx/appactions/interaction/capabilities/core/impl/utils/CallbackUtils.kt

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
/*
2+
* Copyright 2023 The Android Open Source Project
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
package androidx.appactions.interaction.capabilities.core.impl.utils
18+
19+
import androidx.appactions.interaction.capabilities.core.impl.exceptions.ExternalException
20+
21+
/** invoke an externally implemented method, wrapping any exceptions with ExternalException.
22+
*/
23+
fun <T> invokeExternalBlock(description: String, block: () -> T): T {
24+
try {
25+
return block()
26+
} catch (t: Throwable) {
27+
throw ExternalException("exception occurred during '$description'", t)
28+
}
29+
}
30+
31+
/** invoke an externally implemented suspend method, wrapping any exceptions with
32+
* ExternalException.
33+
*/
34+
suspend fun <T> invokeExternalSuspendBlock(description: String, block: suspend () -> T): T {
35+
try {
36+
return block()
37+
} catch (t: Throwable) {
38+
throw ExternalException("exception occurred during '$description'", t)
39+
}
40+
}

0 commit comments

Comments
 (0)