solid-logic 3.1.1 → 4.0.0-3818f4f

package/test/chatLogic.test.ts

@@ -1,316 +0,0 @@
-/**
-* @jest-environment jsdom
-*
-*/
-import { UpdateManager, Store, Fetcher } from "rdflib";
-import { createAclLogic } from "../src/acl/aclLogic";
-import { createChatLogic } from '../src/chat/chatLogic';
-import { createProfileLogic } from "../src/profile/profileLogic";
-import { createContainerLogic } from "../src/util/containerLogic";
-import { createUtilityLogic } from "../src/util/utilityLogic";
-import { alice, bob } from "./helpers/dataSetup";
-
-window.$SolidTestEnvironment = { username: alice.uri }
-
-describe("Chat logic", () => {
-  let chatLogic;
-  let store;
-  beforeEach(() => {
-    fetchMock.resetMocks();
-    fetchMock.mockResponse("Not Found", {
-      status: 404,
-    });
-    store = new Store()
-    store.fetcher = new Fetcher(store, { fetch: fetch });
-    store.updater = new UpdateManager(store);
-    const authn = {
-      currentUser: () => {
-        return alice;
-      },
-    };
-    const util = createUtilityLogic(store, createAclLogic(store), createContainerLogic(store))
-    chatLogic = createChatLogic(store, createProfileLogic(store, authn, util))
-  });
-
-  describe("get chat, without creating", () => {
-    describe("when no chat exists yet", () => {
-      let result;
-      beforeEach(async () => {
-        aliceHasValidProfile();
-        noChatWithBobExists();
-        result = await chatLogic.getChat(bob, false);
-      });
-      it("does not return a chat", async () => {
-        expect(result).toBeNull();
-      });
-      it("loaded the current user profile", () => {
-        expect(fetchMock.mock.calls[0][0]).toBe(
-          "https://alice.example.com/profile/card.ttl"
-        );
-      });
-      it("tried to load the chat document", () => {
-        expect(fetchMock.mock.calls[1][0]).toBe(
-          "https://alice.example.com/IndividualChats/bob.example.com/index.ttl"
-        );
-      });
-      it("has no additional fetch requests", () => {
-        expect(fetchMock.mock.calls.length).toBe(2);
-      });
-    });
-  });
-
-  describe("get chat, create if missing", () => {
-    describe("when no chat exists yet", () => {
-      let result;
-      beforeEach(async () => {
-        Date.now = jest.fn(() =>
-          new Date(Date.UTC(2021, 1, 6, 10, 11, 12)).valueOf()
-        );
-        aliceHasValidProfile();
-        noChatWithBobExists();
-        chatWithBobCanBeCreated();
-        bobHasAnInbox();
-        invitationCanBeSent();
-        chatContainerIsFound();
-        chatContainerAclCanBeSet();
-        editablePrivateTypeIndexIsFound();
-        privateTypeIndexIsUpdated();
-        result = await chatLogic.getChat(bob, true);
-      });
-      it("returns the chat URI based on the invitee's WebID", () => {
-        expect(result.uri).toBe(
-          "https://alice.example.com/IndividualChats/bob.example.com/index.ttl#this"
-        );
-      });
-      it("created a chat document", () => {
-        const request = getRequestTo(
-          "PUT",
-          "https://alice.example.com/IndividualChats/bob.example.com/index.ttl"
-        );
-        expect(request.body).toBe(`@prefix : <#>.
-@prefix dc: <http://purl.org/dc/elements/1.1/>.
-@prefix meeting: <http://www.w3.org/ns/pim/meeting#>.
-@prefix xsd: <http://www.w3.org/2001/XMLSchema#>.
-@prefix c: </profile/card.ttl#>.
-
-:this
-    a meeting:LongChat;
-    dc:author c:me;
-    dc:created "2021-02-06T10:11:12Z"^^xsd:dateTime;
-    dc:title "Chat channel".
-`);
-      });
-      it("allowed Bob to participate in the chat by adding an ACL", () => {
-        const request = getRequestTo(
-          "PUT",
-          "https://alice.example.com/IndividualChats/bob.example.com/.acl"
-        );
-        expect(request.body).toBe(`
-            @prefix acl: <http://www.w3.org/ns/auth/acl#>.
-            <#owner>
-            a acl:Authorization;
-            acl:agent <https://alice.example.com/profile/card.ttl#me>;
-            acl:accessTo <.>;
-            acl:default <.>;
-            acl:mode
-                acl:Read, acl:Write, acl:Control.
-            <#invitee>
-            a acl:Authorization;
-            acl:agent <https://bob.example.com/profile/card.ttl#me>;
-            acl:accessTo <.>;
-            acl:default <.>;
-            acl:mode
-                acl:Read, acl:Append.
-            `);
-      });
-      it("sent an invitation to invitee inbox", () => {
-        const request = getRequestTo("POST", "https://bob.example.com/inbox");
-        expect(request.body).toContain(`
-        <> a <http://www.w3.org/ns/pim/meeting#LongChatInvite> ;
-        <http://www.w3.org/1999/02/22-rdf-syntax-ns#seeAlso> <https://alice.example.com/IndividualChats/bob.example.com/index.ttl#this> .
-        `);
-      });
-      it("added the new chat to private type index", () => {
-        const request = getRequestTo(
-          "PATCH",
-          "https://alice.example.com/settings/privateTypeIndex.ttl"
-        );
-        expect(request.body)
-          .toBe(`INSERT DATA { <https://alice.example.com/settings/privateTypeIndex.ttl#id1612606272000> <http://www.w3.org/1999/02/22-rdf-syntax-ns#type> <http://www.w3.org/ns/solid/terms#TypeRegistration> .
-<https://alice.example.com/settings/privateTypeIndex.ttl#id1612606272000> <http://www.w3.org/ns/solid/terms#forClass> <http://www.w3.org/ns/pim/meeting#LongChat> .
-<https://alice.example.com/settings/privateTypeIndex.ttl#id1612606272000> <http://www.w3.org/ns/solid/terms#instance> <https://alice.example.com/IndividualChats/bob.example.com/index.ttl#this> .
- }
-`);
-      });
-      it("has no additional fetch requests", () => {
-        expect(fetchMock.mock.calls.length).toBe(9);
-      });
-    });
-  });
-
-  describe("possible errors", () => {
-    it("profile does not link to storage", async () => {
-      fetchMock.mockOnceIf("https://alice.example.com/profile/card.ttl", "<><><>.", {
-        headers: {
-          "Content-Type": "text/turtle",
-        },
-      });
-      const expectedError = new Error("User pod root not found!");
-      await expect(chatLogic.getChat(bob, false)).rejects.toEqual(expectedError);
-    });
-
-    it("invitee inbox not found", async () => {
-      aliceHasValidProfile();
-      noChatWithBobExists();
-      chatWithBobCanBeCreated();
-      bobDoesNotHaveAnInbox();
-      const expectedError = new Error(
-        "Invitee inbox not found! https://bob.example.com/profile/card.ttl#me"
-      );
-      await expect(chatLogic.getChat(bob, true)).rejects.toEqual(expectedError);
-    });
-  });
-
-  function aliceHasValidProfile() {
-    fetchMock.mockOnceIf(
-      "https://alice.example.com/profile/card.ttl",
-      `
-            <https://alice.example.com/profile/card.ttl#me>
-              <http://www.w3.org/ns/pim/space#storage> <https://alice.example.com/> ;
-              <http://www.w3.org/ns/solid/terms#privateTypeIndex> <https://alice.example.com/settings/privateTypeIndex.ttl> ;
-            .`,
-      {
-        headers: {
-          "Content-Type": "text/turtle",
-        },
-      }
-    );
-  }
-
-  function noChatWithBobExists() {
-    return fetchMock.mockOnceIf(
-      ({ url, method }) =>
-        url === "https://alice.example.com/IndividualChats/bob.example.com/index.ttl" &&
-        method === "GET",
-      "Not found",
-      {
-        status: 404,
-      }
-    );
-  }
-
-  function chatWithBobCanBeCreated() {
-    return fetchMock.mockOnceIf(
-      ({ url, method }) =>
-        url === "https://alice.example.com/IndividualChats/bob.example.com/index.ttl" &&
-        method === "PUT",
-      "Created",
-      {
-        status: 201,
-      }
-    );
-  }
-
-  function bobHasAnInbox() {
-    fetchMock.mockOnceIf(
-      "https://bob.example.com/profile/card.ttl",
-      "<https://bob.example.com/profile/card.ttl#me><http://www.w3.org/ns/ldp#inbox><https://bob.example.com/inbox>.",
-      {
-        headers: { "Content-Type": "text/turtle" },
-      }
-    );
-  }
-
-  function bobDoesNotHaveAnInbox() {
-    fetchMock.mockOnceIf("https://bob.example.com/profile/card.ttl", "<><><>.", {
-      headers: {
-        "Content-Type": "text/turtle",
-      },
-    });
-  }
-
-  function invitationCanBeSent() {
-    return fetchMock.mockOnceIf(
-      ({ url, method }) =>
-        url === "https://bob.example.com/inbox" && method === "POST",
-      "Created",
-      {
-        status: 201,
-        headers: {
-          location:
-            "https://bob.example.com/inbox/22373339-6cc0-49fc-b69e-0402edda6e4e.ttl",
-        },
-      }
-    );
-  }
-
-  function chatContainerIsFound() {
-    return fetchMock.mockOnceIf(
-      ({ url, method }) =>
-        url === "https://alice.example.com/IndividualChats/bob.example.com/" &&
-        method === "GET",
-      "<><><>.",
-      {
-        status: 200,
-        headers: {
-          "Content-Type": "text/turtle",
-          Link: '<.acl>; rel="acl"',
-        },
-      }
-    );
-  }
-
-  function chatContainerAclCanBeSet() {
-    return fetchMock.mockOnceIf(
-      ({ url, method }) =>
-        url === "https://alice.example.com/IndividualChats/bob.example.com/.acl" &&
-        method === "PUT",
-      "Created",
-      {
-        status: 201,
-      }
-    );
-  }
-
-  function editablePrivateTypeIndexIsFound() {
-    return fetchMock.mockOnceIf(
-      ({ url, method }) =>
-        url === "https://alice.example.com/settings/privateTypeIndex.ttl" &&
-        method === "GET",
-      "<><><>.",
-      {
-        status: 200,
-        headers: {
-          "Content-Type": "text/turtle",
-          "wac-allow": 'user="read write append control",public=""',
-          "ms-author-via": "SPARQL",
-        },
-      }
-    );
-  }
-
-  function privateTypeIndexIsUpdated() {
-    return fetchMock.mockOnceIf(
-      ({ url, method }) =>
-        url === "https://alice.example.com/settings/privateTypeIndex.ttl" &&
-        method === "PATCH",
-      "OK",
-      {
-        status: 200,
-      }
-    );
-  }
-
-  function getRequestTo(
-    method: "GET" | "PUT" | "POST" | "DELETE" | "PATCH",
-    url: string
-  ): RequestInit {
-    const call = fetchMock.mock.calls.find(
-      (it) => it[0] === url && method === it[1]?.method
-    );
-    expect(call).not.toBeNull();
-    const request = call?.[1];
-    expect(request).not.toBeNull();
-    return request!;
-  }
-});

