66 auto skip serialize relate readonly fields

[Oyelowo]

Summary

This PR introduces a series of enhancements and cleanups to the attribute handling and serialization logic specifically focusing on improving integration with the serde library for serialization and deserialization processes. The updates include rigorous validation, error handling improvements, and more intuitive usage patterns for developers working with relational fields and serialization attributes.

Key Changes

• Attribute Handling Enhancements: Introduced and validated new attributes for better control and specification, ensuring that both default and skip_serializing are properly handled to meet our serialization requirements.

• Links and Relates Default value: made sure that we don't require that the foreign node requires default implementation as links and relates fields can default to null or empty vector with e.g LinkMany::null() or Relate::null(). Didn't realize the Default trait derive macro automatically creates a bound for every generics of Self to implement Default and we dont necessarily want to impose that restriction for links types since we can derive the types without know ing the type of the generic e.g for: LinkMany<T>, or LinkOne<T>, we can default to empty vector or null respectively

• Error Message Improvements: Refined the error messages related to required attributes, making them more informative and helpful in debugging and development processes.

• Serde Integration: Made significant updates to ensure that serialization and deserialization behaviors are correctly managed, reinstating the default attribute where necessary to avoid deserialization errors.

• Code Cleanup and Documentation: Conducted thorough cleanups to structure and spacing of the code for better readability and maintainability. Enhanced Rust documentation comments to clarify the functionality and usage of relational types.

• Testing and Updates: Updated tests to cover new scenarios and ensure that all changes are robust and stable across various use cases. This includes updates to snapshot tests and query relation tests.

• Optimization and Refactoring: Removed unused code and imports, utilized macros for defaults, and applied annotations to ignore unused code temporarily for easier search and future refactoring.

Technical Details

• Reconfigured the handling of non-serializable fields to ensure they are appropriately skipped during serialization, thus preventing runtime errors and maintaining data integrity.
• Adjusted field definitions and included defaults for relational fields to prevent null errors during deserialization.
• Enhanced the workspace resolver settings and synchronized feature updates across all related crates.

This PR makes sure the serialization logic is both robust and efficient, facilitating better maintainability and future-proofing the codebase against potential serialization-related issues.

Example:

use chrono::{DateTime, Utc};
use serde::{Deserialize, Serialize};
use surreal_orm::*;

#[derive(Node, Serialize, Deserialize, Debug, Clone)]
#[serde(rename_all = "camelCase")]
#[surreal_orm(table = user)]
pub struct User<'a> {
    pub id: SurrealId<Self, String>,
    pub name: String,
    pub created: DateTime<Utc>,
    pub company: &'a str,
    pub tags: Vec<String>,
}

#[derive(Edge, Serialize, Deserialize, Debug, Clone)]
#[serde(rename_all = "camelCase")]
#[surreal_orm(table = like)]
pub struct Like<In: Node, Out: Node> {
    pub id: SurrealSimpleId<Self>,

    #[surreal_orm(link_many = In)]
    pub r#in: LinkOne<In>,

    #[surreal_orm(link_one = Out)]
    pub out: LinkOne<Out>,

    #[surreal_orm(ty = "option<float>")]
    pub score: Option<f64>,

    #[surreal_orm(ty = "array<array<float>>")]
    pub scores_plural: Vec<Vec<f64>>,

    #[surreal_orm(nest_object = Time)]
    pub time: Time,
}
pub type CompanyLikeUser<'a> = Like<Company<'a>, User<'a>>;

#[derive(Node, Serialize, Deserialize, Debug, Clone)]
#[serde(rename_all = "camelCase")]
#[surreal_orm(table = company)]
pub struct Company<'b> {
    pub id: SurrealSimpleId<Self>,
    pub name: String,
    pub namex: &'b str,

    #[surreal_orm(link_many = "User<'b>")]
    pub users: LinkMany<User<'b>>,

    #[surreal_orm(relate(model = "CompanyLikeUser<'b>", connection = "->like->user"))]
    #[serde(skip_serializing, default)]
    pub devs: Relate<User<'b>>,
}

#[derive(Object, Serialize, Deserialize, Debug, Clone)]
#[serde(rename_all = "camelCase")]
pub struct Time {
    pub connected: DateTime<Utc>,
}

#[derive(Node, Serialize, Debug, Clone)]
#[serde(rename_all = "camelCase")]
#[surreal_orm(table = organization)]
pub struct Organization<'a> {
    pub id: SurrealSimpleId<Self>,
    pub name: String,

    #[surreal_orm(link_many = "User<'a>")]
    pub users: LinkMany<User<'a>>,

    #[surreal_orm(nest_object = Time)]
    pub time: Time,
    pub age: u8,
}