test(dpp): improve coverage for document serialization, extended documents, and methods

packages/rs-dpp/src/document/document_methods/get_raw_for_document_type/v0/mod.rs

@@ -82,3 +82,342 @@ pub trait DocumentGetRawForDocumentTypeV0: DocumentV0Getters {
             .transpose()
     }
 }
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+    use crate::data_contract::accessors::v0::DataContractV0Getters;
+    use crate::data_contract::document_type::random_document::CreateRandomDocument;
+    use crate::document::DocumentV0;
+    use crate::tests::json_document::json_document_to_contract;
+    use platform_value::Identifier;
+    use platform_version::version::PlatformVersion;
+    use std::collections::BTreeMap;
+
+    fn make_document_with_known_ids() -> DocumentV0 {
+        DocumentV0 {
+            id: Identifier::new([0xAA; 32]),
+            owner_id: Identifier::new([0xBB; 32]),
+            properties: BTreeMap::new(),
+            revision: None,
+            created_at: Some(1_700_000_000_000),
+            updated_at: Some(1_700_000_100_000),
+            transferred_at: Some(1_700_000_200_000),
+            created_at_block_height: Some(100),
+            updated_at_block_height: Some(200),
+            transferred_at_block_height: Some(300),
+            created_at_core_block_height: Some(50),
+            updated_at_core_block_height: Some(60),
+            transferred_at_core_block_height: Some(70),
+            creator_id: Some(Identifier::new([0xCC; 32])),
+        }
+    }
+
+    // ================================================================
+    //  System field extraction: $id, $ownerId, $creatorId
+    // ================================================================
+
+    #[test]
+    fn get_raw_returns_id_for_dollar_id() {
+        let platform_version = PlatformVersion::latest();
+        let contract = json_document_to_contract(
+            "../rs-drive/tests/supporting_files/contract/dashpay/dashpay-contract.json",
+            false,
+            platform_version,
+        )
+        .expect("expected contract");
+        let document_type = contract
+            .document_type_for_name("profile")
+            .expect("expected document type");
+
+        let doc = make_document_with_known_ids();
+        let raw = doc
+            .get_raw_for_document_type_v0("$id", document_type, None, platform_version)
+            .expect("should succeed");
+        assert_eq!(
+            raw,
+            Some(doc.id.to_vec()),
+            "$id should return the document id bytes"
+        );
+    }
+
+    #[test]
+    fn get_raw_returns_owner_id_for_dollar_owner_id() {
+        let platform_version = PlatformVersion::latest();
+        let contract = json_document_to_contract(
+            "../rs-drive/tests/supporting_files/contract/dashpay/dashpay-contract.json",
+            false,
+            platform_version,
+        )
+        .expect("expected contract");
+        let document_type = contract
+            .document_type_for_name("profile")
+            .expect("expected document type");
+
+        let doc = make_document_with_known_ids();
+        let raw = doc
+            .get_raw_for_document_type_v0("$ownerId", document_type, None, platform_version)
+            .expect("should succeed");
+        assert_eq!(raw, Some(doc.owner_id.to_vec()));
+    }
+
+    #[test]
+    fn get_raw_returns_override_owner_id_when_provided() {
+        let platform_version = PlatformVersion::latest();
+        let contract = json_document_to_contract(
+            "../rs-drive/tests/supporting_files/contract/dashpay/dashpay-contract.json",
+            false,
+            platform_version,
+        )
+        .expect("expected contract");
+        let document_type = contract
+            .document_type_for_name("profile")
+            .expect("expected document type");
+
+        let doc = make_document_with_known_ids();
+        let override_owner = [0xFF; 32];
+        let raw = doc
+            .get_raw_for_document_type_v0(
+                "$ownerId",
+                document_type,
+                Some(override_owner),
+                platform_version,
+            )
+            .expect("should succeed");
+        assert_eq!(
+            raw,
+            Some(Vec::from(override_owner)),
+            "explicit owner_id should override the document's owner_id"
+        );
+    }
+
+    #[test]
+    fn get_raw_returns_creator_id() {
+        let platform_version = PlatformVersion::latest();
+        let contract = json_document_to_contract(
+            "../rs-drive/tests/supporting_files/contract/dashpay/dashpay-contract.json",
+            false,
+            platform_version,
+        )
+        .expect("expected contract");
+        let document_type = contract
+            .document_type_for_name("profile")
+            .expect("expected document type");
+
+        let doc = make_document_with_known_ids();
+        let raw = doc
+            .get_raw_for_document_type_v0("$creatorId", document_type, None, platform_version)
+            .expect("should succeed");
+        assert_eq!(raw, Some(Identifier::new([0xCC; 32]).to_vec()));
+    }
+
+    // ================================================================
+    //  Timestamp fields
+    // ================================================================
+
+    #[test]
+    fn get_raw_returns_encoded_created_at() {
+        let platform_version = PlatformVersion::latest();
+        let contract = json_document_to_contract(
+            "../rs-drive/tests/supporting_files/contract/dashpay/dashpay-contract.json",
+            false,
+            platform_version,
+        )
+        .expect("expected contract");
+        let document_type = contract
+            .document_type_for_name("profile")
+            .expect("expected document type");
+
+        let doc = make_document_with_known_ids();
+        let raw = doc
+            .get_raw_for_document_type_v0("$createdAt", document_type, None, platform_version)
+            .expect("should succeed");
+        assert!(raw.is_some(), "$createdAt should produce bytes");
+        let expected = DocumentPropertyType::encode_date_timestamp(1_700_000_000_000);
+        assert_eq!(raw.unwrap(), expected);
+    }
+
+    #[test]
+    fn get_raw_returns_encoded_updated_at() {
+        let platform_version = PlatformVersion::latest();
+        let contract = json_document_to_contract(
+            "../rs-drive/tests/supporting_files/contract/dashpay/dashpay-contract.json",
+            false,
+            platform_version,
+        )
+        .expect("expected contract");
+        let document_type = contract
+            .document_type_for_name("profile")
+            .expect("expected document type");
+
+        let doc = make_document_with_known_ids();
+        let raw = doc
+            .get_raw_for_document_type_v0("$updatedAt", document_type, None, platform_version)
+            .expect("should succeed");
+        assert!(raw.is_some());
+        let expected = DocumentPropertyType::encode_date_timestamp(1_700_000_100_000);
+        assert_eq!(raw.unwrap(), expected);
+    }
+
+    #[test]
+    fn get_raw_returns_encoded_block_heights() {
+        let platform_version = PlatformVersion::latest();
+        let contract = json_document_to_contract(
+            "../rs-drive/tests/supporting_files/contract/dashpay/dashpay-contract.json",
+            false,
+            platform_version,
+        )
+        .expect("expected contract");
+        let document_type = contract
+            .document_type_for_name("profile")
+            .expect("expected document type");
+
+        let doc = make_document_with_known_ids();
+
+        // $createdAtBlockHeight -> encode_u64(100)
+        let raw = doc
+            .get_raw_for_document_type_v0(
+                "$createdAtBlockHeight",
+                document_type,
+                None,
+                platform_version,
+            )
+            .expect("should succeed");
+        assert_eq!(raw, Some(DocumentPropertyType::encode_u64(100)));
+
+        // $updatedAtBlockHeight -> encode_u64(200)
+        let raw = doc
+            .get_raw_for_document_type_v0(
+                "$updatedAtBlockHeight",
+                document_type,
+                None,
+                platform_version,
+            )
+            .expect("should succeed");
+        assert_eq!(raw, Some(DocumentPropertyType::encode_u64(200)));
+
+        // $createdAtCoreBlockHeight -> encode_u32(50)
+        let raw = doc
+            .get_raw_for_document_type_v0(
+                "$createdAtCoreBlockHeight",
+                document_type,
+                None,
+                platform_version,
+            )
+            .expect("should succeed");
+        assert_eq!(raw, Some(DocumentPropertyType::encode_u32(50)));
+
+        // $updatedAtCoreBlockHeight -> encode_u32(60)
+        let raw = doc
+            .get_raw_for_document_type_v0(
+                "$updatedAtCoreBlockHeight",
+                document_type,
+                None,
+                platform_version,
+            )
+            .expect("should succeed");
+        assert_eq!(raw, Some(DocumentPropertyType::encode_u32(60)));
+    }
+
+    #[test]
+    fn get_raw_returns_encoded_transferred_fields() {
+        let platform_version = PlatformVersion::latest();
+        let contract = json_document_to_contract(
+            "../rs-drive/tests/supporting_files/contract/dashpay/dashpay-contract.json",
+            false,
+            platform_version,
+        )
+        .expect("expected contract");
+        let document_type = contract
+            .document_type_for_name("profile")
+            .expect("expected document type");
+
+        let doc = make_document_with_known_ids();
+
+        let raw = doc
+            .get_raw_for_document_type_v0("$transferredAt", document_type, None, platform_version)
+            .expect("should succeed");
+        assert_eq!(
+            raw,
+            Some(DocumentPropertyType::encode_date_timestamp(
+                1_700_000_200_000
+            ))
+        );
+
+        let raw = doc
+            .get_raw_for_document_type_v0(
+                "$transferredAtBlockHeight",
+                document_type,
+                None,
+                platform_version,
+            )
+            .expect("should succeed");
+        assert_eq!(raw, Some(DocumentPropertyType::encode_u64(300)));
+
+        let raw = doc
+            .get_raw_for_document_type_v0(
+                "$transferredAtCoreBlockHeight",
+                document_type,
+                None,
+                platform_version,
+            )
+            .expect("should succeed");
+        assert_eq!(raw, Some(DocumentPropertyType::encode_u32(70)));
+    }
+
+    // ================================================================
+    //  Non-existent property returns None
+    // ================================================================
+
+    #[test]
+    fn get_raw_returns_none_for_missing_property() {
+        let platform_version = PlatformVersion::latest();
+        let contract = json_document_to_contract(
+            "../rs-drive/tests/supporting_files/contract/dashpay/dashpay-contract.json",
+            false,
+            platform_version,
+        )
+        .expect("expected contract");
+        let document_type = contract
+            .document_type_for_name("profile")
+            .expect("expected document type");
+
+        let doc = make_document_with_known_ids();
+        let raw = doc
+            .get_raw_for_document_type_v0("nonExistentField", document_type, None, platform_version)
+            .expect("should succeed");
+        assert_eq!(raw, None);
+    }
+
+    // ================================================================
+    //  User-defined property serialization
+    // ================================================================
+
+    #[test]
+    fn get_raw_serializes_user_defined_property() {
+        let platform_version = PlatformVersion::latest();
+        let contract = json_document_to_contract(
+            "../rs-drive/tests/supporting_files/contract/dashpay/dashpay-contract.json",
+            false,
+            platform_version,
+        )
+        .expect("expected contract");
+        let document_type = contract
+            .document_type_for_name("profile")
+            .expect("expected document type");
+
+        let document = document_type
+            .random_document(Some(42), platform_version)
+            .expect("expected random document");
+
+        let doc_v0 = match &document {
+            crate::document::Document::V0(d) => d,
+        };
+
+        // "displayName" is a required string property in dashpay profile
+        let raw = doc_v0
+            .get_raw_for_document_type_v0("displayName", document_type, None, platform_version)
+            .expect("should succeed");
+        assert!(raw.is_some(), "displayName should produce serialized bytes");
+    }
+}