Skip to content

OpenPanel is an open-source web and product analytics platform, an open-source alternative to Mixpanel with optional self-hosting.

test(dashboard): replace QA bug ids in e2e comments with plain statements

Carl-Gerhard Lindesvärd693672861645
diff --git a/apps/start/e2e/auth-onboarding.spec.ts b/apps/start/e2e/auth-onboarding.spec.ts
index c33d95adf..fcd4bc616 100644
--- a/apps/start/e2e/auth-onboarding.spec.ts
+++ b/apps/start/e2e/auth-onboarding.spec.ts
@@ -366,9 +366,8 @@ test('a website project leads to the connect step with its one-time credentials'
expect(issues.unexpected()).toEqual([]);
});
-// BUG "`LinkButton href` renders a link to the current page": TanStack's
-// `Link` builds its href from `to`, so `href` is dropped and `target="_blank"`
-// links open the page you are already on.
+// Open defect: TanStack's `Link` builds its href from `to`, so a LinkButton's
+// `href` is dropped and `target="_blank"` links open the page you are already on.
test('"More details" in the framework instructions links to the docs', async ({
page,
context,
@@ -544,8 +543,8 @@ test('the profile tab edits the name and keeps it after a reload', async ({
expect(issues.unexpected()).toEqual([]);
});
-// BUG "Profile form shows a raw validation dump for an empty name": the form's
-// own schema accepts '', the API does not, and the toast prints the Zod issues.
+// Open defect: the form's own schema accepts '', the API does not, and the
+// toast prints the raw Zod issues.
test('an empty first name is refused with a readable message', async ({
page,
context,
diff --git a/apps/start/e2e/auth-recovery.spec.ts b/apps/start/e2e/auth-recovery.spec.ts
index a5bffb60a..2e3bff302 100644
--- a/apps/start/e2e/auth-recovery.spec.ts
+++ b/apps/start/e2e/auth-recovery.spec.ts
@@ -88,8 +88,8 @@ test('/reset-password refuses an unknown token and keeps the visitor on the page
expect(issues.unexpected([/auth\.resetPassword/])).toEqual([]);
});
-// BUG "Reset password form swallows validation errors": the input is rendered
-// without the `error` prop, so a too-short password makes the button do nothing.
+// Open defect: the password input is rendered without the `error` prop, so a
+// too-short password makes the button do nothing.
test('/reset-password tells the visitor when the new password is too short', async ({
page,
}) => {
diff --git a/apps/start/e2e/auth-session.spec.ts b/apps/start/e2e/auth-session.spec.ts
index dd1987e97..33e5e8aa8 100644
--- a/apps/start/e2e/auth-session.spec.ts
+++ b/apps/start/e2e/auth-session.spec.ts
@@ -43,8 +43,8 @@ test('an invalid session cookie is treated as signed out, not as an error', asyn
expect(guarded.status()).toBe(401);
});
-// BUG "A stale `session` cookie ahead of a valid one locks the user out": the
-// API reads only the first `session` value of the Cookie header.
+// Open defect: the API reads only the first `session` value of the Cookie
+// header, so a stale cookie ahead of a valid one locks the user out.
test('a stale session cookie next to a fresh one does not block signing in', async ({
page,
context,
diff --git a/apps/start/e2e/org-create-project.spec.ts b/apps/start/e2e/org-create-project.spec.ts
index 016d78e9b..e32b2ac5e 100644
--- a/apps/start/e2e/org-create-project.spec.ts
+++ b/apps/start/e2e/org-create-project.spec.ts
@@ -187,7 +187,7 @@ test('a website + backend project is created with its domains and leads into set
expect(apiFailures(problems)).toEqual([]);
});
-// BUG org-3: project.create hardcodes `types: []`, so the choice made in this
+// Open defect: project.create hardcodes `types: []`, so the choice made in this
// modal is dropped (onboarding's first project keeps it).
test('the tracking types chosen in the modal are stored on the project', async ({
page,
diff --git a/apps/start/e2e/org-members.spec.ts b/apps/start/e2e/org-members.spec.ts
index 3f4626364..fde750be4 100644
--- a/apps/start/e2e/org-members.spec.ts
+++ b/apps/start/e2e/org-members.spec.ts
@@ -288,7 +288,7 @@ test('an admin invite with project access shows in the list and can be copied an
await guestContext.close();
});
-// BUG org-8: the picker offers "Pick '<typed text>'" for anything that is not a project.
+// Open defect: the picker offers "Pick '<typed text>'" for anything that is not a project.
test('the project access picker only offers projects', async ({
page,
seed,
@@ -428,7 +428,7 @@ test.describe('an invited member', () => {
}
});
- // BUG org-0: removeMember and updateMemberAccess do not clear the 5-minute
+ // Open defect: removeMember and updateMemberAccess do not clear the 5-minute
// access cache, so the removed user keeps reading project data.
test('loses access as soon as an admin removes them', async ({
page,
diff --git a/apps/start/e2e/org-projects.spec.ts b/apps/start/e2e/org-projects.spec.ts
index f0624944f..59aea9592 100644
--- a/apps/start/e2e/org-projects.spec.ts
+++ b/apps/start/e2e/org-projects.spec.ts
@@ -78,7 +78,7 @@ test('a card links to the project and its cog opens project settings', async ({
await expect(page).toHaveURL(/\/acme\/acme-shop$/);
});
-// BUG org-1: LinkButton passes `href` to TanStack's <Link>, which renders the
+// Open defect: LinkButton passes `href` to TanStack's <Link>, which renders the
// current location instead. Open-in-new-tab and copy-link go to /acme.
test('the cog on a card carries the project settings href', async ({
page,
@@ -179,7 +179,7 @@ test('an organization the user is not a member of is refused', async ({
await shot(page, 'foreign-org');
});
-// BUG org-2: same LinkButton `href` problem; the button points at the page it is on.
+// Open defect: same LinkButton `href` problem; the button points at the page it is on.
test('"Go to home" on the not-found page leaves the page', async ({ page }) => {
await gotoHydrated(page, '/e2e-org-not-a-member');
const home = page.getByRole('link', { name: 'Go to home' });
diff --git a/apps/start/e2e/org-settings.spec.ts b/apps/start/e2e/org-settings.spec.ts
index 7c3a9ad39..eb4469007 100644
--- a/apps/start/e2e/org-settings.spec.ts
+++ b/apps/start/e2e/org-settings.spec.ts
@@ -80,7 +80,7 @@ test('the name can be changed and restored', async ({ page, seed }) => {
expectNoCrashes(problems);
});
-// BUG org-7: saving refetches organization.get only; the sidebar reads organization.list.
+// Open defect: saving refetches organization.get only; the sidebar reads organization.list.
test('the sidebar shows the new name right after a rename', async ({
page,
}) => {
@@ -97,7 +97,7 @@ test('the sidebar shows the new name right after a rename', async ({
}
});
-// BUG org-5: the form has no resolver, so the server's zod issue list is shown raw.
+// Open defect: the form has no resolver, so the server's zod issue list is shown raw.
test('a too short name gets a readable validation message', async ({
page,
seed,
@@ -138,7 +138,7 @@ test('the timezone can be changed, survives a reload and is restored', async ({
}
});
-// BUG org-6: 419 zones in a list that cannot be searched.
+// Open defect: 419 zones in a list that cannot be searched.
test('the timezone picker can be searched', async ({ page }) => {
await timezonePicker(page).click();
await expect(page.getByRole('option').first()).toBeVisible();
diff --git a/apps/start/e2e/settings-notifications.spec.ts b/apps/start/e2e/settings-notifications.spec.ts
index 8e9172ae5..3dad48522 100644
--- a/apps/start/e2e/settings-notifications.spec.ts
+++ b/apps/start/e2e/settings-notifications.spec.ts
@@ -210,7 +210,7 @@ test('the rule modal validates, lists every template variable and creates an eve
template: TEMPLATE,
config: { type: 'events', events: [{ name: TRIGGER_EVENT }] },
});
- // Opening the event picker logs a React list-key warning; reported separately.
+ // Opening the event picker logs a React list-key warning; known, so it is filtered out below.
expect(
issues.list.filter((issue) => !issue.includes('unique "key"'))
).toEqual([]);
@@ -256,7 +256,7 @@ test('a matching event produces an in-app notification with the template filled
await expect(row).toHaveCount(0);
await page.getByPlaceholder('Search').fill('plan=pro');
await expect(row).toHaveCount(1);
- // The table logs a React setState-in-render warning; reported separately.
+ // The table logs a React setState-in-render warning; known, so it is filtered out below.
expect(
issues.list.filter((issue) => !issue.includes('Cannot update a component'))
).toEqual([]);
@@ -317,7 +317,7 @@ test('a rule is deleted after confirmation', async ({ page }) => {
await expect(page.getByText('Rule deleted')).toBeVisible(SLOW_ASSERT);
await expect(page.getByText('No rules yet')).toBeVisible(SLOW_ASSERT);
expect(await fetchRules()).toEqual([]);
- // The funnel card renders its events without keys; reported separately.
+ // The funnel card renders its events without keys; known, so it is filtered out below.
expect(
issues.list.filter((issue) => !issue.includes('unique "key"'))
).toEqual([]);