Skip to content

Fix Tideways: write tideways.api_key to php.ini and handle CLI access token#77

Merged
peterjaap merged 7 commits into
mainfrom
copilot/update-tideways-documentation
Apr 10, 2026
Merged

Fix Tideways: write tideways.api_key to php.ini and handle CLI access token#77
peterjaap merged 7 commits into
mainfrom
copilot/update-tideways-documentation

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Apr 8, 2026 •
edited by peterjaap
Loading

Problem

Tideways was not actually working for MageBox users. Two distinct problems, both in magebox tideways config:

  1. PHP extension got no API key. The Tideways PHP extension requires tideways.api_key=<KEY> in php.ini in order to transmit traces. MageBox never wrote this directive — it only wrote a daemon.conf file (which, for good measure, was buggy: it wrote api_key=xxx\n literally with a backslash-n instead of a newline). The extension therefore never sent anything to Tideways.
  2. No support for the CLI access token. The tideways commandline tool (tideways run, tideways event create, tideways tracepoint create) authenticates with a separate personal token imported via tideways import <token>. That credential was not handled at all.

The initial version of this PR only corrected the hint URL in the prompt. This revision actually fixes the functional issues.

Changes

Write tideways.api_key to the PHP extension ini

  • internal/tideways/manager.go: new WriteAPIKeyToExtension(phpVersion) — reads the ini, replaces any existing (commented or uncommented) tideways.api_key line or appends one, then writes via sudo tee because mods-available/*.ini is root-owned. The pure rewrite logic is split into rewriteAPIKeyIni so it is unit-testable.
  • cmd/magebox/tideways.go: runTidewaysConfig iterates platform.GetInstalledPHPVersions() and writes the directive for every PHP version that has the Tideways extension installed, then reloads PHP-FPM for the current project's PHP version so the change takes effect immediately.
  • Fixed IsExtensionEnabled which was splitting on the literal string \n (backslash + n) instead of newlines, so it could never find the extension line.
  • Removed the dead ConfigureDaemon path and its helpers.

Handle the Tideways CLI access token as a separate credential

  • internal/config/global.go + internal/tideways/types.go: TidewaysCredentials and Credentials now carry both APIKey and AccessToken.
  • Added HasTidewaysAccessToken() and TIDEWAYS_CLI_TOKEN env var support (takes precedence over the stored value).
  • internal/tideways/manager.go: new ImportCLIToken() — runs tideways import <token> if the tideways CLI is on PATH; otherwise returns a clear error and MageBox prints a "run tideways import <token> manually" hint.
  • cmd/magebox/tideways.go:
    • Interactive prompt now asks for both credentials and explains the distinction up front.
    • New --access-token flag for non-interactive mode (joins existing --api-key).
    • magebox tideways status now shows both "API Key configured" and "CLI access token set".

Documentation

  • vitepress/services/tideways.md: describes the two credentials and what each is used for, with links to the Tideways docs and to the CLI import settings page. Documents the non-interactive form and both env vars.
  • vitepress/guide/global-config.md: adds access_token to the YAML example and TIDEWAYS_CLI_TOKEN to the env var table.

Tests

  • internal/config/global_test.go:
    • TestGlobalConfig_TidewaysCredentials covers HasTidewaysCredentials / HasTidewaysAccessToken and env var precedence for both keys.
    • TestGlobalConfig_TidewaysRoundTrip verifies the new access_token field survives YAML save/load.
  • internal/tideways/manager_test.go (new): TestRewriteAPIKeyIni covers append, replace uncommented, replace commented-with-whitespace, missing trailing newline, and empty-file cases.

Changelog

Added [Unreleased] entry under Fixed (PHP extension API key) and Added (CLI access token).

Test plan

  • make lint — 0 issues
  • make test — all packages passing, new tests included
  • Manual: magebox tideways config on a Debian/Ubuntu box — verify tideways.api_key=... appears in /etc/php/<ver>/mods-available/tideways.ini and that traces start flowing to the Tideways dashboard
  • Manual: magebox tideways config --api-key k --access-token t non-interactive — verify config.yaml contains both fields and tideways import is invoked when the CLI is installed
  • Manual: magebox tideways status — verify both credential rows display correctly

Copilot AI linked an issue Apr 8, 2026 that may be closed by this pull request
Tideways Documentation seems wrong #76
Closed
Copilot AI changed the title [WIP] Update Tideways documentation regarding API key Fix incorrect Tideways API key URL in CLI hint and docs Apr 8, 2026
Copilot AI requested a review from peterjaap April 8, 2026 11:00
@peterjaap peterjaap marked this pull request as ready for review April 9, 2026 13:17
@peterjaap
Write tideways.api_key to php.ini and handle CLI access token (#77)
2e60c47 
The Tideways PHP extension refuses to transmit traces unless
`tideways.api_key=<KEY>` is present in php.ini. MageBox previously only
wrote a (buggy) daemon config file, so the extension was effectively
silent. `magebox tideways config` now writes the directive into every
installed PHP version's extension ini file via `sudo tee` and reloads
PHP-FPM for the current project.

The `tideways` commandline tool uses a separate personal token imported
via `tideways import <token>`. Added an `access_token` credential
alongside `api_key`, a `--access-token` flag, and `TIDEWAYS_CLI_TOKEN`
env var support, and run `tideways import` automatically when the token
is provided and the CLI is on PATH. Both credentials are documented as
distinct in the guide and service pages.

Also fixed `IsExtensionEnabled` which was splitting on the literal
string `\n` instead of newlines, and dropped the dead `ConfigureDaemon`
path that wrote `api_key=xxx\n` literally.
@peterjaap peterjaap changed the title Fix incorrect Tideways API key URL in CLI hint and docs Fix Tideways: write tideways.api_key to php.ini and handle CLI access token Apr 9, 2026
@peterjaap
Point Tideways API key hint to per-project Installation page
f3cdcd4 
The support-doc URL isn't where you actually copy the key from — the
in-app Installation page per project is. Update both the interactive
`magebox tideways config` prompt and the VitePress docs to reference
https://app.tideways.io/o/<organization>/<project>/installation.
@peterjaap
Added build dir to gitignor
8815a38
@peterjaap
Write tideways.environment to PHP ini with local_$USER default
ec58537 
Without tideways.environment in php.ini, the Tideways PHP extension
labels traces with the server-side default `production`, so traces from
a developer machine land in the production bucket on app.tideways.io —
exactly the opposite of what you want for a local dev environment.

- Add Environment field to TidewaysCredentials (config + tideways pkg)
- Add DefaultTidewaysEnvironment() returning `local_<username>` from
  os/user, with TIDEWAYS_ENVIRONMENT env var override in
  GetTidewaysCredentials (same precedence pattern as api_key / cli token)
- Generalize rewriteAPIKeyIni → rewriteIniDirective and rename
  WriteAPIKeyToExtension → WriteExtensionConfig, which now writes both
  tideways.api_key and tideways.environment in a single sudo tee pass
- `magebox tideways config` prompts for Environment (with the
  local_<username> default pre-filled), accepts a new --environment
  flag, and shows the resolved value when writing ini files
- `magebox tideways status` shows the resolved environment
- Unit tests: rewriteIniDirective covers api_key and environment cases
  (append, replace uncommented, replace commented, composition,
  replace-in-place); global config tests cover env var precedence, the
  local_<username> fallback, and save/load round-trip for Environment
@peterjaap
Configure Tideways environment via daemon, not PHP ini
9e863d4 
The previous commit wrote tideways.environment to the PHP extension
ini, but that directive does not exist — the PHP extension silently
ignored it, so traces from local dev machines kept landing in the
server-side 'production' bucket on app.tideways.io.

Per the Tideways docs, the environment label is a *daemon-level*
setting. The PHP extension ships traces to the local tideways-daemon,
which stamps them with whatever --env (or TIDEWAYS_ENVIRONMENT env var)
it was started with (default: production).

Fix:

- Stop writing tideways.environment to the PHP extension ini. Rename
  WriteExtensionConfig back to WriteAPIKeyToExtension, which now also
  strips any stale tideways.environment line left behind by the
  previous commit (via stripIniDirective).
- Add WriteDaemonEnvironment on Linux: installs a systemd drop-in at
  /etc/systemd/system/tideways-daemon.service.d/magebox-environment.conf
  that sets Environment="TIDEWAYS_ENVIRONMENT=<env>", then runs
  `systemctl daemon-reload` and `systemctl restart tideways-daemon`.
  The daemon reads TIDEWAYS_ENVIRONMENT at startup and labels all
  subsequent traces with it. On macOS this returns a clear "not
  supported yet" error with a manual-config hint.
- runTidewaysConfig now writes api_key to every installed PHP version
  *and* configures the daemon environment, printing both steps.
- Pure renderDaemonEnvironmentDropIn helper so the systemd unit shape
  is testable without sudo.

Tests: drop the misleading rewriteIniDirective environment cases and
the composition test (we no longer compose api_key + environment into
the ini). Add TestStripIniDirective for the eviction path, and
TestRenderDaemonEnvironmentDropIn to lock down the systemd unit
structure ([Service] + Environment= line + managed-by marker).

See https://support.tideways.com/documentation/setup/configuration/environments.html
@peterjaap peterjaap merged commit 5c44b59 into main Apr 10, 2026
11 checks passed
@peterjaap peterjaap deleted the copilot/update-tideways-documentation branch April 10, 2026 10:59
@peterjaap peterjaap mentioned this pull request Apr 10, 2026
Merged
8 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@peterjaap peterjaap Awaiting requested review from peterjaap

Assignees

@peterjaap peterjaap

Copilot code review Copilot

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Tideways Documentation seems wrong

2 participants

@peterjaap