[BUG] WorkflowRequest doesn't serialize the use case and default parameters over transport

[dbwiddis]

What is the bug?

The WorkflowRequest class doesn't serialize the use case and default parameters over transport.

The writeTo() only writes the provision parameter and params map:

flow-framework/src/main/java/org/opensearch/flowframework/transport/WorkflowRequest.java

Lines 197 to 206 in cf1016f

	public void writeTo(StreamOutput out) throws IOException {
	super.writeTo(out);
	out.writeOptionalString(workflowId);
	out.writeOptionalString(template == null ? null : template.toJson());
	out.writeStringArray(validation);
	out.writeBoolean(provision);
	if (provision) {
	out.writeMap(params, StreamOutput::writeString, StreamOutput::writeString);
	}
	}

Similarly, the constructor using StreamInput doesn't read them

flow-framework/src/main/java/org/opensearch/flowframework/transport/WorkflowRequest.java

Lines 128 to 136 in cf1016f

	public WorkflowRequest(StreamInput in) throws IOException {
	super(in);
	this.workflowId = in.readOptionalString();
	String templateJson = in.readOptionalString();
	this.template = templateJson == null ? null : Template.parse(templateJson);
	this.validation = in.readStringArray();
	this.provision = in.readBoolean();
	this.params = this.provision ? in.readMap(StreamInput::readString, StreamInput::readString) : Collections.emptyMap();
	}

This was missed in unit testing because the tests incorrectly checked the original workflowRequest and not the streamInputRequest after passing through transport. (Note the last 4 lines.)

flow-framework/src/test/java/org/opensearch/flowframework/transport/WorkflowRequestResponseTests.java

Lines 155 to 166 in cf1016f

	BytesStreamOutput out = new BytesStreamOutput();
	workflowRequest.writeTo(out);
	BytesStreamInput in = new BytesStreamInput(BytesReference.toBytes(out.bytes()));
	WorkflowRequest streamInputRequest = new WorkflowRequest(in);
	assertEquals(workflowRequest.getWorkflowId(), streamInputRequest.getWorkflowId());
	assertEquals(workflowRequest.getTemplate().toString(), streamInputRequest.getTemplate().toString());
	assertNull(workflowRequest.validate());
	assertFalse(workflowRequest.isProvision());
	assertTrue(workflowRequest.getDefaultParams().isEmpty());
	assertEquals(workflowRequest.getUseCase(), "cohere-embedding_model_deploy");

How can one reproduce the bug?

Fix the unit test to properly test the workflow created from transport. Change lines 163-166 above to:

        assertNull(streamInputRequest.validate());
        assertFalse(streamInputRequest.isProvision());
        // FAILS, `getDefaultParams()` is null
        assertTrue(streamInputRequest.getDefaultParams().isEmpty()); 
        // FAILS, `getUseCase()` is null
        assertEquals(streamInputRequest.getUseCase(), "cohere-embedding_model_deploy");

What is the expected behavior?

If these fields are required to be part of the WorkflowRequest they should be properly serialized. Note that adding these fields would break compatibility across versions and would require version-checking for the additional fields.

However, these fields are never accessed in the code, other than in the (failing) tests. If they are not needed, they should be removed.

Do you have any additional context?

The fields were added in #583.

The tests have been fixed in #757, with the failing tests commented out until this issue is resolved.

[dbwiddis]

This can be addressed as part of #823