Improve HttpRequests
#1741
Open
Improve HttpRequests
#1741
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #1741 +/- ##
==========================================
- Coverage 97.81% 97.66% -0.16%
==========================================
Files 17 17
Lines 1465 1498 +33
Branches 307 317 +10
==========================================
+ Hits 1433 1463 +30
- Misses 32 35 +3 ☔ View full report in Codecov by Sentry. |
flevi29
added
maintenance
flevi29
commented
Oct 10, 2024
src/clients/client.ts
Outdated
| body: params, | ||
| })) as EnqueuedTaskObject; | ||
|
|
||
| return new EnqueuedTask(taks); | ||
| } |
There was a problem hiding this comment.
bug: previously this did not return EnqueuedTask, but rather EnqueuedTaskObject
flevi29
commented
Oct 10, 2024
Comment on lines
+72
to
95
| test(`${permission} key: Create client with custom headers (object)`, async () => { | ||
| const key = await getKey(permission); | ||
| const client = new MeiliSearch({ | ||
| ...config, | ||
| apiKey: key, | ||
| requestInit: { | ||
| headers: { | ||
| "Hello-There!": "General Kenobi", | ||
| }, | ||
| }, | ||
| }, | ||
| }); | ||
|
|
||
| assert.isTrue(await client.isHealthy()); | ||
|
|
||
| assert.isDefined(fetchSpy.mock.lastCall); | ||
| const [, requestInit] = fetchSpy.mock.lastCall!; | ||
|
|
||
| assert.isDefined(requestInit?.headers); | ||
| assert.instanceOf(requestInit!.headers, Headers); | ||
| assert.strictEqual( | ||
| (requestInit!.headers! as Headers).get("Hello-There!"), | ||
| "General Kenobi", | ||
| ); | ||
| }); |
There was a problem hiding this comment.
Because headers are internal implementation details, to check them we have to spy on fetch now.
flevi29
commented
Oct 10, 2024
| }); | ||
|
|
||
| test(`Client handles host URL with domain and path and no trailing slash`, () => { |
There was a problem hiding this comment.
Combine this test into the other.
flevi29
commented
Oct 10, 2024
Comment on lines
+256
to
263
| async update(data?: IndexOptions): Promise<EnqueuedTask> { | ||
| const task = (await this.httpRequest.patch({ | ||
| relativeURL: `indexes/${this.uid}`, | ||
| body: data, | ||
| })) as EnqueuedTaskObject; | ||
|
|
||
| task.enqueuedAt = new Date(task.enqueuedAt); | ||
|
|
||
| return task; | ||
| return new EnqueuedTask(task); | ||
| } |
There was a problem hiding this comment.
bug: previously this did not return EnqueuedTask
flevi29
commented
Oct 10, 2024
src/indexes.ts
Outdated
Comment on lines
565
to
571
| async deleteDocument(documentId: string | number): Promise<EnqueuedTask> { | ||
| const url = `indexes/${this.uid}/documents/${documentId}`; | ||
| const task = await this.httpRequest.delete<EnqueuedTask>(url); | ||
|
|
||
| task.enqueuedAt = new Date(task.enqueuedAt); | ||
| const task = (await this.httpRequest.delete({ | ||
| relativeURL: `indexes/${this.uid}/documents/${documentId}`, | ||
| })) as EnqueuedTaskObject; | ||
|
|
||
| return task; | ||
| return new EnqueuedTask(task); | ||
| } |
There was a problem hiding this comment.
bug: previously this did not return EnqueuedTask
flevi29
commented
Oct 10, 2024
Comment on lines
617
to
623
| async deleteAllDocuments(): Promise<EnqueuedTask> { | ||
| const url = `indexes/${this.uid}/documents`; | ||
| const task = await this.httpRequest.delete<EnqueuedTask>(url); | ||
| const task = (await this.httpRequest.delete({ | ||
| relativeURL: `indexes/${this.uid}/documents`, | ||
| })) as EnqueuedTaskObject; | ||
|
|
||
| task.enqueuedAt = new Date(task.enqueuedAt); | ||
|
|
||
| return task; | ||
| return new EnqueuedTask(task); | ||
| } |
There was a problem hiding this comment.
bug: previously this did not return EnqueuedTask
flevi29
commented
Oct 10, 2024
src/indexes.ts
Outdated
Comment on lines
669
to
676
| async updateSettings(settings: Settings): Promise<EnqueuedTask> { | ||
| const url = `indexes/${this.uid}/settings`; | ||
| const task = await this.httpRequest.patch(url, settings); | ||
| const task = (await this.httpRequest.patch({ | ||
| relativeURL: `indexes/${this.uid}/settings`, | ||
| body: settings, | ||
| })) as EnqueuedTaskObject; | ||
|
|
||
| task.enqueued = new Date(task.enqueuedAt); | ||
|
|
||
| return task; | ||
| return new EnqueuedTask(task); | ||
| } |
There was a problem hiding this comment.
bug: previously this did not return EnqueuedTask, I'm not going to mark the rest, there are more
flevi29
commented
Oct 10, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull Request
Sorry for the huge PR, but
HttpRequestsis core, and is used everywhere.What does this PR do?
EnqueuedTaskObjects not being converted toEnqueuedTaskCaution
BREAKING: From now on only some methods are public on
HttpRequests(get,post,put,patch,delete), the rest of the properties and methods are internal implementation details, and are not meant to be directly accessed.PR checklist
Please check if your PR fulfills the following requirements:
Thank you so much for contributing to Meilisearch!