Struct ReimportObservation 

pub struct ReimportObservation { /* private fields */ }

One named query observation used to reconcile the empty-database reimport.

Implementations

impl ReimportObservation

pub fn new( name: InstallationSymbol, query: InstallationSymbol, expected_hash: GeneratedArtifactHash, maximum_items: u32, ) -> Result<ReimportObservation, ApplicationPortabilityError>

Creates one bounded symbolic observation.

pub fn new_with_parameters( name: InstallationSymbol, query: InstallationSymbol, module_hash: QueryModuleHash, parameters: Vec<ReimportObservationParameter>, expected_hash: GeneratedArtifactHash, maximum_items: u32, ) -> Result<ReimportObservation, ApplicationPortabilityError>

Creates one bounded symbolic observation with exact typed scalar parameters.

Examples found in repository

examples/generate_portability_fixtures.rs (lines 150-167)

fn generate_domain(root: &Path, domain: &Domain<'_>, write: bool) {
    let bundle = ContractBundle::decode(
        &fs::read(
            root.join(domain.application_root)
                .join("generated/riffdb.contract.bundle"),
        )
        .expect("read adapter contract bundle"),
    )
    .expect("decode adapter contract bundle");
    let adapter = AdapterConformanceManifest::decode_canonical(
        &fs::read(
            root.join("fixtures/adapters/conformance")
                .join(domain.name)
                .join("adapter.conformance.json"),
        )
        .expect("read adapter manifest"),
    )
    .expect("decode adapter manifest");
    let observation_hash = empty_observation_hash(domain.empty_collection);
    let module_hash = adapter
        .input()
        .artifacts
        .iter()
        .find(|artifact| artifact.kind() == InstallationArtifactKind::QueryModule)
        .map(|artifact| QueryModuleHash::from_bytes(*artifact.content_hash().as_bytes()))
        .expect("adapter query module");
    let manifest = ApplicationPortabilityManifest::compile(ApplicationPortabilityManifestInput {
        adapter_manifest_hash: adapter.identity(),
        contract_lineage: bundle.lineage().clone(),
        contract_version: bundle.contract_version(),
        contract_bundle_hash: bundle.bundle_hash(),
        mappings: domain
            .mappings
            .iter()
            .map(|(entity, command)| {
                PortableRecordMapping::new(
                    PortableRecordClass::Entity,
                    symbol(entity),
                    PortableReimportStrategy::reimport_command(symbol(command)),
                )
            })
            .collect(),
        omissions: vec![
            PortableOmission::new(
                PortableOmissionClass::Provenance,
                None,
                PortableOmissionReason::HistoricalRecordsNotRegenerable,
            )
            .expect("provenance omission"),
            PortableOmission::new(
                PortableOmissionClass::PublicAudit,
                None,
                PortableOmissionReason::HistoricalRecordsNotRegenerable,
            )
            .expect("audit omission"),
        ],
        observations: vec![
            ReimportObservation::new_with_parameters(
                symbol("application_observation"),
                symbol(domain.query),
                module_hash,
                domain
                    .parameters
                    .iter()
                    .map(|(name, suffix)| {
                        ReimportObservationParameter::new(
                            symbol(name),
                            CanonicalValue::Uuid(application_uuid(*suffix)),
                        )
                        .expect("observation parameter")
                    })
                    .collect(),
                observation_hash,
                500,
            )
            .expect("observation"),
        ],
    })
    .expect("compile portability manifest");
    manifest
        .validate_compiled_contract(&bundle)
        .expect("compiled contract mapping");
    assert_eq!(manifest.input().adapter_manifest_hash, adapter.identity());
    assert_eq!(
        manifest.input().contract_lineage,
        adapter.input().contract_lineage
    );
    assert!(adapter.input().evolution.iter().any(|evolution| {
        evolution.successor().version() == manifest.input().contract_version
            && evolution.successor().bundle_hash() == manifest.input().contract_bundle_hash
    }));
    manifest
        .validate_adapter_conformance(&adapter)
        .unwrap_or_else(|error| panic!("{} adapter mapping: {error:?}", domain.name));

    let outcome_hash = hash_generated_artifact(format!("{}-outcomes-v1", domain.name).as_bytes());
    let destination = root.join("fixtures/export").join(domain.name);
    let receipt = reimport_receipt(&manifest, domain, outcome_hash);
    update(
        destination.join("portability-manifest-v3.json"),
        manifest.canonical_bytes(),
        write,
    );
    let legacy_manifest_path = destination.join("portability-manifest-v2.json");
    if legacy_manifest_path.is_file() {
        let legacy_manifest = ApplicationPortabilityManifest::decode_canonical(
            &fs::read(legacy_manifest_path).expect("read V2 portability manifest"),
        )
        .expect("decode V2 portability manifest");
        let legacy_receipt = reimport_receipt(&legacy_manifest, domain, outcome_hash);
        update(
            destination.join("reimport-receipt-v2.json"),
            legacy_receipt.canonical_bytes(),
            write,
        );
    }
    update(
        destination.join("reimport-receipt-v3.json"),
        receipt.canonical_bytes(),
        write,
    );
}

