ref: Remove generate-schema command and JSON schema (#3974)

As it was not used in an automated context, we're removing the generated JSON schema for the event protocol. This resolves inconsistencies in the documentation of our event protocol and also improves our compile times through fewer derives. We will subsequently improve the documentation of Relays types and work on a replacement mechanism to publish docs for these types. In the meanwhile, documentation can be viewed here: https://getsentry.github.io/relay/relay_event_schema/protocol/index.html
getsentry · Sep 2, 2024 · 743d4b1 · 743d4b1
1 parent 44186da
commit 743d4b1
Show file tree

Hide file tree

Showing 62 changed files with 5 additions and 5,256 deletions.
diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
@@ -48,56 +48,6 @@ jobs:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           publish_dir: target/doc
 
-  event_schema:
-    name: Event Schema
-    runs-on: ubuntu-latest
-
-    steps:
-      - uses: actions/checkout@v4
-        with:
-          submodules: recursive
-
-      - name: Install Rust Toolchain
-        run: rustup toolchain install stable --profile minimal --no-self-update
-
-      - uses: swatinem/rust-cache@v2
-        with:
-          key: ${{ github.job }}
-
-      - name: Generate Schema
-        run: cargo run -p generate-schema -- -o event.schema.json
-
-      - name: Deploy
-        if: github.ref == 'refs/heads/master'
-        env:
-          GITHUB_TOKEN: ${{ secrets.DATA_SCHEMAS_GITHUB_TOKEN }}
-        run: |
-          git config --global user.name "$(git log -1 --pretty=format:%an $GITHUB_SHA)"
-          git config --global user.email "$(git log -1 --pretty=format:%ae $GITHUB_SHA)"
-          git clone https://getsentry-bot:[email protected]/getsentry/sentry-data-schemas
-          cd sentry-data-schemas/
-          mkdir -p ./relay/
-          mv ../event.schema.json relay/event.schema.json
-          git add relay/event.schema.json
-
-          echo "attempting commit"
-          if ! git commit -m "getsentry/relay@$GITHUB_SHA" ; then
-            echo "Stopping, no changes"
-            exit 0
-          fi
-
-          for i in 1 2 3 4 5; do
-            echo "git push; Attempt $i"
-            if git push; then
-              exit 0
-            fi
-
-            git pull --rebase
-          done
-
-          echo "Failed to push"
-          exit 1
-
   metrics_docs:
     name: Metrics Docs
     runs-on: ubuntu-latest

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -24,6 +24,7 @@
 - Remove support for extrapolation of metrics. ([#3969](https://github.com/getsentry/relay/pull/3969))
 - Remove the internal dashboard that shows logs and metrics. ([#3970](https://github.com/getsentry/relay/pull/3970))
 - Remove the OTEL spans endpoint in favor of Envelopes. ([#3973](https://github.com/getsentry/relay/pull/3973))
+- Remove the `generate-schema` tool. Relay no longer exposes JSON schema for the event protocol. Consult the Rust type documentation of the `relay-event-schema` crate instead. ([#3974](https://github.com/getsentry/relay/pull/3974))
 - Allow creation of `SqliteEnvelopeBuffer` from config, and load existing stacks from db on startup. ([#3967](https://github.com/getsentry/relay/pull/3967))
 
 ## 24.8.0

diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -57,7 +57,6 @@ relay-ua = { path = "relay-ua" }
 relay-test = { path = "relay-test" }
 relay-protocol-derive = { path = "relay-protocol-derive" }
 relay-event-derive = { path = "relay-event-derive" }
-relay-jsonschema-derive = { path = "relay-jsonschema-derive" }
 
 android_trace_log = { version = "0.3.0", features = ["serde"] }
 anyhow = "1.0.66"
@@ -137,7 +136,6 @@ regex = "1.10.2"
 regex-lite = "0.1.6"
 reqwest = "0.12.7"
 rmp-serde = "1.1.1"
-schemars = { version = "=0.8.10", features = ["uuid1", "chrono"] }
 sentry = "0.34.0"
 sentry-core = "0.34.0"
 sentry-kafka-schemas = { version = "0.1.86", default-features = false }

diff --git a/relay-base-schema/Cargo.toml b/relay-base-schema/Cargo.toml
@@ -16,12 +16,10 @@ workspace = true
 regex = { workspace = true }
 relay-common = { workspace = true }
 relay-protocol = { workspace = true }
-schemars = { workspace = true, optional = true }
 serde = { workspace = true }
 
 [dev-dependencies]
 serde_json = { workspace = true }
 
 [features]
 default = []
-jsonschema = ["dep:schemars", "relay-protocol/jsonschema"]
diff --git a/relay-base-schema/src/events.rs b/relay-base-schema/src/events.rs
@@ -7,8 +7,6 @@ use std::fmt;
 use std::str::FromStr;
 
 use relay_protocol::{Annotated, Empty, ErrorKind, FromValue, IntoValue, SkipSerialization, Value};
-#[cfg(feature = "jsonschema")]
-use schemars::JsonSchema;
 use serde::{Deserialize, Serialize};
 
 /// The type of an event.
@@ -26,7 +24,6 @@ use serde::{Deserialize, Serialize};
 #[derive(
     Clone, Copy, Debug, Eq, Hash, Ord, PartialEq, PartialOrd, Deserialize, Serialize, Default,
 )]
-#[cfg_attr(feature = "jsonschema", derive(JsonSchema))]
 #[serde(rename_all = "lowercase")]
 pub enum EventType {
     /// Events that carry an exception payload.

diff --git a/relay-base-schema/src/metrics/units.rs b/relay-base-schema/src/metrics/units.rs
@@ -94,17 +94,6 @@ impl std::str::FromStr for MetricUnit {
 
 relay_common::impl_str_serde!(MetricUnit, "a metric unit string");
 
-#[cfg(feature = "jsonschema")]
-impl schemars::JsonSchema for MetricUnit {
-    fn schema_name() -> String {
-        std::any::type_name::<Self>().to_owned()
-    }
-
-    fn json_schema(gen: &mut schemars::gen::SchemaGenerator) -> schemars::schema::Schema {
-        String::json_schema(gen)
-    }
-}
-
 impl Empty for MetricUnit {
     #[inline]
     fn is_empty(&self) -> bool {

diff --git a/relay-base-schema/src/spans.rs b/relay-base-schema/src/spans.rs
@@ -4,8 +4,6 @@ use std::fmt;
 use std::str::FromStr;
 
 use relay_protocol::{Annotated, Empty, Error, FromValue, IntoValue, SkipSerialization, Value};
-#[cfg(feature = "jsonschema")]
-use schemars::JsonSchema;
 use serde::Serialize;
 
 /// Trace status.
@@ -16,7 +14,6 @@ use serde::Serialize;
 // Note: This type is represented as a u8 in Snuba/Clickhouse, with Unknown being the default
 // value. We use repr(u8) to statically validate that the trace status has 255 variants at most.
 #[derive(Clone, Copy, Debug, PartialEq, Serialize)]
-#[cfg_attr(feature = "jsonschema", derive(JsonSchema))]
 #[serde(rename_all = "snake_case")]
 #[repr(u8)] // size limit in clickhouse
 pub enum SpanStatus {

diff --git a/relay-event-schema/Cargo.toml b/relay-event-schema/Cargo.toml
@@ -21,9 +21,7 @@ enumset = { workspace = true }
 relay-common = { workspace = true }
 relay-base-schema = { workspace = true }
 relay-event-derive = { workspace = true }
-relay-jsonschema-derive = { workspace = true, optional = true }
 relay-protocol = { workspace = true, features = ["derive"] }
-schemars = { workspace = true, optional = true }
 sentry-release-parser = { workspace = true }
 serde = { workspace = true }
 serde_json = { workspace = true }
@@ -35,11 +33,3 @@ uuid = { workspace = true }
 insta = { workspace = true }
 relay-protocol = { workspace = true, features = ["test"] }
 similar-asserts = { workspace = true }
-
-[features]
-jsonschema = [
-    "relay-base-schema/jsonschema",
-    "relay-protocol/jsonschema",
-    "dep:relay-jsonschema-derive",
-    "dep:schemars",
-]
diff --git a/relay-event-schema/src/protocol/breadcrumb.rs b/relay-event-schema/src/protocol/breadcrumb.rs
@@ -1,7 +1,5 @@
 #[cfg(test)]
 use chrono::{TimeZone, Utc};
-#[cfg(feature = "jsonschema")]
-use relay_jsonschema_derive::JsonSchema;
 use relay_protocol::{Annotated, Empty, FromValue, IntoValue, Object, Value};
 
 use crate::processor::ProcessValue;
@@ -47,7 +45,6 @@ use crate::protocol::{EventId, Level, Timestamp};
 /// }
 /// ```
 #[derive(Clone, Debug, Default, PartialEq, Empty, FromValue, IntoValue, ProcessValue)]
-#[cfg_attr(feature = "jsonschema", derive(JsonSchema))]
 #[metastructure(process_func = "process_breadcrumb", value_type = "Breadcrumb")]
 pub struct Breadcrumb {
     /// The timestamp of the breadcrumb. Recommended.

diff --git a/relay-event-schema/src/protocol/clientsdk.rs b/relay-event-schema/src/protocol/clientsdk.rs
@@ -1,13 +1,10 @@
-#[cfg(feature = "jsonschema")]
-use relay_jsonschema_derive::JsonSchema;
 use relay_protocol::{Annotated, Array, Empty, FromValue, IntoValue, Object, Value};
 
 use crate::processor::ProcessValue;
 use crate::protocol::IpAddr;
 
 /// An installed and loaded package as part of the Sentry SDK.
 #[derive(Clone, Debug, Default, PartialEq, Empty, FromValue, IntoValue, ProcessValue)]
-#[cfg_attr(feature = "jsonschema", derive(JsonSchema))]
 pub struct ClientSdkPackage {
     /// Name of the package.
     pub name: Annotated<String>,
@@ -17,7 +14,6 @@ pub struct ClientSdkPackage {
 
 /// The SDK Interface describes the Sentry SDK and its configuration used to capture and transmit an event.
 #[derive(Clone, Debug, Default, PartialEq, Empty, FromValue, IntoValue, ProcessValue)]
-#[cfg_attr(feature = "jsonschema", derive(JsonSchema))]
 #[metastructure(process_func = "process_client_sdk_info", value_type = "ClientSdkInfo")]
 pub struct ClientSdkInfo {
     /// Unique SDK name. _Required._

diff --git a/relay-event-schema/src/protocol/contexts/app.rs b/relay-event-schema/src/protocol/contexts/app.rs
@@ -1,5 +1,3 @@
-#[cfg(feature = "jsonschema")]
-use relay_jsonschema_derive::JsonSchema;
 use relay_protocol::{Annotated, Empty, FromValue, IntoValue, Object, Value};
 
 use crate::processor::ProcessValue;
@@ -10,7 +8,6 @@ use crate::protocol::LenientString;
 /// App context describes the application. As opposed to the runtime, this is the actual
 /// application that was running and carries metadata about the current session.
 #[derive(Clone, Debug, Default, PartialEq, Empty, FromValue, IntoValue, ProcessValue)]
-#[cfg_attr(feature = "jsonschema", derive(JsonSchema))]
 pub struct AppContext {
     /// Start time of the app.
     ///

diff --git a/relay-event-schema/src/protocol/contexts/browser.rs b/relay-event-schema/src/protocol/contexts/browser.rs
@@ -1,12 +1,9 @@
-#[cfg(feature = "jsonschema")]
-use relay_jsonschema_derive::JsonSchema;
 use relay_protocol::{Annotated, Empty, FromValue, IntoValue, Object, Value};
 
 use crate::processor::ProcessValue;
 
 /// Web browser information.
 #[derive(Clone, Debug, Default, PartialEq, Empty, FromValue, IntoValue, ProcessValue)]
-#[cfg_attr(feature = "jsonschema", derive(JsonSchema))]
 pub struct BrowserContext {
     /// Display name of the browser application.
     pub name: Annotated<String>,

diff --git a/relay-event-schema/src/protocol/contexts/cloud_resource.rs b/relay-event-schema/src/protocol/contexts/cloud_resource.rs
@@ -1,5 +1,3 @@
-#[cfg(feature = "jsonschema")]
-use relay_jsonschema_derive::JsonSchema;
 use relay_protocol::{Annotated, Empty, FromValue, IntoValue, Object, Value};
 
 use crate::processor::ProcessValue;
@@ -22,7 +20,6 @@ use crate::processor::ProcessValue;
 /// }
 /// ```
 #[derive(Clone, Debug, Default, PartialEq, Empty, FromValue, IntoValue, ProcessValue)]
-#[cfg_attr(feature = "jsonschema", derive(JsonSchema))]
 pub struct CloudResourceContext {
     /// The cloud account ID the resource is assigned to.
     #[metastructure(pii = "maybe")]

diff --git a/relay-event-schema/src/protocol/contexts/device.rs b/relay-event-schema/src/protocol/contexts/device.rs
@@ -1,5 +1,3 @@
-#[cfg(feature = "jsonschema")]
-use relay_jsonschema_derive::JsonSchema;
 use relay_protocol::{Annotated, Empty, FromValue, IntoValue, Object, Value};
 use uuid::Uuid;
 
@@ -10,7 +8,6 @@ use crate::processor::ProcessValue;
 /// Device context describes the device that caused the event. This is most appropriate for mobile
 /// applications.
 #[derive(Clone, Debug, Default, PartialEq, Empty, FromValue, IntoValue, ProcessValue)]
-#[cfg_attr(feature = "jsonschema", derive(JsonSchema))]
 pub struct DeviceContext {
     /// Name of the device.
     #[metastructure(pii = "maybe")]

diff --git a/relay-event-schema/src/protocol/contexts/gpu.rs b/relay-event-schema/src/protocol/contexts/gpu.rs
@@ -1,5 +1,3 @@
-#[cfg(feature = "jsonschema")]
-use relay_jsonschema_derive::JsonSchema;
 use relay_protocol::{Annotated, Empty, FromValue, IntoValue, Object, Value};
 
 use crate::processor::ProcessValue;
@@ -20,7 +18,6 @@ use crate::processor::ProcessValue;
 /// }
 /// ```
 #[derive(Clone, Debug, Default, PartialEq, Empty, FromValue, IntoValue, ProcessValue)]
-#[cfg_attr(feature = "jsonschema", derive(JsonSchema))]
 pub struct GpuContext {
     /// The name of the graphics device.
     #[metastructure(pii = "maybe")]