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

Backported schemas to codegen branch may break portability between platforms due to handling typeDSL #863

Open
tom-tan opened this issue Aug 30, 2024 · 0 comments

Comments

@tom-tan
Copy link
Member

tom-tan commented Aug 30, 2024

I'm not sure here is an appropriate place for this issue but I report it here because it is related to saladVersion.

Historically, in my understanding, the saladVersion field was introduced not to break the compatibility when implementing nested typeDSL.
That is:

  • Schemas of CWL v1.0, v1.1, v1.2 are defined with saladVersion v1.2 or earlier, not to handle nested typeDSL. Otherwise it may break portability between platforms
  • A Schema of CWL v1.3 is defined with saladVersion v1.3 to handle nestd typeDSL

At that time, we also discussed to introduce another field to control it but finally it was rejected.

By the way, saladVersion v1.3 also introduces map and union schemas to represent input objects and they are backported to the schemas in the codegen branch of CWL v1.0-v1.2.

That is, the code-gerenated parsers with backported schemas in saladVersion v1.3 accidentally support nested typeDSL.
Not to break the portability between platforms, it would be nice if we can fix this issue.

There are several ways to fix it.

  1. Introduce a new field to control nested typeDSL
    • It was discussed when implementing nested typeDSL but finally we decided to introduce saladVersion instead
    • IMO this option is worth discussed again
  2. Give up to backport map and union schemas to CWL v1.0-v1.2
    • It may become complex to implement and maintain the platforms for CWL v1.0-v1.2
  3. Support nested typeDSL in CWL v1.0-v1.2
    • IMO we cannot use this option because it is a breaking change to the spec
  4. Others?

What do you think?

@tom-tan tom-tan changed the title Backported schemas to codegen branch may break portability between platforms Backported schemas to codegen branch may break portability between platforms due to handling typeDSL Sep 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant