|
| 1 | +# Contribuindo |
| 2 | + |
| 3 | +## Compilando o PHP |
| 4 | + |
| 5 | +### Com Docker (Linux) |
| 6 | + |
| 7 | +Crie a imagem Docker de desenvolvimento: |
| 8 | + |
| 9 | +```console |
| 10 | +docker build -t frankenphp-dev -f dev.Dockerfile . |
| 11 | +docker run --cap-add=SYS_PTRACE --security-opt seccomp=unconfined -p 8080:8080 -p 443:443 -p 443:443/udp -v $PWD:/go/src/app -it frankenphp-dev |
| 12 | +``` |
| 13 | + |
| 14 | +A imagem contém as ferramentas de desenvolvimento usuais (Go, GDB, Valgrind, |
| 15 | +Neovim...) e usa os seguintes locais de configuração do PHP: |
| 16 | + |
| 17 | +- php.ini: `/etc/frankenphp/php.ini`. |
| 18 | + Um arquivo `php.ini` com configurações de desenvolvimento é fornecido por |
| 19 | + padrão. |
| 20 | +- Arquivos de configuração adicionais: `/etc/frankenphp/php.d/*.ini`. |
| 21 | +- Extensões PHP: `/usr/lib/frankenphp/modules/`. |
| 22 | + |
| 23 | +Se a sua versão do Docker for anterior à 23.0, a compilação falhará devido ao |
| 24 | +[problema de padrão do `.dockerignore`](https://github.com/moby/moby/pull/42676). |
| 25 | +Adicione diretórios ao `.dockerignore`. |
| 26 | + |
| 27 | +```patch |
| 28 | + !testdata/*.php |
| 29 | + !testdata/*.txt |
| 30 | ++!caddy |
| 31 | ++!internal |
| 32 | +``` |
| 33 | + |
| 34 | +### Sem Docker (Linux e macOS) |
| 35 | + |
| 36 | +[Siga as instruções para compilar a partir dos fontes](compile.md) e passe a |
| 37 | +flag de configuração `--debug`. |
| 38 | + |
| 39 | +## Executando a suite de testes |
| 40 | + |
| 41 | +```console |
| 42 | +go test -tags watcher -race -v ./... |
| 43 | +``` |
| 44 | + |
| 45 | +## Módulo Caddy |
| 46 | + |
| 47 | +Construa o Caddy com o módulo Caddy FrankenPHP: |
| 48 | + |
| 49 | +```console |
| 50 | +cd caddy/frankenphp/ |
| 51 | +go build -tags watcher,brotli,nobadger,nomysql,nopgx |
| 52 | +cd ../../ |
| 53 | +``` |
| 54 | + |
| 55 | +Execute o Caddy com o módulo Caddy FrankenPHP: |
| 56 | + |
| 57 | +```console |
| 58 | +cd testdata/ |
| 59 | +../caddy/frankenphp/frankenphp run |
| 60 | +``` |
| 61 | + |
| 62 | +O servidor está escutando em `127.0.0.1:80`: |
| 63 | + |
| 64 | +> [!NOTE] |
| 65 | +> Se você estiver usando o Docker, terá que vincular a porta 80 do contêiner ou |
| 66 | +> executar de dentro do contêiner. |
| 67 | +
|
| 68 | +```console |
| 69 | +curl -vk http://127.0.0.1/phpinfo.php |
| 70 | +``` |
| 71 | + |
| 72 | +## Servidor de teste mínimo |
| 73 | + |
| 74 | +Construa o servidor de teste mínimo: |
| 75 | + |
| 76 | +```console |
| 77 | +cd internal/testserver/ |
| 78 | +go build |
| 79 | +cd ../../ |
| 80 | +``` |
| 81 | + |
| 82 | +Execute o servidor de teste: |
| 83 | + |
| 84 | +```console |
| 85 | +cd testdata/ |
| 86 | +../internal/testserver/testserver |
| 87 | +``` |
| 88 | + |
| 89 | +O servidor está escutando em `127.0.0.1:8080`: |
| 90 | + |
| 91 | +```console |
| 92 | +curl -v http://127.0.0.1:8080/phpinfo.php |
| 93 | +``` |
| 94 | + |
| 95 | +## Construindo imagens Docker localmente |
| 96 | + |
| 97 | +Imprima o plano do bake: |
| 98 | + |
| 99 | +```console |
| 100 | +docker buildx bake -f docker-bake.hcl --print |
| 101 | +``` |
| 102 | + |
| 103 | +Construa imagens FrankenPHP para amd64 localmente: |
| 104 | + |
| 105 | +```console |
| 106 | +docker buildx bake -f docker-bake.hcl --pull --load --set "*.platform=linux/amd64" |
| 107 | +``` |
| 108 | + |
| 109 | +Construa imagens FrankenPHP para arm64 localmente: |
| 110 | + |
| 111 | +```console |
| 112 | +docker buildx bake -f docker-bake.hcl --pull --load --set "*.platform=linux/arm64" |
| 113 | +``` |
| 114 | + |
| 115 | +Construa imagens FrankenPHP do zero para arm64 e amd64 e envie para o Docker |
| 116 | +Hub: |
| 117 | + |
| 118 | +```console |
| 119 | +docker buildx bake -f docker-bake.hcl --pull --no-cache --push |
| 120 | +``` |
| 121 | + |
| 122 | +## Depurando falhas de segmentação com compilações estáticas |
| 123 | + |
| 124 | +1. Baixe a versão de depuração do binário do FrankenPHP do GitHub ou crie sua |
| 125 | + própria compilação estática personalizada, incluindo símbolos de depuração: |
| 126 | + |
| 127 | + ```console |
| 128 | + docker buildx bake \ |
| 129 | + --load \ |
| 130 | + --set static-builder.args.DEBUG_SYMBOLS=1 \ |
| 131 | + --set "static-builder.platform=linux/amd64" \ |
| 132 | + static-builder |
| 133 | + docker cp $(docker create --name static-builder-musl dunglas/frankenphp:static-builder-musl):/go/src/app/dist/frankenphp-linux-$(uname -m) frankenphp |
| 134 | + ``` |
| 135 | + |
| 136 | +2. Substitua sua versão atual do `frankenphp` pelo executável de depuração do |
| 137 | + FrankenPHP. |
| 138 | +3. Inicie o FrankenPHP normalmente (alternativamente, você pode iniciar o |
| 139 | + FrankenPHP diretamente com o GDB: `gdb --args frankenphp run`). |
| 140 | +4. Anexe ao processo com o GDB: |
| 141 | + |
| 142 | + ```console |
| 143 | + gdb -p `pidof frankenphp` |
| 144 | + ``` |
| 145 | + |
| 146 | +5. Se necessário, digite `continue` no shell do GDB. |
| 147 | +6. Faça o FrankenPHP travar. |
| 148 | +7. Digite `bt` no shell do GDB. |
| 149 | +8. Copie a saída. |
| 150 | + |
| 151 | +## Depurando falhas de segmentação no GitHub Actions |
| 152 | + |
| 153 | +1. Abra o arquivo `.github/workflows/tests.yml`. |
| 154 | +2. Habilite os símbolos de depuração do PHP: |
| 155 | + |
| 156 | + ```patch |
| 157 | + - uses: shivammathur/setup-php@v2 |
| 158 | + # ... |
| 159 | + env: |
| 160 | + phpts: ts |
| 161 | + + debug: true |
| 162 | + ``` |
| 163 | + |
| 164 | +3. Habilite o `tmate` para se conectar ao contêiner: |
| 165 | + |
| 166 | + ```patch |
| 167 | + - name: Set CGO flags |
| 168 | + run: echo "CGO_CFLAGS=$(php-config --includes)" >> "$GITHUB_ENV" |
| 169 | + + - run: | |
| 170 | + + sudo apt install gdb |
| 171 | + + mkdir -p /home/runner/.config/gdb/ |
| 172 | + + printf "set auto-load safe-path /\nhandle SIG34 nostop noprint pass" > /home/runner/.config/gdb/gdbinit |
| 173 | + + - uses: mxschmitt/action-tmate@v3 |
| 174 | + ``` |
| 175 | + |
| 176 | +4. Conecte-se ao contêiner. |
| 177 | +5. Abra o `frankenphp.go`. |
| 178 | +6. Habilite o `cgosymbolizer`: |
| 179 | + |
| 180 | + ```patch |
| 181 | + - //_ "github.com/ianlancetaylor/cgosymbolizer" |
| 182 | + + _ "github.com/ianlancetaylor/cgosymbolizer" |
| 183 | + ``` |
| 184 | + |
| 185 | +7. Baixe o módulo: `go get`. |
| 186 | +8. No contêiner, você pode usar o GDB e similares: |
| 187 | + |
| 188 | + ```console |
| 189 | + go test -tags watcher -c -ldflags=-w |
| 190 | + gdb --args frankenphp.test -test.run ^MyTest$ |
| 191 | + ``` |
| 192 | + |
| 193 | +9. Quando a falha for corrigida, reverta todas essas alterações. |
| 194 | + |
| 195 | +## Recursos diversos de desenvolvimento |
| 196 | + |
| 197 | +- [PHP embedding in uWSGI](https://github.com/unbit/uwsgi/blob/master/plugins/php/php_plugin.c) |
| 198 | +- [PHP embedding in NGINX Unit](https://github.com/nginx/unit/blob/master/src/nxt_php_sapi.c) |
| 199 | +- [PHP embedding in Go (go-php)](https://github.com/deuill/go-php) |
| 200 | +- [PHP embedding in Go (GoEmPHP)](https://github.com/mikespook/goemphp) |
| 201 | +- [PHP embedding in C++](https://gist.github.com/paresy/3cbd4c6a469511ac7479aa0e7c42fea7) |
| 202 | +- [Extending and Embedding PHP por Sara Golemon](https://books.google.fr/books?id=zMbGvK17_tYC&pg=PA254&lpg=PA254#v=onepage&q&f=false) |
| 203 | +- [What the heck is TSRMLS_CC, anyway?](http://blog.golemon.com/2006/06/what-heck-is-tsrmlscc-anyway.html) |
| 204 | +- [SDL bindings](https://pkg.go.dev/github.com/veandco/go-sdl2@v0.4.21/sdl#Main) |
| 205 | + |
| 206 | +## Recursos relacionados ao Docker |
| 207 | + |
| 208 | +- [Definição do arquivo Bake](https://docs.docker.com/build/customize/bake/file-definition/) |
| 209 | +- [`docker buildx build`](https://docs.docker.com/engine/reference/commandline/buildx_build/) |
| 210 | + |
| 211 | +## Comando útil |
| 212 | + |
| 213 | +```console |
| 214 | +apk add strace util-linux gdb |
| 215 | +strace -e 'trace=!futex,epoll_ctl,epoll_pwait,tgkill,rt_sigreturn' -p 1 |
| 216 | +``` |
| 217 | + |
| 218 | +## Traduzindo a documentação |
| 219 | + |
| 220 | +Para traduzir a documentação e o site para um novo idioma, siga estes passos: |
| 221 | + |
| 222 | +1. Crie um novo diretório com o código ISO de 2 caracteres do idioma no |
| 223 | + diretório `docs/` deste repositório. |
| 224 | +2. Copie todos os arquivos `.md` da raiz do diretório `docs/` para o novo |
| 225 | + diretório (sempre use a versão em inglês como fonte para tradução, pois está |
| 226 | + sempre atualizada). |
| 227 | +3. Copie os arquivos `README.md` e `CONTRIBUTING.md` do diretório raiz para o |
| 228 | + novo diretório. |
| 229 | +4. Traduza o conteúdo dos arquivos, mas não altere os nomes dos arquivos, nem |
| 230 | + traduza strings que comecem com `> [!` (é uma marcação especial para o |
| 231 | + GitHub). |
| 232 | +5. Crie um pull request com as traduções. |
| 233 | +6. No |
| 234 | + [repositório do site](https://github.com/dunglas/frankenphp-website/tree/main), |
| 235 | + copie e traduza os arquivos de tradução nos diretórios `content/`, `data/` e |
| 236 | + `i18n/`. |
| 237 | +7. Traduza os valores no arquivo YAML criado. |
| 238 | +8. Abra um pull request no repositório do site. |
0 commit comments