PrismDevRelOpen the app
Case studies: Architecture walkthrough

Overview

Case studies

UORust

How UORust was modeledArchitecture walkthroughDesign views in OPM and UMLFeatures and journeysSecurity and threat modelQuality model (ISO/IEC 25010)Behavior and proofsSystem and releaseExtension facetsCommand referenceSlides and video scriptRecord explorerllms.txt and Markdown twins

Prism-DevRel

How Prism-DevRel was modeledArchitecture walkthroughDesign views in OPM and UMLFeatures and journeysSecurity and threat modelQuality model (ISO/IEC 25010)Behavior and proofsExtension facetsSlides and video scriptRecord explorerllms.txt and Markdown twins

Rule 30

How Rule 30 was modeledArchitecture walkthroughSecurity and threat modelQuality model (ISO/IEC 25010)Behavior and proofsSlides and video scriptRecord explorerllms.txt and Markdown twins

Verdant Resonance

How Verdant Resonance was modeledBehavior and proofsExtension facetsSlides and video scriptRecord explorerllms.txt and Markdown twins

Foundry

How Foundry was modeledBehavior and proofsSlides and video scriptRecord explorerllms.txt and Markdown twins

// case study · UORust

Architecture walkthrough

Who UORust is for, what they care about, its parts and how they connect.

Subject: UORust at commit afd5cea950a8, 331 facet records, source digest f3f743b6834adaff.

Architecture records by kindComponent: 14 records; Concern: 7 records; Edge: 20 records; Stakeholder: 5 records; StandardReference: 1 records; View: 7 records; Viewpoint: 7 recordsComponent14Concern7Edge20Stakeholder5StandardReference1View7Viewpoint7
Architecture records by kind. The 61 records this page teaches, one bar for each kind. Each kind has its own section below.
The data in this figure
records
Component14
Concern7
Edge20
Stakeholder5
StandardReference1
View7
Viewpoint7

The architecture facet is an ISO/IEC/IEEE 42010 architecture description. It says who the system is for (stakeholders) and what they worry about (concerns). It names the parts (components) and how data and control move between them (edges). Viewpoints and views answer each concern. Each record is a definition whose result is a Foundation.Arch record, numbered by its identifier. The rules are in PrismPM SPEC section 2. How to write them is in Write the model.

Architecture facet explains the facet for every Prism model, with the counts of every case study.

Components and edges

Components and edgescontrolFlowcontrolFlowdataFlowdataFlowcontrolFlowdataFlowdataFlowdataFlowdataFlowdataFlowdataFlowdataFlowdataFlowcontrolFlowdataFlowdataFlowcontrolFlowcontrolFlowdataFlowdataFlowAdmissionCargouorust CLIcrates.ioEmitterGitHub ActionsIngestPages sitePrismPM SDKRoute CLI adapterRoute-table guestRouterrustc toolchainSubject workspace
Components and edges. Boxes are parts, arrows are the links between them, drawn from the model's own records.
The data in this figure

14 elements: Admission, Cargo, uorust CLI, crates.io, Emitter, GitHub Actions, Ingest, Pages site, PrismPM SDK, Route CLI adapter, Route-table guest, Router, rustc toolchain, Subject workspace. GitHub Actions to uorust CLI (controlFlow). GitHub Actions to Pages site (controlFlow). Admission to Emitter (dataFlow). Cargo to Ingest (dataFlow). uorust CLI to Ingest (controlFlow). crates.io to Cargo (dataFlow). crates.io to uorust CLI (dataFlow). Emitter to uorust CLI (dataFlow). Emitter to PrismPM SDK (dataFlow). Route-table guest to Pages site (dataFlow). Route-table guest to Route CLI adapter (dataFlow). Ingest to Router (dataFlow). Pages site to Route-table guest (dataFlow). PrismPM SDK to Route-table guest (controlFlow). Route CLI adapter to Route-table guest (dataFlow). Router to Admission (dataFlow). Router to Route-table guest (controlFlow). rustc toolchain to uorust CLI (controlFlow). Subject workspace to Cargo (dataFlow). Subject workspace to Ingest (dataFlow).

