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

fix(source/nats): add missing default attribute for vectors #18261

Merged

Conversation

benjamin-awd
Copy link
Contributor

@benjamin-awd benjamin-awd commented Aug 27, 2024

I hereby agree to the terms of the RisingWave Labs, Inc. Contributor License Agreement.

What's changed and what's your intention?

Currently, the backoff and filter_subjects fields are required due to a missing default attribute, causing source creation to fail when they are not defined.

However, these fields should are supposed to be optional and should allow the creation of the source to proceed, even if they are not defined.

This PR adds the missing default attribute, which fixes the above issue.

Related to #17615

Checklist

  • I have written necessary rustdoc comments
  • I have added necessary unit tests and integration tests
  • I have added test labels as necessary. See details.
  • I have added fuzzing tests or opened an issue to track them. (Optional, recommended for new SQL features Sqlsmith: Sql feature generation #7934).
  • My PR contains breaking changes. (If it deprecates some features, please create a tracking issue to remove them in the future).
  • All checks passed in ./risedev check (or alias, ./risedev c)
  • My PR changes performance-critical code. (Please run macro/micro-benchmarks and show the results.)
  • My PR contains critical fixes that are necessary to be merged into the latest release. (Please check out the details)

Documentation

  • My PR needs documentation updates. (Please use the Release note section below to summarize the impact on users)

Release note

If this PR includes changes that directly affect users or other significant modifications relevant to the community, kindly draft a release note to provide a concise summary of these changes. Please prioritize highlighting the impact these changes will have on users.

@benjamin-awd benjamin-awd force-pushed the fix/nats-missing-default branch from 6d6a6a1 to 8df4a9a Compare August 27, 2024 07:35
Comment on lines 539 to +540
required: false
default: Default::default
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this PR imply the following problems:

  • Without the serde(default) the required: false here is actually misleading
  • Other attributes without serde(default) have the same problem

Copy link
Contributor Author

@benjamin-awd benjamin-awd Aug 27, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Based on our testing of this, the other attributes are unaffected. It seems that only the vector types are affected - my guess is that this is somehow needed due to the custom deserializer.

I drew reference from the Iceberg sink that uses a similar pattern

#[serde(
rename = "s3.path.style.access",
default,
deserialize_with = "deserialize_bool_from_string"
)]
pub path_style_access: bool,
#[serde(
rename = "primary_key",
default,
deserialize_with = "deserialize_optional_string_seq_from_string"
)]
pub primary_key: Option<Vec<String>>,

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! Yes, it seems only required when using deserialize_with. We will see if we can fix the required: false in yaml.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Anyway just to confirm, these attributes are optional so I think it's fine to keep required: false :)

Thanks for taking a look!

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes these 2 are now truly optional with default. I meant fixing the yaml generator when default is missing but deserialize_with is present.

@xiangjinwu xiangjinwu added this pull request to the merge queue Aug 28, 2024
Merged via the queue into risingwavelabs:main with commit 7998622 Aug 28, 2024
31 of 32 checks passed
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

Successfully merging this pull request may close these issues.

2 participants