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

Derive Serialize and Deserialize for most objects #412

Merged
merged 5 commits into from
Jan 6, 2025
Merged

Conversation

sfackler
Copy link
Member

@sfackler sfackler commented Jan 3, 2025

Before this PR

We manually implemented Serialize and Deserialize for all types, even if their representations could be handled by the normal serde derive macros.

After this PR

==COMMIT_MSG==
Serialize and Deserialize implementations of objects, aliases, and enums now use serde's derive macros.
==COMMIT_MSG==

This both shrinks the amount of code we're generating and should make it a bit more readable.

Unions are still manually implemented since serde doesn't support Conjure's weird combination of external and adjacent tagging. At some point we should move that logic into our own #[derive(Serialize_conjure)] macro.

@sfackler sfackler requested a review from a team January 3, 2025 01:23
@changelog-app
Copy link

changelog-app bot commented Jan 3, 2025

Generate changelog in changelog/@unreleased

What do the change types mean?
  • feature: A new feature of the service.
  • improvement: An incremental improvement in the functionality or operation of the service.
  • fix: Remedies the incorrect behaviour of a component of the service in a backwards-compatible way.
  • break: Has the potential to break consumers of this service's API, inclusive of both Palantir services
    and external consumers of the service's API (e.g. customer-written software or integrations).
  • deprecation: Advertises the intention to remove service functionality without any change to the
    operation of the service itself.
  • manualTask: Requires the possibility of manual intervention (running a script, eyeballing configuration,
    performing database surgery, ...) at the time of upgrade for it to succeed.
  • migration: A fully automatic upgrade migration task with no engineer input required.

Note: only one type should be chosen.

How are new versions calculated?
  • ❗The break and manual task changelog types will result in a major release!
  • 🐛 The fix changelog type will result in a minor release in most cases, and a patch release version for patch branches. This behaviour is configurable in autorelease.
  • ✨ All others will result in a minor version release.

Type

  • Feature
  • Improvement
  • Fix
  • Break
  • Deprecation
  • Manual task
  • Migration

Description

Serialize and Deserialize implementations of objects, aliases, and enums now use serde's derive macros.

Check the box to generate changelog(s)

  • Generate changelog entry

@sfackler sfackler merged commit 3b26b3b into master Jan 6, 2025
5 checks passed
@sfackler sfackler deleted the restructure branch January 6, 2025 15:50
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.

3 participants