javier
b680ae0689
This PR contains the work done to introduce a `StructuredData` type that pages use to describe themselves to search engines as schema.org JSON-LD, and wires it into the Page protocol so the payload renders automatically in the document head. Reviewed-on: rock-n-code/loud-amsterdam#32 Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>
51 lines
4.4 KiB
Markdown
51 lines
4.4 KiB
Markdown
# Infrastructure
|
|
The shared [Hummingbird](https://github.com/hummingbird-project/hummingbird) toolkit the **Loud** services build on: declarative routing, hardened HTTP middlewares, pre-rendered localized HTML responses, and the page and asset scaffolding.
|
|
|
|
## Overview
|
|
The package provides, grouped by role:
|
|
| Role | Types |
|
|
| --- | --- |
|
|
| Routing | `RouterController`, `RouteCollectionBuilder`, the `addController` extension on `RouterMethods` |
|
|
| Middlewares | `SecurityHeadersMiddleware`, `VaryMiddleware`, `RateLimitMiddleware`, `LocalizationMiddleware`, `NotFoundMiddleware` |
|
|
| Pages and assets | `Page`, `Asset`, `AssetExtension`, `FingerprintAssets` |
|
|
| Link previews | `SocialCard`, its `Image`, and the `Tag` meta tags it derives |
|
|
| Structured data | `StructuredData`, the `Node`, `Property`, and `Value` types of its schema.org graph, and the open `Name` and `Kind` vocabularies |
|
|
| Responses | `CachedHTMLResponse`, `LocalizedHTMLCollectionResponse` |
|
|
| Contexts | `LocalizedRequestContext` |
|
|
| Constants | The `HTTPField.Name` header names, `Int.RateLimit` limits, and `String.Security` header values the middlewares default to |
|
|
|
|
## Design rules
|
|
The package holds only what every service can reuse; anything a service owns is injected, never referenced:
|
|
- **No site-specific content.** No page markup, no asset catalog, no `Bundle.module` lookups. A type that needs a service's content takes it as a parameter: the `bundle:` whose String Catalog names the supported languages (`LocalizationMiddleware`, `LocalizedHTMLCollectionResponse`, `NotFoundMiddleware`), the `document:` closure that builds a page for a locale, and the `metadata` requirement through which a `Page` conformer supplies its icon links and theme colors — as are the `summary`, `canonicalURL`, `socialCard`, and `structuredData` values its other head tags render, each omitted unless the page provides it. A `SocialCard` and a `StructuredData` node take their URLs fully formed and absolute; composing them from an origin and a versioned asset path stays with the page providing them.
|
|
- **Services fill the gaps once, via extensions.** A service restores its convenient call sites with retroactive extensions — the Website's `Page+Defaults`, `LocalizationMiddleware+Defaults`, and `NotFoundMiddleware+Defaults` are the pattern to follow. The open schema.org vocabularies extend the same way: the package declares only the `Property.Name` and `Node.Kind` constants every service shares, and a service adds the ones its own node shapes need.
|
|
- **Method structs.** Single-operation types such as `FingerprintAssets` hold their lifetime-fixed configuration in `init` and take only per-call inputs in `callAsFunction`.
|
|
|
|
## Layout
|
|
Sources are split by visibility, then by kind, one type per file:
|
|
```
|
|
Sources/
|
|
├── Public/ public API
|
|
│ ├── Builders/ RouteCollectionBuilder
|
|
│ ├── Enumerations/ AssetExtension
|
|
│ ├── Extensions/ addController, plus the default header names and values
|
|
│ ├── Methods/ FingerprintAssets
|
|
│ ├── Middlewares/ the five HTTP middlewares
|
|
│ ├── Protocols/ Asset, LocalizedRequestContext, Page, RouterController
|
|
│ ├── Responses/ CachedHTMLResponse, LocalizedHTMLCollectionResponse
|
|
│ └── Types/ SocialCard and StructuredData, with their nested types in SocialCard/ and StructuredData/
|
|
└── Internal/
|
|
├── Extensions/ implementation details (the String separators)
|
|
└── Types/ implementation details (FNV1aHash)
|
|
Tests/
|
|
├── Cases/ the test suites, mirroring the Sources/ layout
|
|
├── Catalogs/ the String Catalog fixture, copied verbatim so it loads on Linux
|
|
└── Utils/ stubs (StubAsset, StubPage, …) and the suite Tag constants
|
|
```
|
|
|
|
## Testing
|
|
Every suite carries a tag naming the kind of API it exercises — `.asset`, `.extension`, `.middleware`, `.protocol`, or `.type`, declared in `Tests/Utils/Extensions/Tag+Constants.swift` — so test plans and result summaries can slice the run by kind. A new suite must adopt the tag matching its subject (or add a tag there if none fits).
|
|
|
|
## Requirements
|
|
- Swift 6.3 toolchain (`swift-tools-version:6.3`).
|
|
- macOS 15, matching the sibling `Localization`, `Persistence`, and `Utility` packages (the services deploy to Linux containers; the packages carry no UI platforms).
|