package/test/container.test.ts

@@ -1,58 +0,0 @@
-/**
-* @jest-environment jsdom
-* 
-*/
-import { UpdateManager, Store, Fetcher, sym } from "rdflib";
-import { createContainerLogic } from "../src/util/containerLogic";
-import { alice } from "./helpers/dataSetup";
-
-window.$SolidTestEnvironment = { username: alice.uri }
-
-describe("Container", () => {
-    let store
-    let containerLogic
-    beforeEach(() => {
-        fetchMock.resetMocks()
-        store = new Store()
-        store.fetcher = new Fetcher(store, { fetch: fetch });
-        store.updater = new UpdateManager(store);
-        containerLogic = createContainerLogic(store)
-    })
-
-    it("getContainerMembers - When container has some containment triples", async () => {
-            containerHasSomeContainmentTriples()
-            const containerMembers = await containerLogic.getContainerMembers(sym('https://container.com/'));
-            const result = containerMembers.map(oneResult => oneResult.value)
-            expect(result.sort()).toEqual([
-                '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(sym('https://container.com/'));
-        expect(result).toEqual([]);
-    });
-
-    function containerIsEmpty() {
-        fetchMock.mockOnceIf(
-            "https://com/",
-            "", // FIXME: https://github.com/jefflau/jest-fetch-mock/issues/189
-            {
-                headers: { "Content-Type": "text/turtle" },
-            }
-        );
-    }
-    
-    function containerHasSomeContainmentTriples() {
-        fetchMock.mockOnceIf(
-            "https://container.com/",
-            "<.> <http://www.w3.org/ns/ldp#contains> <./foo.txt>, <./bar/> .",
-            {
-                headers: { "Content-Type": "text/turtle" },
-            }
-        );
-        
-    }
-})

package/test/helpers/dataSetup.ts

@@ -1,134 +0,0 @@
-import { sym } from 'rdflib'
-import * as rdf from "rdflib";
-import solidNamespace from "solid-namespace";
-import { SolidNamespace } from '../../src/types';
-const ns: SolidNamespace = solidNamespace(rdf);
-
-//------ Club -------------------------------------------------------
-const club = sym('https://club.example.com/profile/card.ttl#it')
-const ClubPreferencesFile = sym('https://club.example.com/settings/prefs.ttl')
-const ClubPublicTypeIndex = sym('https://club.example.com/profile/public-type-index.ttl')
-const ClubPrivateTypeIndex = sym('https://club.example.com/settings/private-type-index.ttl')
-
-const ClubProfile = `
-
-<#it> a vcard:Organization;
-    space:preferencesFile ${ClubPreferencesFile};
-    solid:publicTypeIndex ${ClubPublicTypeIndex};
-    vcard:fn "Card Club" .
-`
-const ClubPreferences =  `
-    ${club} solid:privateTypeIndex ${ClubPrivateTypeIndex} .
-`
-const ClubPublicTypes = `
-
-:chat1 solid:forClass meeting:LongChat; solid:instance <../publicStuff/ourChat.ttl#this> .
-
-:todo solid:forClass wf:Tracker; solid:instance  <../publicStuff/actionItems.ttl#this>.
-
-:issues solid:forClass wf:Tracker; solid:instance  <../project4/clubIssues.ttl#this>.
-`;
-
-const ClubPrivateTypes = `
-:id1592319218311 solid:forClass wf:Tracker; solid:instance  <../privateStuff/ToDo.ttl#this>.
-
-:id1592319391415 solid:forClass wf:Tracker; solid:instance <../privateStuff/Goals.ttl#this>.
-
-:id1595595377864 solid:forClass wf:Tracker; solid:instance <../privateStuff/tasks.ttl#this>.
-
-:id1596123375929 solid:forClass meeting:Meeting; solid:instance  <../project4/clubMeeting.ttl#this>.
-
-`;
-
-//------ Alice -------------------------------------------------------
-const alice = sym("https://alice.example.com/profile/card.ttl#me")
-const AliceProfileFile = alice.doc()
-const AlicePreferencesFile = sym('https://alice.example.com/settings/prefs.ttl')
-const AlicePublicTypeIndex = sym('https://alice.example.com/profile/public-type-index.ttl')
-const AlicePrivateTypeIndex = sym('https://alice.example.com/settings/private-type-index.ttl')
-const AlicePhotoFolder = sym(alice.dir().uri + "Photos/")
-const AliceProfile = `
-<#me> a vcard:Individual;
-    space:preferencesFile ${AlicePreferencesFile};
-    solid:publicTypeIndex ${AlicePublicTypeIndex};
-    vcard:fn "Alice" .
-`
-const AlicePreferences =  `
-    ${alice} solid:privateTypeIndex ${AlicePrivateTypeIndex};
-    solid:community ${club} .
-`
-const AlicePublicTypes = `
-
-:chat1 solid:forClass meeting:LongChat; solid:instance <../publicStuff/myChat.ttl#this> .
-
-:todo solid:forClass wf:Tracker; solid:instance  <../publicStuff/actionItems.ttl#this>.
-
-:issues solid:forClass wf:Tracker; solid:instance  <../project4/issues.ttl#this>.
-
-:photos solid:forClass schema:Image; solid:instanceContainer  ${AlicePhotoFolder} .
-`;
-
-const AlicePrivateTypes = `
-:id1592319218311 solid:forClass wf:Tracker; solid:instance  <../privateStuff/ToDo.ttl#this>.
-
-:id1592319391415 solid:forClass wf:Tracker; solid:instance <../privateStuff/Goals.ttl#this>.
-
-:id1595595377864 solid:forClass wf:Tracker; solid:instance <../privateStuff/workingOn.ttl#this>.
-
-:id1596123375929 solid:forClass meeting:Meeting; solid:instance  <../project4/meeting1.ttl#this>.
-
-`;
-
-const AlicePhotos = `
-<>
-    a ldp:BasicContainer, ldp:Container;
-    dct:modified "2021-04-26T05:34:16Z"^^xsd:dateTime;
-    ldp:contains
-        <photo1.png>, <photo2.png>, <photo3.png> ;
-    stat:mtime 1619415256.541;
-    stat:size 4096 .
-`
-
-//------ Bob -------------------------------------------------------
-const bob = sym('https://bob.example.com/profile/card.ttl#me')
-
-const BobProfile = `
-<#me> a vcard:Individual;
-vcard:fn "Bob" .
-`
-
-//------ Boby -------------------------------------------------------
-const boby = sym('https://boby.example.com/profile/card.ttl#me')
-
-const BobyProfile = `
-<#me> a vcard:Individual;
-vcard:fn "Boby" .
-`
-export function loadWebObject() {
-    const web = {}
-    web[alice.doc().uri] = AliceProfile
-    web[AlicePreferencesFile.uri] = AlicePreferences
-    web[AlicePrivateTypeIndex.uri] = AlicePrivateTypes
-    web[AlicePublicTypeIndex.uri] = AlicePublicTypes
-    web[AlicePhotoFolder.uri] = AlicePhotos
-    web[bob.doc().uri] = BobProfile
-    web[boby.doc().uri] = BobyProfile
-
-    web[club.doc().uri] = ClubProfile
-    web[ClubPreferencesFile.uri] = ClubPreferences
-    web[ClubPrivateTypeIndex.uri] = ClubPrivateTypes
-    web[ClubPublicTypeIndex.uri] = ClubPublicTypes
-    return web
-}
-
-function clearLocalStore(store) {
-    store.statements.slice().forEach(store.remove.bind(store))
-}
-
-export {
-    alice, bob, boby, club,
-    AlicePhotoFolder, AlicePreferences, AlicePhotos, AlicePreferencesFile, AlicePrivateTypeIndex, AlicePrivateTypes, AliceProfile, AliceProfileFile, AlicePublicTypeIndex, AlicePublicTypes,
-    BobProfile,
-    ClubPreferences, ClubPreferencesFile, ClubPrivateTypeIndex, ClubPrivateTypes, ClubProfile, ClubPublicTypeIndex, ClubPublicTypes,
-    clearLocalStore
-}

package/test/helpers/setup.ts

@@ -1,17 +0,0 @@
-import { error, log, trace, warn } from '../../src/util/debug'
-import fetchMock from "jest-fetch-mock";
-import { TextEncoder, TextDecoder } from 'util'
-global.TextEncoder = TextEncoder
-global.TextDecoder = TextDecoder
-
-
-fetchMock.enableMocks();
-// We don't want to output debug messages to console as part of the tests
-jest.mock('../../src/util/debug')
-
-export function silenceDebugMessages () {
-  (log as any).mockImplementation(() => null)
-  ;(warn as any).mockImplementation(() => null)
-  ;(error as any).mockImplementation(() => null)
-  ;(trace as any).mockImplementation(() => null)
-}