Rename variables

Signed-off-by: Olga Bulat <[email protected]>
WordPress · Apr 8, 2024 · e8d129e · e8d129e
1 parent 109365e
commit e8d129e
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 20 deletions.
diff --git a/frontend/src/data/media-service.ts b/frontend/src/data/media-service.ts
@@ -10,7 +10,7 @@ import type { Events } from "~/types/analytics"
 
 import type { AxiosResponse } from "axios"
 
-export type SearchTimeEvent =
+export type SearchTimeEventPayload =
   | Events["AUDIO_SEARCH_RESPONSE_TIME"]
   | Events["IMAGE_SEARCH_RESPONSE_TIME"]
 
@@ -34,15 +34,15 @@ class MediaService<T extends Media> {
   }
 
   /**
-   * Processes AxiosResponse from a search query to
-   * construct SEARCH_RESPONSE_TIME analytics event.
+   * Processes AxiosResponse from a search query to construct
+   * SEARCH_RESPONSE_TIME analytics event payload.
    * @param response - Axios response
    * @param requestDatetime - datetime before request was sent
    */
-  buildSearchTimeEvent(
+  buildEventPayload(
     response: AxiosResponse,
     requestDatetime: Date
-  ): SearchTimeEvent | undefined {
+  ): SearchTimeEventPayload | undefined {
     const REQUIRED_HEADERS = ["date", "cf-cache-status", "cf-ray"]
 
     const responseHeaders = response.headers
@@ -107,7 +107,7 @@ class MediaService<T extends Media> {
   async search(
     params: PaginatedSearchQuery | PaginatedCollectionQuery
   ): Promise<{
-    searchTimeEvent: SearchTimeEvent | undefined
+    eventPayload: SearchTimeEventPayload | undefined
     data: MediaResult<Record<string, Media>>
   }> {
     // Add the `peaks` param to all audio searches automatically
@@ -122,9 +122,9 @@ class MediaService<T extends Media> {
       params as unknown as Record<string, string>
     )
 
-    const searchTimeEvent = this.buildSearchTimeEvent(res, requestDatetime)
+    const eventPayload = this.buildEventPayload(res, requestDatetime)
 
-    return { searchTimeEvent, data: this.transformResults(res.data) }
+    return { eventPayload, data: this.transformResults(res.data) }
   }
 
   /**

diff --git a/frontend/src/stores/media/index.ts b/frontend/src/stores/media/index.ts
@@ -28,7 +28,7 @@ interface SearchFetchState extends Omit<FetchState, "hasStarted"> {
   hasStarted: boolean
 }
 import type { EventName } from "~/types/analytics"
-import type { SearchTimeEvent } from "~/data/media-service"
+import type { SearchTimeEventPayload } from "~/data/media-service"
 
 export type MediaStoreResult = {
   count: number
@@ -451,13 +451,13 @@ export const useMediaStore = defineStore("media", {
     },
 
     recordSearchTime(
-      event: SearchTimeEvent | undefined,
+      payload: SearchTimeEventPayload | undefined,
       mediaType: SupportedMediaType
     ) {
-      if (event) {
-        const searchEvent =
+      if (payload) {
+        const eventName =
           `${mediaType.toUpperCase()}_SEARCH_RESPONSE_TIME` as EventName
-        this.$nuxt.$sendCustomEvent(searchEvent, event)
+        this.$nuxt.$sendCustomEvent(eventName, payload)
       }
     },
 
@@ -483,8 +483,8 @@ export const useMediaStore = defineStore("media", {
       try {
         const accessToken = this.$nuxt.$openverseApiToken
         const service = initServices[mediaType](accessToken)
-        const { searchTimeEvent, data } = await service.search(queryParams)
-        this.recordSearchTime(searchTimeEvent, mediaType)
+        const { eventPayload, data } = await service.search(queryParams)
+        this.recordSearchTime(eventPayload, mediaType)
         const mediaCount = data.result_count
         let errorData: FetchingError | undefined
         /**

diff --git a/frontend/test/unit/specs/data/media-service.spec.ts b/frontend/test/unit/specs/data/media-service.spec.ts
@@ -25,7 +25,7 @@ describe("Media Service search and recordSearchTime", () => {
 
     const res = await initServices.image().search({})
 
-    expect(res.searchTimeEvent).not.toBeDefined()
+    expect(res.eventPayload).not.toBeDefined()
   })
 
   it("should not send a SEARCH_RESPONSE_TIME analytics event if the response was locally cached", async () => {
@@ -45,7 +45,7 @@ describe("Media Service search and recordSearchTime", () => {
 
     const res = await initServices.audio().search({})
 
-    expect(res.searchTimeEvent).not.toBeDefined()
+    expect(res.eventPayload).not.toBeDefined()
   })
 
   it("should not send a SEARCH_RESPONSE_TIME analytics event if the cf-ray is malformed", async () => {
@@ -67,7 +67,7 @@ describe("Media Service search and recordSearchTime", () => {
 
     const res = await initServices.audio().search({})
 
-    expect(res.searchTimeEvent).not.toBeDefined()
+    expect(res.eventPayload).not.toBeDefined()
   })
 
   it("should send SEARCH_RESPONSE_TIME analytics with correct parameters", async () => {
@@ -106,7 +106,7 @@ describe("Media Service search and recordSearchTime", () => {
     const IMAGE_QUERY_PARAMS = { q: "apple" }
     const imageRes = await initServices.image().search(IMAGE_QUERY_PARAMS)
 
-    expect(imageRes.searchTimeEvent).toEqual({
+    expect(imageRes.eventPayload).toEqual({
       cfCacheStatus: "HIT",
       cfRayIATA: "SJC",
       elapsedTime: 2,
@@ -116,7 +116,7 @@ describe("Media Service search and recordSearchTime", () => {
     const AUDIO_QUERY_PARAMS = { q: "table" }
     const audioRes = await initServices.audio().search(AUDIO_QUERY_PARAMS)
 
-    expect(audioRes.searchTimeEvent).toEqual({
+    expect(audioRes.eventPayload).toEqual({
       cfCacheStatus: "MISS",
       cfRayIATA: "LHR",
       elapsedTime: 3,