Skip to content

Fixed a bug with spaces in WorkflowIds when creating links in the UI. #2874

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

Open
Evanthx wants to merge 1 commit into
base: master
Choose a base branch
from
+41 −1
Open

Fixed a bug with spaces in WorkflowIds when creating links in the UI. #2874

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
10 changes: 9 additions & 1 deletion temporal-sdk/src/main/java/io/temporal/internal/common/LinkConverter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,11 +32,19 @@ public class LinkConverter {

public static io.temporal.api.nexus.v1.Link workflowEventToNexusLink(Link.WorkflowEvent we) {
try {

String url =
String.format(
linkPathFormat,
URLEncoder.encode(we.getNamespace(), StandardCharsets.UTF_8.toString()),
URLEncoder.encode(we.getWorkflowId(), StandardCharsets.UTF_8.toString()),
// The 'replace' below handles spaces - the encoder will convert them to a plus,
// which the UI then handles as a plus, thus breaking the link as the
// space is lost.
// It's a known quirk with the URLEncoder as it encodes for forms, not general URIs.
// Only done for the WorkflowId as the other two are values we control,
// and will never have spaces.
URLEncoder.encode(we.getWorkflowId(), StandardCharsets.UTF_8.toString())
.replace("+", "%20"),
URLEncoder.encode(we.getRunId(), StandardCharsets.UTF_8.toString()));

List<Map.Entry<String, String>> queryParams = new ArrayList<>();
Expand Down
32 changes: 32 additions & 0 deletions temporal-sdk/src/test/java/io/temporal/internal/common/LinkConverterTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@

import io.temporal.api.common.v1.Link;
import io.temporal.api.enums.v1.EventType;
import java.io.UnsupportedEncodingException;
import java.net.URLDecoder;
import java.nio.charset.StandardCharsets;
import org.junit.Test;

public class LinkConverterTest {
Expand Down Expand Up @@ -98,6 +101,35 @@ public void testConvertWorkflowEventToNexus_ValidSlash() {
assertEquals(expected, actual);
}

@Test
public void testConvertWorkflowEventToNexus_ValidSpace() throws UnsupportedEncodingException {
Link.WorkflowEvent input =
Link.WorkflowEvent.newBuilder()
.setNamespace("ns")
.setWorkflowId("wf space+plus")
.setRunId("run-id")
.setEventRef(
Link.WorkflowEvent.EventReference.newBuilder()
.setEventId(1)
.setEventType(EventType.EVENT_TYPE_WORKFLOW_EXECUTION_STARTED))
.build();

io.temporal.api.nexus.v1.Link expected =
io.temporal.api.nexus.v1.Link.newBuilder()
.setUrl(
"temporal:///namespaces/ns/workflows/wf%20space%2Bplus/run-id/history?referenceType=EventReference&eventID=1&eventType=WorkflowExecutionStarted")
.setType("temporal.api.common.v1.Link.WorkflowEvent")
.build();

io.temporal.api.nexus.v1.Link actual = workflowEventToNexusLink(input);
assertEquals(expected, actual);

String decoded = URLDecoder.decode(actual.getUrl(), StandardCharsets.UTF_8.toString());
assertEquals(
"temporal:///namespaces/ns/workflows/wf space+plus/run-id/history?referenceType=EventReference&eventID=1&eventType=WorkflowExecutionStarted",
decoded);
}

@Test
public void testConvertWorkflowEventToNexus_ValidEventIDMissing() {
Link.WorkflowEvent input =
Expand Down
Loading