From fcdb27a05612b510e3737fc8ee73cd442ec0c6fc Mon Sep 17 00:00:00 2001 From: AaronPlave Date: Fri, 13 Nov 2026 14:46:26 -0800 Subject: [PATCH 1/5] Add plan descriptions to plan creation and metadata views. --- e2e-tests/tests/plan-metadata.test.ts | 29 ++++++++ e2e-tests/tests/plans.test.ts | 8 +++ src/components/plan/PlanForm.svelte | 23 ++++++ src/components/plan/PlanForm.svelte.test.ts | 80 +++++++++++++++++++++ src/components/plan/PlanMergeReview.test.ts | 1 + src/routes/plans/+page.svelte | 29 +++++++- src/types/plan.ts | 5 +- src/utilities/activities.test.ts | 1 + src/utilities/effects.test.ts | 41 +++++++++++ src/utilities/effects.ts | 4 ++ src/utilities/gql.ts | 5 ++ src/utilities/plan.test.ts | 3 + 12 files changed, 227 insertions(+), 2 deletions(-) create mode 100644 src/components/plan/PlanForm.svelte.test.ts diff --git a/e2e-tests/tests/plan-metadata.test.ts b/e2e-tests/tests/plan-metadata.test.ts index abadc1285e..4aa0bfc20e 100644 --- a/e2e-tests/tests/plan-metadata.test.ts +++ b/e2e-tests/tests/plan-metadata.test.ts @@ -145,6 +145,32 @@ test.afterAll(async () => { }); test.describe.serial('Plan Metadata', () => { + test('Description can be edited, read on both pages, and cleared', async () => { + await planA.showPanel(PanelNames.PLAN_METADATA, true); + const description = planA.panelPlanMetadata.getByLabel('Description', { exact: true }); + const value = 'Plan purpose\nSecond line '; + await description.fill(value); + await description.press('Tab'); + await expect(setupA.page.getByText('Plan Updated Successfully', { exact: true })).toBeVisible(); + await setupA.page.reload(); + await expect(description).toHaveValue(value); + + await plansA.goto(); + await plansA.filterTable(planA.planName); + await plansA.tableRow(planA.planName).click(); + const selectedDescription = setupA.page.getByLabel('Description', { exact: true }); + await expect(selectedDescription).toHaveValue(value); + await expect(selectedDescription).toHaveAttribute('readonly', ''); + + await planA.goto(String(planAId)); + await planA.showPanel(PanelNames.PLAN_METADATA, true); + await description.fill(''); + await description.press('Tab'); + await expect(setupA.page.getByText('Plan Updated Successfully', { exact: true })).toBeVisible(); + await setupA.page.reload(); + await expect(description).toHaveValue(''); + }); + test('Plan should be re-nameable', async () => { await planA.showPanel(PanelNames.PLAN_METADATA, true); await planA.renamePlan(planA.planName + '_renamed'); @@ -183,6 +209,9 @@ test.describe.serial('Plan Metadata', () => { await planAForUserB.showPanel(PanelNames.PLAN_METADATA, true); await planAForUserB.waitForPlanCollaboratorLoad(); await expect(planAForUserB.planCollaboratorInputContainer).toHaveAttribute('readonly'); + const description = planAForUserB.panelPlanMetadata.getByLabel('Description', { exact: true }); + await expect(description).toHaveAttribute('readonly', ''); + await expect(description).toBeEnabled(); }); test(`userB can be added as a plan collaborator to userA's plan`, async () => { diff --git a/e2e-tests/tests/plans.test.ts b/e2e-tests/tests/plans.test.ts index 49c564a5d2..c596aa5285 100644 --- a/e2e-tests/tests/plans.test.ts +++ b/e2e-tests/tests/plans.test.ts @@ -111,7 +111,15 @@ test.describe('Plans - Form Validation', () => { test.describe.serial('Plans - CRUD Operations', () => { test('Create plan', async () => { await setup.plans.goto(); + await setup.page.getByLabel('Description', { exact: true }).fill('Created description\nSecond line'); await setup.plans.createPlan(); + await expect(setup.page.getByLabel('Description', { exact: true })).toHaveValue(''); + await setup.plans.tableRow(setup.plans.planName).click(); + await expect(setup.page.getByLabel('Description', { exact: true })).toHaveValue('Created description\nSecond line'); + await setup.page.reload(); + await setup.plans.filterTable(setup.plans.planName); + await setup.plans.tableRow(setup.plans.planName).click(); + await expect(setup.page.getByLabel('Description', { exact: true })).toHaveValue('Created description\nSecond line'); }); test('Delete plan', async () => { diff --git a/src/components/plan/PlanForm.svelte b/src/components/plan/PlanForm.svelte index 5aaefb635e..d48c3cf1ea 100644 --- a/src/components/plan/PlanForm.svelte +++ b/src/components/plan/PlanForm.svelte @@ -72,6 +72,7 @@ 'Plan name already exists', ), ]); + let planDescription: string = ''; let planExporting: boolean = false; $: permissionError = $planReadOnly ? PlanStatusMessages.READ_ONLY : 'You do not have permission to edit this plan.'; @@ -109,6 +110,7 @@ } $: if (plan) { planNameField.validateAndSet(plan?.name ?? ''); + planDescription = plan.description ?? ''; } async function onTagsInputChange(event: TagsChangeEvent) { @@ -172,6 +174,12 @@ } } + async function onPlanDescriptionChange() { + if (plan && hasPlanUpdatePermission && planDescription !== (plan.description ?? '')) { + await effects.updatePlan(plan, { description: planDescription }, user); + } + } + async function onExportPlan() { if (plan && !planExporting && !$planImportRequest && activityDirectivesMap) { planExporting = true; @@ -224,6 +232,21 @@ + + +