Every record

Every record 61 rows
IndexRecordKindName
0Architecture::componentAdmissionComponentAdmission
1Architecture::componentCargoComponentCargo
2Architecture::componentCliComponentuorust CLI
3Architecture::componentCratesIoComponentcrates.io
4Architecture::componentEmitterComponentEmitter
5Architecture::componentGitHubActionsComponentGitHub Actions
6Architecture::componentIngestComponentIngest
7Architecture::componentPagesSiteComponentPages site
8Architecture::componentPrismPmComponentPrismPM SDK
9Architecture::componentRouteCliComponentRoute CLI adapter
10Architecture::componentRouteGuestComponentRoute-table guest
11Architecture::componentRouterComponentRouter
12Architecture::componentRustcComponentrustc toolchain
13Architecture::componentSubjectWorkspaceComponentSubject workspace
14Architecture::concernCompletenessConcernCompleteness of the model
15Architecture::concernDeterminismConcernDeterministic output
16Architecture::concernDiscoverabilityConcernDiscoverability
17Architecture::concernFidelityConcernFidelity to the source
18Architecture::concernNoDefaultsConcernNo silent defaults
19Architecture::concernReadOnlyConcernRead-only ingestion
20Architecture::concernSupplyChainConcernSupply-chain integrity
21Architecture::edgeActionsCliEdgeedgeActionsCli
22Architecture::edgeActionsPagesEdgeedgeActionsPages
23Architecture::edgeAdmissionEmitterEdgeedgeAdmissionEmitter
24Architecture::edgeCargoIngestEdgeedgeCargoIngest
25Architecture::edgeCliIngestEdgeedgeCliIngest
26Architecture::edgeCratesIoCargoEdgeedgeCratesIoCargo
27Architecture::edgeCratesIoCliEdgeedgeCratesIoCli
28Architecture::edgeEmitterCliEdgeedgeEmitterCli
29Architecture::edgeEmitterPrismPmEdgeedgeEmitterPrismPm
30Architecture::edgeGuestPagesEdgeedgeGuestPages
31Architecture::edgeGuestRouteCliEdgeedgeGuestRouteCli
32Architecture::edgeIngestRouterEdgeedgeIngestRouter
33Architecture::edgePagesGuestEdgeedgePagesGuest
34Architecture::edgePrismPmGuestEdgeedgePrismPmGuest
35Architecture::edgeRouteCliGuestEdgeedgeRouteCliGuest
36Architecture::edgeRouterAdmissionEdgeedgeRouterAdmission
37Architecture::edgeRouterGuestEdgeedgeRouterGuest
38Architecture::edgeRustcCliEdgeedgeRustcCli
39Architecture::edgeWorkspaceCargoEdgeedgeWorkspaceCargo
40Architecture::edgeWorkspaceIngestEdgeedgeWorkspaceIngest
42Architecture::stakeholderDevRelAuthorStakeholderDevRel author
43Architecture::stakeholderMaintainerStakeholderMaintainer
44Architecture::stakeholderPrismModelerStakeholderPrism modeler
45Architecture::stakeholderRustDeveloperStakeholderRust developer
46Architecture::stakeholderSecurityReviewerStakeholderSecurity reviewer
47Architecture::standardIso42010StandardReferencestandardIso42010
48Architecture::viewDeterminismViewviewDeterminism
49Architecture::viewDiscoverabilityViewviewDiscoverability
50Architecture::viewPipelineCompletenessViewviewPipelineCompleteness
51Architecture::viewPipelineFidelityViewviewPipelineFidelity
52Architecture::viewReadOnlyViewviewReadOnly
53Architecture::viewRefusalViewviewRefusal
54Architecture::viewSupplyChainViewviewSupplyChain
55Architecture::viewpointDeterminismViewpointviewpointDeterminism
56Architecture::viewpointDiscoverabilityViewpointviewpointDiscoverability
57Architecture::viewpointPipelineCompletenessViewpointviewpointPipelineCompleteness
58Architecture::viewpointPipelineFidelityViewpointviewpointPipelineFidelity
59Architecture::viewpointReadOnlyViewpointviewpointReadOnly
60Architecture::viewpointRefusalViewpointviewpointRefusal
61Architecture::viewpointSupplyChainViewpointviewpointSupplyChain

