Merge pull request #512 from linkeddata/flush-metadata

Flush metadata

Author: angelo-v

src/fetcher.ts

@@ -721,7 +721,7 @@ export default class Fetcher implements CallbackifyInterface {
   _fetch: Fetch
   mediatypes: MediatypesMap
   /** Denoting this session */
-  appNode: BlankNode
+  appNode: NamedNode
   /**
    * this.requested[uri] states:
    * undefined     no record of web access or records reset
@@ -771,8 +771,9 @@ export default class Fetcher implements CallbackifyInterface {
     if (!this._fetch) {
       throw new Error('No _fetch function available for Fetcher')
     }
-
-    this.appNode = this.store.rdfFactory.blankNode()
+    // This is the name of the graph we store all the HTTP metadata in
+    this.appNode = this.store.sym('chrome://TheCurrentSession')
+    // this.appNode = this.store.rdfFactory.blankNode() // Needs to have a URI in tests
     this.store.fetcher = this // Bi-linked
     this.requested = {}
     this.timeouts = {}
@@ -1725,22 +1726,22 @@ export default class Fetcher implements CallbackifyInterface {
 
     let responseNode = kb.bnode()
 
-    kb.add(options.req, this.ns.link('response'), responseNode, responseNode)
+    kb.add(options.req, this.ns.link('response'), responseNode, this.appNode)
     kb.add(responseNode, this.ns.http('status'),
-    kb.rdfFactory.literal(response.status as any), responseNode)
+    kb.rdfFactory.literal(response.status as any), this.appNode)
     kb.add(responseNode, this.ns.http('statusText'),
-    kb.rdfFactory.literal(response.statusText), responseNode)
+    kb.rdfFactory.literal(response.statusText), this.appNode)
 
     // Save the response headers
     response.headers.forEach((value, header) => {
-      kb.add(responseNode, this.ns.httph(header), this.store.rdfFactory.literal(value), responseNode)
+      kb.add(responseNode, this.ns.httph(header), this.store.rdfFactory.literal(value), this.appNode)
 
       if (header === 'content-type') {
         kb.add(
           options.resource,
           this.ns.rdf('type'),
           kb.rdfFactory.namedNode(Util.mediaTypeClass(value).value),
-          responseNode
+          this.appNode // responseNode
         )
       }
     })

src/update-manager.ts

@@ -81,14 +81,52 @@ export default class UpdateManager {
     return( uri.slice(0,4) === 'http' )
   }
 
+/** Remove from the store HTTP authorization metadata
+* The editble function below relies on copies we have in the store
+* of the results of previous HTTP transactions. Howver, when
+* the user logs in, then that data misrepresents what would happen
+* if the user tried again.
+*/
+flagAuthorizationMetadata () {
+  const kb = this.store
+  const meta = kb.fetcher.appNode
+  const requests = kb.statementsMatching(undefined, this.ns.link('requestedURI'), undefined, meta).map(st => st.subject)
+  for (const request of requests) {
+    const response = kb.any(request, this.ns.link('response'), null, meta) as Quad_Subject
+    if (response !== undefined) { // ts
+      this.store.add(response, this.ns.link('outOfDate'), true as any, meta) // @@ Boolean is fine - fix types
+    }
+  }
+}
 
+/**
+ * Tests whether a file is editable.
+ * If the file has a specific annotation that it is machine written,
+ * for safety, it is editable (this doesn't actually check for write access)
+ * If the file has wac-allow and accept patch headers, those are respected.
+ * and local write access is determined by those headers.
+ * This async version not only looks at past HTTP requests, it also makes new ones if necessary.
+ *
+ * @returns The method string SPARQL or DAV or
+ *   LOCALFILE or false if known, undefined if not known.
+ */
+ async checkEditable (uri: string | NamedNode, kb?: IndexedFormula): Promise<string | boolean | undefined> {
+   const initial = this.editable(uri, kb)
+   if (initial !==  undefined) {
+     return initial
+   }
+   await this.store.fetcher.load(uri)
+   const final = this.editable(uri, kb)
+   // console.log(`Loaded ${uri} just to check editable, result: ${final}.`)
+   return final
+ }
   /**
    * Tests whether a file is editable.
    * If the file has a specific annotation that it is machine written,
    * for safety, it is editable (this doesn't actually check for write access)
    * If the file has wac-allow and accept patch headers, those are respected.
    * and local write access is determined by those headers.
-   * This version only looks at past HTTP requests, does not make new ones.
+   * This synchronous version only looks at past HTTP requests, does not make new ones.
    *
    * @returns The method string SPARQL or DAV or
    *   LOCALFILE or false if known, undefined if not known.
@@ -103,7 +141,7 @@ export default class UpdateManager {
     uri = termValue(uri)
 
     if ( !this.isHttpUri(uri as string) ) {
-      if (kb.holds(
+      if (this.store.holds(
           this.store.rdfFactory.namedNode(uri),
           this.store.rdfFactory.namedNode('http://www.w3.org/1999/02/22-rdf-syntax-ns#type'),
           this.store.rdfFactory.namedNode('http://www.w3.org/2007/ont/link#MachineEditableDocument'))) {
@@ -113,14 +151,21 @@ export default class UpdateManager {
 
     var request
     var definitive = false
+    const meta = this.store.fetcher.appNode
+    // const kb = s
+
      // @ts-ignore passes a string to kb.each, which expects a term. Should this work?
-    var requests = kb.each(undefined, this.ns.link('requestedURI'), docpart(uri))
+    var requests = kb.each(undefined, this.ns.link('requestedURI'), docpart(uri), meta)
     var method: string
     for (var r = 0; r < requests.length; r++) {
       request = requests[r]
       if (request !== undefined) {
-        var response = kb.any(request, this.ns.link('response')) as Quad_Subject
-        if (request !== undefined) {
+        const response = kb.any(request, this.ns.link('response'), null, meta) as Quad_Subject
+        if (response !== undefined) { // ts
+
+          const outOfDate = kb.anyJS(response, this.ns.link('outOfDate'), null, meta) as Quad_Subject
+          if (outOfDate) continue
+
           var wacAllow = kb.anyValue(response, this.ns.httph('wac-allow'))
           if (wacAllow) {
             for (var bit of wacAllow.split(',')) {

tests/unit/fetcher-test.js

@@ -175,7 +175,7 @@ describe('Fetcher', () => {
   describe('load', () => {
     // let fetcher, uri, options, xhr
 
-    it('should load multiple docs')
+    // it.skip('should load multiple docs', () => {})
   })
 
   describe('load', () => {
@@ -338,7 +338,6 @@ describe('Fetcher', () => {
       delete fetcher.requested[uri]
       return fetcher.webOperation('PATCH', uri, options) // load() is not usable for PATCH
         .then(result => {}, () => {
-          console.log('###### ' + fetcher.requested[uri])
           expect(fetcher.requested[uri]).to.not.exist()
         })
     })
@@ -438,33 +437,33 @@ describe('Fetcher', () => {
   })
 
   describe('guessContentType', () => {
-    it('should return null if uri has no extension')
+    // it.skip('should return null if uri has no extension')
 
-    it('should return null if unknown extension')
+    // it.skip('should return null if unknown extension')
 
-    it('it should return the content type for a known extension')
+    // it.skip('it should return the content type for a known extension')
   })
 
   describe('normalizedContentType', () => {
-    it('should return the forced content type if present')
+    // it.skip('should return the forced content type if present')
 
-    it('should try to guess content type if none returned in header')
+    // it.skip('should try to guess content type if none returned in header')
 
-    it('should try to guess content type for octet-stream generic type')
+    // it.skip('should try to guess content type for octet-stream generic type')
 
-    it('should return the content type in the headers')
+    // it.skip('should return the content type in the headers')
 
-    it('should default to text/xml for file: protocol uris')
+    // it.skip('should default to text/xml for file: protocol uris')
 
-    it('should default to text/xml for chrome: protocol uris')
+    // it.skip('should default to text/xml for chrome: protocol uris')
   })
 
   describe('handlerForContentType', () => {
-    it('should return null when no contentType given')
+    // it.skip('should return null when no contentType given')
 
-    it('should return a handler instance if content type matches')
+    // it.skip('should return a handler instance if content type matches')
 
-    it('should return null when no handler match is found')
+    // it.skip('should return null when no handler match is found')
   })
 
   describe('load nock tests', () => {
@@ -568,6 +567,6 @@ describe('Fetcher', () => {
   })
 
   describe('createContainer', () => {
-    it('should invoke webOperation with the right options')
+    // it.skip('should invoke webOperation with the right options', () => {})
   })
 })

tests/unit/lists-test.js

@@ -62,12 +62,13 @@ describe('Lists', () => {
   '[ rdf:first 1; rdf:rest [ rdf:first 2; rdf:rest [ rdf:first 3; rdf:rest rdf:nil ]]] <#value>  <#test>  .'
         parse(content, store, base, mimeType)
         convertFirstRestNil(store, doc)
-        console.log('@@@ CCC ' + dumpStore(store))
+        // console.log('@@@ CCC ' + dumpStore(store))
         expect(store.statements[0].subject.termType).to.eql('Collection')
         expect(store.statements[0].subject.elements.length).to.eql(3)
       })
 
       // Skip for now as serializer does not handle list as subject
+      /*
       it.skip('handles a lone list in Subject position serialized', () => {
         let base = 'https://example.com/tests/test.ttl'
         let mimeType = 'text/turtle'
@@ -79,14 +80,15 @@ describe('Lists', () => {
         // console.log('@@@ AAA ' + showDoc(store, doc))
         // expect(store.statements[0].object.termType).to.eql('BlankNode')
         convertFirstRestNil(store, doc)
-        console.log('@@@ CCC ' + dumpStore(store))
+        // console.log('@@@ CCC ' + dumpStore(store))
         // expect(store.statements[0].object.termType).to.eql('Collection')
         expect(showDoc(store, doc)).to.eql(`@prefix : <#>.
 
  ( 1 2 3 ) :value :test .
 
 `)
       })
+      */
 
       it('handles nested lists', () => {
         let base = 'https://example.com/tests/test.ttl'

tests/unit/live-store-test.js

@@ -27,7 +27,7 @@ const doc = bar.doc()
 const doc1 = bar.doc()
 const doc2 = baz.doc()
 
-const meta = $rdf.sym(doc.uri + '#meta') // random graph name for meta data
+const meta = $rdf.sym('chrome://TheCurrentSession') // graph name for meta data
 const st1 = $rdf.st(bar, p, 111, doc)
 const st2 = $rdf.st(bar, p, 222, doc1)
 const st3 = $rdf.st(baz, p, 333, doc2)

tests/unit/update-manager-test.js

@@ -27,15 +27,16 @@ const doc = bar.doc()
 const doc1 = bar.doc()
 const doc2 = baz.doc()
 
-const meta = $rdf.sym(doc.uri + '#meta') // random graph name for meta data
+const meta = $rdf.sym('chrome://TheCurrentSession') // specific graph name for meta data
+// const meta = store.fetcher.appNode // random graph name for meta data
 const st1 = $rdf.st(bar, p, 111, doc)
 const st2 = $rdf.st(bar, p, 222, doc1)
 const st3 = $rdf.st(baz, p, 333, doc2)
 
 const httpResultsText = `
 @prefix httph: <http://www.w3.org/2007/ont/httph#> .
 @prefix link: <http://www.w3.org/2007/ont/link#>.
- [] link:requestedURI "${doc.uri}", "${doc2.uri}"; link:response [ httph:ms-author-via "SPARQL" ].
+ [] link:requestedURI "${doc.uri}", "${doc2.uri}"; link:response [ httph:accept-patch "application/sparql-update" ].
  `
 
 function loadMeta (store) {
@@ -155,15 +156,13 @@ describe('UpdateManager', () => {
 
     })
 
-    // on console should display @@@@@@@     updateMany to: 2
     it('Should insert triples in more than one document', () => {
       loadMeta(updater.store)
       updater.updateMany([], [st1, st2, st3]).then(array => {
         expect(updater.store.fetcher.webOperation).to.have.been.called()
       })
     })
 
-    // on console should display @@@@@@@     updateMany to: 2
     it('Should remove triples in more than one document', done => {
       loadMeta(updater.store)
       updater.updateMany([], [st1, st2, st3])
@@ -198,4 +197,55 @@ describe('UpdateManager', () => {
 
   })
 
+  describe('editable', () => {
+    const self = {err: ''}
+    let updater, docuri, rterm, options, userCallback, loadStub
+    var loadStatus = 200
+
+    beforeEach(() => {
+      options = {}
+      userCallback = () => {}
+
+      updater = new UpdateManager()
+      updater.store.fetcher.webOperation = sinon.stub().resolves({ ok: true, status: 200, statusText: "Dummy stub 1"})
+      updater.store.fetcher.load = sinon.stub().resolves({ ok: true, status: 200, statusText: "Dummy stub 2"})
+
+    })
+
+    it('Should detect a document is editable from metadata', () => {
+      loadMeta(updater.store)
+      expect(updater.editable(doc1)).to.equal('SPARQL')
+    })
+
+    it('Should not detect a document is editable from metadata after flush', () => {
+      loadMeta(updater.store)
+      updater.flagAuthorizationMetadata()
+      expect(updater.editable(doc1)).to.equal(undefined)
+    })
+
+
+    it('Async version should detect a document is editable from metadata', async () => {
+      loadMeta(updater.store)
+      const result = await updater.checkEditable(doc1)
+      expect(result).to.equal('SPARQL')
+      expect(updater.editable(doc1)).to.equal('SPARQL')
+    })
+
+    it('Async version should not detect a document is editable from metadata after flush', async () => {
+      loadMeta(updater.store)
+
+      expect(updater.editable(doc1)).to.equal('SPARQL')
+
+      updater.flagAuthorizationMetadata()
+
+      const result = await updater.checkEditable(doc1)
+
+      expect(result).to.equal(undefined)
+    })
+
+
+  })
+
+
+
 })