pub const fn name(&self) -> &InstallationSymbol

Stable observation name.

Examples found in repository

examples/generate_portability_fixtures.rs (line 249)

fn reimport_receipt(
    manifest: &ApplicationPortabilityManifest,
    domain: &Domain<'_>,
    outcome_hash: riffdb_types::GeneratedArtifactHash,
) -> ApplicationReimportReceipt {
    ApplicationReimportReceipt::reconcile(
        manifest,
        ApplicationExportManifestHash::from_bytes(
            *hash_generated_artifact(format!("{}-export-v1", domain.name).as_bytes()).as_bytes(),
        ),
        database_id(domain.seed),
        manifest
            .input()
            .mappings
            .iter()
            .map(|mapping| {
                ReimportMappingResult::new(
                    mapping.class(),
                    mapping.symbol().clone(),
                    2,
                    2,
                    0,
                    outcome_hash,
                )
                .expect("mapping result")
            })
            .collect(),
        manifest
            .input()
            .observations
            .iter()
            .map(|observation| {
                ReimportObservationResult::new(
                    observation.name().clone(),
                    observation.expected_hash(),
                )
            })
            .collect(),
    )
    .expect("reimport receipt")
}

pub const fn query(&self) -> &InstallationSymbol

Named query used for reconciliation.

pub const fn module_hash(&self) -> Option<QueryModuleHash>

Exact query module identity for V3 observations.

pub fn parameters(&self) -> &[ReimportObservationParameter]

Exact typed parameters in canonical name order.

pub const fn expected_hash(&self) -> GeneratedArtifactHash

Expected application-level observation digest.

Examples found in repository

examples/generate_portability_fixtures.rs (line 250)

fn reimport_receipt(
    manifest: &ApplicationPortabilityManifest,
    domain: &Domain<'_>,
    outcome_hash: riffdb_types::GeneratedArtifactHash,
) -> ApplicationReimportReceipt {
    ApplicationReimportReceipt::reconcile(
        manifest,
        ApplicationExportManifestHash::from_bytes(
            *hash_generated_artifact(format!("{}-export-v1", domain.name).as_bytes()).as_bytes(),
        ),
        database_id(domain.seed),
        manifest
            .input()
            .mappings
            .iter()
            .map(|mapping| {
                ReimportMappingResult::new(
                    mapping.class(),
                    mapping.symbol().clone(),
                    2,
                    2,
                    0,
                    outcome_hash,
                )
                .expect("mapping result")
            })
            .collect(),
        manifest
            .input()
            .observations
            .iter()
            .map(|observation| {
                ReimportObservationResult::new(
                    observation.name().clone(),
                    observation.expected_hash(),
                )
            })
            .collect(),
    )
    .expect("reimport receipt")
}

pub const fn maximum_items(&self) -> u32

Maximum total result records accepted from this bounded observation.

Trait Implementations

impl Clone for ReimportObservation

fn clone(&self) -> ReimportObservation

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ReimportObservation

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Eq for ReimportObservation

impl Ord for ReimportObservation

fn cmp(&self, other: &ReimportObservation) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for ReimportObservation

fn eq(&self, other: &ReimportObservation) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl PartialOrd for ReimportObservation

fn partial_cmp(&self, other: &ReimportObservation) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for ReimportObservation