feat(pos-make-findable): Indicate whether the resource is present in any index

Author: angelo-v

elements/src/components/pos-make-findable/pos-make-findable.spec.tsx

@@ -53,7 +53,9 @@ describe('pos-make-findable', () => {
     };
     when(mockOs.store.get).calledWith('https://thing.example#it').mockReturnValue({ fake: 'thing' });
     const labelIndexAssume = jest.fn();
-    when(labelIndexAssume).calledWith(LabelIndex).mockReturnValue({ fake: 'index' });
+    when(labelIndexAssume)
+      .calledWith(LabelIndex)
+      .mockReturnValue({ fake: 'index', contains: () => false });
     when(mockOs.store.get).calledWith('https://pod.example/label-index').mockReturnValue({
       assume: labelIndexAssume,
     });
@@ -66,10 +68,47 @@ describe('pos-make-findable', () => {
     await page.waitForChanges();
 
     // then the thing is added to the index
-    expect(mockOs.addToLabelIndex).toHaveBeenCalledWith({ fake: 'thing' }, { fake: 'index' });
+    expect(mockOs.addToLabelIndex).toHaveBeenCalledWith({ fake: 'thing' }, expect.objectContaining({ fake: 'index' }));
 
-    // and the state changes to success
-    expect(page.rootInstance.success).toEqual(true);
+    // and the state changes to indexed
+    expect(page.rootInstance.isIndexed).toEqual(true);
+  });
+
+  it('indicates if thing is already indexed', async () => {
+    // given a user profile in the current session with a single private label index
+    session.state.isLoggedIn = true;
+    session.state.profile = {
+      getPrivateLabelIndexes: () => ['https://pod.example/label-index'],
+    } as unknown as WebIdProfile;
+
+    // and a make findable component for a thing
+    page = await newSpecPage({
+      components: [PosMakeFindable],
+      html: `<pos-make-findable uri="https://thing.example#it"/>`,
+    });
+
+    // and a PodOS instance that yields Thing and LabelIndex instances for the URIs in question
+    const mockOs = {
+      store: {
+        get: jest.fn(),
+      },
+    };
+    when(mockOs.store.get).calledWith('https://thing.example#it').mockReturnValue({ fake: 'thing' });
+    const contains = jest.fn();
+    const labelIndexAssume = jest.fn();
+    when(labelIndexAssume).calledWith(LabelIndex).mockReturnValue({ fake: 'index', contains });
+    when(mockOs.store.get).calledWith('https://pod.example/label-index').mockReturnValue({
+      assume: labelIndexAssume,
+    });
+
+    // and the index already contains the URI
+    when(contains).calledWith('https://thing.example#it').mockReturnValue(true);
+
+    // and the component received that PodOs instance
+    page.rootInstance.receivePodOs(mockOs);
+
+    // then the state indicates that the URI is already indexed
+    expect(page.rootInstance.isIndexed).toEqual(true);
   });
 
   it('emits error if updating the index fails', async () => {
@@ -98,7 +137,9 @@ describe('pos-make-findable', () => {
     };
     when(mockOs.store.get).calledWith('https://thing.example#it').mockReturnValue({ fake: 'thing' });
     const labelIndexAssume = jest.fn();
-    when(labelIndexAssume).calledWith(LabelIndex).mockReturnValue({ fake: 'index' });
+    when(labelIndexAssume)
+      .calledWith(LabelIndex)
+      .mockReturnValue({ fake: 'index', contains: () => false });
     when(mockOs.store.get).calledWith('https://pod.example/label-index').mockReturnValue({
       assume: labelIndexAssume,
     });
@@ -204,7 +245,9 @@ describe('pos-make-findable', () => {
     };
     when(mockOs.store.get).calledWith('https://thing.example#it').mockReturnValue({ fake: 'thing' });
     const labelIndexAssume = jest.fn();
-    when(labelIndexAssume).calledWith(LabelIndex).mockReturnValue({ fake: 'index' });
+    when(labelIndexAssume)
+      .calledWith(LabelIndex)
+      .mockReturnValue({ fake: 'index', contains: () => false });
     when(mockOs.store.get).calledWith('https://pod.example/label-index').mockReturnValue({
       assume: labelIndexAssume,
     });
@@ -229,7 +272,7 @@ describe('pos-make-findable', () => {
 
     // and is working
     fireEvent.click(button);
-    expect(mockOs.addToLabelIndex).toHaveBeenCalledWith({ fake: 'thing' }, { fake: 'index' });
+    expect(mockOs.addToLabelIndex).toHaveBeenCalledWith({ fake: 'thing' }, expect.objectContaining({ fake: 'index' }));
   });
 
   it('updates thing when URI changes', async () => {
@@ -258,7 +301,7 @@ describe('pos-make-findable', () => {
     expect(page.rootInstance.thing).toEqual({ uri: 'https://other.example#it' });
   });
 
-  it('resets success state when URI changes', async () => {
+  it('resets index indication when URI changes', async () => {
     // given a make findable component for a thing
     page = await newSpecPage({
       components: [PosMakeFindable],
@@ -274,13 +317,13 @@ describe('pos-make-findable', () => {
 
     // and the component received that PodOs instance already
     page.rootInstance.receivePodOs(mockOs);
-    // and the component is in success state
-    page.rootInstance.success = true;
+    // and the component is in indexed state
+    page.rootInstance.isIndexed = true;
 
     // when the URI attribute changes
     page.root.setAttribute('uri', 'https://other.example#it');
-    // then the success status resets
-    expect(page.rootInstance.success).toEqual(false);
+    // then the indexed status resets
+    expect(page.rootInstance.isIndexed).toEqual(false);
   });
 
   describe('multiple indexes to choose from', () => {
@@ -386,8 +429,8 @@ describe('pos-make-findable', () => {
       const list = screen.queryByRole('listbox');
       expect(list).toBeNull();
 
-      // and the state changes to success
-      expect(page.rootInstance.success).toEqual(true);
+      // and the state changes to indexed
+      expect(page.rootInstance.isIndexed).toEqual(true);
     });
 
     it('closes the options, if clicked elsewhere', async () => {

elements/src/components/pos-make-findable/pos-make-findable.tsx

@@ -19,7 +19,7 @@ export class PosMakeFindable implements PodOsAware {
   @State() unsubscribeSessionChange: undefined | (() => void);
 
   @State() showOptions = false;
-  @State() success = false;
+  @State() isIndexed = false;
 
   @Event({ eventName: 'pod-os:error' }) errorEmitter: EventEmitter;
 
@@ -51,7 +51,11 @@ export class PosMakeFindable implements PodOsAware {
   @Watch('uri')
   updateUri(uri: string) {
     this.thing = this.os.store.get(uri);
-    this.success = false;
+    this.isIndexed = this.checkIfIndexed(uri);
+  }
+
+  private checkIfIndexed(uri: string) {
+    return this.indexes.some(it => it.contains(uri));
   }
 
   receivePodOs = async (os: PodOS) => {
@@ -66,12 +70,12 @@ export class PosMakeFindable implements PodOsAware {
   private getLabelIndexes(profile: WebIdProfile) {
     if (profile) {
       this.indexes = profile.getPrivateLabelIndexes().map(it => this.os.store.get(it).assume(LabelIndex));
+      this.isIndexed = this.checkIfIndexed(this.uri);
     }
   }
 
   private async onClick(e: MouseEvent) {
     e.preventDefault();
-    this.success = false;
     if (this.indexes.length === 1) {
       await this.addToLabelIndex(this.indexes[0]);
     } else if (this.indexes.length > 1) {
@@ -96,7 +100,7 @@ export class PosMakeFindable implements PodOsAware {
   private async addToLabelIndex(index: LabelIndex) {
     try {
       await this.os.addToLabelIndex(this.thing, index);
-      this.success = true;
+      this.isIndexed = true;
     } catch (e) {
       this.errorEmitter.emit(e);
     }
@@ -115,11 +119,11 @@ export class PosMakeFindable implements PodOsAware {
         <button
           type="button"
           aria-label={label}
-          class={{ main: true, open: this.showOptions, success: this.success }}
+          class={{ main: true, open: this.showOptions, success: this.isIndexed }}
           onClick={e => this.onClick(e)}
           title=""
         >
-          {this.success ? <IconSuccess /> : <IconMakeFindable />}
+          {this.isIndexed ? <IconSuccess /> : <IconMakeFindable />}
           <p>{label}</p>
         </button>
         {this.showOptions && (