Chat proof

src/chat/keys.ts

@@ -82,17 +82,33 @@ export async function getPrivateKey (webId: NamedNode) {
   return privateKey as string
 }
 
+const deleteKey = async (keyDoc: string) => {
+  await store.fetcher.load(keyDoc)
+
+  const keyAclDoc = store.any(store.sym(keyDoc), store.sym('http://www.iana.org/assignments/link-relations/acl'))
+  if (keyAclDoc) {
+    // delete READ only keyAclDoc. This is possible if the webId is an owner
+    try {
+      const response = await store.fetcher.webOperation('DELETE', keyAclDoc.value) // this may fail if webId is not an owner
+      debug.log('delete ' + keyAclDoc.value + ' ' + response.status) // should test 404 and 2xx
+    } catch (err) {
+      if (err.response.status !== 404) { throw new Error(err) }
+      debug.log('delete ' + keyAclDoc.value + ' ' + err.response.status) // should test 404 and 2xx
+    }
+  }
+}
+
 /**
  * delete acl if keydoc exists
  * create/edit keyDoc
  * set keyDoc acl
  */
 async function saveKey (keyDoc: string, del, add, me: string = '') {
-  await store.fetcher.load(keyDoc)
+  // await store.fetcher.load(keyDoc) //think we can delete this
   // delete keyAclDoc
-  try {
+  /*  try { //here
     // get keyAcldoc
-    const keyAclDoc = store.any(store.sym(keyDoc), store.sym('http://www.iana.org/assignments/link-relations/acl'))
+   const keyAclDoc = store.any(store.sym(keyDoc), store.sym('http://www.iana.org/assignments/link-relations/acl'))
     if (keyAclDoc) {
       // delete READ only keyAclDoc. This is possible if the webId is an owner
       try {
@@ -103,12 +119,12 @@ async function saveKey (keyDoc: string, del, add, me: string = '') {
         debug.log('delete ' + keyAclDoc.value + ' ' + err.response.status) // should test 404 and 2xx
       }
     }
+  */
+  await deleteKey(keyDoc)
+  // save key
+  await store.updater.updateMany(del, add) // or a promise store.updater.update ?
 
-    // save key
-    await store.updater.updateMany(del, add) // or a promise store.updater.update ?
-
-    // create READ only ACL
-    const aclBody = keyAclBody(keyDoc, me)
-    await setAcl(keyDoc, aclBody)
-  } catch (err) { throw new Error(err) }
+  // create READ only ACL
+  const aclBody = keyAclBody(keyDoc, me)
+  await setAcl(keyDoc, aclBody)
 }

src/utils/keyHelpers/acl.ts

@@ -19,19 +19,15 @@ export async function setAcl (keyDoc: string, aclBody: string) {
     throw new Error('Key ACL doc not found!')
   }
 
-  // delete READ only keyAclDoc. This is possible if the webId is an owner
   try {
-    const response = await store.fetcher.webOperation('DELETE', keyAclDoc.value) // this may fail if webId is not an owner
-    debug.log('delete ' + keyAclDoc.value + ' ' + response.status) // should test 404 and 2xx
+    await store.fetcher.webOperation('PUT', keyAclDoc.value, {
+      data: aclBody,
+      contentType: 'text/turtle'
+    })
   } catch (err) {
-    if (err.response.status !== 404) { throw new Error(err) }
+    if (err?.response?.status !== 404) { throw new Error(err) }
     debug.log('delete ' + keyAclDoc.value + ' ' + err.response.status) // should test 404 and 2xx
   }
