Message-ID: <57c12c52-123c-4a13-a258-02639473fa17@dunslane.net>
Date: Thu, 1 Aug 2024 17:38:17 -0400
MIME-Version: 1.0
User-Agent: Mozilla Thunderbird
Subject: Re: Official devcontainer config
To: Junwang Zhao <zhjwpku@gmail.com>,
 PostgreSQL Hackers <pgsql-hackers@lists.postgresql.org>
Cc: Andrey Borodin <amborodin86@gmail.com>,
 Jelte Fennema-Nio <postgres@jeltef.nl>
References: <CAEG8a3K_mZsBZ60smh4FM4Dk9cazAUmM72iXdFKEHgthZnaHcw@mail.gmail.com>
From: Andrew Dunstan <andrew@dunslane.net>
Content-Language: en-US
Autocrypt: addr=andrew@dunslane.net; keydata=
 xsBNBE7KWFkBCAClridxur2AIc7eW2AR7izbfp3EnNefie2HbLF0izW5Ik5UjX2HBXBx4syI
 gY6b0ugohXrr274+baoAlvSbq6cAoQuEVrk5IZFzt20b1Xkx65FwGSEj526yiKLocqkJceSq
 Xr9xcA5SGY+FZv441chh5SU92v4q6z+6LPpoHOh97ptAVXZYNTtU0LevyvD5lja0TzbvJm6C
 eFXitJfnm1pLEr0DGJCR/iUOl/N62Kh4855zZC7NHIjQHPOvV5Stz/l5ilDhvGVk+xkXFPys
 SjZoUr1rXhYLpiyi5sR0X9FHXT0KnGuz1F5ERO7ZTLSSQ6fJwPj6gOk9K+vvoKvoeql5ABEB
 AAHNJEFuZHJldyBEdW5zdGFuIDxhbmRyZXdAZHVuc2xhbmUubmV0PsLAmwQTAQgARQIbAwIX
 gAIZAQULCQgHAgMiAgEGFQoJCAsCBBYCAwECHgcWIQTkPlhGHfx8v0RpFaWZ+n/LWfw7gQUC
 ZFlxxwUJGVGAbgAKCRCZ+n/LWfw7gXikB/9ZdcUy6CTBFIIuL/bVsc1eLEW/gJBjJBF6HxNY
 xgEkAgXAp4Lg4A5U+QB9GouFr7+GYxF0BU4hzoGhNPUWltxnHdMWP8nC/38LAqgMi8L/bbsm
 HW5YPBdWYaAZAPJQVfOAgjTbRUb26KSprpyrrJKW0ZmrZfjhNPcQ72jpWzoPLQqx2X6B0fru
 1jq+cBh8lb6r1mJTim1T3JIn+F/v5VpdQS+EL8xqsHkfzKjIPsW3CIXpkypSk6saA55Rkkbl
 26AW8ftPVB0Q6Lnn6FLt9CP0MGNixBQ55yq8r1K+nCBvCCjvQjM8RDm0UUum0WNl+ifQgTLO
 E8TWEnwVtkBf+3QWzsBNBE7KWFkBCADRnOM0FCzsYW6jtncg+dWIagjUZpvaClmqn/sJluLa
 Q3v1VXMQJzYs3eC1gh386W+XBwLRpDj3jzH81lX+p73Re3d3oJW7X+ffsxuzu5ZVdMUkqBYo
 nkAbKxr6gyJ12F/+JkUVzLcoTN+d/7YsQvUVi7NaKH8mJgjz112O4fUe3p9wfAaFa0RXHc5S
 GPzRTYRRlv/XZBIho4J2tkZOnteZJZ+GbxQVlINt6fd8P6al3MWOvpP/ExJPguEfjOsO6Njy
 xjo3WfpD4lHMOR/Oc3/8mScEF84rF2jXbsFgelWnbPWAvXY+pD0dXOFRkagGmC/viwBDqq5b
 5tk76kKmUbZxABEBAAHCwHwEGAEIACYCGwwWIQTkPlhGHfx8v0RpFaWZ+n/LWfw7gQUCZFlx
 5wUJGVGAjgAKCRCZ+n/LWfw7gf+iB/4g8CPY5jihf5r/8EsoIGe2H+dpVmpPF8YGBzTIvCz/
 fQoOq8AX/pE76QEuFnFZWfjw+wgBXgCVmkox2Eflkk6z4ND3pcwGZ6CfCxTQCDk/dij+2DQ4
 6bmDCy/sBgcbz9mTpoLC11HLoPae6YN9nBNQRZDcEFEu54OaVOqlIdbA6m+POIBCXZdHOFc0
 WoDTgxHRzC1jgQNidyd6tKqcsVJs0dzF0oKTmFFmUAqTdJO12LBuNA1rlqrR3EtpYk8B/wtS
 5dIMD7Q8hwQpL+4C6GNpb6ZKnPkLi47pDOLhz2qBrqN+rqUEsT3YnExYpzj5yOBi+FlmV1Hw
 49QYe1sn2ZPs
