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

Change type of exchange_workflow field in RecurringExchange. #183

Closed
wants to merge 1 commit into from

Conversation

SanjayVas
Copy link
Member

This resource type is not used by any service so this is a safe change.

Closes #182

@wfa-reviewable
Copy link

This change is Reviewable

@SanjayVas SanjayVas force-pushed the sanjayvas-exchange-workflow branch from 60b70b7 to c8bfdd9 Compare October 13, 2023 19:05
Copy link
Contributor

@stevenwarejones stevenwarejones left a comment

Choose a reason for hiding this comment

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

Reviewed 2 of 2 files at r1, all commit messages.
Reviewable status: all files reviewed, 1 unresolved discussion (waiting on @SanjayVas)


src/main/proto/wfa/measurement/api/v2alpha/recurring_exchange.proto line 45 at r1 (raw file):

  // Serialized `ExchangeWorkflow` for this `RecurringExchange`.
  bytes exchange_workflow = 2 [

Shouldn't you deprecate the old field and add a new?

Copy link
Member Author

@SanjayVas SanjayVas left a comment

Choose a reason for hiding this comment

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

Reviewable status: all files reviewed, 1 unresolved discussion (waiting on @stevenwarejones)


src/main/proto/wfa/measurement/api/v2alpha/recurring_exchange.proto line 45 at r1 (raw file):
As indicated in the PR description:

This resource type is not used by any service so this is a safe change.

This resource has never been returned by any service, so we're free to make backwards-incompatible changes. Of course we should eventually have Get and List methods for every resource.

Copy link
Contributor

@stevenwarejones stevenwarejones left a comment

Choose a reason for hiding this comment

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

Reviewable status: all files reviewed, 1 unresolved discussion (waiting on @SanjayVas)


src/main/proto/wfa/measurement/api/v2alpha/recurring_exchange.proto line 45 at r1 (raw file):

Previously, SanjayVas (Sanjay Vasandani) wrote…

As indicated in the PR description:

This resource type is not used by any service so this is a safe change.

This resource has never been returned by any service, so we're free to make backwards-incompatible changes. Of course we should eventually have Get and List methods for every resource.

The name should be consistent with https://github.com/world-federation-of-advertisers/cross-media-measurement-api/blob/main/src/main/proto/wfa/measurement/api/v2alpha/exchange_step.proto#L73

This resource type is not used by any service so this is a safe change.
@SanjayVas SanjayVas force-pushed the sanjayvas-exchange-workflow branch from c8bfdd9 to b8d2bbb Compare October 16, 2023 15:33
Copy link
Member Author

@SanjayVas SanjayVas left a comment

Choose a reason for hiding this comment

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

Reviewable status: 1 of 2 files reviewed, 1 unresolved discussion (waiting on @stevenwarejones)


src/main/proto/wfa/measurement/api/v2alpha/recurring_exchange.proto line 45 at r1 (raw file):

Previously, stevenwarejones (Steven Ware Jones) wrote…

The name should be consistent with https://github.com/world-federation-of-advertisers/cross-media-measurement-api/blob/main/src/main/proto/wfa/measurement/api/v2alpha/exchange_step.proto#L73

Done (updated the field in ExchangeStep).

I had thought of that too, but had been avoiding the disruption. That said, we're making other breaking changes to the exchange API in this version anyway and the rename is wire-compatible change.

Note that renaming the field in this message would be inconsistent with any of our other serialized message fields which do not use the "serialized" prefix. I assume that ExchangeStep only had this prefix since the field in this message was not serialized.

Copy link
Contributor

@stevenwarejones stevenwarejones left a comment

Choose a reason for hiding this comment

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

Reviewed 1 of 1 files at r2, all commit messages.
Reviewable status: all files reviewed, 2 unresolved discussions (waiting on @SanjayVas)


src/main/proto/wfa/measurement/api/v2alpha/exchange_step.proto line 73 at r1 (raw file):

  // Denormalized `exchange_workflow` field from the ancestor
  // `RecurringExchange`.
  bytes serialized_exchange_workflow = 3 [

this field is read by clients today. That does make this a breaking change.

Copy link
Member Author

@SanjayVas SanjayVas left a comment

Choose a reason for hiding this comment

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

Reviewable status: all files reviewed, 2 unresolved discussions (waiting on @stevenwarejones)


src/main/proto/wfa/measurement/api/v2alpha/exchange_step.proto line 73 at r1 (raw file):

Previously, stevenwarejones (Steven Ware Jones) wrote…

this field is read by clients today. That does make this a breaking change.

"Breaking change" for API protobuf definition changes refers to wire-incompatible changes. A field rename for a gRPC-only API is fully wire compatible. (Note that this wouldn't be a backwards-compatible change if we also exposed this as a REST API, as that involves JSON serialization by field name).

This may result in changes to generated language-specific code that could result in compilation breakage, but that's a separate concern.

Copy link
Contributor

@stevenwarejones stevenwarejones left a comment

Choose a reason for hiding this comment

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

Reviewable status: :shipit: complete! all files reviewed, all discussions resolved (waiting on @SanjayVas)

@SanjayVas SanjayVas closed this Nov 1, 2023
@SanjayVas SanjayVas deleted the sanjayvas-exchange-workflow branch November 1, 2023 16:59
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.

RecurringExchange has deserialized ExchangeWorkflow field
3 participants