Catalog factory for the S3 bundle provider ("provider": "s3" in catalog.json)
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 22/100
Research direction
Start from the existing IBundleProviderFactory seam and how KnowledgeCatalogOptions.ProviderFactories registers factories, then read the catalog.json source handling in OKF4net.Catalog. The open questions are placement (shared with #236), endpoint trust, and client disposal, and they need a maintainer decision before code. Done means the S3 factory passes the three acceptance tests (matching filesystem results, diagnostics without bucket or signed-URL leakage, rejected settings) against RustFS under Category=S3Integration.
Written by the indexing model from the issue text.
Description
Area
Catalog integration for the S3 bundle provider (#142): let a catalog.json knowledge source name "provider": "s3" and be served from S3 / an S3-compatible store, through the existing IBundleProviderFactory seam (KnowledgeCatalogOptions.ProviderFactories).
Why it matters
#142 delivers the provider as a library only (out of its scope by decision). A host composing its knowledge through OKF4net.Catalog would otherwise build the handle by hand, outside the catalog, losing fused search, diagnostics and per-source policy (RefreshPolicy, OnAccess by default for catalog sources).
Scope
- An
IBundleProviderFactory(ProviderType = "s3") whose clients are handed to it by the host — never built from ambient credentials, never fromcatalog.json(spec §7, security framing on #139, 2026-10-06 §3). AcceptedSettings: bucket, key prefix, region, endpoint, addressing style — nothing else; any credential-like setting is rejected (IllegalSetting).- Endpoint trust:
catalog.jsonis operator configuration (trusted, #139 §1), but decide whether an endpoint written there is accepted as is or must match an endpoint (or client) the host registered — a manifest choosing the host its credentials are sent to is the riskiest part of this factory. - One client per endpoint/account, or one per source: decide, and state who disposes it (
IBundleProviderFactory: the catalog never disposes a provider). IBundleProvider.Idstable and non-blank so the fused resolvers deduplicate correctly.
Placement — decide once with #236
Where the factory lives is the same question as for the embedded provider (#236): in the provider project (which then references OKF4net.Catalog, so every host reading an S3 bundle inherits the catalog), or in a small leaf package so the provider stays OKF4net-only. Settle it for both factories together, so the two backends follow one rule. The filesystem provider is built into the catalog (filesystem cannot be registered), so no other existing provider needs a factory.
Acceptance
- A catalog test with an S3 source (RustFS,
Category=S3Integration, out of default CI like the provider's own integration tests) returns the same search results and diagnostics as the same bundle on the filesystem. - An unknown bucket or prefix, or an unreachable endpoint, is reported as a
ProviderUnavailable/SourceUnavailable/SourceStalediagnostic naming an exception type only — never an exception out of the catalog, never a bucket name, request id or signed URL in a message. - A setting outside
AcceptedSettingsis rejected before anything is created.
Depends on
#142; coordinate with #236.
Effort
M
- Dominant language
- C#
- Stars
- 4
- Forks
- 1
- Avg merge
- 1d 4h
- Merged PRs (30d)
- 32
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from jchable/okf4net
-
documentation
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
Maintainers usually reply within 1 day
-
.NET bug
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
Maintainers usually reply within 1 day
-
test
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 1 day
-
documentation good first issue
Difficulty 1/5 1-3 hours Newbie friendliness 90/100
Maintainers usually reply within 1 day
-
documentation good first issue
Difficulty 1/5 Under an hour Newbie friendliness 82/100
Maintainers usually reply within 1 day
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
area/backend type/bug
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
umbraco/Umbraco-CMS#24668 · 1 comment ·
Maintainers usually reply within 1 day
-
Pri3
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
MicrosoftDocs/windows-dev-docs#6205 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
Maintainers usually reply within 1 day
-
area-ai untriaged
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
dotnet/extensions#7956 ·
Maintainers usually reply within 1 day