fix: merge regression

.changeset/funny-dodos-applaud.md

@@ -0,0 +1,5 @@
+---
+"@hydrofoil/talos": patch
+---
+
+Regression: existing resources would have been merged instead of rewritten

packages/talos/lib/bootstrap.ts

@@ -1,22 +1,20 @@
 import { NamedNode } from 'rdf-js'
-import StreamClient, { StreamClientOptions } from 'sparql-http-client'
 import type DatasetExt from 'rdf-ext/lib/Dataset'
 import clownface from 'clownface'
-import { ResourcePerGraphStore } from '@hydrofoil/knossos/lib/store'
+import type { ResourceStore } from '@hydrofoil/knossos/lib/store'
 import { hydra } from '@tpluscode/rdf-ns-builders'
 import { isNamedNode } from 'is-graph-pointer'
 import $rdf from 'rdf-ext'
 import { log } from './log'
 import { talosNs } from './ns'
 
-type Bootstrap = StreamClientOptions & {
+type Bootstrap = {
+  store: ResourceStore
   dataset: DatasetExt
   apiUri: NamedNode
 }
 
-export async function bootstrap({ dataset, apiUri, ...options }: Bootstrap): Promise<void> {
-  const store = new ResourcePerGraphStore(new StreamClient(options))
-
+export async function bootstrap({ dataset, apiUri, store }: Bootstrap): Promise<void> {
   const graph = clownface({ dataset, graph: talosNs.resources })
   const resources = graph.has(talosNs.action)
   for (const resource of resources.toArray().filter(isNamedNode)) {
@@ -26,20 +24,20 @@ export async function bootstrap({ dataset, apiUri, ...options }: Bootstrap): Pro
       .namedNode(resource)
       .addOut(hydra.apiDocumentation, apiUri)
 
-    const action = resource.out(talosNs.action).value
+    const action = resource.out(talosNs.action).term
     const exists = await store.exists(pointer.term)
-    if (exists && action === 'skip') {
+    if (exists && talosNs.skip.equals(action)) {
       log(`Skipping resource ${resource}`)
       continue
     }
 
     if (exists) {
-      if (action === 'overwrite') {
-        log(`Replacing resource ${resource}`)
-      } else {
+      if (talosNs.merge.equals(action)) {
         log(`Merging existing resource ${resource}`)
         const current = await store.load(pointer.term)
         pointer.dataset.addAll(current.dataset)
+      } else {
+        log(`Replacing resource ${resource}`)
       }
     } else {
       log(`Creating resource ${resource}`)

packages/talos/lib/command/put.ts

@@ -1,4 +1,6 @@
 import $rdf from 'rdf-ext'
+import { ResourcePerGraphStore } from '@hydrofoil/knossos/lib/store'
+import StreamClient from 'sparql-http-client'
 import { bootstrap } from '../bootstrap'
 import { deleteApi } from '../deleteApi'
 import { fromDirectories } from '../resources'
@@ -17,10 +19,12 @@ export async function put(directories: string[], { token, api, endpoint, updateE
   await bootstrap({
     dataset,
     apiUri,
-    endpointUrl: endpoint,
-    updateUrl: updateEndpoint || endpoint,
-    user,
-    password,
+    store: new ResourcePerGraphStore(new StreamClient({
+      endpointUrl: endpoint,
+      updateUrl: updateEndpoint || endpoint,
+      user,
+      password,
+    })),
   })
 
   await deleteApi({ apiUri, token })

packages/talos/lib/resources.ts

@@ -1,6 +1,6 @@
 import path from 'path'
 import fs from 'fs'
-import { NamedNode } from 'rdf-js'
+import { NamedNode, DatasetCore } from 'rdf-js'
 import walk from '@fcostarodrigo/walk'
 import $rdf from 'rdf-ext'
 import type DatasetExt from 'rdf-ext/lib/Dataset'
@@ -19,7 +19,18 @@ interface ResourceOptions {
 
 export async function fromDirectories(directories: string[], api: string): Promise<DatasetExt> {
   const validDirs = directories.filter(isValidDir)
-  return validDirs.reduce(toGraphs(api), Promise.resolve($rdf.dataset()))
+  const dataset = await validDirs.reduce(toGraphs(api), Promise.resolve($rdf.dataset()))
+
+  setDefaultAction(dataset)
+
+  return dataset
+}
+
+function setDefaultAction(dataset: DatasetCore) {
+  clownface({ dataset, graph: talosNs.resources })
+    .has(talosNs.action, talosNs.default)
+    .deleteOut(talosNs.action, talosNs.default)
+    .addOut(talosNs.action, talosNs.overwrite)
 }
 
 function toGraphs(api: string) {

packages/talos/package.json

@@ -43,6 +43,7 @@
     "sparql-http-client": "^2.4.1"
   },
   "devDependencies": {
+    "@labyrinth/testing": "*",
     "@types/mime-types": "^2.1.1",
     "@types/replacestream": "^4.0.1",
     "@wikibus/vocabularies": "^0.2.2",

packages/talos/test/lib/command/__snapshots__/put.test.ts.snap

@@ -0,0 +1,8 @@
+exports["@hydrofoil/talos/lib/command/put --resources api http://example.com turtle replaces entire graph by default"] = "<http://example.com/project> <http://schema.org/parentItem> <http://example.com> .\n<http://example.com/project> <http://www.w3.org/1999/02/22-rdf-syntax-ns#type> <http://schema.org/Thing> .\n<http://example.com/project> <http://www.w3.org/ns/hydra/core#apiDocumentation> <http://example.com/api> .\n";
+
+exports["@hydrofoil/talos/lib/command/put --resources api http://example.com turtle merge existing graph when annotated"] = "<http://example.com/project/creta/user.group/admins> <http://www.w3.org/1999/02/22-rdf-syntax-ns#type> <http://www.w3.org/2006/vcard/ns#Group> .\n<http://example.com/project/creta/user.group/admins> <http://www.w3.org/2006/vcard/ns#hasMember> <http://example.com/project/creta/user/tpluscode> .\n<http://example.com/project/creta/user.group/admins> <http://www.w3.org/2006/vcard/ns#n> \"Administrators\" .\n<http://example.com/project/creta/user.group/admins> <http://www.w3.org/ns/hydra/core#apiDocumentation> <http://example.com/api> .\n";
+
+exports["@hydrofoil/talos/lib/command/put --resources api http://example.com/base turtle replaces entire graph by default"] = "<http://example.com/base/project> <http://schema.org/parentItem> <http://example.com/base> .\n<http://example.com/base/project> <http://www.w3.org/1999/02/22-rdf-syntax-ns#type> <http://schema.org/Thing> .\n<http://example.com/base/project> <http://www.w3.org/ns/hydra/core#apiDocumentation> <http://example.com/base/api> .\n";
+
+exports["@hydrofoil/talos/lib/command/put --resources api http://example.com/base turtle merge existing graph when annotated"] = "<http://example.com/base/project/creta/user.group/admins> <http://www.w3.org/1999/02/22-rdf-syntax-ns#type> <http://www.w3.org/2006/vcard/ns#Group> .\n<http://example.com/base/project/creta/user.group/admins> <http://www.w3.org/2006/vcard/ns#hasMember> <http://example.com/base/project/creta/user/tpluscode> .\n<http://example.com/base/project/creta/user.group/admins> <http://www.w3.org/2006/vcard/ns#n> \"Administrators\" .\n<http://example.com/base/project/creta/user.group/admins> <http://www.w3.org/ns/hydra/core#apiDocumentation> <http://example.com/base/api> .\n";
+

packages/talos/test/lib/command/put.test.ts

@@ -1,13 +1,14 @@
 import * as path from 'path'
 import { put, Put } from 'talos/lib/command/put'
-import { ASK, DELETE, INSERT, SELECT } from '@tpluscode/sparql-builder'
+import { ASK, CONSTRUCT, DELETE, SELECT } from '@tpluscode/sparql-builder'
 import ParsingClient from 'sparql-http-client/ParsingClient'
 import { expect } from 'chai'
 import { dash, doap, hydra, schema, vcard, sh, foaf } from '@tpluscode/rdf-ns-builders/loose'
 import namespace from '@rdfjs/namespace'
 import * as NodeFetch from 'node-fetch'
 import sinon from 'sinon'
 import $rdf from 'rdf-ext'
+import { testData } from '@labyrinth/testing/client'
 
 const apis = [
   'http://example.com',
@@ -36,11 +37,15 @@ for (const api of apis) {
     before(async () => {
       await DELETE`?s ?p ?o`.WHERE`?s ?p ?o`.execute(client.query)
 
-      await INSERT.DATA`
+      await testData`          
         GRAPH ${ns('project/creta/user.group/admins')} {
           ${ns('project/creta/user.group/admins')} ${vcard.hasMember} ${ns('project/creta/user/tpluscode')}
         }
-      `.execute(client.query)
+
+        GRAPH ${ns('project')} {
+          ${ns('project')} ${schema.name} "DELETE" .
+        }
+      `
     })
 
     it('ignores paths which do not exist', async () => {
@@ -57,6 +62,24 @@ for (const api of apis) {
       })
 
       context('turtle', () => {
+        it('replaces entire graph by default', async function () {
+          const dataset = $rdf.dataset().addAll(await CONSTRUCT`?s ?p ?o`
+            .FROM(ns('project'))
+            .WHERE`?s ?p ?o`
+            .execute(client.query))
+
+          expect(dataset.toCanonical()).to.matchSnapshot(this)
+        })
+
+        it('merge existing graph when annotated', async function () {
+          const dataset = $rdf.dataset().addAll(await CONSTRUCT`?s ?p ?o`
+            .FROM(ns('project/creta/user.group/admins'))
+            .WHERE`?s ?p ?o`
+            .execute(client.query))
+
+          expect(dataset.toCanonical()).to.matchSnapshot(this)
+        })
+
         it('inserts into graph constructed from path', async () => {
           const userCreated = ASK`${ns('project/creta/user/tpluscode')} a ${schema.Person}`
             .FROM(ns('project/creta/user/tpluscode'))

packages/talos/test/lib/resources.test.ts

@@ -42,10 +42,10 @@ describe('@hydrofoil/talos/lib/resources', () => {
       expect(toCanonical(resource)).to.matchSnapshot(this)
     })
 
-    it('marks a resource for "default" by default', () => {
+    it('marks a resource for "overwrite" by default', () => {
       const [{ object: action }, ...more] = dataset.match(ns(), talosNs.action, null, talosNs.resources)
 
-      expect(action).to.deep.eq(talosNs.default)
+      expect(action).to.deep.eq(talosNs.overwrite)
       expect(more).to.be.empty
     })