In-Reply-To: <CAEG8a3K_mZsBZ60smh4FM4Dk9cazAUmM72iXdFKEHgthZnaHcw@mail.gmail.com>
Content-Type: text/plain; charset=UTF-8; format=flowed
Content-Transfer-Encoding: 7bit
Archived-At: <https://www.postgresql.org/message-id/57c12c52-123c-4a13-a258-02639473fa17%40dunslane.net>
Precedence: bulk


On 2024-08-01 Th 10:56 AM, Junwang Zhao wrote:
> Stack Overflow 2024 developer survey[1] said VSCode
> is the most used development environment.
>
> In a PostgreSQL Hacker Mentoring discussion, we talked
> about how to use vscode to debug and running postgres,
> Andrey(ccd) has tons of tips for new developers, and
> I post my daily used devcontainer config[2] , Jelte(ccd)
> suggested that it might be a good idea we integrate the
> config into postgres repo so that the barrier to entry for
> new developers will be much lower.
>
> **Note**
>
> This is not intended to change the workflow of experienced
> hackers, it is just hoping to make the life easier for
> beginner developers.
>
> **How to use**
>
> Open VSCode Command Palette(cmd/ctrl + shift + p),
> search devcontainer, then choose something like
> `Dev containers: Rebuild and Reopen in Container`, you are
> good to go.
>
> **About the patch**
>
> devcontainer.json:
>
> The .devcontainer/devcontainer.json is the entry point for
> VSCode to *open folder to develop in a container*, it will build
> the docker image for the first time you open in container,
> this will take some time.
>
> There are some parameters(runArgs) for running the container,
> we need some settings and privileges to run perf or generate
> core dumps.
>
> It has a mount point mapping the hosts $HOME/freedom
> to container's /opt/freedom, I chose the name *freedom*
> because the container is kind of a jail.
>
> It also installed some vscode extensions and did some
> customizations.
>
> After diving into the container, the postCreateCommand.sh
> will be automatically called, it will do some configurations
> like git, perf, .vscode, core_pattern, etc. It also downloads
> michaelpq's pg_plugins and FlameGraph.
>
> Dockerfile:
>
> It is based on debian bookworm, it installed dependencies
> to build postgres, also IPC::Run to run TAP tests I guess.
>
> It also has a .gdbinit to break elog.c:errfinish for elevel 21,
> this will make the debugging easier why error is logged.
>
> gdbpg.py is adapted from https://github.com/tvondra/gdbpg,
> I think putting it here will make it evolve as time goes.
>
> tasks.json:
>
> This is kind of like a bookkeeping for developers, it has
> the following commands:
>
> - meson debug setup
> - meson release setup
> - ninja build
> - regression tests
> - ninja install
> - init cluster
> - start cluster
> - stop cluster
> - install pg_bsd_indent
> - pgindent
> - apply patch
> - generate flamegraph
>
> launch.json:
>
> It has one configuration that makes it possible to attach
> to one process(e.g. postgres backend) and debug
> with vscode.
>
> PFA and please give it a try if you are a VSCode user.
>
> [1]: https://survey.stackoverflow.co/2024/technology#1-integrated-development-environment
> [2]: https://github.com/atomicdb/devcontainer/tree/main/postgres
>

Not totally opposed, and I will probably give it a try very soon, but 
I'm wondering if this really needs to go in the core repo. We've 
generally shied away from doing much in the way of editor / devenv 
support, trying to be fairly agnostic. It's true we carry .dir-locals.el 
and .editorconfig, so that's not entirely true, but those are really 
just about supporting our indentation etc. standards.

Also, might it not be better for this to be carried in a separate repo 
maintained by people using vscode? I don't know how may committers do. 
Maybe lots do, and I'm just a dinosaur. If vscode really needs 
.devcontainer to live in the code root, maybe it could be symlinked. 
Another reason not carry the code ourselves is that it will make it less 
convenient for people who want to customize it.

Without having tried it, looks like a nice effort though. Well done.


cheers


andrew


--
Andrew Dunstan
EDB: https://www.enterprisedb.com