feat: configurable endpoint

.changeset/polite-buckets-glow.md

@@ -0,0 +1,5 @@
+---
+"@kopflos-cms/hydra": minor
+---
+
+Configurable SPARQL Endpoint to use for fetching collection members

.changeset/six-camels-cough.md

@@ -0,0 +1,5 @@
+---
+"@kopflos-cms/core": patch
+---
+
+Added `kl:endpoint` predicate

example/kopflos.config.ts

@@ -10,6 +10,7 @@ export default <KopflosConfig> {
       updateUrl: 'http://localhost:7878/update',
       storeUrl: 'http://localhost:7878/store',
     },
+    lindas: 'https://lindas.admin.ch/query',
   },
   watch: ['lib'],
   plugins: {

example/resources/countries.ttl

@@ -0,0 +1,21 @@
+PREFIX kl: <https://kopflos.described.at/>
+PREFIX schema: <http://schema.org/>
+PREFIX sh: <http://www.w3.org/ns/shacl#>
+PREFIX rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#>
+PREFIX hydra: <http://www.w3.org/ns/hydra/core#>
+prefix kl-hydra: <https://kopflos.described.at/hydra#>
+
+<>
+  a hydra:Collection ;
+  hydra:memberAssertion
+    [
+      hydra:property rdf:type ;
+      hydra:object schema:Country ;
+    ] ;
+  kl:endpoint "lindas" ;
+  kl-hydra:memberShape
+    [
+      sh:property [ sh:path schema:name ; sh:languageIn ("en" "de") ] ;
+      sh:property [ sh:path schema:identifier ] ;
+    ] ;
+.

packages/core/ns.ts

@@ -1,6 +1,6 @@
 import rdf from '@zazuko/env-node'
 
-type Properties = 'api' | 'resourceLoader' | 'handler' | 'method' | 'config'
+type Properties = 'api' | 'resourceLoader' | 'handler' | 'method' | 'config' | 'endpoint'
 type Classes = 'Config' | 'Api' | 'ResourceShape' | 'Handler'
 type Shorthands = 'DescribeLoader' | 'OwnGraphLoader'
 

packages/hydra/handlers/collection.ts

@@ -13,15 +13,22 @@ constraints.set(kl['hydra#MemberAssertionConstraintComponent'], HydraMemberAsser
 
 export function get(): Handler {
   return ({ env, subject }) => {
+    const endpoint = subject.out(kl.endpoint).value || 'default'
+
     if (!isReadable(env, subject)) {
       return new error.MethodNotAllowed('Collection is not readable')
     }
 
     const memberQuery = constructQuery(memberQueryShape({ env, collection: subject }))
-    const members = env.sparql.default.stream.query.construct(memberQuery)
+    const sparqlClient = env.sparql[endpoint]
+    if (!sparqlClient) {
+      return new error.InternalServerError(`SPARQL endpoint '${endpoint}' not found`)
+    }
+
+    const members = sparqlClient.stream.query.construct(memberQuery)
 
     const totalQuery = constructQuery(totalsQueryShape({ env, collection: subject }))
-    const totals = env.sparql.default.stream.query.construct(totalQuery)
+    const totals = sparqlClient.stream.query.construct(totalQuery)
 
     return {
       status: 200,

packages/hydra/lib/queryShapes.ts

@@ -7,17 +7,22 @@ import { isGraphPointer } from 'is-graph-pointer'
 // eslint-disable-next-line import/no-unresolved
 import { kl } from '@kopflos-cms/core/ns.js'
 import { log } from '@kopflos-cms/core'
+import type { DatasetCoreFactory } from '@rdfjs/types'
 
 interface MemberQueryShapeArgs {
-  env: Environment<ClownfaceFactory | NsBuildersFactory>
+  env: Environment<ClownfaceFactory | NsBuildersFactory | DatasetCoreFactory>
   collection: GraphPointer
   limit?: number
   offset?: number
 }
 
-export function memberQueryShape({ env, collection, limit, offset }: MemberQueryShapeArgs): GraphPointer {
+export function memberQueryShape({ env, collection: original, limit, offset }: MemberQueryShapeArgs): GraphPointer {
   const { hydra, sh, rdf } = env.ns
 
+  const collection = env.clownface({
+    dataset: env.dataset([...original.dataset]),
+    term: original.term,
+  })
   const shape = collection
     .blankNode()
     .addOut(rdf.type, sh.NodeShape)
@@ -105,13 +110,17 @@ export function memberQueryShape({ env, collection, limit, offset }: MemberQuery
 }
 
 interface TotalsQueryShapeArgs {
-  env: Environment<ClownfaceFactory | NsBuildersFactory>
+  env: Environment<ClownfaceFactory | NsBuildersFactory | DatasetCoreFactory>
   collection: GraphPointer
 }
 
-export function totalsQueryShape({ env, collection }: TotalsQueryShapeArgs) {
+export function totalsQueryShape({ env, collection: original }: TotalsQueryShapeArgs) {
   const { hydra, sh, rdf } = env.ns
 
+  const collection = env.clownface({
+    dataset: env.dataset([...original.dataset]),
+    term: original.term,
+  })
   const filterShape = collection.blankNode()
   filterShape.addOut(hydra.memberAssertion, collection.out(hydra.memberAssertion))
 

packages/hydra/package.json

@@ -20,7 +20,7 @@
     "handlers/*.d.ts"
   ],
   "dependencies": {
-    "@hydrofoil/shape-to-query": "^0.13.6",
+    "@hydrofoil/shape-to-query": "^0.13.8",
     "@kopflos-cms/core": "^0.3.1",
     "@sindresorhus/merge-streams": "^4.0.0",
     "@tpluscode/rdf-ns-builders": "^4.3.0",

packages/hydra/test/collection.test.ts

@@ -32,6 +32,7 @@ describe('@kopflos-cms/hydra', () => {
       baseIri,
       sparql: {
         default: inMemoryClients(this.rdf),
+        lindas: 'https://lindas.admin.ch/query',
       },
     }
   })
@@ -136,6 +137,46 @@ describe('@kopflos-cms/hydra', () => {
           expect(pointer.out(ns.hydra.totalItems).term).to.deep.eq(toRdf(14))
         })
       })
+
+      context('when collection is sourced from another endpoint', () => {
+        it('should return a stream of members', async function () {
+          // given
+          const kopflos = await startKopflos()
+
+          // when
+          const collection = ex['countries/from-lindas']
+          const res = await kopflos.handleRequest({
+            method: 'GET',
+            iri: collection,
+            headers: {},
+            query: {},
+            body: {} as Body,
+          })
+
+          // then
+          const dataset = await $rdf.dataset().import(res.body as Stream)
+          const pointer = $rdf.clownface({ dataset }).node(collection)
+          expect(pointer.out(ns.hydra.member).terms).to.have.length.above(200)
+        })
+
+        it('should fail when endpoint is not configured', async function () {
+          // given
+          const kopflos = await startKopflos()
+
+          // when
+          const collection = ex['countries/wrong-endpoint']
+          const res = await kopflos.handleRequest({
+            method: 'GET',
+            iri: collection,
+            headers: {},
+            query: {},
+            body: {} as Body,
+          })
+
+          // then
+          expect(res.status).to.equal(500)
+        })
+      })
     })
 
     context('post', () => {

packages/hydra/test/collection.test.ts.trig

@@ -75,3 +75,37 @@ GRAPH <municipalities/from-static-district> {
       ] ;
   .
 }
+
+GRAPH <countries/from-lindas> {
+  <countries/from-lindas>
+    a hydra:Collection ;
+    hydra:memberAssertion
+      [
+        hydra:property rdf:type ;
+        hydra:object schema:Country ;
+      ] ;
+    kl:endpoint "lindas" ;
+    kl-hydra:memberShape
+      [
+        sh:property [ sh:path schema:name ] ;
+        sh:property [ sh:path schema:identifier ] ;
+      ] ;
+  .
+}
+
+GRAPH <countries/wrong-endpoint> {
+  <countries/wrong-endpoint>
+    a hydra:Collection ;
+    hydra:memberAssertion
+      [
+        hydra:property rdf:type ;
+        hydra:object schema:Country ;
+      ] ;
+    kl:endpoint "foobar" ;
+    kl-hydra:memberShape
+      [
+        sh:property [ sh:path schema:name ] ;
+        sh:property [ sh:path schema:identifier ] ;
+      ] ;
+  .
+}