feat(url-clicks): update schema and scopes

opengovsg · Dec 21, 2020 · 5173734 · 5173734
1 parent 8e03cf8
commit 5173734
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 11 deletions.
diff --git a/src/server/models/url.ts b/src/server/models/url.ts
@@ -1,5 +1,5 @@
 import Sequelize from 'sequelize'
-import { UrlClicks } from './statistics/clicks'
+import { UrlClicks, UrlClicksType } from './statistics/clicks'
 import { ACTIVE, INACTIVE } from './types'
 import {
   SHORT_URL_REGEX,
@@ -24,7 +24,7 @@ interface UrlBaseType extends IdType {
 }
 
 export interface UrlType extends IdType, UrlBaseType, Sequelize.Model {
-  readonly clicks: number
+  readonly UrlClicks?: UrlClicksType
   readonly createdAt: string
   readonly updatedAt: string
   readonly email: string
@@ -144,11 +144,6 @@ export const Url = <UrlTypeStatic>sequelize.define(
       values: [ACTIVE, INACTIVE],
       defaultValue: ACTIVE,
     },
-    clicks: {
-      type: Sequelize.INTEGER,
-      allowNull: false,
-      defaultValue: 0,
-    },
     isFile: {
       type: Sequelize.BOOLEAN,
       allowNull: false,
@@ -231,6 +226,16 @@ export const Url = <UrlTypeStatic>sequelize.define(
         fields: [Sequelize.literal(`(${urlSearchVector})`)],
       },
     ],
+    scopes: {
+      getClicks: {
+        include: [
+          {
+            model: UrlClicks,
+            as: 'UrlClicks',
+          },
+        ],
+      },
+    },
   },
 )
 

diff --git a/src/server/models/user.ts b/src/server/models/user.ts
@@ -91,7 +91,7 @@ export const User = <UserTypeStatic>sequelize.define(
         return {
           include: [
             {
-              model: Url,
+              model: Url.scope('getClicks'),
               as: 'Urls',
               where: whereUrlConditions,
               // use left outer join instead of default inner join
@@ -115,7 +115,7 @@ export const User = <UserTypeStatic>sequelize.define(
         return {
           include: [
             {
-              model: Url,
+              model: Url.scope('getClicks'),
               as: 'Urls',
               where: { shortUrl },
             },

diff --git a/src/server/repositories/types.ts b/src/server/repositories/types.ts
@@ -1,4 +1,5 @@
 import { UrlType } from '../models/url'
+import { UrlClicksType } from '../models/statistics/clicks'
 
 /**
  * A type that represents Urls stored in the data store.
@@ -8,13 +9,13 @@ export type StorableUrl = Pick<
   | 'shortUrl'
   | 'longUrl'
   | 'state'
-  | 'clicks'
   | 'isFile'
   | 'createdAt'
   | 'updatedAt'
   | 'description'
   | 'contactEmail'
->
+> &
+  Pick<UrlClicksType, 'clicks'>
 
 /**
  * A type that represents a file that can be stored in the data store.