From 732e7393d39078ef252b29d8d291aa1b78abc3e8 Mon Sep 17 00:00:00 2001 From: Pavel Feldman Date: Tue, 11 Jun 2024 16:05:21 -0700 Subject: [PATCH] =?UTF-8?q?Revert=20"feat(test):=20add=20`URL`=20field=20t?= =?UTF-8?q?o=20annotations=20for=20hyperlink=20disp=E2=80=A6=20(#31259)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit …lay (#30665)" --- docs/src/test-api/class-test.md | 18 ++---------------- .../html-reporter/src/testCaseView.spec.tsx | 4 ++-- packages/html-reporter/src/types.ts | 2 +- packages/playwright/src/common/config.ts | 2 +- packages/playwright/types/test.d.ts | 6 ++---- 5 files changed, 8 insertions(+), 24 deletions(-) diff --git a/docs/src/test-api/class-test.md b/docs/src/test-api/class-test.md index 7b03353361..9b56fbf2e6 100644 --- a/docs/src/test-api/class-test.md +++ b/docs/src/test-api/class-test.md @@ -71,8 +71,7 @@ import { test, expect } from '@playwright/test'; test('basic test', { annotation: { type: 'issue', - description: 'feature tags API', - url: 'https://github.com/microsoft/playwright/issues/23180' + description: 'https://github.com/microsoft/playwright/issues/23180', }, }, async ({ page }) => { await page.goto('https://playwright.dev/'); @@ -98,8 +97,7 @@ Test title. - `tag` ?<[string]|[Array]<[string]>> - `annotation` ?<[Object]|[Array]<[Object]>> - `type` <[string]> Annotation type, for example `'issue'`. - - `description` ?<[string]> Optional annotation description. - - `url` ?<[string]> Optional for example an issue url. + - `description` ?<[string]> Optional annotation description, for example an issue url. Additional test details. @@ -442,7 +440,6 @@ Group title. - `annotation` ?<[Object]|[Array]<[Object]>> - `type` <[string]> - `description` ?<[string]> - - `url` ?<[string]> Additional details for all tests in the group. @@ -571,7 +568,6 @@ Group title. - `annotation` ?<[Object]|[Array]<[Object]>> - `type` <[string]> - `description` ?<[string]> - - `url` ?<[string]> See [`method: Test.describe`] for details description. @@ -627,7 +623,6 @@ Group title. - `annotation` ?<[Object]|[Array]<[Object]>> - `type` <[string]> - `description` ?<[string]> - - `url` ?<[string]> See [`method: Test.describe`] for details description. @@ -681,7 +676,6 @@ Group title. - `annotation` ?<[Object]|[Array]<[Object]>> - `type` <[string]> - `description` ?<[string]> - - `url` ?<[string]> See [`method: Test.describe`] for details description. @@ -733,7 +727,6 @@ Group title. - `annotation` ?<[Object]|[Array]<[Object]>> - `type` <[string]> - `description` ?<[string]> - - `url` ?<[string]> See [`method: Test.describe`] for details description. @@ -789,7 +782,6 @@ Group title. - `annotation` ?<[Object]|[Array]<[Object]>> - `type` <[string]> - `description` ?<[string]> - - `url` ?<[string]> See [`method: Test.describe`] for details description. @@ -847,7 +839,6 @@ Group title. - `annotation` ?<[Object]|[Array]<[Object]>> - `type` <[string]> - `description` ?<[string]> - - `url` ?<[string]> See [`method: Test.describe`] for details description. @@ -900,7 +891,6 @@ Group title. - `annotation` ?<[Object]|[Array]<[Object]>> - `type` <[string]> - `description` ?<[string]> - - `url` ?<[string]> See [`method: Test.describe`] for details description. @@ -1119,7 +1109,6 @@ Test title. - `annotation` ?<[Object]|[Array]<[Object]>> - `type` <[string]> - `description` ?<[string]> - - `url` ?<[string]> See [`method: Test.(call)`] for test details description. @@ -1225,7 +1214,6 @@ Test title. - `annotation` ?<[Object]|[Array]<[Object]>> - `type` <[string]> - `description` ?<[string]> - - `url` ?<[string]> See [`method: Test.(call)`] for test details description. @@ -1303,7 +1291,6 @@ Test title. - `annotation` ?<[Object]|[Array]<[Object]>> - `type` <[string]> - `description` ?<[string]> - - `url` ?<[string]> See [`method: Test.(call)`] for test details description. @@ -1449,7 +1436,6 @@ Test title. - `annotation` ?<[Object]|[Array]<[Object]>> - `type` <[string]> - `description` ?<[string]> - - `url` ?<[string]> See [`method: Test.(call)`] for test details description. diff --git a/packages/html-reporter/src/testCaseView.spec.tsx b/packages/html-reporter/src/testCaseView.spec.tsx index 0a4da91b6e..28fe8247f5 100644 --- a/packages/html-reporter/src/testCaseView.spec.tsx +++ b/packages/html-reporter/src/testCaseView.spec.tsx @@ -52,8 +52,8 @@ const testCase: TestCase = { projectName: 'chromium', location: { file: 'test.spec.ts', line: 42, column: 0 }, annotations: [ - { type: 'annotation', description: 'Annotation text', url: 'example url' }, - { type: 'annotation', description: 'Another annotation text', url: 'Another example url' }, + { type: 'annotation', description: 'Annotation text' }, + { type: 'annotation', description: 'Another annotation text' }, ], tags: [], outcome: 'expected', diff --git a/packages/html-reporter/src/types.ts b/packages/html-reporter/src/types.ts index 79dc2f3812..733e88e8b9 100644 --- a/packages/html-reporter/src/types.ts +++ b/packages/html-reporter/src/types.ts @@ -59,7 +59,7 @@ export type TestFileSummary = { stats: Stats; }; -export type TestCaseAnnotation = { type: string, description?: string, url?: string}; +export type TestCaseAnnotation = { type: string, description?: string }; export type TestCaseSummary = { testId: string, diff --git a/packages/playwright/src/common/config.ts b/packages/playwright/src/common/config.ts index ac7b313820..025b7e3838 100644 --- a/packages/playwright/src/common/config.ts +++ b/packages/playwright/src/common/config.ts @@ -35,7 +35,7 @@ export type FixturesWithLocation = { fixtures: Fixtures; location: Location; }; -export type Annotation = { type: string, description?: string, url?: string }; +export type Annotation = { type: string, description?: string }; export const defaultTimeout = 30000; diff --git a/packages/playwright/types/test.d.ts b/packages/playwright/types/test.d.ts index 3d68c341e8..2b1f105d7e 100644 --- a/packages/playwright/types/test.d.ts +++ b/packages/playwright/types/test.d.ts @@ -2198,8 +2198,7 @@ interface TestFunction { * test('basic test', { * annotation: { * type: 'issue', - * description: 'feature tags API', - * url: 'https://github.com/microsoft/playwright/issues/23180' + * description: 'https://github.com/microsoft/playwright/issues/23180', * }, * }, async ({ page }) => { * await page.goto('https://playwright.dev/'); @@ -2275,8 +2274,7 @@ interface TestFunction { * test('basic test', { * annotation: { * type: 'issue', - * description: 'feature tags API', - * url: 'https://github.com/microsoft/playwright/issues/23180' + * description: 'https://github.com/microsoft/playwright/issues/23180', * }, * }, async ({ page }) => { * await page.goto('https://playwright.dev/');