add NDJSON Serialization class #730

TheDigitalOrchard · 2025-03-19T18:09:44Z

Pull Request

What does this PR do?

adds NDJSON class for serialization

PR checklist

Please check if your PR fulfills the following requirements:

[Y ] Does this PR fix an existing issue, or have you listed the changes applied in the PR description (and why they are needed)?
[ Y] Have you read the contributing guidelines?
[ Y] Have you made sure that the title is accurate and descriptive of the changes?

Thank you so much for contributing to Meilisearch!

norkunas · 2025-03-20T05:23:53Z

src/Http/Client.php

@@ -30,7 +31,7 @@ class Client implements Http
    /** @var array<string,string> */
    private array $headers;
    private string $baseUrl;
-    private Json $json;
+    private Json|Ndjson $json;


this should be Meilisearch\Http\Serialize\SerializerInterface instead.

norkunas · 2025-03-20T05:25:37Z

src/Http/Client.php

@@ -83,9 +91,12 @@ public function post(string $path, $body = null, array $query = [], ?string $con
    {
        if (!\is_null($contentType)) {
            $this->headers['Content-type'] = $contentType;
+        } elseif (str_ends_with($body, "}\n")) {
+            $this->headers['Content-type'] = 'application/x-ndjson';
+            $body = $this->json(new Ndjson)->serialize($body);


I don't this is a good idea to switch format on the fly. Serializer should be preconfigured imho, or if contentType is manually set, then just instantiate other serializer without overriding the client state

norkunas · 2025-03-20T05:25:53Z

src/Http/Serialize/Ndjson.php

+use Meilisearch\Exceptions\JsonDecodingException;
+use Meilisearch\Exceptions\JsonEncodingException;
+
+class Ndjson implements SerializerInterface


Suggested change

class Ndjson implements SerializerInterface

final class Ndjson implements SerializerInterface

norkunas · 2025-03-20T05:27:51Z

src/Http/Client.php

     */
    private function isJSONResponse(array $headerValues): bool
    {
        $filteredHeaders = array_filter($headerValues, static function (string $headerValue) {
-            return false !== strpos($headerValue, 'application/json');
+            return str_contains($headerValue, 'application/json') || str_contains($headerValue, 'application/x-ndjson');


str_contains is available only from php 8, this library supports php 7.4, so you cannot use it yet

coderabbitai · 2025-05-14T06:12:01Z

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Explain this complex logic.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai explain this code block.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and explain its main purpose.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

Copilot

Pull Request Overview

This PR adds a new NDJSON serialization class and integrates it into the HTTP client in order to support NDJSON payloads.

Introduces an NDJSON serializer for encoding and decoding newline-delimited JSON.
Updates the HTTP client to detect NDJSON payloads using a heuristic and set the appropriate content type.
Modifies response parsing to support both JSON and NDJSON formats.

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File	Description
src/Http/Serialize/Ndjson.php	Adds NDJSON serialization logic with error handling using JSON_THROW_ON_ERROR.
src/Http/Client.php	Updates serialization handling to conditionally use NDJSON based on payload content and changes how serializers are managed via the json() method.

Comments suppressed due to low confidence (1)

src/Http/Client.php:59

[nitpick] The method name 'json' is the same as the property name, which may lead to confusion. Consider renaming the method to something like 'serializer' or 'setSerializer' for clarity.

    public function json(Json|Ndjson|null $json = null) {

Copilot · 2025-05-14T06:12:13Z

src/Http/Client.php

@@ -83,9 +91,12 @@ public function post(string $path, $body = null, array $query = [], ?string $con
    {
        if (!\is_null($contentType)) {
            $this->headers['Content-type'] = $contentType;
+        } elseif (str_ends_with($body, "}\n")) {


Relying on str_ends_with($body, "}\n") to detect NDJSON payloads may be brittle. Consider implementing an explicit flag or configuration option to determine when to use NDJSON serialization.

add NDJSON Serialization class

14b47e2

TheDigitalOrchard closed this Mar 19, 2025

make json parameter dynamic to support NDJSON object, as well

c1b66ff

TheDigitalOrchard reopened this Mar 19, 2025

TheDigitalOrchard marked this pull request as draft March 19, 2025 18:47

replace pipe with OR operator

66a5f61

norkunas requested changes Mar 20, 2025

View reviewed changes

Strift requested a review from Copilot May 14, 2025 06:11

Merge branch 'main' into ndjson-support

509a0c6

Copilot AI reviewed May 14, 2025

View reviewed changes

Strift added the enhancement New feature or request label May 14, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

add NDJSON Serialization class #730

add NDJSON Serialization class #730

Uh oh!

TheDigitalOrchard commented Mar 19, 2025

Uh oh!

norkunas Mar 20, 2025

Uh oh!

norkunas Mar 20, 2025

Uh oh!

norkunas Mar 20, 2025

Uh oh!

norkunas Mar 20, 2025

Uh oh!

coderabbitai bot commented May 14, 2025

Review skipped

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI May 14, 2025

Uh oh!

Uh oh!

	class Ndjson implements SerializerInterface
	final class Ndjson implements SerializerInterface

add NDJSON Serialization class #730

Are you sure you want to change the base?

add NDJSON Serialization class #730

Uh oh!

Conversation

TheDigitalOrchard commented Mar 19, 2025

Pull Request

What does this PR do?

PR checklist

Uh oh!

norkunas Mar 20, 2025

Choose a reason for hiding this comment

Uh oh!

norkunas Mar 20, 2025

Choose a reason for hiding this comment

Uh oh!

norkunas Mar 20, 2025

Choose a reason for hiding this comment

Uh oh!

norkunas Mar 20, 2025

Choose a reason for hiding this comment

Uh oh!

coderabbitai bot commented May 14, 2025

Review skipped

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI May 14, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

CodeRabbit Configuration File (`.coderabbit.yaml`)