Merge pull request #58 from SolidOS/stringUrl

Refactoring String url into NamedNode

Author: bourgeoa

README.md

@@ -3,6 +3,6 @@ Core business logic of SolidOS
 
 # Adendum
 
-Solid-logic was a move to sparate business logic from UI functionality so that people using different UI frameworks could use logic code. 
+Solid-logic was a move to separate business logic from UI functionality so that people using different UI frameworks could use logic code. 
 
-It was created when the "chat with me" feature was built. We needed shared logic between chat-pane and profile-pane (which was part of solid-panes back then I think) due to that feature. The whole idea of it is to separate core solid logic from UI components, to make logic reusable, e.g. by other UI libraries or even non web apps like CLI tools etc. 
+It was created when the "chat with me" feature was built. We needed to share logic between chat-pane and profile-pane (which was part of solid-panes back then I think) due to that feature. The whole idea of it is to separate core solid logic from UI components, to make logic reusable, e.g. by other UI libraries or even non web apps like CLI tools etc. 

package-lock.json

@@ -11,10 +11,9 @@ export function createAclLogic(store): AclLogic {
 
     const ns = namespace
 
-    async function findAclDocUrl(url: string) {
-        const doc = store.sym(url);
-        await store.fetcher.load(doc);
-        const docNode = store.any(doc, ACL_LINK);
+    async function findAclDocUrl(url: NamedNode) {
+        await store.fetcher.load(url);
+        const docNode = store.any(url, ACL_LINK);
         if (!docNode) {
             throw new Error(`No ACL link discovered for ${url}`);
         }

src/acl/aclLogic.ts

@@ -1,4 +1,4 @@
-import { NamedNode } from "rdflib";
+import { NamedNode, sym } from "rdflib";
 import { InboxLogic } from "../types";
 import { getArchiveUrl } from "../util/utils";
 
@@ -21,12 +21,12 @@ export function createInboxLogic(store, profileLogic, utilityLogic, containerLog
 
   async function getNewMessages(
       user?: NamedNode
-    ): Promise<string[]> {
+    ): Promise<NamedNode[]> {
       if (!user) {
         user = await profileLogic.loadMe();
       }
       const inbox = await profileLogic.getMainInbox(user);
-      const urls = await containerLogic.getContainerMembers(inbox.value);
+      const urls = await containerLogic.getContainerMembers(inbox);
       return urls.filter(url => !containerLogic.isContainer(url));
   }
 

src/inbox/inboxLogic.ts

@@ -72,7 +72,7 @@ export interface ProfileLogic {
 }
 
 export interface AclLogic {
-    findAclDocUrl: (url: string) => Promise<any>,
+    findAclDocUrl: (url: NamedNode) => Promise<any>,
     setACLUserPublic: (docURI: string, me: NamedNode,
         options: {
             defaultForNew?: boolean,
@@ -89,7 +89,7 @@ export interface AclLogic {
 
 export interface InboxLogic {
     createInboxFor: (peerWebId: string, nick: string) => Promise<string>,
-    getNewMessages: (user?: NamedNode) => Promise<string[]>,
+    getNewMessages: (user?: NamedNode) => Promise<NamedNode[]>,
     markAsRead: (url: string, date: Date) => void
 }
 

src/types.ts

@@ -6,44 +6,43 @@ import { NamedNode, Statement, sym } from "rdflib";
 export function createContainerLogic(store) {
 
     function getContainerElements(containerNode: NamedNode): NamedNode[] {
-            return store
-                .statementsMatching(
-                    containerNode,
-                    sym("http://www.w3.org/ns/ldp#contains"),
-                    undefined,
-                    containerNode.doc()
-                )
-                .map((st: Statement) => st.object as NamedNode);
+        return store
+            .statementsMatching(
+                containerNode,
+                sym("http://www.w3.org/ns/ldp#contains"),
+                undefined
+            )
+            .map((st: Statement) => st.object as NamedNode);
     }
 
-    function isContainer(url: string) {
-            return url.charAt(url.length - 1) === "/";
+    function isContainer(url: NamedNode) {
+        const nodeToString = url.value;
+        return nodeToString.charAt(nodeToString.length - 1) === "/";
     }
 
     async function createContainer(url: string) {
-            if (!isContainer(url)) {
-                throw new Error(`Not a container URL ${url}`);
-            }
-            // Copied from https://github.com/solidos/solid-crud-tests/blob/v3.1.0/test/surface/create-container.test.ts#L56-L64
-            const result = await store.fetcher._fetch(url, {
-                method: "PUT",
-                headers: {
-                    "Content-Type": "text/turtle",
-                    "If-None-Match": "*",
-                    Link: '<http://www.w3.org/ns/ldp#BasicContainer>; rel="type"', // See https://github.com/solidos/node-solid-server/issues/1465
-                },
-                body: " ", // work around https://github.com/michielbdejong/community-server/issues/4#issuecomment-776222863
-            });
-            if (result.status.toString()[0] !== '2') {
-                throw new Error(`Not OK: got ${result.status} response while creating container at ${url}`);
-            }
+        const stringToNode = sym(url);
+        if (!isContainer(stringToNode)) {
+            throw new Error(`Not a container URL ${url}`);
+        }
+        // Copied from https://github.com/solidos/solid-crud-tests/blob/v3.1.0/test/surface/create-container.test.ts#L56-L64
+        const result = await store.fetcher._fetch(url, {
+            method: "PUT",
+            headers: {
+                "Content-Type": "text/turtle",
+                "If-None-Match": "*",
+                Link: '<http://www.w3.org/ns/ldp#BasicContainer>; rel="type"', // See https://github.com/solidos/node-solid-server/issues/1465
+            },
+            body: " ", // work around https://github.com/michielbdejong/community-server/issues/4#issuecomment-776222863
+        });
+        if (result.status.toString()[0] !== '2') {
+            throw new Error(`Not OK: got ${result.status} response while creating container at ${url}`);
+        }
     }
 
-    async function getContainerMembers(containerUrl: string): Promise<string[]> {
-            const containerNode = store.sym(containerUrl);
-            await store.fetcher.load(containerNode);
-            const nodes = getContainerElements(containerNode);
-            return nodes.map(node => node.value);
+    async function getContainerMembers(containerUrl: NamedNode): Promise<NamedNode[]> {
+        await store.fetcher.load(containerUrl);
+        return getContainerElements(containerUrl);
     }
     return {
         isContainer,

src/util/containerLogic.ts

@@ -1,21 +1,22 @@
-import { NamedNode, st } from "rdflib";
+import { NamedNode, st, sym } from "rdflib";
 import { CrossOriginForbiddenError, FetchError, NotEditableError, SameOriginForbiddenError, UnauthorizedError, WebOperationError } from "../logic/CustomError";
 import * as debug from '../util/debug';
 import { differentOrigin } from "./utils";
 
 export function createUtilityLogic(store, aclLogic, containerLogic) {
 
-  async function recursiveDelete(url: string) {
+  async function recursiveDelete(containerNode: NamedNode) {
       try {
-        if (containerLogic.isContainer(url)) {
-          const aclDocUrl = await aclLogic.findAclDocUrl(url);
+        if (containerLogic.isContainer(containerNode)) {
+          const aclDocUrl = await aclLogic.findAclDocUrl(containerNode)
           await store.fetcher._fetch(aclDocUrl, { method: "DELETE" });
-          const containerMembers = await containerLogic.getContainerMembers(url);
+          const containerMembers = await containerLogic.getContainerMembers(containerNode);
           await Promise.all(
             containerMembers.map((url) => recursiveDelete(url))
           );
         }
-        return store.fetcher._fetch(url, { method: "DELETE" });
+        const nodeToStringHere = containerNode.value;
+        return store.fetcher._fetch(nodeToStringHere, { method: "DELETE" });
       } catch (e) {
         // debug.log(`Please manually remove ${url} from your system under test.`, e);
       }
@@ -126,7 +127,7 @@ export function createUtilityLogic(store, aclLogic, containerLogic) {
         ''
       ].join('\n')
     }
-    const aclDocUrl = await aclLogic.findAclDocUrl(options.target);
+    const aclDocUrl = await aclLogic.findAclDocUrl(sym(options.target))
     return store.fetcher._fetch(aclDocUrl, {
       method: 'PUT',
       body: str,

src/util/utilityLogic.ts

@@ -2,7 +2,7 @@
 * @jest-environment jsdom
 * 
 */
-import { UpdateManager, Store, Fetcher } from "rdflib";
+import { UpdateManager, Store, Fetcher, sym } from "rdflib";
 import { createContainerLogic } from "../src/util/containerLogic";
 import { alice } from "./helpers/dataSetup";
 
@@ -21,16 +21,17 @@ describe("Container", () => {
 
     it("getContainerMembers - When container has some containment triples", async () => {
             containerHasSomeContainmentTriples()
-            const result = await containerLogic.getContainerMembers('https://com/');
+            const containerMembers = await containerLogic.getContainerMembers(sym('https://container.com/'));
+            const result = containerMembers.map(oneResult => oneResult.value)
             expect(result.sort()).toEqual([
-                'https://com/foo.txt',
-                'https://com/bar/'
+                'https://container.com/foo.txt',
+                'https://container.com/bar/'
             ].sort());
     });
     it.skip("getContainerMembers- When container is empty - Resolves to an empty array", async () => {
         jest.setTimeout(2000)
         containerIsEmpty();
-        const result = await containerLogic.getContainerMembers('https://container.com/');
+        const result = await containerLogic.getContainerMembers(sym('https://container.com/'));
         expect(result).toEqual([]);
     });
 
@@ -46,7 +47,7 @@ describe("Container", () => {
 
     function containerHasSomeContainmentTriples() {
         fetchMock.mockOnceIf(
-            "https://com/",
+            "https://container.com/",
             "<.> <http://www.w3.org/ns/ldp#contains> <./foo.txt>, <./bar/> .",
             {
                 headers: { "Content-Type": "text/turtle" },

test/container.test.ts

@@ -52,7 +52,8 @@ describe("Inbox logic", () => {
       beforeEach(async () => {
         bobHasAnInbox();
         inboxHasSomeContainmentTriples();
-        result = await inboxLogic.getNewMessages(bob);
+        const messages = await inboxLogic.getNewMessages(bob);
+        result = messages.map(oneMessage => oneMessage.value)
       });
       it("Resolves to an array with URLs of non-container resources in inbox", () => {
         expect(result.sort()).toEqual([