Merge #1338

1338: refactor: Construct date type for related keys r=bidoubiwa a=TheLearneer

# Pull Request

I have updated the codebase so that the keys which are technically of date type are constructed with `Date()` object before returning.
Also I have updated the Test cases.

## What does this PR do?
Fixes #1223 

## PR checklist
Please check if your PR fulfills the following requirements:
- [x] Does this PR fix an existing issue?
- [x] Have you read the contributing guidelines?
- [x] Have you made sure that the title is accurate and descriptive of the changes?
- [x] Updated the test cases to see they pass

Thank you so much for contributing to Meilisearch!


Co-authored-by: Santosh Bhandari <[email protected]>

Author: meili-bors[bot]

src/clients/client.ts

@@ -266,7 +266,15 @@ class Client {
    */
   async getKeys(parameters: KeysQuery = {}): Promise<KeysResults> {
     const url = `keys`
-    return await this.httpRequest.get<KeysResults>(url, parameters)
+    const keys = await this.httpRequest.get<KeysResults>(url, parameters)
+
+    keys.results = keys.results.map((key) => ({
+      ...key,
+      createdAt: new Date(key.createdAt),
+      updateAt: new Date(key.updateAt),
+    }))
+
+    return keys
   }
 
   /**
@@ -395,7 +403,11 @@ class Client {
    */
   async createDump(): Promise<EnqueuedTask> {
     const url = `dumps`
-    return await this.httpRequest.post<undefined, EnqueuedTask>(url)
+    const task = await this.httpRequest.post<undefined, EnqueuedTask>(url)
+
+    task.enqueuedAt = new Date(task.enqueuedAt)
+
+    return task
   }
 
   ///

src/indexes.ts

@@ -195,7 +195,11 @@ class Index<T = Record<string, any>> {
   ): Promise<EnqueuedTask> {
     const url = `indexes`
     const req = new HttpRequests(config)
-    return req.post(url, { ...options, uid })
+    const task = await req.post(url, { ...options, uid })
+
+    task.enqueuedAt = new Date(task.enqueuedAt)
+
+    return task
   }
 
   /**
@@ -207,7 +211,11 @@ class Index<T = Record<string, any>> {
    */
   async update(data: IndexOptions): Promise<EnqueuedTask> {
     const url = `indexes/${this.uid}`
-    return await this.httpRequest.patch(url, data)
+    const task = await this.httpRequest.patch(url, data)
+
+    task.enqueuedAt = new Date(task.enqueuedAt)
+
+    return task
   }
 
   /**
@@ -218,7 +226,11 @@ class Index<T = Record<string, any>> {
    */
   async delete(): Promise<EnqueuedTask> {
     const url = `indexes/${this.uid}`
-    return await this.httpRequest.delete(url)
+    const task = await this.httpRequest.delete(url)
+
+    task.enqueuedAt = new Date(task.enqueuedAt)
+
+    return task
   }
 
   ///
@@ -384,7 +396,11 @@ class Index<T = Record<string, any>> {
     options?: DocumentOptions
   ): Promise<EnqueuedTask> {
     const url = `indexes/${this.uid}/documents`
-    return await this.httpRequest.post(url, documents, options)
+    const task = await this.httpRequest.post(url, documents, options)
+
+    task.enqueuedAt = new Date(task.enqueuedAt)
+
+    return task
   }
 
   /**
@@ -424,7 +440,11 @@ class Index<T = Record<string, any>> {
     options?: DocumentOptions
   ): Promise<EnqueuedTask> {
     const url = `indexes/${this.uid}/documents`
-    return await this.httpRequest.put(url, documents, options)
+    const task = await this.httpRequest.put(url, documents, options)
+
+    task.enqueuedAt = new Date(task.enqueuedAt)
+
+    return task
   }
 
   /**
@@ -460,7 +480,11 @@ class Index<T = Record<string, any>> {
    */
   async deleteDocument(documentId: string | number): Promise<EnqueuedTask> {
     const url = `indexes/${this.uid}/documents/${documentId}`
-    return await this.httpRequest.delete<EnqueuedTask>(url)
+    const task = await this.httpRequest.delete<EnqueuedTask>(url)
+
+    task.enqueuedAt = new Date(task.enqueuedAt)
+
+    return task
   }
 
   /**
@@ -475,7 +499,11 @@ class Index<T = Record<string, any>> {
   ): Promise<EnqueuedTask> {
     const url = `indexes/${this.uid}/documents/delete-batch`
 
-    return await this.httpRequest.post(url, documentsIds)
+    const task = await this.httpRequest.post(url, documentsIds)
+
+    task.enqueuedAt = new Date(task.enqueuedAt)
+
+    return task
   }
 
   /**
@@ -486,7 +514,11 @@ class Index<T = Record<string, any>> {
    */
   async deleteAllDocuments(): Promise<EnqueuedTask> {
     const url = `indexes/${this.uid}/documents`
-    return await this.httpRequest.delete<EnqueuedTask>(url)
+    const task = await this.httpRequest.delete<EnqueuedTask>(url)
+
+    task.enqueuedAt = new Date(task.enqueuedAt)
+
+    return task
   }
 
   ///
@@ -514,7 +546,11 @@ class Index<T = Record<string, any>> {
    */
   async updateSettings(settings: Settings): Promise<EnqueuedTask> {
     const url = `indexes/${this.uid}/settings`
-    return await this.httpRequest.patch(url, settings)
+    const task = await this.httpRequest.patch(url, settings)
+
+    task.enqueued = new Date(task.enqueuedAt)
+
+    return task
   }
 
   /**
@@ -525,7 +561,11 @@ class Index<T = Record<string, any>> {
    */
   async resetSettings(): Promise<EnqueuedTask> {
     const url = `indexes/${this.uid}/settings`
-    return await this.httpRequest.delete<EnqueuedTask>(url)
+    const task = await this.httpRequest.delete<EnqueuedTask>(url)
+
+    task.enqueuedAt = new Date(task.enqueuedAt)
+
+    return task
   }
 
   ///
@@ -552,7 +592,11 @@ class Index<T = Record<string, any>> {
    */
   async updateSynonyms(synonyms: Synonyms): Promise<EnqueuedTask> {
     const url = `indexes/${this.uid}/settings/synonyms`
-    return await this.httpRequest.put(url, synonyms)
+    const task = await this.httpRequest.put(url, synonyms)
+
+    task.enqueuedAt = new Date(task.enqueuedAt)
+
+    return task
   }
 
   /**
@@ -563,7 +607,11 @@ class Index<T = Record<string, any>> {
    */
   async resetSynonyms(): Promise<EnqueuedTask> {
     const url = `indexes/${this.uid}/settings/synonyms`
-    return await this.httpRequest.delete<EnqueuedTask>(url)
+    const task = await this.httpRequest.delete<EnqueuedTask>(url)
+
+    task.enqueuedAt = new Date(task.enqueuedAt)
+
+    return task
   }
 
   ///
@@ -590,7 +638,11 @@ class Index<T = Record<string, any>> {
    */
   async updateStopWords(stopWords: StopWords): Promise<EnqueuedTask> {
     const url = `indexes/${this.uid}/settings/stop-words`
-    return await this.httpRequest.put(url, stopWords)
+    const task = await this.httpRequest.put(url, stopWords)
+
+    task.enqueuedAt = new Date(task.enqueuedAt)
+
+    return task
   }
 
   /**
@@ -601,7 +653,11 @@ class Index<T = Record<string, any>> {
    */
   async resetStopWords(): Promise<EnqueuedTask> {
     const url = `indexes/${this.uid}/settings/stop-words`
-    return await this.httpRequest.delete<EnqueuedTask>(url)
+    const task = await this.httpRequest.delete<EnqueuedTask>(url)
+
+    task.enqueuedAt = new Date(task.enqueuedAt)
+
+    return task
   }
 
   ///
@@ -628,7 +684,11 @@ class Index<T = Record<string, any>> {
    */
   async updateRankingRules(rankingRules: RankingRules): Promise<EnqueuedTask> {
     const url = `indexes/${this.uid}/settings/ranking-rules`
-    return await this.httpRequest.put(url, rankingRules)
+    const task = await this.httpRequest.put(url, rankingRules)
+
+    task.enqueuedAt = new Date(task.enqueuedAt)
+
+    return task
   }
 
   /**
@@ -639,7 +699,11 @@ class Index<T = Record<string, any>> {
    */
   async resetRankingRules(): Promise<EnqueuedTask> {
     const url = `indexes/${this.uid}/settings/ranking-rules`
-    return await this.httpRequest.delete<EnqueuedTask>(url)
+    const task = await this.httpRequest.delete<EnqueuedTask>(url)
+
+    task.enqueuedAt = new Date(task.enqueuedAt)
+
+    return task
   }
 
   ///
@@ -668,7 +732,11 @@ class Index<T = Record<string, any>> {
     distinctAttribute: DistinctAttribute
   ): Promise<EnqueuedTask> {
     const url = `indexes/${this.uid}/settings/distinct-attribute`
-    return await this.httpRequest.put(url, distinctAttribute)
+    const task = await this.httpRequest.put(url, distinctAttribute)
+
+    task.enqueuedAt = new Date(task.enqueuedAt)
+
+    return task
   }
 
   /**
@@ -679,7 +747,11 @@ class Index<T = Record<string, any>> {
    */
   async resetDistinctAttribute(): Promise<EnqueuedTask> {
     const url = `indexes/${this.uid}/settings/distinct-attribute`
-    return await this.httpRequest.delete<EnqueuedTask>(url)
+    const task = await this.httpRequest.delete<EnqueuedTask>(url)
+
+    task.enqueuedAt = new Date(task.enqueuedAt)
+
+    return task
   }
 
   ///
@@ -708,7 +780,11 @@ class Index<T = Record<string, any>> {
     filterableAttributes: FilterableAttributes
   ): Promise<EnqueuedTask> {
     const url = `indexes/${this.uid}/settings/filterable-attributes`
-    return await this.httpRequest.put(url, filterableAttributes)
+    const task = await this.httpRequest.put(url, filterableAttributes)
+
+    task.enqueuedAt = new Date(task.enqueuedAt)
+
+    return task
   }
 
   /**
@@ -719,7 +795,11 @@ class Index<T = Record<string, any>> {
    */
   async resetFilterableAttributes(): Promise<EnqueuedTask> {
     const url = `indexes/${this.uid}/settings/filterable-attributes`
-    return await this.httpRequest.delete<EnqueuedTask>(url)
+    const task = await this.httpRequest.delete<EnqueuedTask>(url)
+
+    task.enqueuedAt = new Date(task.enqueuedAt)
+
+    return task
   }
 
   ///
@@ -748,7 +828,11 @@ class Index<T = Record<string, any>> {
     sortableAttributes: SortableAttributes
   ): Promise<EnqueuedTask> {
     const url = `indexes/${this.uid}/settings/sortable-attributes`
-    return await this.httpRequest.put(url, sortableAttributes)
+    const task = await this.httpRequest.put(url, sortableAttributes)
+
+    task.enqueuedAt = new Date(task.enqueuedAt)
+
+    return task
   }
 
   /**
@@ -759,7 +843,11 @@ class Index<T = Record<string, any>> {
    */
   async resetSortableAttributes(): Promise<EnqueuedTask> {
     const url = `indexes/${this.uid}/settings/sortable-attributes`
-    return await this.httpRequest.delete<EnqueuedTask>(url)
+    const task = await this.httpRequest.delete<EnqueuedTask>(url)
+
+    task.enqueuedAt = new Date(task.enqueuedAt)
+
+    return task
   }
 
   ///
@@ -788,7 +876,11 @@ class Index<T = Record<string, any>> {
     searchableAttributes: SearchableAttributes
   ): Promise<EnqueuedTask> {
     const url = `indexes/${this.uid}/settings/searchable-attributes`
-    return await this.httpRequest.put(url, searchableAttributes)
+    const task = await this.httpRequest.put(url, searchableAttributes)
+
+    task.enqueuedAt = new Date(task.enqueuedAt)
+
+    return task
   }
 
   /**
@@ -799,7 +891,11 @@ class Index<T = Record<string, any>> {
    */
   async resetSearchableAttributes(): Promise<EnqueuedTask> {
     const url = `indexes/${this.uid}/settings/searchable-attributes`
-    return await this.httpRequest.delete<EnqueuedTask>(url)
+    const task = await this.httpRequest.delete<EnqueuedTask>(url)
+
+    task.enqueuedAt = new Date(task.enqueuedAt)
+
+    return task
   }
 
   ///
@@ -828,7 +924,11 @@ class Index<T = Record<string, any>> {
     displayedAttributes: DisplayedAttributes
   ): Promise<EnqueuedTask> {
     const url = `indexes/${this.uid}/settings/displayed-attributes`
-    return await this.httpRequest.put(url, displayedAttributes)
+    const task = await this.httpRequest.put(url, displayedAttributes)
+
+    task.enqueuedAt = new Date(task.enqueuedAt)
+
+    return task
   }
 
   /**
@@ -839,7 +939,11 @@ class Index<T = Record<string, any>> {
    */
   async resetDisplayedAttributes(): Promise<EnqueuedTask> {
     const url = `indexes/${this.uid}/settings/displayed-attributes`
-    return await this.httpRequest.delete<EnqueuedTask>(url)
+    const task = await this.httpRequest.delete<EnqueuedTask>(url)
+
+    task.enqueuedAt = new Date(task.enqueuedAt)
+
+    return task
   }
 
   ///
@@ -868,7 +972,11 @@ class Index<T = Record<string, any>> {
     typoTolerance: TypoTolerance
   ): Promise<EnqueuedTask> {
     const url = `indexes/${this.uid}/settings/typo-tolerance`
-    return await this.httpRequest.patch(url, typoTolerance)
+    const task = await this.httpRequest.patch(url, typoTolerance)
+
+    task.enqueuedAt = new Date(task.enqueuedAt)
+
+    return task
   }
 
   /**
@@ -879,7 +987,11 @@ class Index<T = Record<string, any>> {
    */
   async resetTypoTolerance(): Promise<EnqueuedTask> {
     const url = `indexes/${this.uid}/settings/typo-tolerance`
-    return await this.httpRequest.delete<EnqueuedTask>(url)
+    const task = await this.httpRequest.delete<EnqueuedTask>(url)
+
+    task.enqueuedAt = new Date(task.enqueuedAt)
+
+    return task
   }
 }