feat(RoomsAdapter): add hasMoreActivities to interface

Additionally, getPreviousRoomActivities returns an array instead of an observable because previous data needs to be pulled instead pushed

Author: lalli-flores

src/adapters/RoomsAdapter.js

@@ -1,7 +1,24 @@
+/* eslint-disable valid-jsdoc */
+/* eslint-disable no-unused-vars */
 import {throwError} from 'rxjs';
 
 import WebexAdapter from './WebexAdapter';
 
+/**
+ * A Room object with details about the room.
+ *
+ * @typedef {Object}  Room
+ * @property {string}    ID     The room identifier.
+ * @property {string}    title  The room title.
+ * @property {RoomType}  type   The type of the room. @see RoomType enum
+ */
+
+/**
+ * @typedef {Object}  ActivityDate
+ * @param {string}  date  Date that will render on a time ruler. Must be a valid date-time string.
+ *                        See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/parse#Date_Time_String_Format
+ */
+
 /**
  * Enum for room type values.
  *
@@ -17,56 +34,57 @@ export const RoomType = {
  * This is a base class that defines the interface that maps room data.
  * Developers that want to extend `RoomsAdapter` must implement all of its methods,
  * adhering to the exact parameters and structure of the returned objects.
+ *
+ * `RoomsAdapter` handles data of a room such as details about that room but also
+ * activities that happened/will happen within that room. Activities are expected
+ * to be lazy loaded, and therefore, chunked.
  */
 export default class RoomsAdapter extends WebexAdapter {
-  /**
-   * A Room object with details about the room.
-   *
-   * @typedef {Object} Room
-   * @property {string}    ID      The room identifier.
-   * @property {string}    title   The room title.
-   * @property {RoomType}  type    The type of the room. @see RoomType enum
-   */
-
-  /**
-   * @typedef {Object} ActivityData
-   * @param {string} date The date to render a time ruler for. Must be a valid date-time string
-   *     https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/parse#Date_Time_String_Format
-   */
-
   /**
    * Returns an observable that emits room data of the given ID.
    *
    * @param {string} ID  ID of the room to get.
    * @returns {Observable.<Room>}
    * @memberof RoomsAdapter
    */
-  // eslint-disable-next-line no-unused-vars
   getRoom(ID) {
     return throwError(new Error('getRoom(ID) must be defined in RoomsAdapter'));
   }
 
   /**
-   * Returns an observable that emits an array of previous activity IDs of the given roomID.
+   * Returns an observable that emits an array of current and future activities of the given roomID.
    *
-   * @param {string} ID  ID of the room to get.
-   * @returns {Observable.<Array.<string>>}
+   * @param {string} ID  ID of the room for which to get activities.
+   * @returns {Observable.<Array.<string|ActivityDate>>}
+   * @memberof RoomsAdapter
+   */
+  getRoomActivities(ID) {
+    return throwError(new Error('getRoomActivities(ID) must be defined in RoomsAdapter'));
+  }
+
+  /**
+   * Returns an observable that emits an array of the next chunk of previous
+   * activity data of the given roomID. If `hasMoreActivities` returns false,
+   * the observable will complete.
+   * **Previous activity data must be sorted oldest-to-latest.**
+   *
+   * @param {string} ID  ID of the room for which to get activities.
+   * @returns {Observable.<Array.<string|ActivityDate>>}
    * @memberof RoomsAdapter
    */
-  // eslint-disable-next-line no-unused-vars
   getPreviousRoomActivities(ID) {
     return throwError(new Error('getPreviousRoomActivities(ID) must be defined in RoomsAdapter'));
   }
 
   /**
-   * Returns an observable that emits an array of current activities of the given roomID.
+   * Returns `true` if there are more activities to load from the room of the given ID.
+   * Otherwise, it returns `false`.
    *
-   * @param {string} ID  ID of the room to get.
-   * @returns {Observable.<Array.<string|ActivityData>>}
+   * @param {string} ID ID of the room for which to verify activities.
+   * @returns {boolean}
    * @memberof RoomsAdapter
    */
-  // eslint-disable-next-line no-unused-vars
-  getRoomActivities(ID) {
-    return throwError(new Error('getRoomActivities(ID) must be defined in RoomsAdapter'));
+  hasMoreActivities(ID) {
+    throw new Error('hasMoreActivities(ID) must be defined in RoomsAdapter');
   }
 }

src/adapters/RoomsAdapter.test.js

@@ -11,8 +11,8 @@ describe('Rooms Adapter Interface', () => {
     expect(rxjs.isObservable(roomsAdapter.getRoom())).toBeTruthy();
   });
 
-  test('getRoom() throws a proper error message', (done) => {
-    roomsAdapter.getRoom('id').subscribe(
+  test('getRoom() errors because it needs to be defined', (done) => {
+    roomsAdapter.getRoom('ID').subscribe(
       () => {},
       (error) => {
         expect(error.message).toBe('getRoom(ID) must be defined in RoomsAdapter');
@@ -21,34 +21,41 @@ describe('Rooms Adapter Interface', () => {
     );
   });
 
-  test('getPreviousRoomActivities() returns an observable', () => {
-    expect(rxjs.isObservable(roomsAdapter.getPreviousRoomActivities())).toBeTruthy();
+  test('getRoomActivities() returns an observable', () => {
+    expect(rxjs.isObservable(roomsAdapter.getRoomActivities())).toBeTruthy();
   });
 
-  test('getPreviousRoomActivities() throws a proper error message', (done) => {
-    roomsAdapter.getPreviousRoomActivities('id').subscribe(
+  test('getRoomActivities() errors because it needs to be defined', (done) => {
+    roomsAdapter.getRoomActivities('id').subscribe(
       () => {},
       (error) => {
-        expect(error.message).toBe('getPreviousRoomActivities(ID) must be defined in RoomsAdapter');
+        expect(error.message).toBe('getRoomActivities(ID) must be defined in RoomsAdapter');
         done();
       }
     );
   });
 
-  test('getRoomActivities() returns an observable', () => {
+  test('getPreviousRoomActivities() returns an observable', () => {
     expect(rxjs.isObservable(roomsAdapter.getRoomActivities())).toBeTruthy();
   });
 
-  test('getRoomActivities() throws a proper error message', (done) => {
-    roomsAdapter.getRoomActivities('id').subscribe(
+  test('getPreviousRoomActivities() errors because it needs to be defined', (done) => {
+    roomsAdapter.getPreviousRoomActivities('id').subscribe(
       () => {},
       (error) => {
-        expect(error.message).toBe('getRoomActivities(ID) must be defined in RoomsAdapter');
+        expect(error.message).toBe('getPreviousRoomActivities(ID) must be defined in RoomsAdapter');
         done();
       }
     );
   });
 
+  test('hasMoreActivities() errors because it needs to be defined', () => {
+    try {
+      expect(roomsAdapter.hasMoreActivities('ID')).toThrowError();
+      // eslint-disable-next-line no-empty
+    } catch (error) {}
+  });
+
   afterEach(() => {
     roomsAdapter = null;
   });