doctrine/sql-formatter

Cannot render SQL queries containing binary strings

Open

#91 opened on Jul 21, 2023

View on GitHub
 (4 comments) (3 reactions) (0 assignees)HTML (17 forks)batch import
enhancementhelp wanted

Repository metrics

Stars
 (1,559 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

At the moment, even though valid, these kind of queries would crash doctrine-bundle + twig

$connection->executeQuery("SELECT {$connection->quote((new \Symfony\Component\Uid\Ulid())->toBinary())}");

We are running all of these queries through this formatter, so I think formatter should do something about these, eg. detect non-utf8 parts and replace them with something.

Original issue was https://github.com/doctrine/DoctrineBundle/issues/1315, I'm moving it here

Contributor guide

Research direction
Examine the SQL formatter source code, particularly the tokenizer and formatter classes, to understand how SQL queries are parsed and output. Look for how non UTF8 characters are currently handled (likely not). The fix may involve detecting binary segments within quoted strings and replacing or escaping them. Review existing tests in the repository to see if any cover binary data, and consider adding a test with a ULID to binary query similar to the issue example. Check the referenced DoctrineBundle issue for additional context on the crash.
Tech stack
php
Domain
database
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
PHPSQLbinary strings
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60