Optimize warn message if state machine matched too many transitions in a frame (#15016)

This commit is contained in:
Leslie Leigh (李的序)
2023-05-10 14:22:31 +08:00
committed by GitHub
parent e5939558e1
commit b119ee5bcf
4 changed files with 84 additions and 18 deletions
+1 -1
View File
@@ -3257,7 +3257,7 @@ Can not decode CCON binary: lack of text decoder.
### 14000
Graph update has been interrupted since too many transitions(greater than %s) occurred during one frame.
State machine matched too many transitions(greater than %s) during this frame: %s.
### 14100
@@ -26,6 +26,13 @@ import { instantiatePoseGraph } from '../pose-graph/instantiation';
import { ConditionEvaluationContext } from './condition/condition-base';
import { ReadonlyClipOverrideMap } from '../clip-overriding';
/**
* The max transitions can be matched in single frame.
*
* @internal Only exported for test usage.
*/
export const MAX_TRANSITIONS_PER_FRAME = 16;
/**
* @en
* Runtime status of a transition.
@@ -422,11 +429,9 @@ class TopLevelStateMachineEvaluation {
/**
* Loop match transitions util no match,
* or util `MAX_ITERATIONS` is reached(in case of circular transition formed).
* or util `MAX_TRANSITIONS_PER_FRAME` is reached(in case of circular transition formed or too long transition path).
*/
private _loopMatchTransitions () {
const MAX_ITERATIONS = 100;
const {
_pendingTransitionPath: pendingTransitionPath,
_activatedTransitions: activatedTransitions,
@@ -440,8 +445,24 @@ class TopLevelStateMachineEvaluation {
/* The terminal condition is handled in loop body */;
++iterations
) {
if (iterations >= MAX_ITERATIONS) {
warnID(14000, MAX_ITERATIONS);
if (iterations >= MAX_TRANSITIONS_PER_FRAME) {
let prettyPath = '';
if (DEBUG) {
const lastDestination = activatedTransitions[activatedTransitions.length - 1].destination;
let loopFormPosition = -1;
for (let i = activatedTransitions.length - 2; i >= 0; --i) {
if (activatedTransitions[i].destination === lastDestination) {
loopFormPosition = i;
break;
}
}
prettyPath = `${this._currentNode.name} --> ... --> `;
const pathToPrint = loopFormPosition < 0
? activatedTransitions.slice(-MAX_TRANSITIONS_PER_FRAME) // We didn't find a loop.
: activatedTransitions.slice(loopFormPosition); // Find a loop, print from last loop position.
prettyPath += `${pathToPrint.map((t) => t.destination.name).join(' --> ')}`;
}
warnID(14000, MAX_TRANSITIONS_PER_FRAME, prettyPath);
break;
}
@@ -9,14 +9,13 @@ import { SingleRealValueObserver } from "./utils/single-real-value-observer";
import '../../utils/matchers/value-type-asymmetric-matchers';
import { createAnimationGraph, StateParams, TransitionParams } from "./utils/factory";
import { ApplyAnimationFixturePoseNode } from "./utils/apply-animation-fixture-pose-node";
import { MAX_TRANSITIONS_PER_FRAME } from "../../../cocos/animation/marionette/state-machine/state-machine-eval";
const DEFAULT_VALUE = 6.666;
// m: Motion | +: Entry | -: Exit
type SequenceString = string;
const MAX_TRANSITIONS_PER_FRAME = 100;
describe(`Transition sequence`, () => {
describe(`At a moment`, () => {
describe(`Zero transitions`, () => {
@@ -710,10 +709,6 @@ describe(`Circular transitions`, () => {
// Every tick, upto `MAX_TRANSITIONS_PER_FRAME` transitions will be appended to transition.
{
const lastStateIndexBeforeTick = expectation.transitions.length === 0
? expectation.headStateIndex
: expectation.transitions[expectation.transitions.length - 1].destStateIndex;
const stateWeightsBeforeTick = new Array(stateCount).fill(0.0);
if (!isFirstTick) {
const [lastStateWeight, destinationWeights] = computeExpectedWeightsOfTransitionSequence(
@@ -723,9 +718,12 @@ describe(`Circular transitions`, () => {
expectation.transitions.forEach(({ destStateIndex }, transitionIndex) => {
stateWeightsBeforeTick[destStateIndex] += destinationWeights[transitionIndex];
});
stateWeightsBeforeTick[lastStateIndexBeforeTick] += lastStateWeight;
stateWeightsBeforeTick[expectation.headStateIndex] += lastStateWeight;
}
const lastStateIndexBeforeTick = expectation.transitions.length === 0
? expectation.headStateIndex
: expectation.transitions[expectation.transitions.length - 1].destStateIndex;
const expectedNewTransitionsCount = isFirstTick
? MAX_TRANSITIONS_PER_FRAME - 1 // The first tick will exclude Entry -> Head consume 1 iteration
: MAX_TRANSITIONS_PER_FRAME;
+52 -5
View File
@@ -4,7 +4,7 @@ import { AnimationBlend1D, AnimationBlend2D, Condition, InvalidTransitionError,
import { AnimationGraph, StateMachine, Transition, isAnimationTransition, AnimationTransition, State, Layer } from '../../cocos/animation/marionette/animation-graph';
import { VariableTypeMismatchedError } from '../../cocos/animation/marionette/errors';
import { AnimationGraphEval } from '../../cocos/animation/marionette/graph-eval';
import { MotionStateStatus, ClipStatus } from '../../cocos/animation/marionette/state-machine/state-machine-eval';
import { MotionStateStatus, ClipStatus, MAX_TRANSITIONS_PER_FRAME } from '../../cocos/animation/marionette/state-machine/state-machine-eval';
import { blend1D } from '../../cocos/animation/marionette/motion/blend-1d';
import '../utils/matcher-deep-close-to';
import { BinaryCondition, UnaryCondition, TriggerCondition } from '../../cocos/animation/marionette/state-machine/condition';
@@ -22,7 +22,7 @@ import '../utils/matchers/value-type-asymmetric-matchers';
import { AnimationBlend1DFixture, LinearRealValueAnimationFixture, ConstantRealValueAnimationFixture, RealValueAnimationFixture } from './new-gen-anim/utils/fixtures';
import { NodeTransformValueObserver } from './new-gen-anim/utils/node-transform-value-observer';
import { SingleRealValueObserver } from './new-gen-anim/utils/single-real-value-observer';
import { createAnimationGraph } from './new-gen-anim/utils/factory';
import { createAnimationGraph, StateParams, TransitionParams } from './new-gen-anim/utils/factory';
/**
* Notable changes
@@ -619,7 +619,7 @@ describe('NewGen Anim', () => {
});
});
test('Infinity loop', () => {
test('Warn in loop transition case', () => {
const warnMockInstance = warnID as unknown as jest.MockInstance<ReturnType<typeof warnID>, Parameters<typeof warnID>>;
warnMockInstance.mockClear();
@@ -641,9 +641,56 @@ describe('NewGen Anim', () => {
graphEval.update(0.0);
expect(warnMockInstance).toBeCalledTimes(1);
expect(warnMockInstance.mock.calls[0]).toHaveLength(2);
expect(warnMockInstance.mock.calls[0]).toHaveLength(3);
expect(warnMockInstance.mock.calls[0][0]).toStrictEqual(14000);
expect(warnMockInstance.mock.calls[0][1]).toStrictEqual(100);
expect(warnMockInstance.mock.calls[0][1]).toStrictEqual(MAX_TRANSITIONS_PER_FRAME);
expect(warnMockInstance.mock.calls[0][2]).toStrictEqual(`Entry --> ... --> Node2 --> Node1 --> Node2`);
});
test('Warn in not loop but too long transition path case', () => {
const warnMockInstance = warnID as unknown as jest.MockInstance<ReturnType<typeof warnID>, Parameters<typeof warnID>>;
warnMockInstance.mockClear();
const states: Record<string, StateParams> = {};
const transitions: TransitionParams[] = [];
const nStates = MAX_TRANSITIONS_PER_FRAME + 2;
const getStateId = (stateIndex: number) => `State${stateIndex}`;
for (let i = 0; i < nStates; ++i) {
states[getStateId(i)] = { type: 'motion' };
}
for (let i = 0; i < nStates - 1; ++i) {
transitions.push({
from: getStateId(i),
to: getStateId(i + 1),
exitTimeEnabled: false,
duration: 0.3,
conditions: [{ type: 'unary', operator: 'to-be-true', operand: { type: 'constant', value: true, } }],
});
}
const graphEval = createAnimationGraphEval(createAnimationGraph({
layers: [{
stateMachine: {
states: states,
entryTransitions: [{ to: getStateId(0) }],
transitions: transitions,
},
}],
}), new Node());
graphEval.update(0.1);
expect(warnMockInstance).toBeCalledTimes(1);
expect(warnMockInstance.mock.calls[0]).toHaveLength(3);
expect(warnMockInstance.mock.calls[0][0]).toStrictEqual(14000);
expect(warnMockInstance.mock.calls[0][1]).toStrictEqual(MAX_TRANSITIONS_PER_FRAME);
expect(warnMockInstance.mock.calls[0][2]).toStrictEqual(`Entry --> ... --> ${
Array.from({ length: nStates }, (_, i) => getStateId(i))
.slice(0, MAX_TRANSITIONS_PER_FRAME)
.join(' --> ')
}`);
});
test('Self transition', () => {