[Console] Section always writes with a newline #37304

kmadejski · 2020-06-16T10:22:54Z

Symfony version(s) affected: 4.1.0 and higher

Description
ConsoleSectionOutput always writes with a newline even if explicitly set to false, eg.:
$section->write('foo', false); since isDecorated() always returns true by default. Output behaves correctly if $section->setDecorated(false); but all decoration is automatically gone which should not be the case.

How to reproduce

<?php

namespace App\Command;

use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;

class TestCommand extends Command
{
    protected function configure(): void
    {
        $this->setName('test-command');
        parent::configure();
    }

    protected function execute(InputInterface $input, OutputInterface $output): int
    {
        /** @var \Symfony\Component\Console\Output\ConsoleOutputInterface $output */
        $section = $output->section();

        for ($i = 0; $i < 100; $i++) {
            $section->write('Element ' . (string) $i, false);
        }

        return 0;
    }
}

Possible Solution
$newline argument value should be taken into account in this method: https://github.com/symfony/console/blob/v4.1.0/Output/ConsoleSectionOutput.php#L97

Once confirmed I'm more than happy to create a PR that fixes it 🙂

The text was updated successfully, but these errors were encountered:

carsonbot · 2021-02-18T13:02:14Z

Hey, thanks for your report!
There has not been a lot of activity here for a while. Is this bug still relevant? Have you managed to find a workaround?

carsonbot · 2021-03-04T13:34:32Z

Could I get an answer? If I do not hear anything I will assume this issue is resolved or abandoned. Please get back to me <3

kmadejski · 2021-03-04T15:28:42Z

Judging from the code It seems that the issue is still present. I'll take a deeper look later today.

DigiLive · 2021-03-31T22:39:06Z

I can confirm this behavior still exists at symfony/console 5.2

chalasr · 2021-04-01T06:52:57Z

PR welcome!

arnegroskurth · 2021-05-20T22:13:30Z

I'm currently working on the section output and am likely able to fix/change this accordingly: #41266

However, the docs currently define the behaviour to kind of be like this: A new line is appended automatically when displaying information in a section. (https://symfony.com/doc/current/console.html#output-sections) Can we change this behaviour anyway and still consider it a fix or are we crossing the line to a BC here?

@chalasr

carsonbot · 2021-11-23T13:04:06Z

Hey, thanks for your report!
There has not been a lot of activity here for a while. Is this bug still relevant? Have you managed to find a workaround?

carsonbot · 2021-12-07T13:06:20Z

Friendly reminder that this issue exists. If I don't hear anything I'll close this.

chapterjason · 2021-12-14T22:23:02Z

I use a BufferedOutput as workaround like this:

         /** @var \Symfony\Component\Console\Output\ConsoleOutputInterface $output */
        $section = $output->section();
        $buffer = new BufferedOutput();            

        for ($i = 0; $i < 100; $i++) {
            $buffer->write('Element ' . (string) $i, false);

            $bufferedData = $buffer->fetch();
            $section->overwrite($bufferedData);
            $buffer->write($bufferedData);
        }

carsonbot · 2022-06-15T13:00:58Z

Hey, thanks for your report!
There has not been a lot of activity here for a while. Is this bug still relevant? Have you managed to find a workaround?

chalasr · 2022-06-21T13:36:05Z

PR welcome on the lowest branch where the bug exists (with test case please!)

Add PHPUnit tests to check write() vs. writeln() in sections

…agendra-ishaya) This PR was submitted for the 4.4 branch but it was merged into the 6.2 branch instead. Discussion ---------- [Console] Fix console section output without newline | Q | A | ------------- | --- | Branch | 4.4 | Bug fix | yes | New feature | no | Deprecations | no | Tickets | Fix #37304 | License | MIT | Doc PR | n/a As described in #37304, when writing to a output section, a newline would automatically be added, inrespective wether using `write()` or `writeln()`. This PR fixes said behaviour. Lines can now be appended to. Commits ------- 92d9382 [Console] Fix forced linebreak in output sections (fixes #37304)

