Skip to content

fix(playwright): point Api Service test connection at a raw GitHub fixture URL - #30866

Merged
mohittilala merged 1 commit into
mainfrom
fix/api-service-test-connection-raw-url
Aug 4, 2026
Merged

fix(playwright): point Api Service test connection at a raw GitHub fixture URL#30866
mohittilala merged 1 commit into
mainfrom
fix/api-service-test-connection-raw-url

Conversation

@mohittilala

Copy link
Copy Markdown
Contributor

Describe your changes:

Fixes #

I worked on the Api Service › Create & Ingest Api Service service Playwright 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.ci copies 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.com pattern already used by ContextCenter.spec.ts.

Type of change:

  • Bug fix

High-level design:

Not applicable. Single-file Playwright test-helper change.

Tests:

Use cases covered

  • Api Service (REST) create and ingest flow: the connection test step resolves the OpenAPI schema over its URL and the test proceeds.

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

  • Updated: openmetadata-ui/src/main/resources/ui/playwright/support/entity/ingestion/ApiIngestionClass.ts

Manual testing performed

  1. Confirmed the fixture URL returns HTTP 200 and valid OpenAPI 3.0.0: https://raw.githubusercontent.com/open-metadata/OpenMetadata/main/ingestion/examples/openapi/sample.json
  2. Ran Prettier and ESLint on the changed file; both clean.
  3. Final end-to-end verification is the Api Service Playwright E2E run going green in CI.

UI screen recording / screenshots:

Not applicable. Test-only change with no user-facing UI change.

Checklist:

  • I have read the CONTRIBUTING document.
  • My PR is linked to a GitHub issue via Fixes #<issue-number> above.
  • I have commented on my code, particularly in hard-to-understand areas.
  • For UI changes: not applicable (test-only, no screen recording needed).
  • I have added/updated tests (this updates the Playwright test itself) and listed them above.

Copilot AI review requested due to automatic review settings August 3, 2026 10:13
@mohittilala
mohittilala requested a review from a team as a code owner August 3, 2026 10:13
@github-actions

github-actions Bot commented Aug 3, 2026

Copy link
Copy Markdown
Contributor

❌ PR checklist incomplete

This PR cannot be merged until the following are addressed on its linked issue:

  • No GitHub issue is linked. Link an issue in the Development section of the PR (or add Fixes #12345 to the description). For a same-org cross-repo issue, add Fixes open-metadata/<repo>#123 to the description.

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 skip-pr-checks label.

@github-actions github-actions Bot added Ingestion safe to test Add this label to run secure Github workflows on PRs labels Aug 3, 2026
@gitar-bot

gitar-bot Bot commented Aug 3, 2026

Copy link
Copy Markdown
Code Review ✅ Approved

Updates 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.

Options

Display: compact → Showing less information.

Comment with these commands to change the behavior for this request:

Compact
gitar display:verbose         

Was this helpful? React with 👍 / 👎 | Gitar | Powered by Gitar — free for open source

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.com fixture URL.
  • Update the form interaction to select the “Open API Schema URL” connection option and fill openAPISchemaURL.

@mohittilala mohittilala added To release Will cherry-pick this PR into the release branch skip-pr-checks Bypass PR metadata validation check labels Aug 3, 2026
@mohittilala mohittilala added safe to test Add this label to run secure Github workflows on PRs and removed To release Will cherry-pick this PR into the release branch safe to test Add this label to run secure Github workflows on PRs labels Aug 3, 2026
@github-actions

github-actions Bot commented Aug 3, 2026

Copy link
Copy Markdown
Contributor

✅ Playwright Results — workflow succeeded

Validated commit b83ed7cf72564c147e3315c862946d03ac19ff88 in Playwright run 30807505194, attempt 1.

✅ 549 passed · ❌ 0 failed · 🟡 1 flaky · ⏭️ 3 skipped · 🧰 0 lifecycle flaky

Performance

Blocking 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:

  • Browser traffic was 201.14 requests per attempt (convergence target: fewer than 200).
  • Application boot ratio was 2.83 per UI scenario (1620 boots / 572 scenarios; convergence target: at most 1).
Shard Passed Failed Flaky Skipped Lifecycle failed Lifecycle flaky
🟡 Shard chromium-01 138 0 1 3 0 0
✅ Shard chromium-02 136 0 0 0 0 0
✅ Shard chromium-03 124 0 0 0 0 0
✅ Shard data-asset-rules-01 61 0 0 0 0 0
✅ Shard domain-isolation-01 14 0 0 0 0 0
✅ Shard global-state-01 34 0 0 0 0 0
✅ Shard ingestion-01 1 0 0 0 0 0
✅ Shard reindex-01 2 0 0 0 0 0
✅ Shard search-01 10 0 0 0 0 0
✅ Shard search-rbac-01 29 0 0 0 0 0
🟡 1 flaky test(s) (passed on retry)
  • Pages/Entity.spec.tsDomain Propagation (shard chromium-01, 1 retry)

📦 Download artifacts

How to debug locally
# Download playwright-test-results-<shard> artifact and unzip
npx playwright show-trace path/to/trace.zip    # view trace

@mohittilala
mohittilala added this pull request to the merge queue Aug 3, 2026
Merged via the queue into main with commit 21a4902 Aug 4, 2026
230 of 237 checks passed
@mohittilala
mohittilala deleted the fix/api-service-test-connection-raw-url branch August 4, 2026 00:34
@mohittilala

Copy link
Copy Markdown
Contributor Author

Manually cherry-picked to 2.0 b6f1025

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Ingestion safe to test Add this label to run secure Github workflows on PRs skip-pr-checks Bypass PR metadata validation check

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants