jskos-server 2.4.0

package/test/chai.js

@@ -0,0 +1,14 @@
+// Setup chai and plugins
+
+import * as chaiModule from "chai"
+
+import chaiAsPromised from "chai-as-promised"
+chaiModule.use(chaiAsPromised)
+
+import chaiHttp from "chai-http"
+const chai = chaiModule.use(chaiHttp)
+
+// eslint-disable-next-line no-unused-vars
+const should = chai.should()
+
+export default chai

package/test/changes.js

@@ -0,0 +1,179 @@
+import { assertMongoDB, dropDatabaseBeforeAndAfter, setupInMemoryMongo, teardownInMemoryMongo, createCollectionsAndIndexes } from "./test-utils.js"
+import WebSocket from "ws"
+import assert from "assert"
+import config from "../config/index.js"
+import { app } from "../server.js"
+import { setupChangesApi } from "../utils/changes.js"
+import { objectTypes } from "jskos-tools"
+import mongoose from "mongoose"
+
+// Map each route to its collection name and expected JSKOS type
+const routes = {
+  voc:          { coll: "terminologies", type: "ConceptScheme"  },
+  concepts:     { coll: "concepts",       type: "Concept"        },
+  mappings:     { coll: "mappings",       type: "ConceptMapping" },
+  concordances: { coll: "concordances",   type: "Concordance"    },
+  annotations:  { coll: "annotations",    type: "Annotation"     },
+  registries:   { coll: "registries",     type: "Registry"       },
+}
+
+describe("Change‐Streams API setup", () => {
+  // Capture console.log output
+  let loggedMessages = []
+  const originalLog = console.log
+
+  before(async () => {
+    console.log = (msg) => loggedMessages.push(msg)
+  })
+
+  after(async () => {
+    console.log = originalLog
+  })
+
+  it("should skip registering when changes is false", async () => {
+    // ensure flag is off
+    config.changes = false
+
+    // call the exported setup function
+    await setupChangesApi(app, config)
+
+    // assert our early‐return message was logged
+    loggedMessages.includes("Change API is disabled by configuration.")
+  })
+
+})
+
+describe("WebSocket Change‐Streams (integration)", function () {
+
+  before(async () => {
+    await setupInMemoryMongo({ replSet: true })
+    config.changes = true
+    await setupChangesApi(app, config)
+    await createCollectionsAndIndexes()
+    // optionally spin up your HTTP+WS server here
+  })
+
+  after(async () => {
+    // close server if you started one
+    await teardownInMemoryMongo()
+  })
+
+  // 🗑 Drop DB before *and* after every single `it()` in this file
+  dropDatabaseBeforeAndAfter()
+
+  // 🔌 Sanity‐check that mongoose really is connected
+  assertMongoDB()
+
+  // generate tests for each route
+  for (const [route, info] of Object.entries(routes)) {
+    lifecycleTests(route, info)
+  }
+
+})
+
+function lifecycleTests(route, { coll, type }) {
+  const uriBase = `urn:test:${route}`
+  const typeUri  = objectTypes[type].type?.[0]
+
+  describe(`${route}/changes`, () => {
+    it("emits create", done => {
+      const ws = new WebSocket(`ws://localhost:${config.port}/${route}/changes`)
+      ws.on("open", async () => {
+        await mongoose.connection.db.collection(coll).insertOne({
+          uri:       `${uriBase}:1`,
+          type:      typeUri,
+          prefLabel: { en: ["A"] },
+        })
+      })
+      ws.on("message", raw => {
+        const evt = JSON.parse(raw)
+        if (evt.type !== "create") {
+          return
+        }
+        try {
+          assert.strictEqual(evt.type, "create")
+          assert.strictEqual(evt.objectType, type)
+          assert.deepStrictEqual(evt.document.prefLabel.en, ["A"])
+          assertOptionalIsoTimestamp(evt.timestamp)
+          ws.close()
+          done()
+        } catch (err) {
+          done(err)
+        }
+      })
+      ws.on("error", err => done(err))
+    })
+
+    it("emits update", done => {
+      const ws = new WebSocket(`ws://localhost:${config.port}/${route}/changes`)
+      ws.on("open", async () => {
+        const { insertedId } = await mongoose.connection.db.collection(coll).insertOne({
+          uri:       `${uriBase}:2`,
+          type:      typeUri,
+          prefLabel: { en: ["B"] },
+        })
+        await mongoose.connection.db.collection(coll).updateOne(
+          { _id: insertedId },
+          { $set: { prefLabel: { en: ["BB"] } } },
+        )
+      })
+      ws.on("message", raw => {
+        const evt = JSON.parse(raw)
+        if (evt.type !== "update") {
+          return
+        }
+        try {
+          assert.strictEqual(evt.objectType, type)
+          assert.deepStrictEqual(evt.document.prefLabel.en, ["BB"])
+          assertOptionalIsoTimestamp(evt.timestamp)
+          ws.close()
+          done()
+        } catch (err) {
+          done(err)
+        }
+      })
+      ws.on("error", err => done(err))
+    })
+
+    it("emits delete", done => {
+      const ws = new WebSocket(`ws://localhost:${config.port}/${route}/changes`)
+      ws.on("open", async () => {
+        const { insertedId } = await mongoose.connection.db.collection(coll).insertOne({
+          uri:       `${uriBase}:3`,
+          type:      typeUri,
+          prefLabel: { en: ["C"] },
+        })
+        await mongoose.connection.db.collection(coll).deleteOne({ _id: insertedId })
+      })
+      ws.on("message", raw => {
+        const evt = JSON.parse(raw)
+        if (evt.type !== "delete") {
+          return
+        }
+        try {
+          // on delete fullDocument is omitted
+          assert.strictEqual(evt.document, undefined)
+          ws.close()
+          done()
+        } catch (err) {
+          done(err)
+        }
+      })
+      ws.on("error", err => done(err))
+    })
+  })
+}
+
+/**
+ * Validates that the provided timestamp, if present, is a string matching the strict ISO 8601 format `YYYY-MM-DDTHH:mm:ss.SSSZ`.
+ *
+ * @param {?string} ts - The timestamp to validate.
+ * @throws {AssertionError} If the timestamp is not a string or does not match the ISO 8601 format.
+ */
+function assertOptionalIsoTimestamp(ts) {
+  if (ts == null) {
+    return
+  }
+  assert.strictEqual(typeof ts, "string")
+  assert.match(ts, /^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$/)
+}

package/test/concepts/conceptNoFileEnding

@@ -0,0 +1,4 @@
+{
+  "uri": "uri:conceptNoFileEnding",
+  "inScheme":[{"uri":"http://dewey.info/scheme/edition/e23/"}]
+}

package/test/concepts/concepts-ddc-6-60-61-62.json

@@ -0,0 +1,123 @@
+[
+    {
+      "@context": "https://gbv.github.io/jskos/context.json",
+      "created": "2000-02-02",
+      "identifier": [
+        "856c92e9-8b1f-3131-bfbe-f2d2266527d3"
+      ],
+      "modified": "2005-11-02",
+      "notation": [
+        "6"
+      ],
+      "prefLabel": {
+        "de": "Technik, Medizin, angewandte Wissenschaften"
+      },
+      "topConceptOf": [
+        {
+          "uri": "http://dewey.info/scheme/edition/e23/"
+        }
+      ],
+      "type": [
+        "http://www.w3.org/2004/02/skos/core#Concept"
+      ],
+      "uri": "http://dewey.info/class/6/e23/",
+      "narrower": [
+        null
+      ]
+    },
+    {
+      "@context": "https://gbv.github.io/jskos/context.json",
+      "broader": [
+        {
+          "uri": "http://dewey.info/class/6/e23/"
+        }
+      ],
+      "created": "2000-02-02",
+      "identifier": [
+        "028d7bfc-77bf-3062-a6a8-857f66153fb9"
+      ],
+      "inScheme": [
+        {
+          "uri": "http://dewey.info/scheme/edition/e23/"
+        }
+      ],
+      "modified": "2005-11-02",
+      "notation": [
+        "60"
+      ],
+      "prefLabel": {
+        "de": "Technik",
+        "en": "Technology"
+      },
+      "type": [
+        "http://www.w3.org/2004/02/skos/core#Concept"
+      ],
+      "uri": "http://dewey.info/class/60/e23/",
+      "narrower": [
+        null
+      ]
+    },
+    {
+      "@context": "https://gbv.github.io/jskos/context.json",
+      "broader": [
+        {
+          "uri": "http://dewey.info/class/6/e23/"
+        }
+      ],
+      "created": "2000-02-02",
+      "identifier": [
+        "c14b599b-42cc-327e-abe2-fc1bb609e99e"
+      ],
+      "inScheme": [
+        {
+          "uri": "http://dewey.info/scheme/edition/e23/"
+        }
+      ],
+      "modified": "2005-11-02",
+      "notation": [
+        "61"
+      ],
+      "prefLabel": {
+        "de": "Medizin & Gesundheit"
+      },
+      "type": [
+        "http://www.w3.org/2004/02/skos/core#Concept"
+      ],
+      "uri": "http://dewey.info/class/61/e23/",
+      "narrower": [
+        null
+      ]
+    },
+    {
+      "@context": "https://gbv.github.io/jskos/context.json",
+      "broader": [
+        {
+          "uri": "http://dewey.info/class/6/e23/"
+        }
+      ],
+      "created": "2000-02-02",
+      "identifier": [
+        "ac872f11-eb09-3f7d-a307-613f3042791e"
+      ],
+      "inScheme": [
+        {
+          "uri": "http://dewey.info/scheme/edition/e23/"
+        }
+      ],
+      "modified": "2005-11-02",
+      "notation": [
+        "62"
+      ],
+      "prefLabel": {
+        "de": "Ingenieurwissenschaften"
+      },
+      "type": [
+        "http://www.w3.org/2004/02/skos/core#Concept"
+      ],
+      "uri": "http://dewey.info/class/62/e23/",
+      "narrower": [
+        null
+      ]
+    }
+  ]
+  

package/test/concordances/concordances.ndjson

@@ -0,0 +1,2 @@
+{"@context":"https://gbv.github.io/jskos/context.json","creator":[{"prefLabel":{"de":"VZG"}}],"extent":"2267","fromScheme":{"notation":["DDC"],"uri":"http://bartoc.org/en/node/241"},"notation":["ddc_rvk_recht"],"scopeNote":{"de":["Recht"]},"toScheme":{"notation":["RVK"],"uri":"http://bartoc.org/en/node/533"},"type":["http://rdfs.org/ns/void#Linkset"],"uri":"http://coli-conc.gbv.de/concordances/ddc_rvk_recht"}
+{"@context":"https://gbv.github.io/jskos/context.json","creator":[{"prefLabel":{"de":"VZG"}}],"extent":"2813","fromScheme":{"notation":["DDC"],"uri":"http://bartoc.org/en/node/241"},"notation":["ddc_rvk_medizin"],"scopeNote":{"de":["Medizin und Gesundheit"]},"toScheme":{"notation":["RVK"],"uri":"http://bartoc.org/en/node/533"},"type":["http://rdfs.org/ns/void#Linkset"],"uri":"http://coli-conc.gbv.de/concordances/ddc_rvk_medizin"}

package/test/config.js

@@ -0,0 +1,26 @@
+import fs from "node:fs"
+import assert from "node:assert"
+import { validateConfig, setupConfig } from "../config/setup.js"
+
+describe("Configuration", () => {
+  for (let file of [
+    "config/config.default.json",
+    "config/config.test.json",
+  ].concat(fs.readdirSync("./test/configs").map(f => `test/configs/${f}`))) {
+    const shouldFail = file.includes("fail-")
+    it(`should ${shouldFail ? "not validate" : "validate and setup"} ${file}`, () => {
+      let config
+      try {
+        config = JSON.parse(fs.readFileSync(file))
+      } catch { /* ignore */ }
+      if (shouldFail) {
+        assert.throws(() => validateConfig(config))
+      } else {
+        validateConfig(config)
+        setupConfig(config)
+        assert.ok(config)
+        assert.ok(config.log)
+      }
+    })
+  }
+})

package/test/configs/complex-config.json

@@ -0,0 +1,90 @@
+{
+  "verbosity": "log",
+  "baseUrl": "https://example.com/",
+  "title": "JSKOS Server Complex Example Config",
+  "port": 12345,
+  "proxies": [
+    "127.0.0.1/8"
+  ],
+  "mongo": {
+    "user": "a",
+    "pass": "b",
+    "host": "127.0.0.1",
+    "port": 27018,
+    "db": "jskos-server-db"
+  },
+  "auth": {
+    "algorithm": "RS256",
+    "key": "public key here"
+  },
+  "schemes": true,
+  "concepts": {
+    "read": {
+      "auth": false
+    },
+    "create": {
+      "auth": true,
+      "ips": [
+        "5.6.7.8"
+      ]
+    },
+    "update": {
+      "identityProviders": [
+        "github"
+      ]
+    },
+    "delete": {
+      "auth": false,
+      "identities": [
+        "http://some.uri"
+      ]
+    }
+  },
+  "mappings": {
+    "read": {
+      "auth": false
+    },
+    "create": {
+      "auth": true
+    },
+    "update": {
+      "auth": true,
+      "crossUser": true
+    },
+    "delete": {
+      "auth": true,
+      "crossUser": false
+    },
+    "fromSchemeWhitelist": [
+      {
+        "uri": "some:scheme"
+      }
+    ],
+    "anonymous": true,
+    "cardinality": "1-to-1"
+  },
+  "concordances": false,
+  "annotations": {
+    "read": {
+      "auth": false
+    },
+    "create": {
+      "auth": true,
+      "identities": [
+        "http://some.uri"
+      ]
+    },
+    "update": {
+      "auth": true,
+      "crossUser": false
+    },
+    "delete": {
+      "auth": true,
+      "crossUser": false,
+      "ips": [
+        "134.5.6.7/24"
+      ]
+    },
+    "moderatingIdentities": []
+  }
+}

package/test/configs/empty-object.json

@@ -0,0 +1 @@
+{}

package/test/configs/fail-array.json

@@ -0,0 +1 @@
+[]

package/test/configs/fail-mapping-only-props1.json

@@ -0,0 +1,5 @@
+{
+  "schemes": {
+    "cardinality": "1-to-1"
+  }
+}

package/test/configs/fail-mapping-only-props2.json

@@ -0,0 +1,5 @@
+{
+  "concepts": {
+    "cardinality": "1-to-1"
+  }
+}

package/test/configs/fail-mapping-only-props3.json

@@ -0,0 +1,5 @@
+{
+  "concordances": {
+    "fromSchemeWhitelist": []
+  }
+}

package/test/configs/fail-mapping-only-props4.json

@@ -0,0 +1,5 @@
+{
+  "annotations": {
+    "toSchemeWhitelist": null
+  }
+}

package/test/configs/fail-nonexisting-prop.json

@@ -0,0 +1,3 @@
+{
+  "some": "property"
+}

package/test/configs/fail-port-string.json

@@ -0,0 +1,3 @@
+{
+  "port": "5000"
+}

package/test/configs/fail-registry-types.json

@@ -0,0 +1,16 @@
+{
+  "registries": {
+    "mixedTypes": true,
+    "update": {
+      "crossUser": true
+    },
+    "types": {
+      "schemes": true,
+      "concepts": {
+        "uriRequired": false,
+        "mustExist": true,
+        "skipInvalid": true
+      }
+    }
+  }
+}

package/test/configs/registry-types.json

@@ -0,0 +1,16 @@
+{
+  "registries": {
+    "mixedTypes": true,
+    "update": {
+      "crossUser": true
+    },
+    "types": {
+      "schemes": true,
+      "concepts": {
+        "uriRequired": false,
+        "mustExist": false,
+        "skipInvalid": true
+      }
+    }
+  }
+}