bhujagendra-ishaya · 2022-07-08T13:12:45Z

If you stumble upon this issue, please note that while this was introduced in 4.1 and considered a bug, the patch was considered a new feature and hence applied only to 6.2 (refer to the conversation of #46812 for further details).

kmadejski added the Bug label Jun 16, 2020

carsonbot added the Status: Needs Review label Jun 16, 2020

javiereguiluz added the Console label Jun 16, 2020

carsonbot added the Stalled label Feb 18, 2021

carsonbot removed the Stalled label Mar 4, 2021

arnegroskurth mentioned this issue May 20, 2021

[Console] Fixed output glitches when trying to use sectioned output larger then terminal and made terminal utility aware of resizes #41266

Closed

carsonbot added the Stalled label Nov 23, 2021

carsonbot removed the Stalled label Dec 14, 2021

carsonbot added the Stalled label Jun 15, 2022

carsonbot removed the Stalled label Jun 21, 2022

chalasr added Status: Reviewed and removed Status: Needs Review labels Jun 21, 2022

bhujagendra-ishaya added a commit to TheBrightPath/symfony that referenced this issue Jun 29, 2022

[Console] Fix forced linebreak (fixes symfony#37304)

58c8a48

bhujagendra-ishaya added a commit to TheBrightPath/symfony that referenced this issue Jun 29, 2022

[Console] Fix forced linebreak (fixes symfony#37304)

a2d89f1

bhujagendra-ishaya added a commit to TheBrightPath/symfony that referenced this issue Jun 29, 2022

[Console] Fix forced linebreak (fixes symfony#37304)

34414b1

bhujagendra-ishaya mentioned this issue Jun 29, 2022

[Console] Fix console section output without newline #46812

Closed

bhujagendra-ishaya added a commit to TheBrightPath/symfony that referenced this issue Jun 30, 2022

[Console] Fix forced linebreak (fixes symfony#37304)

258cc0d

bhujagendra-ishaya added a commit to TheBrightPath/symfony that referenced this issue Jun 30, 2022

[Console] Fix forced linebreak in output sections (fixes symfony#37304)

0308a2c

Add PHPUnit tests to check write() vs. writeln() in sections

fabpot closed this as completed in 92d9382 Jul 8, 2022

maxbeckers mentioned this issue Jan 3, 2023

[Console] Question helper is behaving differently when inside a Section #47411

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Console] Section always writes with a newline #37304

[Console] Section always writes with a newline #37304

kmadejski commented Jun 16, 2020 •

edited by javiereguiluz

Loading

carsonbot commented Feb 18, 2021

carsonbot commented Mar 4, 2021

kmadejski commented Mar 4, 2021

DigiLive commented Mar 31, 2021

chalasr commented Apr 1, 2021

arnegroskurth commented May 20, 2021 •

edited

Loading

carsonbot commented Nov 23, 2021

carsonbot commented Dec 7, 2021

chapterjason commented Dec 14, 2021

carsonbot commented Jun 15, 2022

chalasr commented Jun 21, 2022

bhujagendra-ishaya commented Jul 8, 2022

[Console] Section always writes with a newline #37304

[Console] Section always writes with a newline #37304

Comments

kmadejski commented Jun 16, 2020 • edited by javiereguiluz Loading

carsonbot commented Feb 18, 2021

carsonbot commented Mar 4, 2021

kmadejski commented Mar 4, 2021

DigiLive commented Mar 31, 2021

chalasr commented Apr 1, 2021

arnegroskurth commented May 20, 2021 • edited Loading

carsonbot commented Nov 23, 2021

carsonbot commented Dec 7, 2021

chapterjason commented Dec 14, 2021

carsonbot commented Jun 15, 2022

chalasr commented Jun 21, 2022

bhujagendra-ishaya commented Jul 8, 2022

kmadejski commented Jun 16, 2020 •

edited by javiereguiluz

Loading

arnegroskurth commented May 20, 2021 •

edited

Loading