fix(playwright): point Api Service test connection at a raw GitHub fixture URL - #30866
Conversation
❌ PR checklist incompleteThis PR cannot be merged until the following are addressed on its linked issue:
The fields live on the linked issue in the Shipping project (open the issue → right sidebar → Projects). After you set them, re-run this check (or push a commit) — issue/project changes do not re-trigger it automatically. Maintainers can bypass this check by adding the |
Code Review ✅ ApprovedUpdates the API Service Playwright test connection fixture to use a raw GitHub URL instead of a local ingestion image path, preventing timeouts in environments where the file is absent. No issues found. OptionsDisplay: compact → Showing less information. Comment with these commands to change the behavior for this request:
Was this helpful? React with 👍 / 👎 | Gitar | Powered by Gitar — free for open source |
There was a problem hiding this comment.
Pull request overview
Updates the Playwright ingestion helper for API Service (REST) so the “Test Connection” step uses an OpenAPI fixture available in both OSS (Airflow) and Collate (Argo) environments, avoiding timeouts caused by relying on an ingestion-image-local file path.
Changes:
- Switch REST connector connection setup from an ingestion-image file path to a
raw.githubusercontent.comfixture URL. - Update the form interaction to select the “Open API Schema URL” connection option and fill
openAPISchemaURL.
✅ Playwright Results — workflow succeededValidated commit ✅ 549 passed · ❌ 0 failed · 🟡 1 flaky · ⏭️ 3 skipped · 🧰 0 lifecycle flaky PerformanceBlocking targets: ✅ met · Optimization targets: 🟡 in progress Shard-job maxima below are not the full workflow wall time; the linked run includes build, fixture, planning, and reporting. 🕒 Full workflow signal wall (to summary) 53m 41s ⏱️ Max setup 3m 23s · max shard execution 18m 2s · max shard-job elapsed before upload 21m 54s · reporting 5s 🌐 201.14 requests/attempt · 2.83 app boots/UI scenario · 5.91% common-shard skew Optimization targets still in progress:
🟡 1 flaky test(s) (passed on retry)
How to debug locally# Download playwright-test-results-<shard> artifact and unzip
npx playwright show-trace path/to/trace.zip # view trace |
|
Manually cherry-picked to 2.0 b6f1025 |
Describe your changes:
Fixes #
I worked on the
Api Service › Create & Ingest Api Service servicePlaywright test because its test connection was timing out on Collate.The test pointed the REST connector at a file baked into the ingestion image (
/home/airflow/ingestion/examples/openapi/sample.json). That path exists in the OSS Airflow image (ingestion/Dockerfile.cicopies the whole ingestion tree) but not in Collate's Argo ingestion image, so the missing file made test connection hang until the 3.5 minute timeout instead of resolving.This points the test at the same fixture served over raw GitHub, so it is reliable and identical across OpenMetadata (Airflow) and Collate (Argo) with no dependency on the ingestion image contents. It reuses the
raw.githubusercontent.compattern already used byContextCenter.spec.ts.Type of change:
High-level design:
Not applicable. Single-file Playwright test-helper change.
Tests:
Use cases covered
Unit tests
Not applicable. No product logic changed; this updates a Playwright test helper.
Backend integration tests
Not applicable. No backend API changes.
Ingestion integration tests
Not applicable. No ingestion code changes.
Playwright (UI) tests
openmetadata-ui/src/main/resources/ui/playwright/support/entity/ingestion/ApiIngestionClass.tsManual testing performed
https://raw.githubusercontent.com/open-metadata/OpenMetadata/main/ingestion/examples/openapi/sample.jsonUI screen recording / screenshots:
Not applicable. Test-only change with no user-facing UI change.
Checklist:
Fixes #<issue-number>above.