Add deprecated field to event types (svix#1416)

## Motivation

Fixes the first bug reported in svix#1415.

## Solution

Backport event-type deprecated support.

Author: svix-jplatte

server/openapi.json

@@ -990,6 +990,10 @@
                         "example": false,
                         "type": "boolean"
                     },
+                    "deprecated": {
+                        "default": false,
+                        "type": "boolean"
+                    },
                     "description": {
                         "example": "A user has signed up",
                         "type": "string"
@@ -1054,6 +1058,9 @@
                         "format": "date-time",
                         "type": "string"
                     },
+                    "deprecated": {
+                        "type": "boolean"
+                    },
                     "description": {
                         "example": "A user has signed up",
                         "type": "string"
@@ -1107,6 +1114,7 @@
                 },
                 "required": [
                     "createdAt",
+                    "deprecated",
                     "description",
                     "name",
                     "updatedAt"
@@ -1118,6 +1126,9 @@
                     "archived": {
                         "type": "boolean"
                     },
+                    "deprecated": {
+                        "type": "boolean"
+                    },
                     "description": {
                         "type": "string"
                     },
@@ -1164,6 +1175,10 @@
                         "example": false,
                         "type": "boolean"
                     },
+                    "deprecated": {
+                        "default": false,
+                        "type": "boolean"
+                    },
                     "description": {
                         "example": "A user has signed up",
                         "type": "string"

server/svix-server/migrations/20240806212329_add_event_type_deprecated.down.sql

@@ -0,0 +1 @@
+ALTER TABLE eventtype DROP COLUMN deprecated;

server/svix-server/migrations/20240806212329_add_event_type_deprecated.up.sql

@@ -0,0 +1 @@
+ALTER TABLE eventtype ADD COLUMN deprecated BOOLEAN DEFAULT FALSE NOT NULL;

server/svix-server/src/db/models/eventtype.rs

@@ -26,6 +26,7 @@ pub struct Model {
     pub org_id: OrganizationId,
     pub description: String,
     pub deleted: bool,
+    pub deprecated: bool,
     pub schemas: Option<Schema>,
     pub name: EventTypeName,
     pub feature_flag: Option<FeatureFlag>,

server/svix-server/src/v1/endpoints/event_type.rs

@@ -60,6 +60,8 @@ pub struct EventTypeIn {
     #[serde(default, rename = "archived")]
     #[schemars(example = "example_event_archived")]
     pub deleted: bool,
+    #[serde(default)]
+    pub deprecated: bool,
     /// The schema for the event type for a specific version as a JSON schema.
     #[schemars(example = "event_type_versioned_schemas_example")]
     pub schemas: Option<eventtype::Schema>,
@@ -78,13 +80,15 @@ impl ModelIn for EventTypeIn {
             deleted,
             schemas,
             feature_flag,
+            deprecated,
         } = self;
 
         model.name = Set(name);
         model.description = Set(description);
         model.deleted = Set(deleted);
         model.schemas = Set(schemas);
         model.feature_flag = Set(feature_flag);
+        model.deprecated = Set(deprecated);
     }
 }
 
@@ -97,6 +101,8 @@ struct EventTypeUpdate {
     #[serde(default, rename = "archived")]
     #[schemars(example = "example_event_archived")]
     deleted: bool,
+    #[serde(default)]
+    deprecated: bool,
     /// The schema for the event type for a specific version as a JSON schema.
     #[schemars(example = "event_type_versioned_schemas_example")]
     schemas: Option<eventtype::Schema>,
@@ -112,12 +118,14 @@ impl ModelIn for EventTypeUpdate {
         let EventTypeUpdate {
             description,
             deleted,
+            deprecated,
             schemas,
             feature_flag,
         } = self;
 
         model.description = Set(description);
         model.deleted = Set(deleted);
+        model.deprecated = Set(deprecated);
         model.schemas = Set(schemas);
         model.feature_flag = Set(feature_flag);
     }
@@ -137,6 +145,9 @@ struct EventTypePatch {
     )]
     deleted: UnrequiredField<bool>,
 
+    #[serde(default, skip_serializing_if = "UnrequiredField::is_absent")]
+    deprecated: UnrequiredField<bool>,
+
     #[serde(default, skip_serializing_if = "UnrequiredNullableField::is_absent")]
     schemas: UnrequiredNullableField<eventtype::Schema>,
 
@@ -151,12 +162,14 @@ impl ModelIn for EventTypePatch {
         let EventTypePatch {
             description,
             deleted,
+            deprecated,
             schemas,
             feature_flag,
         } = self;
 
         patch_field_non_nullable!(model, description);
         patch_field_non_nullable!(model, deleted);
+        patch_field_non_nullable!(model, deprecated);
         patch_field_nullable!(model, schemas);
         patch_field_nullable!(model, feature_flag);
     }
@@ -171,6 +184,7 @@ pub struct EventTypeOut {
     #[serde(rename = "archived")]
     #[schemars(example = "example_event_archived", default = "example_event_archived")]
     pub deleted: bool,
+    pub deprecated: bool,
     /// The schema for the event type for a specific version as a JSON schema.
     #[schemars(example = "event_type_versioned_schemas_example")]
     pub schemas: Option<eventtype::Schema>,
@@ -196,6 +210,7 @@ impl From<eventtype::Model> for EventTypeOut {
             name: model.name,
             description: model.description,
             deleted: model.deleted,
+            deprecated: model.deprecated,
             schemas: model.schemas,
             feature_flag: model.feature_flag,
 

server/svix-server/tests/it/e2e_event_type.rs

@@ -218,6 +218,7 @@ async fn test_event_type_feature_flags() {
                 name: EventTypeName("event-type-with-flag".to_owned()),
                 description: "test-event-description".to_owned(),
                 deleted: false,
+                deprecated: false,
                 schemas: None,
                 feature_flag: Some(feature),
             },
@@ -233,6 +234,7 @@ async fn test_event_type_feature_flags() {
                 name: EventTypeName("no-flag-event".to_owned()),
                 description: "test-event-description".to_owned(),
                 deleted: false,
+                deprecated: false,
                 schemas: None,
                 feature_flag: None,
             },

server/svix-server/tests/it/utils/common_calls.rs

@@ -184,6 +184,7 @@ pub fn event_type_in(
         deleted: false,
         schemas: schema.into().map(|s| serde_json::from_value(s).unwrap()),
         feature_flag: None,
+        deprecated: false,
     })
 }