Component (14)

Admission

Architecture::componentAdmission Component #0 source

Admission: what the router proposes is admitted, or refused with a typed reason that becomes an open claim.

index
0
kind
(ctor Foundation.Arch::ComponentKind.service)

Taught by Architecture walkthrough, Slides and video script

Cargo

Architecture::componentCargo Component #1 source

The cargo metadata command that resolves the subject workspace's packages, targets and dependencies.

index
1
kind
(ctor Foundation.Arch::ComponentKind.externalSystem)

Taught by Architecture walkthrough

uorust CLI

Architecture::componentCli Component #2 source

Project any Cargo workspace into a complete, checked Prism project.

index
2
kind
(ctor Foundation.Arch::ComponentKind.releaseBinary)

Taught by Architecture walkthrough

crates.io

Architecture::componentCratesIo Component #3 source

The registry the locked dependencies of uorust and of the subject come from.

index
3
kind
(ctor Foundation.Arch::ComponentKind.externalSystem)

Taught by Architecture walkthrough

Emitter

Architecture::componentEmitter Component #4 source

Projection: admitted facts to the files of a Prism project, byte for byte the same for the same workspace.

index
4
kind
(ctor Foundation.Arch::ComponentKind.service)

Taught by Architecture walkthrough

GitHub Actions

Architecture::componentGitHubActions Component #5 source

The CI that runs just vv on every push and deploys the Pages site.

index
5
kind
(ctor Foundation.Arch::ComponentKind.externalSystem)

Taught by Architecture walkthrough

Ingest

Architecture::componentIngest Component #6 source

Ingest: cargo metadata, the manifests, Cargo.lock and every source file, parsed with syn, into facts with spans.

index
6
kind
(ctor Foundation.Arch::ComponentKind.service)

Taught by Architecture walkthrough

Pages site

Architecture::componentPagesSite Component #7 source

The GitHub Pages site that describes UORust and runs the route-table guest in the browser.

index
7
kind
(ctor Foundation.Arch::ComponentKind.staticSite)

Taught by Architecture walkthrough

PrismPM SDK

Architecture::componentPrismPm Component #8 source

The locked PrismPM and LexLean SDK that checks the emitted project and verifies this model.

index
8
kind
(ctor Foundation.Arch::ComponentKind.externalSystem)

Taught by Architecture walkthrough

Route CLI adapter

Architecture::componentRouteCli Component #9 source

The generated uorust-routes program that answers the same route requests as the page from a file or standard input.

index
9
kind
(ctor Foundation.Arch::ComponentKind.cliAdapter)

Taught by Architecture walkthrough

Route-table guest

Architecture::componentRouteGuest Component #10 source

The Core-Wasm guest compiled from app/src/Routes.lex.tex: the verified route table, replayed against every acceptance vector.

index
10
kind
(ctor Foundation.Arch::ComponentKind.service)

Taught by Architecture walkthrough

Router

Architecture::componentRouter Component #11 source

The route table and the router: which kind of Rust fact becomes which kind of Prism record in which facet.

index
11
kind
(ctor Foundation.Arch::ComponentKind.service)

Taught by Architecture walkthrough

rustc toolchain

Architecture::componentRustc Component #12 source

The pinned Rust toolchain that compiles uorust with forbid(unsafe_code) and the workspace lints.

