Skip to content
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.

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

Need ODM SDF Syntax to Declare an Expected Response to an odmAction #63

Open
gerickson opened this issue Aug 16, 2019 · 4 comments
Open
Assignees
Labels
bug Something isn't working F2F4 Review PR WDL Related to Weave and the Weave Data Language and the ability for ODM SDF to losslessly express WDL.

Comments

@gerickson
Copy link

gerickson commented Aug 16, 2019

In Weave Data Language (WDL), Commands (ODM "Actions") may either be one-way "fire-and-forget" requests or two-way request / responses. A two-way response is declared as a RESPONSE_EVENT.

To be expressed in ODM SDF losslessly, a syntax construct for declaring an odmAction response is required.

This issue is related to #40. Where that declares the name of the response to expect in the request; this issue deals with declaring the response itself.

Relevant Example Schema Input Files

Example Input WDL

message SetUserPincodeRequest {
    option (wdl.message_type) = COMMAND;

    option (wdl.command) = {
        id: 0x01,
        completion_event: "SetUserPincodeResponse"
    };

    UserPincode  user_pincode = 1;
}

message SetUserPincodeResponse {
    option (wdl.message_type) = RESPONSE_EVENT;

    PincodeErrorCodes status = 1;
}
@mjkoster mjkoster self-assigned this Aug 28, 2019
@mjkoster mjkoster added the bug Something isn't working label Aug 28, 2019
@mjkoster
Copy link
Contributor

mjkoster commented Aug 28, 2019

outputData should cover this see #69

@WAvdBeek
Copy link
Collaborator

WAvdBeek commented Sep 2, 2019

i agree with Michael.

do we want to have a separate error identification?

@gerickson gerickson added the WDL Related to Weave and the Weave Data Language and the ability for ODM SDF to losslessly express WDL. label Sep 6, 2019
@mjkoster mjkoster added the F2F4 label Oct 1, 2019
@asoloway64
Copy link
Contributor

F2F4: We do not have any way to currently represent this. Lack of required output data cannot distinguish between "fire-and-forget" or optional payload. Action: Michael to create a new quality after confirmation on our understanding.

@mjkoster
Copy link
Contributor

mjkoster commented Nov 13, 2019

It seems like we need to indicate whether the action is expected to have a response or not, separately from whether output data are defined. I.e. if there are no output data defined, there still may be a response (we used to call it "synchronous" but that might be confusing in this context). How about a boolean quality "responseExpected" which could be used as a protocol hint?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working F2F4 Review PR WDL Related to Weave and the Weave Data Language and the ability for ODM SDF to losslessly express WDL.
Projects
None yet
Development

No branches or pull requests

4 participants