[Fairground] Deprecate and rename fields for new card attributes

[waisingyiu]

What does this change?

New types of cards have been introduced as part of the homepage redesign work, and the Card schema has been updated to enable MAPI to dictate which card UI to render via the collection response.

The previous PR #100 added new card size and boost level attributes. This pull request makes other changes to the schema as proposed:

• deprecate boosted, compact, mega_boosted, tail_image_size, trail_image_aspect_ratio, boosted_headline and headline_position fields in Card
• rename sublinks_arrangement to preferred_sublinks_arrangement by deprecating the old one and creating a new one

Although we want to deprecate the boosted and compact attributes and the CARD_TYPE_HIGHLIGHT card type, we cannot make them as deprecated in the proto file because production apps are consuming these attributes and we must continue to populate these attributes. Setting values in a deprecated field results in a warning that, under the current MAPI compilation settings, fails the whole compilation.

[gu-scala-library-release]

@waisingyiu has published a preview version of this PR with release workflow run #62, based on commit 3878e5e:

1.0.24-PREVIEW.fairgrounddeprecate-and-rename-fields-for-new-card-attributes.2024-09-12T1455.3878e5ec

Want to make another preview release?

Click 'Run workflow' in the GitHub UI, specifying the fairground/deprecate-and-rename-fields-for-new-card-attributes branch, or use the GitHub CLI command:

gh workflow run release.yml --ref fairground/deprecate-and-rename-fields-for-new-card-attributes

Want to make a full release after this PR is merged?

Click 'Run workflow' in the GitHub UI, leaving the branch as the default, or use the GitHub CLI command:

gh workflow run release.yml

[gu-scala-library-release]

@waisingyiu has published a preview version of this PR with release workflow run #63, based on commit 31f36e3:

1.0.24-PREVIEW.fairgrounddeprecate-and-rename-fields-for-new-card-attributes.2024-09-12T1508.31f36e36

Want to make another preview release?

Click 'Run workflow' in the GitHub UI, specifying the fairground/deprecate-and-rename-fields-for-new-card-attributes branch, or use the GitHub CLI command:

gh workflow run release.yml --ref fairground/deprecate-and-rename-fields-for-new-card-attributes

Want to make a full release after this PR is merged?

Click 'Run workflow' in the GitHub UI, leaving the branch as the default, or use the GitHub CLI command:

gh workflow run release.yml

[gu-scala-library-release]

@waisingyiu has published a preview version of this PR with release workflow run #64, based on commit 963d18b:

1.0.24-PREVIEW.fairgrounddeprecate-and-rename-fields-for-new-card-attributes.2024-09-12T1533.963d18ba

Want to make another preview release?

Click 'Run workflow' in the GitHub UI, specifying the fairground/deprecate-and-rename-fields-for-new-card-attributes branch, or use the GitHub CLI command:

gh workflow run release.yml --ref fairground/deprecate-and-rename-fields-for-new-card-attributes

Want to make a full release after this PR is merged?

Click 'Run workflow' in the GitHub UI, leaving the branch as the default, or use the GitHub CLI command:

gh workflow run release.yml

[waisingyiu]

Hey @ab-gnm sorry, I made some more changes after you approved the PR.

I found that accessing deprecated fields in MAPI results in a warning that would fail the compilation (due to our current "warning-as-error" compilation flag). So I should not mark some fields as deprecated if we still need to access them from MAPI, namely the compact, boosted and CARD_TYPE_HIGHLIGHT.

Great if you could take a look at it.

[ab-gnm]

So I should not mark some fields as deprecated if we still need to access them from MAPI, namely the compact, boosted and CARD_TYPE_HIGHLIGHT.

Do we still need to access these fields in MAPI when we're migrating to the new ones?

[waisingyiu]

So I should not mark some fields as deprecated if we still need to access them from MAPI, namely the compact, boosted and CARD_TYPE_HIGHLIGHT.

Do we still need to access these fields in MAPI when we're migrating to the new ones?

I think we still need to populate these fields because existing production apps are looking at compact and boosted attributes to decide on the type of cards for rendering. We still keep the CARD_TYPE_HIGHLIGHT card type for highlights collection because I assume the apps we are using for AB testing are looking at this card type. Or are there anything I miss?