-
-  const aclResponse = await store.fetcher.webOperation('PUT', keyAclDoc.value, {
-    data: aclBody,
-    contentType: 'text/turtle'
-  })
 }
 
 /**

test/unit/README.md

@@ -1,7 +1,7 @@
 # Solid-UI Unit Testing
 The purpose of this README is to provide guidance on how to write tests for solid-ui for beginners.
 
-Although we would love to have 100% test coverage, we realize that this is not a commericial product. solid-ui is an open source, volunteer built library that houses UI components that can be used to build Solid applications. We are working to increase test coverage on existing code, any help is much appreciated. If you add a new component to solid-ui, you should write tests to test the main functionality of your component in order for your PR to be merged.
+Although we would love to have 100% test coverage, we realize that this is not a commericial product. `solid-ui` is an open source, volunteer built library that houses UI components that can be used to build Solid applications. We are working to increase test coverage on existing code, and any help is much appreciated. If you add a new component to `solid-ui`, you should write tests to test the main functionality of your component before your PR will be merged.
 
 ## Running Tests
 
@@ -10,30 +10,35 @@ The following command will run all the tests.
 `npm run test`
 
 ### One file at a time
-There are a lot of tests in `solid-ui` so you will most likely want to run only the test you are working on at the moment. In order to do that you can use the following command.
+There are a lot of tests in `solid-ui`, so you will most likely want to run only the test you are working on at the moment. You can use the commands like the following to do that:
 `npm test <filetobetested>`
 `npm test test/unit/utils/keyHelpers/accessData.test.ts`
 
 ### Coverage
 Run the following command:
 `npm run coverage`
 
-Then you can see the results in `coverage/lcov-report/index.html`. If you are using VSCode you can right click and select to `Open in Browser Preview`. Otherwise, you can type the path in your browswer, for instance `file:///Users/<yourhomedirectory>/2023Development/solid-ui/coverage/lcov-report/index.html` is an example.
+The results will be found in `coverage/lcov-report/index.html`. If you are using VSCode, you can right click and select `Open in Browser Preview`. Alternatively, you can type the path in your browser; for instance, the following:
+```
+file:///Users/<yourhomedirectory>/2023Development/solid-ui/coverage/lcov-report/index.html
+```
 
 ## Tips and Tricks
-The following are some tips and tricks in hopes to make testing easier.
+The following are some tips and tricks to make your testing easier.
 
 ### VSCode Debugging
-There is an extension that can be used to aide in debugging jest tests. To find out more about it you can look at [Jest Runner](https://marketplace.visualstudio.com/items?itemName=firsttris.vscode-jest-runner)
+There is an extension that can be used to aide in debugging `jest` tests. To find out more about it, you can look at [Jest Runner](https://marketplace.visualstudio.com/items?itemName=firsttris.vscode-jest-runner).
 
 ### Mocking
-In solid-ui we do not currently follow a MVC pattern therefore there can be some difficulty in testing. The following are patterns to help with this.
+In `solid-ui`, we do not currently follow a MVC pattern, so testing is not always easy. The following are patterns to help with this.
 #### Store methods
 ##### Load
-In SolidOS we use [rdflib.js](https://github.com/linkeddata/rdflib.js/) to work with LinkedData. The way this works is that you first load the document you need to work with into the store. Once the document is loaded you can then access the data by using additional methods on the store such as `any, each,...`. Since the data that gets returned will need to be mocked, `load` doesn't need to do anything. See below for what you need to put in the top of your file in order to mock the `load` method.  
-`import { store } from 'solid-logic'` at the top of your file.
-
-`store.fetcher.load = jest.fn().mockImplementation(() => {})`
+In SolidOS, we use [`rdflib.js`](https://github.com/linkeddata/rdflib.js/) to work with LinkedData. First, you load the document you need to work with into the store. Once the document is loaded, you can access the data by using additional methods on the store such as `any`, `each`, etc. Since the data that gets returned will need to be mocked, `load` doesn't need to do anything. You need to put the following into your file to mock the `load` method:
+```
+import { store } from 'solid-logic'      /* at the top of your file */
+...
+store.fetcher.load = jest.fn().mockImplementation(() => {})
+```
 
 ##### Any
 

test/unit/utils/keyHelpers/accessData.test.ts

@@ -37,7 +37,7 @@ describe('cryptoKeyHelpers', () => {
   })
   describe.skip('privKeyUrl', () => {
     it('returns...', () => {
-      const result = privKeyUrl('https://alice.solid.example/profile/card#me')
+      const result = privKeyUrl(new NamedNode('https://alice.solid.example/profile/card#me'))
       expect(result).toEqual('https://alice.solid.example/profile/keys/privateKey.ttl')
     })
   })
@@ -61,20 +61,16 @@ describe('cryptoKeyHelpers', () => {
       const result = await getKeyIfExists(webId, PUB_KEY, 'PublicKey')
       expect(result).toBe(PUB_KEY)
     })
-    it.skip('does something the key can not be found.. need to ask Alain', async () => {
+    it.skip('throws an error when load fails', async () => {
+      // need to check if 'any' can throw an error
       const webId = new NamedNode('https://alice.solid.example/profile/card#me')
       const result = await getKeyIfExists(webId, 'testing', 'PublicKey')
       expect(result).toBe('testing')
     })
-    it.skip('throws an error if the key can not be stored', async () => {
+    it.skip('returns undefined if key not found', async () => {
       const webId = new NamedNode('https://alice.solid.example/profile/card#me')
       const result = await getKeyIfExists(webId, PUB_KEY, 'PublicKey')
       expect(result).toBe(PUB_KEY)
     })
-    it.skip('throws an error if key is not found', async () => {
-      const webId = new NamedNode('https://alice.solid.example/profile/card#me')
-      const result = await getKeyIfExists(webId, 'testing', 'PublicKey')
-      expect(result).toBe('testing')
-    })
   })
 })

test/unit/utils/keyHelpers/acl.test.ts

@@ -3,17 +3,36 @@ import { setAcl, keyAclBody } from '../../../../src/utils/keyHelpers/acl'
 
 store.fetcher.load = jest.fn().mockImplementation(() => {})
 store.any = jest.fn()
+store.fetcher.webOperation = jest.fn()
+
+const keyDoc = 'https://alice.solidcommunity.net/profile/keys/publicKey.ttl'
+const keyAclDoc = 'https://alice.solidcommunity.net/profile/keys/publicKey.ttl'
+const error404 = {
+  response: {
+    status: 404
+  }
+}
 
 describe('ACL Helpers', () => {
   describe('setAcl', () => {
     it('throws an error if an ACL document is NOT found', async () => {
       /* @ts-ignore */
-      store.any.mockReturnValue('')
-      const keyDoc = 'https://alice.solidcommunity.net/profile/keys/publicKey.ttl'
+      store.any.mockReturnValueOnce('')
       await expect(setAcl(keyDoc, keyAclBody(keyDoc, ''))).rejects.toThrowError('Key ACL doc not found!')
     })
-    it.skip('want to find out why we delete and then re-add', () => {
-
+    it('throws error if acl can not be written', async () => {
+      /* @ts-ignore */
+      store.any.mockReturnValueOnce(keyAclDoc)
+      /* @ts-ignore */
+      store.fetcher.webOperation.mockRejectedValueOnce()
+      await expect(setAcl(keyDoc, keyAclBody(keyDoc, ''))).rejects.toThrowError('')
+    })
+    it('continues if error is because acl doc can not be found.', async () => {
+      /* @ts-ignore */
+      store.any.mockReturnValueOnce(keyAclDoc)
+      /* @ts-ignore */
+      store.fetcher.webOperation.mockRejectedValueOnce(error404)
+      await expect(setAcl(keyDoc, keyAclBody(keyDoc, ''))).resolves.toBeUndefined
     })
   })
 })