Merge pull request #356 from Lezek123/channelsApiFixes

API: Fix /channels and add /channels/unverified

Author: Leszek Wiesner

src/repository/channel.ts

@@ -299,17 +299,19 @@ export class ChannelsRepository implements IRepository<YtChannel> {
     })
   }
 
-  async query(init: ConditionInitializer, f: (q: Query<AnyItem>) => Query<AnyItem>) {
+  async query(init: ConditionInitializer, f: (q: Query<AnyItem>) => Query<AnyItem>, limit?: number) {
     return this.withLock(async () => {
       let lastKey = undefined
       const results = []
       do {
-        // FIXME: Is this the reason why /channels returns ALL channels?
         let queriedBatch: QueryResponse<AnyItem> = await f(this.model.query(init))
           .startAt(lastKey as any)
           .exec()
         let batchResult = queriedBatch.map((b) => mapTo<YtChannel>(b))
         results.push(...batchResult)
+        if (limit && results.length >= limit) {
+          return results.slice(0, limit)
+        }
         lastKey = queriedBatch.lastKey
       } while (lastKey)
       return results
@@ -396,12 +398,26 @@ export class ChannelsService {
   }
 
   /**
-   * @param count Number of record to retrieve
-   * @returns List of `n` recent verified channels
+   * @param limit Max. number of records to retrieve
+   * @returns List of up to `limit` recent, VERIFIED channels
+   */
+  async getRecent(limit: number): Promise<YtChannel[]> {
+    return this.channelsRepository.query(
+      { phantomKey: 'phantomData' },
+      (q) => q.sort('descending').using('phantomKey-createdAt-index'),
+      limit
+    )
+  }
+
+  /**
+   * @param limit Max. number of records to retrieve
+   * @returns List of up to `limit` recent, UNVERIFIED channels
    */
-  async getRecent(count: number): Promise<YtChannel[]> {
-    return this.channelsRepository.query({ phantomKey: 'phantomData' }, (q) =>
-      q.sort('descending').limit(count).using('phantomKey-createdAt-index')
+  async getUnverified(limit?: number): Promise<YtChannel[]> {
+    return this.channelsRepository.query(
+      { phantomKey: 'phantomData', yppStatus: 'Unverified' },
+      (q) => q.sort('descending').using('phantomKey-createdAt-index'),
+      limit
     )
   }
 

src/services/httpApi/api-spec.json

@@ -90,6 +90,29 @@
         ]
       }
     },
+    "/channels/unverified": {
+      "get": {
+        "operationId": "ChannelsController_getUnverifiedChannels",
+        "summary": "",
+        "description": "Retrieves channels waiting for verification",
+        "parameters": [],
+        "responses": {
+          "default": {
+            "description": "",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ChannelDto"
+                }
+              }
+            }
+          }
+        },
+        "tags": [
+          "channels"
+        ]
+      }
+    },
     "/channels/{joystreamChannelId}": {
       "get": {
         "operationId": "ChannelsController_get",
@@ -898,6 +921,21 @@
               "OptedOut"
             ]
           },
+          "preOptOutStatus": {
+            "type": "string",
+            "enum": [
+              "Unverified",
+              "Verified::Bronze",
+              "Verified::Silver",
+              "Verified::Gold",
+              "Verified::Diamond",
+              "Suspended::CopyrightBreach",
+              "Suspended::MisleadingContent",
+              "Suspended::ProgramTermsExploit",
+              "Suspended::UnsupportedTopic",
+              "OptedOut"
+            ]
+          },
           "joystreamChannelId": {
             "type": "number"
           },
@@ -930,6 +968,7 @@
           "description",
           "shouldBeIngested",
           "yppStatus",
+          "preOptOutStatus",
           "joystreamChannelId",
           "referrerChannelId",
           "videoCategoryId",

src/services/httpApi/controllers/channels.ts

@@ -152,6 +152,19 @@ export class ChannelsController {
     }
   }
 
+  @Get("/unverified")
+  @ApiResponse({ type: ChannelDto })
+  @ApiOperation({ description: 'Retrieves channels waiting for verification' })
+  async getUnverifiedChannels() {
+    try {
+      const channels = await this.dynamodbService.channels.getUnverified()
+      return channels.map((channel) => new ChannelDto(channel))
+    } catch (error) {
+      const message = error instanceof Error ? error.message : error
+      throw new ServiceUnavailableException(message)
+    }
+  }
+
   @Get(':joystreamChannelId')
   @ApiResponse({ type: ChannelDto })
   @ApiOperation({ description: 'Retrieves channel by joystreamChannelId' })