index
12
kind
(ctor Foundation.Arch::ComponentKind.externalSystem)

Taught by Architecture walkthrough

Subject workspace

Architecture::componentSubjectWorkspace Component #13 source

The Cargo workspace uorust reads: manifests, lock file and Rust sources.

index
13
kind
(ctor Foundation.Arch::ComponentKind.externalSystem)

Taught by Architecture walkthrough

Concern (7)

Edge (20)

edgeActionsCli

Architecture::edgeActionsCli Edge #21 source

index
0
fromIndex
5
toIndex
2
kind
(ctor Foundation.Arch::EdgeKind.controlFlow)

Taught by Architecture walkthrough

edgeActionsPages

Architecture::edgeActionsPages Edge #22 source

index
1
fromIndex
5
toIndex
7
kind
(ctor Foundation.Arch::EdgeKind.controlFlow)

Taught by Architecture walkthrough

edgeAdmissionEmitter

Architecture::edgeAdmissionEmitter Edge #23 source

index
2
fromIndex
0
toIndex
4
kind
(ctor Foundation.Arch::EdgeKind.dataFlow)

Taught by Architecture walkthrough

edgeCargoIngest

Architecture::edgeCargoIngest Edge #24 source

index
3
fromIndex
1
toIndex
6
kind
(ctor Foundation.Arch::EdgeKind.dataFlow)

Taught by Architecture walkthrough

edgeCliIngest

Architecture::edgeCliIngest Edge #25 source

index
4
fromIndex
2
toIndex
6
kind
(ctor Foundation.Arch::EdgeKind.controlFlow)

Taught by Architecture walkthrough

edgeCratesIoCargo

Architecture::edgeCratesIoCargo Edge #26 source

index
5
fromIndex
3
toIndex
1
kind
(ctor Foundation.Arch::EdgeKind.dataFlow)

Taught by Architecture walkthrough

edgeCratesIoCli

Architecture::edgeCratesIoCli Edge #27 source

index
6
fromIndex
3
toIndex
2
kind
(ctor Foundation.Arch::EdgeKind.dataFlow)

Taught by Architecture walkthrough

edgeEmitterCli

Architecture::edgeEmitterCli Edge #28 source

index
7
fromIndex
4
toIndex
2
kind
(ctor Foundation.Arch::EdgeKind.dataFlow)

Taught by Architecture walkthrough

edgeEmitterPrismPm

Architecture::edgeEmitterPrismPm Edge #29 source

index
8
fromIndex
4
toIndex
8
kind
(ctor Foundation.Arch::EdgeKind.dataFlow)

Taught by Architecture walkthrough

edgeGuestPages

Architecture::edgeGuestPages Edge #30 source

index
9
fromIndex
10
toIndex
7
kind
(ctor Foundation.Arch::EdgeKind.dataFlow)

Taught by Architecture walkthrough

edgeGuestRouteCli

Architecture::edgeGuestRouteCli Edge #31 source

index
10
fromIndex
10
toIndex
9
kind
(ctor Foundation.Arch::EdgeKind.dataFlow)

Taught by Architecture walkthrough

edgeIngestRouter

Architecture::edgeIngestRouter Edge #32 source

index
11
fromIndex
6
toIndex
11
kind
(ctor Foundation.Arch::EdgeKind.dataFlow)

Taught by Architecture walkthrough

edgePagesGuest

Architecture::edgePagesGuest Edge #33 source

index
12
fromIndex
7
toIndex
10
kind
(ctor Foundation.Arch::EdgeKind.dataFlow)

Taught by Architecture walkthrough

edgePrismPmGuest

Architecture::edgePrismPmGuest Edge #34 source

index
13
fromIndex
8
toIndex
10
kind
(ctor Foundation.Arch::EdgeKind.controlFlow)

Taught by Architecture walkthrough

edgeRouteCliGuest

