feat(url-clicks): use url_clicks table for directory search

opengovsg · Dec 21, 2020 · d1a578e · d1a578e
1 parent 07dbeaf
commit d1a578e
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 6 deletions.
diff --git a/src/server/repositories/UrlRepository.ts b/src/server/repositories/UrlRepository.ts
@@ -3,6 +3,7 @@
 import { inject, injectable } from 'inversify'
 import { QueryTypes } from 'sequelize'
 import { Url, UrlType } from '../models/url'
+import { UrlClicks } from '../models/statistics/clicks'
 import { NotFoundError } from '../util/error'
 import { redirectClient } from '../redis'
 import { logger, redirectExpiry } from '../config'
@@ -149,11 +150,16 @@ export class UrlRepository implements UrlRepositoryInterface {
   ) => Promise<UrlDirectoryPaginated> = async (conditions) => {
     const { query, order, limit, offset, state, isFile, isEmail } = conditions
 
-    const { tableName } = Url
+    const { tableName: urlTableName } = Url
+    const { tableName: urlClicksTableName } = UrlClicks
 
     const urlVector = urlSearchVector
 
-    const rankingAlgorithm = this.getRankingAlgorithm(order, tableName)
+    const rankingAlgorithm = this.getRankingAlgorithm(
+      order,
+      urlTableName,
+      urlClicksTableName,
+    )
 
     const urlsModel = await (isEmail
       ? this.getRelevantUrlsFromEmail(
@@ -196,6 +202,8 @@ export class UrlRepository implements UrlRepositoryInterface {
     const rawQuery = `
       SELECT "users"."email", "urls"."shortUrl", "urls"."state", "urls"."isFile", "urls"."longUrl"
       FROM urls AS "urls"
+      JOIN url_clicks
+      ON "urls"."shortUrl" = "url_clicks"."shortUrl"
       JOIN users
       ON "urls"."userId" = "users"."id"
       AND "users"."email" LIKE ANY (ARRAY[:likeQuery])
@@ -239,6 +247,8 @@ export class UrlRepository implements UrlRepositoryInterface {
     const rawQuery = `
       SELECT "urls"."shortUrl", "users"."email", "urls"."state", "urls"."isFile", "urls"."longUrl"
       FROM urls AS "urls"
+      JOIN url_clicks
+      ON "urls"."shortUrl" = "url_clicks"."shortUrl"
       JOIN users
       ON "urls"."userId" = "users"."id"
       JOIN plainto_tsquery('english', $newQuery) query
@@ -389,20 +399,22 @@ export class UrlRepository implements UrlRepositoryInterface {
    * Generates the ranking algorithm to be used in the ORDER BY clause in the
    * SQL statement based on the input sort order.
    * @param  {SearchResultsSortOrder} order
-   * @param  {string} tableName
+   * @param  {string} urlTableName
+   * @param  {string} urlClicksTableName
    * @returns The clause as a string.
    */
   private getRankingAlgorithm(
     order: SearchResultsSortOrder,
-    tableName: string,
+    urlTableName: string,
+    urlClicksTableName: string,
   ): string {
     let rankingAlgorithm
     switch (order) {
       case SearchResultsSortOrder.Recency:
-        rankingAlgorithm = `${tableName}."createdAt"`
+        rankingAlgorithm = `${urlTableName}."createdAt"`
         break
       case SearchResultsSortOrder.Popularity:
-        rankingAlgorithm = `${tableName}.clicks`
+        rankingAlgorithm = `${urlClicksTableName}.clicks`
         break
       default:
         throw new Error(`Unsupported SearchResultsSortOrder: ${order}`)

diff --git a/test/server/repositories/UrlRepository.test.ts b/test/server/repositories/UrlRepository.test.ts
@@ -7,6 +7,7 @@ import {
   mockTransaction,
   redisMockClient,
   sanitiseMock,
+  urlClicksModelMock,
   urlModelMock,
 } from '../api/util'
 import { UrlRepository } from '../../../src/server/repositories/UrlRepository'
@@ -22,6 +23,10 @@ jest.mock('../../../src/server/models/url', () => ({
   sanitise: sanitiseMock,
 }))
 
+jest.mock('../../../src/server/models/statistics/clicks', () => ({
+  UrlClicks: urlClicksModelMock,
+}))
+
 jest.mock('../../../src/server/models/statistics/daily', () => ({
   Clicks: clicksModelMock,
 }))