Merge pull request #1175 from serlo/simplify-time-interface

refactor(time interface): remove duplicate properties
serlo · Dec 4, 2023 · 50017c3 · 50017c3
2 parents bfea11e + 0632663
commit 50017c3
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 33 deletions.
diff --git a/__tests__/examples/data-sources/how-to-create-a-query.ts b/__tests__/examples/data-sources/how-to-create-a-query.ts
@@ -92,10 +92,10 @@ describe('How to create a query in a data source: Fetching the content of an art
             enableSwr: true,
 
             // After one hour, a cached value shall be considered to be stale
-            staleAfter: { hour: 1 },
+            staleAfter: { hours: 1 },
 
             // After one day, no cached value shall be used
-            maxAge: { day: 1 },
+            maxAge: { days: 1 },
 
             getKey({ id }) {
               return `article/${id}`

diff --git a/packages/server/src/internals/swr-queue.ts b/packages/server/src/internals/swr-queue.ts
@@ -299,37 +299,19 @@ async function shouldProcessJob({
 }
 
 export interface Time {
-  day?: number
   days?: number
-  hour?: number
   hours?: number
-  minute?: number
   minutes?: number
-  second?: number
   seconds?: number
 }
 
 export function timeToSeconds({
-  day = 0,
   days = 0,
-  hour = 0,
   hours = 0,
-  minute = 0,
   minutes = 0,
-  second = 0,
   seconds = 0,
 }: Time) {
-  const SECOND = 1
-  const MINUTE = 60 * SECOND
-  const HOUR = 60 * MINUTE
-  const DAY = 24 * HOUR
-
-  return (
-    (day + days) * DAY +
-    (hour + hours) * HOUR +
-    (minute + minutes) * MINUTE +
-    (second + seconds) * SECOND
-  )
+  return ((days * 24 + hours) * 60 + minutes) * 60 + seconds
 }
 
 export function timeToMilliseconds(time: Time) {

diff --git a/packages/server/src/model/google-spreadsheet-api.ts b/packages/server/src/model/google-spreadsheet-api.ts
@@ -83,7 +83,7 @@ export function createGoogleSpreadsheetApiModel({
           return specifyErrorLocation(E.left({ error: E.toError(error) }))
         }
       },
-      staleAfter: { hour: 1 },
+      staleAfter: { hours: 1 },
       getKey: (args) => {
         const { spreadsheetId, range } = args
         const majorDimension = args.majorDimension ?? MajorDimension.Rows

diff --git a/packages/server/src/model/serlo.ts b/packages/server/src/model/serlo.ts
@@ -40,7 +40,7 @@ export function createSerloModel({
         const uuid = await DatabaseLayer.makeRequest('UuidQuery', payload)
         return isSupportedUuid(uuid) ? uuid : null
       },
-      staleAfter: { day: 1 },
+      staleAfter: { days: 1 },
       getKey: ({ id }) => {
         return `de.serlo.org/api/uuid/${id}`
       },
@@ -89,7 +89,7 @@ export function createSerloModel({
       getCurrentValue() {
         return DatabaseLayer.makeRequest('ActiveAuthorsQuery', undefined)
       },
-      staleAfter: { hour: 1 },
+      staleAfter: { hours: 1 },
       getKey: () => {
         return 'de.serlo.org/api/user/active-authors'
       },
@@ -110,7 +110,7 @@ export function createSerloModel({
       getCurrentValue() {
         return DatabaseLayer.makeRequest('ActiveReviewersQuery', undefined)
       },
-      staleAfter: { hour: 1 },
+      staleAfter: { hours: 1 },
       getKey: () => {
         return 'de.serlo.org/api/user/active-reviewers'
       },
@@ -236,7 +236,7 @@ export function createSerloModel({
         })
       },
       enableSwr: true,
-      staleAfter: { day: 1 },
+      staleAfter: { days: 1 },
       getKey: ({ path, instance }) => {
         const cleanPath = encodePath(decodePath(path))
         return `${instance}.serlo.org/api/alias${cleanPath}`
@@ -261,7 +261,7 @@ export function createSerloModel({
         return DatabaseLayer.makeRequest('SubjectsQuery', {})
       },
       enableSwr: true,
-      staleAfter: { day: 1 },
+      staleAfter: { days: 1 },
       getKey: () => 'serlo.org/subjects',
       getPayload: (key) => {
         return key === 'serlo.org/subjects' ? O.some(undefined) : O.none
@@ -280,7 +280,7 @@ export function createSerloModel({
       },
       enableSwr: true,
       staleAfter: { minutes: 2 },
-      maxAge: { hour: 1 },
+      maxAge: { hours: 1 },
       getKey: () => 'serlo.org/unrevised',
       getPayload: (key) => {
         return key === 'serlo.org/unrevised' ? O.some(undefined) : O.none
@@ -322,7 +322,7 @@ export function createSerloModel({
         return isSupportedNotificationEvent(event) ? event : null
       },
       enableSwr: true,
-      staleAfter: { day: 1 },
+      staleAfter: { days: 1 },
       getKey: ({ id }) => {
         return `de.serlo.org/api/event/${id}`
       },
@@ -372,8 +372,8 @@ export function createSerloModel({
         }
       },
       enableSwr: true,
-      staleAfter: { minute: 2 },
-      maxAge: { hour: 1 },
+      staleAfter: { minutes: 2 },
+      maxAge: { hours: 1 },
       examplePayload: { first: 5 },
     },
     environment,
@@ -436,7 +436,7 @@ export function createSerloModel({
       ) => {
         return DatabaseLayer.makeRequest('SubscriptionsQuery', payload)
       },
-      staleAfter: { hour: 1 },
+      staleAfter: { hours: 1 },
       getKey: ({ userId }) => {
         return `de.serlo.org/api/subscriptions/${userId}`
       },
@@ -500,7 +500,7 @@ export function createSerloModel({
         return DatabaseLayer.makeRequest('ThreadsQuery', payload)
       },
       enableSwr: true,
-      staleAfter: { day: 1 },
+      staleAfter: { days: 1 },
       getKey: ({ id }) => {
         return `de.serlo.org/api/threads/${id}`
       },