Architecture::edgeRouteCliGuest Edge #35 source

index
14
fromIndex
9
toIndex
10
kind
(ctor Foundation.Arch::EdgeKind.dataFlow)

Taught by Architecture walkthrough

edgeRouterAdmission

Architecture::edgeRouterAdmission Edge #36 source

index
15
fromIndex
11
toIndex
0
kind
(ctor Foundation.Arch::EdgeKind.dataFlow)

Taught by Architecture walkthrough

edgeRouterGuest

Architecture::edgeRouterGuest Edge #37 source

index
16
fromIndex
11
toIndex
10
kind
(ctor Foundation.Arch::EdgeKind.controlFlow)

Taught by Architecture walkthrough

edgeRustcCli

Architecture::edgeRustcCli Edge #38 source

index
17
fromIndex
12
toIndex
2
kind
(ctor Foundation.Arch::EdgeKind.controlFlow)

Taught by Architecture walkthrough

edgeWorkspaceCargo

Architecture::edgeWorkspaceCargo Edge #39 source

index
18
fromIndex
13
toIndex
1
kind
(ctor Foundation.Arch::EdgeKind.dataFlow)

Taught by Architecture walkthrough

edgeWorkspaceIngest

Architecture::edgeWorkspaceIngest Edge #40 source

index
19
fromIndex
13
toIndex
6
kind
(ctor Foundation.Arch::EdgeKind.dataFlow)

Taught by Architecture walkthrough

Stakeholder (5)

Security reviewer

Architecture::stakeholderSecurityReviewer Stakeholder #46 source

Reviews the threat model uorust derives from unsafe code, effects and the supply chain, and the controls that answer it.

index
4

Taught by How UORust was modeled, Architecture walkthrough

StandardReference (1)

standardIso42010

Architecture::standardIso42010 StandardReference #47 source

standardIndex
4
editionIndex
0
standardId
ISO-42010-2022
edition
2022

Taught by Architecture walkthrough

View (7)

Viewpoint (7)

viewpointDeterminism

Architecture::viewpointDeterminism Viewpoint #55 source

index
0
stakeholderIndex
1
concernIndex
1
modelKindIndex
1

Taught by Architecture walkthrough

viewpointDiscoverability

Architecture::viewpointDiscoverability Viewpoint #56 source

index
1
stakeholderIndex
0
concernIndex
2
modelKindIndex
0

Taught by Architecture walkthrough

viewpointPipelineCompleteness

Architecture::viewpointPipelineCompleteness Viewpoint #57 source

index
2
stakeholderIndex
2
concernIndex
0
modelKindIndex
0

Taught by Architecture walkthrough

viewpointPipelineFidelity

Architecture::viewpointPipelineFidelity Viewpoint #58 source

index
3
stakeholderIndex
3
concernIndex
3
modelKindIndex
0

Taught by Architecture walkthrough

viewpointReadOnly

Architecture::viewpointReadOnly Viewpoint #59 source

index
4
stakeholderIndex
4
concernIndex
5
modelKindIndex
2

Taught by Architecture walkthrough

viewpointRefusal

Architecture::viewpointRefusal Viewpoint #60 source

index
5
stakeholderIndex
2
concernIndex
4
modelKindIndex
0

Taught by Architecture walkthrough

viewpointSupplyChain

Architecture::viewpointSupplyChain Viewpoint #61 source

index
6
stakeholderIndex
4
concernIndex
6
modelKindIndex
2

Taught by Architecture walkthrough

explanationLearncase studyMarkdown

Words on this page 4
Prism model
A description of an app, written in LexLean, that covers every facet of it and that the Lean kernel checks before the app is built.
facet
One view of a model, such as its architecture, its security or its quality. Each facet holds records.
record
One entry in a facet: a component, a threat, a measure or a journey step, with the place in the source it came from.
stakeholder
A person or group with an interest in the system, as ISO/IEC/IEEE 42010 defines it.