2409

Committed 03 Jul 2024 08:33PM CUT coverage: 61.467% (-0.05%) from 61.518%

Build # 2409

Build Type

push

buildkite

Committed by

web-flow

Commit Message

Avoid consuming ByteBuffers (#913)

A ByteBuffer is a pointer to a byte[] with a starting position, a current position, and a limit. Any function that reads from its contents updates the current position. Both TracingPropagator and WorkflowUtils copy the entirety of its contents, and in doing so they mutate the current position. WorkflowUtils resets it afterwards but this still isn't thread-safe as another thread may be trying to read it.

By duplicating the ByteBuffer (copying only the metadata, not the actual contents) we avoid modifying it. It doesn't seem likely that there's real impact in either of these cases beyond unit tests, where these ByteBuffers stick around in the workflow history and are repeatedly serialized/deserialized. Modifying them during serialization can create test flakiness as that can trigger exceptions.

Run Details

2 of 2 new or added lines in 2 files covered. (100.0%)

10 existing lines in 4 files now uncovered.

11972 of 19477 relevant lines covered (61.47%)

0.61 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

0.0

/src/main/java/com/uber/cadence/client/WorkflowAlreadyCompletedException.java

/*
 *  Copyright 2012-2016 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 *
 *  Modifications copyright (C) 2017 Uber Technologies, Inc.
 *
 *  Licensed under the Apache License, Version 2.0 (the "License"). You may not
 *  use this file except in compliance with the License. A copy of the License is
 *  located at
 *
 *  http://aws.amazon.com/apache2.0
 *
 *  or in the "license" file accompanying this file. This file is distributed on
 *  an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
 *  express or implied. See the License for the specific language governing
 *  permissions and limitations under the License.
 */

package com.uber.cadence.client;

import com.uber.cadence.WorkflowExecution;
import java.util.Optional;

/**
 * Thrown when workflow already completed its execution and when the client is trying to run an
 * operation on the workflow like signal, terminate, cancel, poll etc.
 */
public final class WorkflowAlreadyCompletedException extends WorkflowException {

  public WorkflowAlreadyCompletedException(
      WorkflowExecution execution, Optional<String> workflowType, String message) {
    super(message, execution, workflowType, null);
  }
}

1	/*
2	* Copyright 2012-2016 Amazon.com, Inc. or its affiliates. All Rights Reserved.
3	*
4	* Modifications copyright (C) 2017 Uber Technologies, Inc.
5	*
6	* Licensed under the Apache License, Version 2.0 (the "License"). You may not
7	* use this file except in compliance with the License. A copy of the License is
8	* located at
9	*
10	* http://aws.amazon.com/apache2.0
11	*
12	* or in the "license" file accompanying this file. This file is distributed on
13	* an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
14	* express or implied. See the License for the specific language governing
15	* permissions and limitations under the License.
16	*/
17
18	package com.uber.cadence.client;
19
20	import com.uber.cadence.WorkflowExecution;
21	import java.util.Optional;
22
23	/**
24	* Thrown when workflow already completed its execution and when the client is trying to run an
25	* operation on the workflow like signal, terminate, cancel, poll etc.
26	*/
27	public final class WorkflowAlreadyCompletedException extends WorkflowException {
28
29	public WorkflowAlreadyCompletedException(
30	WorkflowExecution execution, Optional<String> workflowType, String message) {
31	super(message, execution, workflowType, null);	×
32	}	×
33	}

uber / cadence-java-client / 2409

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous