From a7659184ca300ab863a14d54c18a14426ef34406 Mon Sep 17 00:00:00 2001 From: Jeff Daley Date: Tue, 6 Feb 2024 11:36:44 -0500 Subject: [PATCH 01/27] Add doc number logic to editable field --- web/app/components/document/sidebar.hbs | 2 ++ web/app/components/editable-field.hbs | 13 +++++++++++++ web/app/components/editable-field.ts | 7 +++++++ 3 files changed, 22 insertions(+) diff --git a/web/app/components/document/sidebar.hbs b/web/app/components/document/sidebar.hbs index d76f4eb56..f0a6c2d7d 100644 --- a/web/app/components/document/sidebar.hbs +++ b/web/app/components/document/sidebar.hbs @@ -85,6 +85,8 @@ data-test-editable={{this.isOwner}} @value={{this.title}} @onSave={{this.saveTitle}} + {{! provide for the docNumber }} + @document={{@document}} @isSaving={{this.saveIsRunning}} @isReadOnly={{this.editingIsDisabled}} @isRequired={{true}} diff --git a/web/app/components/editable-field.hbs b/web/app/components/editable-field.hbs index a8519dac4..72ac7880f 100644 --- a/web/app/components/editable-field.hbs +++ b/web/app/components/editable-field.hbs @@ -1,6 +1,8 @@
@@ -37,6 +39,8 @@ name={{@name}} as |F| > + {{! FIXME: }} + {{! need the height o;f this }} {{#if this.emptyValueErrorIsShown}} This field is required {{/if}} @@ -100,4 +104,13 @@ {{/if}} {{/if}} + + {{#if this.docNumberIsShown}} +
+ {{@document.docNumber}} +
+ {{/if}}
diff --git a/web/app/components/editable-field.ts b/web/app/components/editable-field.ts index 4fb555d3b..2459bc362 100644 --- a/web/app/components/editable-field.ts +++ b/web/app/components/editable-field.ts @@ -95,6 +95,13 @@ export default class EditableFieldComponent extends Component Date: Tue, 6 Feb 2024 12:40:50 -0500 Subject: [PATCH 02/27] Rearrange status --- web/app/components/doc/state.ts | 2 +- web/app/components/document/sidebar.hbs | 42 ++++++++++--------------- web/app/components/editable-field.hbs | 2 +- web/app/components/editable-field.ts | 3 +- web/app/styles/components/sidebar.scss | 9 +++--- 5 files changed, 25 insertions(+), 33 deletions(-) diff --git a/web/app/components/doc/state.ts b/web/app/components/doc/state.ts index 523d6cc63..06d137435 100644 --- a/web/app/components/doc/state.ts +++ b/web/app/components/doc/state.ts @@ -44,7 +44,7 @@ export default class DocStateComponent extends Component
+ {{! div to break the parent's space-y styles }}
- {{! div to break the parent's space-y styles }} -
- + + {{! visibility toggle }} {{#if (and this.isDraft this.isOwner (not this.editingIsDisabled))}}
- {{! Status }} -
- -
- - -
+ {{! Doctype }} + {{! Add bgColor to make badge `multiply` work }} +
+ +
{{! Product/Area }} diff --git a/web/app/components/editable-field.hbs b/web/app/components/editable-field.hbs index 72ac7880f..60e79a8e6 100644 --- a/web/app/components/editable-field.hbs +++ b/web/app/components/editable-field.hbs @@ -107,7 +107,7 @@ {{#if this.docNumberIsShown}}
{{@document.docNumber}} diff --git a/web/app/components/editable-field.ts b/web/app/components/editable-field.ts index 2459bc362..cdb9b01d4 100644 --- a/web/app/components/editable-field.ts +++ b/web/app/components/editable-field.ts @@ -96,7 +96,8 @@ export default class EditableFieldComponent extends Component Date: Tue, 6 Feb 2024 12:46:47 -0500 Subject: [PATCH 03/27] Fix tests --- web/app/components/document/sidebar.hbs | 1 + .../acceptance/authenticated/document-test.ts | 25 ++++++++++++++++--- 2 files changed, 22 insertions(+), 4 deletions(-) diff --git a/web/app/components/document/sidebar.hbs b/web/app/components/document/sidebar.hbs index 840939ecd..69935aac7 100644 --- a/web/app/components/document/sidebar.hbs +++ b/web/app/components/document/sidebar.hbs @@ -21,6 +21,7 @@ {{! Add bgColor to make badge `multiply` work }}
Date: Tue, 6 Feb 2024 13:11:03 -0500 Subject: [PATCH 04/27] Rename to status --- .../components/doc/{state.hbs => status.hbs} | 6 +-- .../components/doc/{state.ts => status.ts} | 16 ++++---- web/app/components/doc/tile-medium.hbs | 4 +- web/app/components/doc/tile.hbs | 2 +- web/app/components/document/sidebar.hbs | 4 +- web/app/components/table/row.hbs | 2 +- .../doc/{state.scss => status.scss} | 6 +-- .../doc/{state-test.js => state-test.ts} | 37 +++++++++++-------- 8 files changed, 41 insertions(+), 36 deletions(-) rename web/app/components/doc/{state.hbs => status.hbs} (70%) rename web/app/components/doc/{state.ts => status.ts} (72%) rename web/app/styles/components/doc/{state.scss => status.scss} (82%) rename web/tests/integration/components/doc/{state-test.js => state-test.ts} (57%) diff --git a/web/app/components/doc/state.hbs b/web/app/components/doc/status.hbs similarity index 70% rename from web/app/components/doc/state.hbs rename to web/app/components/doc/status.hbs index 433459831..3e723778e 100644 --- a/web/app/components/doc/state.hbs +++ b/web/app/components/doc/status.hbs @@ -1,6 +1,6 @@ {{#unless @hideProgress}}
  1. @@ -10,8 +10,8 @@ {{/unless}} diff --git a/web/app/components/doc/state.ts b/web/app/components/doc/status.ts similarity index 72% rename from web/app/components/doc/state.ts rename to web/app/components/doc/status.ts index 06d137435..ae67d7720 100644 --- a/web/app/components/doc/state.ts +++ b/web/app/components/doc/status.ts @@ -1,19 +1,19 @@ import { dasherize } from "@ember/string"; import Component from "@glimmer/component"; -interface DocStateComponentSignature { +interface DocStatusComponentSignature { Element: HTMLDivElement; Args: { - state?: string; + status?: string; hideProgress?: boolean; }; } -export default class DocStateComponent extends Component { +export default class DocStatusComponent extends Component { protected get dasherizedName() { let name = ""; - if (typeof this.args.state === "string") { - name = dasherize(this.args.state); + if (typeof this.args.status === "string") { + name = dasherize(this.args.status); } switch (name) { case "in-review": @@ -25,7 +25,7 @@ export default class DocStateComponent extends Component {{! Status }} - diff --git a/web/app/components/doc/tile.hbs b/web/app/components/doc/tile.hbs index 040701978..6fa77f093 100644 --- a/web/app/components/doc/tile.hbs +++ b/web/app/components/doc/tile.hbs @@ -22,7 +22,7 @@ @product={{@productArea}} @size="large" /> - +

diff --git a/web/app/components/document/sidebar.hbs b/web/app/components/document/sidebar.hbs index 69935aac7..f10a697db 100644 --- a/web/app/components/document/sidebar.hbs +++ b/web/app/components/document/sidebar.hbs @@ -20,9 +20,9 @@
{{! Add bgColor to make badge `multiply` work }}
-
- +
diff --git a/web/app/styles/components/doc/state.scss b/web/app/styles/components/doc/status.scss similarity index 82% rename from web/app/styles/components/doc/state.scss rename to web/app/styles/components/doc/status.scss index 1fc130414..c8aa3be44 100644 --- a/web/app/styles/components/doc/state.scss +++ b/web/app/styles/components/doc/status.scss @@ -1,4 +1,4 @@ -.doc-state { +.doc-status { .progress-bar { @apply h-0.5 rounded-full bg-color-palette-neutral-200; } @@ -14,7 +14,7 @@ @apply bg-color-palette-purple-200 opacity-75; } li:nth-child(2) { - @apply bg-color-palette-purple-200 h-1; + @apply h-1 bg-color-palette-purple-200; } } @@ -23,7 +23,7 @@ @apply bg-color-palette-green-200 opacity-75; } li:nth-child(3) { - @apply opacity-100 h-1; + @apply h-1 opacity-100; } } } diff --git a/web/tests/integration/components/doc/state-test.js b/web/tests/integration/components/doc/state-test.ts similarity index 57% rename from web/tests/integration/components/doc/state-test.js rename to web/tests/integration/components/doc/state-test.ts index 93abc87db..18d2ebe0e 100644 --- a/web/tests/integration/components/doc/state-test.js +++ b/web/tests/integration/components/doc/state-test.ts @@ -1,49 +1,54 @@ import { module, test } from "qunit"; import { setupRenderingTest } from "ember-qunit"; -import { render } from "@ember/test-helpers"; +import { TestContext, render } from "@ember/test-helpers"; import { hbs } from "ember-cli-htmlbars"; +interface Context extends TestContext { + hideProgress: boolean; + status: string; +} + module("Integration | Component | doc/state", function (hooks) { setupRenderingTest(hooks); test("it renders correctly for every state", async function (assert) { this.set("hideProgress", false); - this.set("state", "In review"); + this.set("status", "In review"); - await render(hbs` - (hbs` + `); // In Review - assert.dom(".doc-state--in-review").exists(); + assert.dom(".doc-status--in-review").exists(); assert.dom(".hds-badge--color-highlight").hasText("In review"); // Approved - this.set("state", "Approved"); + this.set("status", "Approved"); - assert.dom(".doc-state--approved").exists(); + assert.dom(".doc-status--approved").exists(); assert.dom(".hds-badge--color-success").hasText("Approved"); // Obsolete - this.set("state", "Obsolete"); - assert.dom(".doc-state--obsolete").exists(); + this.set("status", "Obsolete"); + assert.dom(".doc-status--obsolete").exists(); assert.dom(".hds-badge--color-neutral").hasText("Obsolete"); - // WIP - this.set("state", "any text"); - assert.dom(".doc-state--wip").exists(); + // Draft + this.set("status", "any text"); + assert.dom(".doc-status--wip").exists(); assert.dom(".hds-badge--color-neutral").hasText("WIP"); - this.set("state", undefined); + this.set("status", undefined); assert.dom(".hds-badge--color-neutral").hasText("WIP"); - this.set("state", null); + this.set("status", null); assert.dom(".hds-badge--color-neutral").hasText("WIP"); - this.set("state", true); + this.set("status", true); assert.dom(".hds-badge--color-neutral").hasText("WIP"); }); }); From c4bdb97eb2571a7d6be97505eff7dbd14299f05b Mon Sep 17 00:00:00 2001 From: Jeff Daley Date: Tue, 6 Feb 2024 13:21:11 -0500 Subject: [PATCH 05/27] Update app.scss --- web/app/styles/app.scss | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/web/app/styles/app.scss b/web/app/styles/app.scss index 6ff960ebe..bcff868fc 100644 --- a/web/app/styles/app.scss +++ b/web/app/styles/app.scss @@ -33,7 +33,7 @@ @use "components/doc/thumbnail"; @use "components/doc/folder-affordance"; @use "components/doc/tile" as doc-tile; -@use "components/doc/state"; +@use "components/doc/status"; @use "components/table/sortable-header"; @use "components/preview-card"; @use "components/project"; From 6794b2cf460dd8edacb9590a4824cc036bff4b92 Mon Sep 17 00:00:00 2001 From: Jeff Daley Date: Tue, 6 Feb 2024 16:15:51 -0500 Subject: [PATCH 06/27] Cleanup and add test --- web/app/components/editable-field.hbs | 5 +- web/app/styles/components/sidebar.scss | 3 +- .../components/editable-field-test.ts | 61 +++++++++++++++++++ 3 files changed, 63 insertions(+), 6 deletions(-) diff --git a/web/app/components/editable-field.hbs b/web/app/components/editable-field.hbs index 60e79a8e6..097d3addc 100644 --- a/web/app/components/editable-field.hbs +++ b/web/app/components/editable-field.hbs @@ -1,6 +1,5 @@
- {{! FIXME: }} - {{! need the height o;f this }} {{#if this.emptyValueErrorIsShown}} This field is required {{/if}} @@ -107,7 +104,7 @@ {{#if this.docNumberIsShown}}
{{@document.docNumber}} diff --git a/web/app/styles/components/sidebar.scss b/web/app/styles/components/sidebar.scss index b05b0955c..5876fbf85 100644 --- a/web/app/styles/components/sidebar.scss +++ b/web/app/styles/components/sidebar.scss @@ -106,8 +106,7 @@ } /* Style the scrollbar Firefox */ - // FIXME - // scrollbar-color: var(--token-color-palette-neutral-300) transparent; + scrollbar-color: var(--token-color-palette-neutral-300) transparent; } .document-title { diff --git a/web/tests/integration/components/editable-field-test.ts b/web/tests/integration/components/editable-field-test.ts index 54fe23e49..e9503d010 100644 --- a/web/tests/integration/components/editable-field-test.ts +++ b/web/tests/integration/components/editable-field-test.ts @@ -3,6 +3,7 @@ import { hbs } from "ember-cli-htmlbars"; import { MirageTestContext, setupMirage } from "ember-cli-mirage/test-support"; import { setupRenderingTest } from "ember-qunit"; import { TEST_USER_EMAIL, authenticateTestUser } from "hermes/mirage/utils"; +import { HermesDocument } from "hermes/types/document"; import { module, test } from "qunit"; const EDITABLE_FIELD = ".editable-field"; @@ -27,6 +28,8 @@ interface EditableFieldComponentTestContext extends MirageTestContext { newArray: string[]; disabled: boolean; buttonSize?: "medium"; + document?: HermesDocument; + name?: string; } module("Integration | Component | editable-field", function (hooks) { @@ -474,4 +477,62 @@ module("Integration | Component | editable-field", function (hooks) { assert.dom(SAVE_BUTTON).hasClass("hds-button--size-medium"); }); + + test("it conditionally renders a docNumber", async function (this: EditableFieldComponentTestContext, assert) { + const title = "foo"; + const docNumber = "123"; + const name = "title"; + + const document = this.server.create("document", { + title, + docNumber, + }); + + this.set("document", document); + + this.set("name", name); + + await render(hbs` + + `); + + assert + .dom(EDITABLE_FIELD) + .containsText( + docNumber, + 'the docNumber is rendered when a document is passed in and the name is "title"', + ) + .hasClass("!mb-12", "the container has extra padding"); + + this.set("name", "notTitle"); + + assert + .dom(EDITABLE_FIELD) + .doesNotContainText( + docNumber, + "the docNumber is not rendered when the name is not 'title'", + ) + .doesNotHaveClass("!mb-12", "the container does not have extra padding"); + + this.set("name", "title"); + + assert + .dom(EDITABLE_FIELD) + .containsText(docNumber, "the docNumber is rendered again"); + + this.set("document", undefined); + + assert + .dom(EDITABLE_FIELD) + .doesNotContainText( + docNumber, + "the docNumber is not rendered when the document is not passed in", + ) + .doesNotHaveClass("!mb-12", "the container does not have extra padding"); + }); }); From 56f1d7279661a25a93605afbeadaf658a51e16b1 Mon Sep 17 00:00:00 2001 From: Jeff Daley Date: Tue, 6 Feb 2024 18:31:35 -0500 Subject: [PATCH 07/27] Add status dropdown --- web/app/components/doc/status.hbs | 4 +- web/app/components/document/sidebar.hbs | 164 ++++++++++++++-------- web/app/components/document/sidebar.ts | 45 +++--- web/app/styles/components/doc/status.scss | 15 +- web/app/styles/components/sidebar.scss | 17 +++ 5 files changed, 154 insertions(+), 91 deletions(-) diff --git a/web/app/components/doc/status.hbs b/web/app/components/doc/status.hbs index 3e723778e..5cb8f7ea7 100644 --- a/web/app/components/doc/status.hbs +++ b/web/app/components/doc/status.hbs @@ -1,6 +1,6 @@ {{#unless @hideProgress}}
  1. @@ -12,6 +12,6 @@ diff --git a/web/app/components/document/sidebar.hbs b/web/app/components/document/sidebar.hbs index f10a697db..bcaaf27a6 100644 --- a/web/app/components/document/sidebar.hbs +++ b/web/app/components/document/sidebar.hbs @@ -20,15 +20,90 @@
    {{! Add bgColor to make badge `multiply` work }}
    - + {{#if this.isDraft}} + + {{else}} + {{! Status dropdown }} + + <:anchor as |dd|> +
    +
    + {{! + if this is not the owner + and the doc is not in some messed-up state + this should be interactive with a little chevron + }} + + + + {{#if this.isOwner}} + + {{/if}} + +
    +
    + + <:item as |dd|> + + + + + + +     + {{/if}} {{! visibility toggle }} {{#if (and this.isDraft this.isOwner (not this.editingIsDisabled))}} {{/if}} {{else}} - {{#if this.isOwner}} -
    - + {{#if this.isApprover}} +
    - -
    - - {{else}} - {{#if this.isApprover}} -
    + {{#if (eq @document.docType "FRD")}} - {{#if (eq @document.docType "FRD")}} - - {{/if}} -
    - {{/if}} + {{/if}} +
    {{/if}} {{/if}} {{/if}} diff --git a/web/app/components/document/sidebar.ts b/web/app/components/document/sidebar.ts index bb663975e..49bb97ac6 100644 --- a/web/app/components/document/sidebar.ts +++ b/web/app/components/document/sidebar.ts @@ -112,6 +112,8 @@ export default class DocumentSidebarComponent extends Component { + const cachedStatus = this.status; + + // Instantly update the UI + this.status = newStatus; + + if (newStatus === "In review") { + newStatus = "In-Review"; + } + try { if ( newStatus === "Approved" && @@ -924,6 +914,7 @@ export default class DocumentSidebarComponent extends Component Date: Tue, 6 Feb 2024 18:38:09 -0500 Subject: [PATCH 08/27] Add `type` arg to Status --- web/app/components/doc/status.hbs | 1 + web/app/components/doc/status.ts | 2 ++ .../integration/components/doc/status-test.ts | 22 +++++++++++++++++++ 3 files changed, 25 insertions(+) diff --git a/web/app/components/doc/status.hbs b/web/app/components/doc/status.hbs index 5cb8f7ea7..048125250 100644 --- a/web/app/components/doc/status.hbs +++ b/web/app/components/doc/status.hbs @@ -12,6 +12,7 @@ diff --git a/web/app/components/doc/status.ts b/web/app/components/doc/status.ts index ae67d7720..0c4aef7a2 100644 --- a/web/app/components/doc/status.ts +++ b/web/app/components/doc/status.ts @@ -1,11 +1,13 @@ import { dasherize } from "@ember/string"; import Component from "@glimmer/component"; +import { HdsBadgeType } from "hds/_shared"; interface DocStatusComponentSignature { Element: HTMLDivElement; Args: { status?: string; hideProgress?: boolean; + type?: HdsBadgeType; }; } diff --git a/web/tests/integration/components/doc/status-test.ts b/web/tests/integration/components/doc/status-test.ts index da78afdee..be8c89fc9 100644 --- a/web/tests/integration/components/doc/status-test.ts +++ b/web/tests/integration/components/doc/status-test.ts @@ -2,10 +2,12 @@ import { module, test } from "qunit"; import { setupRenderingTest } from "ember-qunit"; import { TestContext, render } from "@ember/test-helpers"; import { hbs } from "ember-cli-htmlbars"; +import { HdsBadgeType } from "hds/_shared"; interface Context extends TestContext { hideProgress: boolean; status: string; + type: HdsBadgeType; } module("Integration | Component | doc/status", function (hooks) { @@ -51,4 +53,24 @@ module("Integration | Component | doc/status", function (hooks) { this.set("status", true); assert.dom(".hds-badge--color-neutral").hasText("WIP"); }); + + test('it takes a "type" argument', async function (assert) { + this.set("type", undefined); + + const filled = ".hds-badge--type-filled"; + const inverted = ".hds-badge--type-inverted"; + + await render(hbs` + + `); + + // By default, the badge type is "filled" + assert.dom(filled).exists(); + assert.dom(inverted).doesNotExist(); + + this.set("type", "inverted"); + + assert.dom(filled).doesNotExist(); + assert.dom(inverted).exists(); + }); }); From a837038405e80d144d136440757bad6c35e904d4 Mon Sep 17 00:00:00 2001 From: Jeff Daley Date: Tue, 6 Feb 2024 18:48:24 -0500 Subject: [PATCH 09/27] Fix broken tests --- web/app/components/document/sidebar.hbs | 14 ++----- .../acceptance/authenticated/document-test.ts | 37 ++++++------------- 2 files changed, 15 insertions(+), 36 deletions(-) diff --git a/web/app/components/document/sidebar.hbs b/web/app/components/document/sidebar.hbs index d2e96fa2d..47c34eeaf 100644 --- a/web/app/components/document/sidebar.hbs +++ b/web/app/components/document/sidebar.hbs @@ -40,11 +40,6 @@ <:anchor as |dd|>
    - {{! - if this is not the owner - and the doc is not in some messed-up state - this should be interactive with a little chevron - }} @@ -70,8 +65,7 @@ "running" "chevron-down" }} - {{! TODO: this should inherit color }} - class="chevron absolute right-1.5" + class="absolute right-1.5" /> {{/if}} @@ -82,7 +76,7 @@ diff --git a/web/tests/acceptance/authenticated/document-test.ts b/web/tests/acceptance/authenticated/document-test.ts index 01cf54f28..a731507a9 100644 --- a/web/tests/acceptance/authenticated/document-test.ts +++ b/web/tests/acceptance/authenticated/document-test.ts @@ -77,8 +77,14 @@ const CONTINUE_TO_DOCUMENT_BUTTON_SELECTOR = const DOC_PUBLISHED_COPY_URL_BUTTON_SELECTOR = "[data-test-doc-published-copy-url-button]"; -const CHANGE_DOC_STATUS_BUTTON = "[data-test-change-doc-status-button]"; const DOC_STATUS = "[data-test-doc-status]"; +const DOC_STATUS_TOGGLE = "[data-test-doc-status-toggle]"; +const DOC_STATUS_DROPDOWN = "[data-test-doc-status-dropdown]"; + +const DOC_STATUS_OPTION = "[data-test-doc-status-option]"; +const DOC_STATUS_OPTION_IN_REVIEW = "[data-test-status='In review']"; +const DOC_STATUS_OPTION_APPROVED = "[data-test-status='Approved']"; +const DOC_STATUS_OPTION_OBSOLETE = "[data-test-status='Obsolete']"; const CUSTOM_STRING_FIELD_SELECTOR = "[data-test-custom-field-type='string']"; const CUSTOM_PEOPLE_FIELD_SELECTOR = "[data-test-custom-field-type='people']"; @@ -802,7 +808,8 @@ module("Acceptance | authenticated/document", function (hooks) { assert.dom(DOC_STATUS).hasText("In review"); - await click(CHANGE_DOC_STATUS_BUTTON); + await click(DOC_STATUS_TOGGLE); + await click(DOC_STATUS_OPTION_APPROVED); assert.dom(DOC_STATUS).hasText("Approved"); @@ -820,7 +827,8 @@ module("Acceptance | authenticated/document", function (hooks) { await visit("/document/1"); - await click(CHANGE_DOC_STATUS_BUTTON); + await click(DOC_STATUS_TOGGLE); + await click(DOC_STATUS_OPTION_APPROVED); const doc = this.server.schema.document.first(); @@ -833,29 +841,6 @@ module("Acceptance | authenticated/document", function (hooks) { assert.equal(doc.attrs.status, "Approved"); }); - test("owners can move a doc they previously approved from in-review to approved", async function (this: AuthenticatedDocumentRouteTestContext, assert) { - this.server.create("document", { - objectID: 1, - status: "In-Review", - approvers: [TEST_USER_EMAIL], - owners: [TEST_USER_EMAIL], - approvedBy: [TEST_USER_EMAIL], - }); - - await visit("/document/1"); - - await click(CHANGE_DOC_STATUS_BUTTON); - - const doc = this.server.schema.document.first(); - - assert.equal(doc.attrs.status, "Approved"); - - assert - .dom(FLASH_MESSAGE_SELECTOR) - .exists({ count: 1 }) - .hasAttribute("data-test-flash-notification-type", "success"); - }); - test("approvers who have approved a document are badged with a checkmark", async function (this: AuthenticatedDocumentRouteTestContext, assert) { this.server.create("document", { objectID: 1, From c5c20dae00e83396fce5507576ba6951d2536d3a Mon Sep 17 00:00:00 2001 From: Jeff Daley Date: Tue, 6 Feb 2024 19:56:27 -0500 Subject: [PATCH 10/27] Update test, remove unnecessary changes --- web/app/components/doc/status.hbs | 2 +- web/app/components/document/sidebar.ts | 9 --- web/app/styles/components/doc/status.scss | 15 +--- .../acceptance/authenticated/document-test.ts | 73 ++++++++++++++----- 4 files changed, 56 insertions(+), 43 deletions(-) diff --git a/web/app/components/doc/status.hbs b/web/app/components/doc/status.hbs index 048125250..9814d9a62 100644 --- a/web/app/components/doc/status.hbs +++ b/web/app/components/doc/status.hbs @@ -1,6 +1,6 @@ {{#unless @hideProgress}}
    1. diff --git a/web/app/components/document/sidebar.ts b/web/app/components/document/sidebar.ts index 49bb97ac6..505520212 100644 --- a/web/app/components/document/sidebar.ts +++ b/web/app/components/document/sidebar.ts @@ -896,15 +896,6 @@ export default class DocumentSidebarComponent extends Component Date: Tue, 6 Feb 2024 20:24:51 -0500 Subject: [PATCH 11/27] Style tweaks and cleanup --- web/app/components/document/sidebar.hbs | 28 ++++++++++++------- web/app/components/document/sidebar.ts | 11 -------- web/app/styles/components/sidebar.scss | 2 ++ .../styles/components/x/dropdown/list.scss | 4 +++ 4 files changed, 24 insertions(+), 21 deletions(-) diff --git a/web/app/components/document/sidebar.hbs b/web/app/components/document/sidebar.hbs index 47c34eeaf..c1b8eae50 100644 --- a/web/app/components/document/sidebar.hbs +++ b/web/app/components/document/sidebar.hbs @@ -31,17 +31,19 @@ {{! Status dropdown }} <:anchor as |dd|>
      - +
      + + +
      +
      diff --git a/web/app/components/document/sidebar.ts b/web/app/components/document/sidebar.ts index 505520212..6337e50be 100644 --- a/web/app/components/document/sidebar.ts +++ b/web/app/components/document/sidebar.ts @@ -311,13 +311,6 @@ export default class DocumentSidebarComponent extends Component Date: Tue, 6 Feb 2024 20:39:32 -0500 Subject: [PATCH 12/27] Another test; border tweak --- web/app/components/document/sidebar.hbs | 50 +++++++++++-------- web/app/styles/hds-overrides.scss | 17 +++++++ .../acceptance/authenticated/document-test.ts | 16 ++++++ 3 files changed, 61 insertions(+), 22 deletions(-) diff --git a/web/app/components/document/sidebar.hbs b/web/app/components/document/sidebar.hbs index c1b8eae50..e78d1bbb0 100644 --- a/web/app/components/document/sidebar.hbs +++ b/web/app/components/document/sidebar.hbs @@ -39,28 +39,25 @@ <:anchor as |dd|>
      - - + data-test-doc-status-toggle + data-test-icon={{this.draftVisibilityIcon}} + class="hds-button hds-button--color-secondary + {{dasherize this.status}}" + > + - {{#if this.isOwner}} - {{/if}} - + + + {{else}} + + + + {{/if}}
      diff --git a/web/app/styles/hds-overrides.scss b/web/app/styles/hds-overrides.scss index eadfc1478..41e615df0 100644 --- a/web/app/styles/hds-overrides.scss +++ b/web/app/styles/hds-overrides.scss @@ -55,3 +55,20 @@ a.hds-button { @apply rounded-l-full rounded-r-full; } } + +.hds-alert--type-inline { + &.hds-alert--color-success { + // hds-green-500/a20 + border-color: #05422133; + } + + &.hds-alert--color-warning { + // hds-amber-500/a20 + border-color: #52270033; + } + + &.hds-alert--color-critical { + // hds-red-500/a20 + border-color: #52140a33; + } +} diff --git a/web/tests/acceptance/authenticated/document-test.ts b/web/tests/acceptance/authenticated/document-test.ts index 087444362..fb2505dd2 100644 --- a/web/tests/acceptance/authenticated/document-test.ts +++ b/web/tests/acceptance/authenticated/document-test.ts @@ -502,6 +502,22 @@ module("Acceptance | authenticated/document", function (hooks) { assertEditingIsDisabled(assert); }); + test("non-owners can't edit the status of a doc", async function (this: AuthenticatedDocumentRouteTestContext, assert) { + this.server.create("document", { + objectID: 1, + isDraft: false, + status: "In-Review", + owners: [TEST_USER_2_EMAIL], + }); + + await visit("/document/1"); + + assert.dom(DOC_STATUS_TOGGLE).doesNotExist("the toggle is not shown"); + assert + .dom(DOC_STATUS) + .hasText("In review", "the status is shown but not as a toggle"); + }); + test("doc owners can publish their docs for review", async function (this: AuthenticatedDocumentRouteTestContext, assert) { this.server.create("document", { objectID: 1, From 81af19c5c2b6de6c7766ad0d560f4ae2075bf49c Mon Sep 17 00:00:00 2001 From: Jeff Daley Date: Tue, 6 Feb 2024 20:49:52 -0500 Subject: [PATCH 13/27] Delete `archive` artifacts; template refactor --- web/app/components/document/sidebar.hbs | 162 ++++++++++-------------- web/app/components/document/sidebar.ts | 11 +- 2 files changed, 71 insertions(+), 102 deletions(-) diff --git a/web/app/components/document/sidebar.hbs b/web/app/components/document/sidebar.hbs index e78d1bbb0..e0ec2c0c9 100644 --- a/web/app/components/document/sidebar.hbs +++ b/web/app/components/document/sidebar.hbs @@ -20,95 +20,87 @@
      {{! Add bgColor to make badge `multiply` work }}
      - {{#if this.isDraft}} - - {{else}} - {{! Status dropdown }} - - <:anchor as |dd|> + + {{! Status }} + + <:anchor as |dd|> + {{#if this.isOwner}} + {{! Status dropdown (doc owner) }}
      - {{#if this.isOwner}} - - - - - - - {{else}} - + - - {{/if}} + +
      - - <:item as |dd|> - + {{/if}} + + <:item as |dd|> + + - -
      +
      + + +
      +
      + + + + - -
      -
      -       -       - -       - {{/if}} {{! visibility toggle }} {{#if (and this.isDraft this.isOwner (not this.editingIsDisabled))}} {{/if}} - {{#if this.archiveModalIsShown}} - - {{/if}} - {{#if this.deleteModalIsShown}} Date: Wed, 7 Feb 2024 11:01:17 -0500 Subject: [PATCH 14/27] WIP footer cleanup --- web/app/components/document/sidebar.hbs | 128 ++++++++++++++++-------- 1 file changed, 84 insertions(+), 44 deletions(-) diff --git a/web/app/components/document/sidebar.hbs b/web/app/components/document/sidebar.hbs index e0ec2c0c9..31d0a12c0 100644 --- a/web/app/components/document/sidebar.hbs +++ b/web/app/components/document/sidebar.hbs @@ -375,6 +375,7 @@ {{#if this.footerIsShown}}
      {{#if this.footerControlsAreDisabled}} + {{! Disabled controls }}
      @@ -412,58 +413,97 @@
      {{else}} - {{#if this.isDraft}} - {{#if this.isOwner}} -
      - - -
      - {{/if}} + + {{#if (and this.isDraft this.isOwner)}} +
      + {{! Publish for review... }} + + {{! Delete... }} + +
      {{else}} {{#if this.isApprover}} -
      - - {{#if (eq @document.docType "FRD")}} + {{! TODO: share div with other state }} +
      + {{#if (or this.hasApproved this.hasRequestedChanges)}} +
      + {{if this.hasApproved "Approved" "Rejected"}} +
      + {{else}} + + {{#if (eq @document.docType "FRD")}} + + {{/if}} + + + <:anchor as |dd|> + + + + + <:item as |dd|> + {{! TODO: need `action` }} + + + {{dd.attrs.label}} + + + {{/if}}
      {{/if}} From 868b4e4e93e40bf966bc4ab970f37cfcd7a3dbc8 Mon Sep 17 00:00:00 2001 From: Jeff Daley Date: Wed, 7 Feb 2024 11:04:03 -0500 Subject: [PATCH 15/27] Add WIP dropdown check/test --- web/app/components/document/sidebar.hbs | 2 +- web/tests/acceptance/authenticated/document-test.ts | 12 ++++++++++++ 2 files changed, 13 insertions(+), 1 deletion(-) diff --git a/web/app/components/document/sidebar.hbs b/web/app/components/document/sidebar.hbs index e0ec2c0c9..629eeaf56 100644 --- a/web/app/components/document/sidebar.hbs +++ b/web/app/components/document/sidebar.hbs @@ -30,7 +30,7 @@ class="theme--neutral" > <:anchor as |dd|> - {{#if this.isOwner}} + {{#if (and this.isOwner (not this.isDraft))}} {{! Status dropdown (doc owner) }}
      diff --git a/web/tests/acceptance/authenticated/document-test.ts b/web/tests/acceptance/authenticated/document-test.ts index fb2505dd2..90e66c549 100644 --- a/web/tests/acceptance/authenticated/document-test.ts +++ b/web/tests/acceptance/authenticated/document-test.ts @@ -170,6 +170,18 @@ module("Acceptance | authenticated/document", function (hooks) { assert.equal(getPageTitle(), "Test Document | Hermes"); }); + test("the status label of a draft is not interactive", async function (this: AuthenticatedDocumentRouteTestContext, assert) { + this.server.create("document", { + objectID: 1, + title: "Test Document", + status: "Draft", + }); + await visit("/document/1?draft=true"); + + assert.dom(DOC_STATUS_TOGGLE).doesNotExist(); + assert.dom(DOC_STATUS).hasText("WIP", "label exists but isn't clickable"); + }); + test("you can change a draft's product area", async function (this: AuthenticatedDocumentRouteTestContext, assert) { const docID = "test-doc-0"; From b0ac7c50daa2b18e1032d010fb9e197114eb68af Mon Sep 17 00:00:00 2001 From: Jeff Daley Date: Wed, 7 Feb 2024 11:23:28 -0500 Subject: [PATCH 16/27] =?UTF-8?q?Fix=20mirage=20attrs=20("Draft"=20?= =?UTF-8?q?=E2=86=92=20"WIP")?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- web/tests/acceptance/authenticated/document-test.ts | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/web/tests/acceptance/authenticated/document-test.ts b/web/tests/acceptance/authenticated/document-test.ts index 90e66c549..a98cf3be8 100644 --- a/web/tests/acceptance/authenticated/document-test.ts +++ b/web/tests/acceptance/authenticated/document-test.ts @@ -164,7 +164,7 @@ module("Acceptance | authenticated/document", function (hooks) { this.server.create("document", { objectID: 1, title: "Test Document", - status: "Draft", + status: "WIP", }); await visit("/document/1?draft=true"); assert.equal(getPageTitle(), "Test Document | Hermes"); @@ -174,7 +174,7 @@ module("Acceptance | authenticated/document", function (hooks) { this.server.create("document", { objectID: 1, title: "Test Document", - status: "Draft", + status: "WIP", }); await visit("/document/1?draft=true"); From 5136afe7448328319625f3b3b61306c7394aebd6 Mon Sep 17 00:00:00 2001 From: Jeff Daley Date: Wed, 7 Feb 2024 16:27:36 -0500 Subject: [PATCH 17/27] WIP try to remove yourself from a doc --- web/app/components/document/sidebar.hbs | 186 ++++++++++-------- web/app/components/document/sidebar.ts | 129 +++++++++--- web/app/components/editable-field.hbs | 4 +- web/app/components/editable-field.ts | 36 +++- .../components/editable-field-test.ts | 4 + 5 files changed, 234 insertions(+), 125 deletions(-) diff --git a/web/app/components/document/sidebar.hbs b/web/app/components/document/sidebar.hbs index 78e47cc5b..ad22f1fbe 100644 --- a/web/app/components/document/sidebar.hbs +++ b/web/app/components/document/sidebar.hbs @@ -413,101 +413,119 @@
      {{else}} - - {{#if (and this.isDraft this.isOwner)}} -
      - {{! Publish for review... }} - - {{! Delete... }} - -
      - {{else}} - {{#if this.isApprover}} - {{! TODO: share div with other state }} + {{#let (and this.isDraft this.isOwner) as |publishScenario|}} + {{#if (or publishScenario this.isApprover)}}
      - {{#if (or this.hasApproved this.hasRequestedChanges)}} -
      - {{if this.hasApproved "Approved" "Rejected"}} -
      - {{else}} + + {{#if publishScenario}} + {{! Publish for review... }} - - {{#if (eq @document.docType "FRD")}} + {{! Delete... }} + + {{else}} + {{! Approver scenario }} + {{! Read-only / isRunning state }} + {{#if + (or + this.hasApproved + this.hasRequestedChanges + this.approve.isRunning + this.requestChanges.isRunning + this.leaveApproverRole.isRunning + ) + }} +
      + {{if + this.requestChanges.isRunning + "Saving..." + (if + this.approve.isRunning + "Approving..." + (if + this.leaveApproverRole.isRunning + "Leaving..." + (if + this.hasApproved + "Approved" + (if this.requestChanges "Rejected") + ) + ) + ) + }} +
      + {{else}} + {{! Approve }} + {{#if (eq @document.docType "FRD")}} + {{! Reject FRD }} + + {{/if}} + {{! Overflow menu (Leave approver role) }} + + <:anchor as |dd|> + + + + + <:item as |dd|> + + + {{dd.attrs.label}} + + + {{/if}} - - - <:anchor as |dd|> - - - - - <:item as |dd|> - {{! TODO: need `action` }} - - - {{dd.attrs.label}} - - - {{/if}}
      {{/if}} - {{/if}} + {{/let}} {{/if}}
      {{/if}} diff --git a/web/app/components/document/sidebar.ts b/web/app/components/document/sidebar.ts index 0556f8488..ad6f00bae 100644 --- a/web/app/components/document/sidebar.ts +++ b/web/app/components/document/sidebar.ts @@ -105,10 +105,17 @@ export default class DocumentSidebarComponent extends Component { + this.approvers = newApprovers; + await this.save.perform("approvers", this.approvers); + }); + saveCustomField = task( async ( fieldName: string, @@ -714,8 +733,11 @@ export default class DocumentSidebarComponent extends Component { + const cachedApprovers = this.approvers; + + try { + this.approvers = this.approvers.filter( + (e) => e !== this.args.profile.email, + ); + + this.approvers = this.approvers; + + await this.save.perform("approvers", this.approvers); + + this.hasJustLeftApproverRole = true; + + this.flashMessages.add({ + message: "You've left the approver role", + title: "Done!", + }); + } catch (e: unknown) { + this.approvers = cachedApprovers; + this.flashMessages.critical((e as any).message, { + title: "Error leaving approver role", + }); + } finally { + setTimeout(() => { + // reset state after a short delay + this.hasJustLeftApproverRole = false; + }, 5000); + } + }); + /** * Fetches the draft's `isShareable` attribute and updates the local property. * Called when a document draft is rendered. @@ -826,25 +885,32 @@ export default class DocumentSidebarComponent extends Component { - try { - await this.fetchSvc.fetch( - `/api/${this.configSvc.config.api_version}/approvals/${this.docID}`, - { - method: "POST", - headers: { "Content-Type": "application/json" }, - }, - ); - if (!options?.skipSuccessMessage) { - this.showFlashSuccess("Done!", "Document approved"); + approve = task( + async (options?: { skipSuccessMessage: boolean } | MouseEvent) => { + try { + await this.fetchSvc.fetch( + `/api/${this.configSvc.config.api_version}/approvals/${this.docID}`, + { + method: "POST", + headers: { "Content-Type": "application/json" }, + }, + ); + + this.hasApproved = true; + + if (options instanceof MouseEvent) return; + + if (!options?.skipSuccessMessage) { + this.showFlashSuccess("Done!", "Document approved"); + } + } catch (error: unknown) { + this.maybeShowFlashError(error as Error, "Unable to approve"); + throw error; } - } catch (error: unknown) { - this.maybeShowFlashError(error as Error, "Unable to approve"); - throw error; - } - this.refreshRoute(); - }); + this.refreshRoute(); + }, + ); requestChanges = task(async () => { try { @@ -855,6 +921,9 @@ export default class DocumentSidebarComponent extends Component { - this.value = this.cachedValue; - this.onChange(this.value as string[]); + this.newValue = this.cachedValue; + this.onChange(this.newValue as string[]); }); } @@ -226,7 +236,7 @@ export default class EditableFieldComponent extends Component { this.disableEditing(); }); } + + protected updateValue = task(async () => { + await this.args.onSave(this.newValue); + this.newValue = null; + }); } declare module "@glint/environment-ember-loose/registry" { diff --git a/web/tests/integration/components/editable-field-test.ts b/web/tests/integration/components/editable-field-test.ts index e9503d010..a76da14c6 100644 --- a/web/tests/integration/components/editable-field-test.ts +++ b/web/tests/integration/components/editable-field-test.ts @@ -158,6 +158,10 @@ module("Integration | Component | editable-field", function (hooks) { .exists("the element is rendered as a div when editing is disabled"); }); + test("the value will update when the passed-in value changes (STRING)", async function (this: EditableFieldComponentTestContext, assert) { + // TODO: + }); + test("it cancels when the escape key is pressed", async function (this: EditableFieldComponentTestContext, assert) { const defaultText = "foo"; From 8fe638db407ba219ce62a5814f85c92dce7b7810 Mon Sep 17 00:00:00 2001 From: Jeff Daley Date: Wed, 7 Feb 2024 20:07:22 -0500 Subject: [PATCH 18/27] Hack the approvers list to re-render --- web/app/components/document/sidebar.hbs | 34 +++++++++++++------------ web/app/components/document/sidebar.ts | 23 ++++++++++++++++- 2 files changed, 40 insertions(+), 17 deletions(-) diff --git a/web/app/components/document/sidebar.hbs b/web/app/components/document/sidebar.hbs index b13457371..047d4453b 100644 --- a/web/app/components/document/sidebar.hbs +++ b/web/app/components/document/sidebar.hbs @@ -258,23 +258,25 @@
      - {{! Approvers }} -
      - -
      - + {{#if this.approversAreShown}} + {{! Approvers }} +
      + +
      + +
      -
      + {{/if}} {{! Related resources }}
      diff --git a/web/app/components/document/sidebar.ts b/web/app/components/document/sidebar.ts index c3bc32cd1..811ea3739 100644 --- a/web/app/components/document/sidebar.ts +++ b/web/app/components/document/sidebar.ts @@ -12,7 +12,7 @@ import { } from "ember-concurrency"; import { capitalize, dasherize } from "@ember/string"; import cleanString from "hermes/utils/clean-string"; -import { debounce } from "@ember/runloop"; +import { debounce, schedule } from "@ember/runloop"; import FetchService from "hermes/services/fetch"; import RouterService from "@ember/routing/router-service"; import SessionService from "hermes/services/session"; @@ -151,6 +151,13 @@ export default class DocumentSidebarComponent extends Component { + this.approversAreShown = true; + }); + this.hasJustLeftApproverRole = true; this.flashMessages.add({ From 86f29c558d92aff3efac9b870ceda3c10f6b3e03 Mon Sep 17 00:00:00 2001 From: Jeff Daley Date: Thu, 8 Feb 2024 09:21:20 -0500 Subject: [PATCH 19/27] Fix tests, rename methods --- web/app/components/document/sidebar.hbs | 17 ++- web/app/components/document/sidebar.ts | 50 ++------ web/mirage/config.ts | 69 +++++++---- .../acceptance/authenticated/document-test.ts | 115 ++++++++++++++++-- 4 files changed, 176 insertions(+), 75 deletions(-) diff --git a/web/app/components/document/sidebar.hbs b/web/app/components/document/sidebar.hbs index 047d4453b..da1f536a1 100644 --- a/web/app/components/document/sidebar.hbs +++ b/web/app/components/document/sidebar.hbs @@ -375,7 +375,10 @@
      {{#if this.footerIsShown}} -
      +
      {{#if this.footerControlsAreDisabled}} {{! Disabled controls }}
      @@ -442,9 +445,9 @@ {{#if (or this.hasApproved - this.hasRequestedChanges + this.hasRejectedFRD this.approve.isRunning - this.requestChanges.isRunning + this.rejectFRD.isRunning this.leaveApproverRole.isRunning ) }} @@ -453,7 +456,7 @@ class="hds-button mock-disabled hds-button--primary hds-button--size-medium w-full leading-none" > {{if - this.requestChanges.isRunning + this.rejectFRD.isRunning "Saving..." (if this.approve.isRunning @@ -464,7 +467,7 @@ (if this.hasApproved "Approved" - (if this.requestChanges "Rejected") + (if this.rejectFRD "Rejected") ) ) ) @@ -473,6 +476,7 @@ {{else}} {{! Approve }} {{/if}} {{! Overflow menu (Leave approver role) }} diff --git a/web/app/components/document/sidebar.ts b/web/app/components/document/sidebar.ts index 811ea3739..f0ce4a5b7 100644 --- a/web/app/components/document/sidebar.ts +++ b/web/app/components/document/sidebar.ts @@ -286,31 +286,6 @@ export default class DocumentSidebarComponent extends Component { + rejectFRD = task(async () => { try { await this.fetchSvc.fetch( `/api/${this.configSvc.config.api_version}/approvals/${this.docID}`, @@ -942,20 +917,15 @@ export default class DocumentSidebarComponent extends Component { diff --git a/web/mirage/config.ts b/web/mirage/config.ts index cfb1067f1..42007b2b5 100644 --- a/web/mirage/config.ts +++ b/web/mirage/config.ts @@ -572,6 +572,53 @@ export default function (mirageConfig) { } }); + /************************************************************************* + * + * Document approvals + * + *************************************************************************/ + + /** + * Used when approving a document. + * Adds the user's email to the `approvedBy` array. + */ + this.post("/approvals/:document_id", (schema, request) => { + const document = schema.document.findBy({ + objectID: request.params.document_id, + }); + + if (document) { + if (!document.attrs.approvedBy?.includes(TEST_USER_EMAIL)) { + const approvedBy = document.attrs.approvedBy || []; + document.update({ + approvedBy: [...approvedBy, TEST_USER_EMAIL], + }); + } + return new Response(200, {}, document.attrs); + } + + return new Response(404, {}, {}); + }); + + /** + * Used when rejecting an FRD or requesting changes to any other document. + */ + this.delete("/approvals/:document_id", (schema, request) => { + const document = schema.document.findBy({ + objectID: request.params.document_id, + }); + + if (document) { + document.update({ + changesRequestedBy: [TEST_USER_EMAIL], + }); + + return new Response(200, {}, document.attrs); + } + + return new Response(404, {}, {}); + }); + /************************************************************************* * * HEAD requests @@ -639,28 +686,6 @@ export default function (mirageConfig) { return new Response(404, {}, {}); }); - /** - * Used when approving a document. - * Adds the user's email to the `approvedBy` array. - */ - this.post("/approvals/:document_id", (schema, request) => { - const document = schema.document.findBy({ - objectID: request.params.document_id, - }); - - if (document) { - if (!document.attrs.approvedBy?.includes(TEST_USER_EMAIL)) { - const approvedBy = document.attrs.approvedBy || []; - document.update({ - approvedBy: [...approvedBy, TEST_USER_EMAIL], - }); - } - return new Response(200, {}, document.attrs); - } - - return new Response(404, {}, {}); - }); - /** * Used by the AuthenticatedUserService to add and remove subscriptions. */ diff --git a/web/tests/acceptance/authenticated/document-test.ts b/web/tests/acceptance/authenticated/document-test.ts index f463c74cd..d56083b73 100644 --- a/web/tests/acceptance/authenticated/document-test.ts +++ b/web/tests/acceptance/authenticated/document-test.ts @@ -26,6 +26,7 @@ import { TEST_USER_3_EMAIL, TEST_USER_EMAIL, TEST_SHORT_LINK_BASE_URL, + TEST_USER_NAME, } from "hermes/mirage/utils"; const ADD_RELATED_RESOURCE_BUTTON_SELECTOR = @@ -34,7 +35,6 @@ const ADD_RELATED_DOCUMENT_OPTION_SELECTOR = ".related-document-option"; const ADD_RELATED_RESOURCE_MODAL_SELECTOR = "[data-test-add-related-resource-modal]"; const FLASH_MESSAGE_SELECTOR = "[data-test-flash-notification]"; -const SIDEBAR_TITLE_BADGE_SELECTOR = "[data-test-sidebar-title-badge]"; const TOOLTIP_SELECTOR = ".hermes-tooltip"; const DRAFT_VISIBILITY_DROPDOWN_SELECTOR = "[data-test-draft-visibility-dropdown]"; @@ -42,7 +42,15 @@ const DRAFT_VISIBILITY_TOGGLE_SELECTOR = "[data-test-draft-visibility-toggle]"; const COPY_URL_BUTTON_SELECTOR = "[data-test-sidebar-copy-url-button]"; const DRAFT_VISIBILITY_OPTION_SELECTOR = "[data-test-draft-visibility-option]"; const SECOND_DRAFT_VISIBILITY_LIST_ITEM_SELECTOR = `${DRAFT_VISIBILITY_DROPDOWN_SELECTOR} li:nth-child(2)`; - +const APPROVE_BUTTON = "[data-test-approve-button]"; +const SIDEBAR_FOOTER_SECONDARY_DROPDOWN_BUTTON = + "[data-test-sidebar-footer-secondary-dropdown-button]"; +const SIDEBAR_FOOTER_OVERFLOW_MENU = "[data-test-sidebar-footer-overflow-menu]"; +const SIDEBAR_FOOTER_OVERFLOW_ITEM = `${SIDEBAR_FOOTER_OVERFLOW_MENU} button`; +const REJECT_FRD_BUTTON = "[data-test-reject-frd-button]"; +const SIDEBAR_FOOTER_PRIMARY_BUTTON_READ_ONLY = + "[data-test-sidebar-footer-primary-button-read-only]"; +("[data-test-sidebar-footer-secondary-button]"); const TITLE_SELECTOR = "[data-test-document-title]"; const SUMMARY_SELECTOR = "[data-test-document-summary]"; const CONTRIBUTORS_SELECTOR = "[data-test-document-contributors]"; @@ -81,11 +89,6 @@ const DOC_STATUS = "[data-test-doc-status]"; const DOC_STATUS_TOGGLE = "[data-test-doc-status-toggle]"; const DOC_STATUS_DROPDOWN = "[data-test-doc-status-dropdown]"; -const DOC_STATUS_OPTION = "[data-test-doc-status-option]"; -const DOC_STATUS_OPTION_IN_REVIEW = "[data-test-status='In review']"; -const DOC_STATUS_OPTION_APPROVED = "[data-test-status='Approved']"; -const DOC_STATUS_OPTION_OBSOLETE = "[data-test-status='Obsolete']"; - const CUSTOM_STRING_FIELD_SELECTOR = "[data-test-custom-field-type='string']"; const CUSTOM_PEOPLE_FIELD_SELECTOR = "[data-test-custom-field-type='people']"; const EDITABLE_FIELD_SAVE_BUTTON_SELECTOR = @@ -501,6 +504,104 @@ module("Acceptance | authenticated/document", function (hooks) { assertEditingIsDisabled(assert); }); + test("an approver can remove themselves from the approver role", async function (this: AuthenticatedDocumentRouteTestContext, assert) { + this.server.create("document", { + objectID: 1, + status: "In review", + isDraft: false, + owners: [TEST_USER_2_EMAIL], + approvers: [TEST_USER_EMAIL], + }); + + await visit("/document/1"); + + const approversList = find(APPROVERS_SELECTOR); + + assert.dom(approversList).containsText("Me"); + + await click(SIDEBAR_FOOTER_SECONDARY_DROPDOWN_BUTTON); + + assert.dom(SIDEBAR_FOOTER_OVERFLOW_MENU).exists(); + assert.dom(SIDEBAR_FOOTER_OVERFLOW_ITEM).exists({ count: 1 }); + + assert.dom(SIDEBAR_FOOTER_OVERFLOW_ITEM).hasText("Leave approver role"); + + await click(SIDEBAR_FOOTER_OVERFLOW_ITEM); + + assert.dom(SIDEBAR_FOOTER_OVERFLOW_MENU).doesNotExist(); + + assert + .dom(FLASH_MESSAGE_SELECTOR) + .hasAttribute("data-test-flash-notification-type", "success") + .containsText("You've left the approver role"); + + assert.dom(approversList).doesNotContainText(TEST_USER_NAME); + + const doc = this.server.schema.document.first(); + + assert.false(doc.attrs.approvers.includes(TEST_USER_EMAIL)); + }); + + test("approvers can approve a document", async function (this: AuthenticatedDocumentRouteTestContext, assert) { + this.server.create("document", { + objectID: 1, + isDraft: false, + status: "In review", + owners: [TEST_USER_2_EMAIL], + approvers: [TEST_USER_EMAIL], + approvedBy: [], + }); + + await visit("/document/1"); + + assert.dom(DOC_STATUS).hasText("In review"); + + await click(APPROVE_BUTTON); + + assert.dom(APPROVE_BUTTON).doesNotExist("footer controls are removed"); + assert.dom(SIDEBAR_FOOTER_PRIMARY_BUTTON_READ_ONLY).hasText("Approved"); + + assert + .dom(FLASH_MESSAGE_SELECTOR) + .hasAttribute("data-test-flash-notification-type", "success") + .containsText("Document approved"); + + const doc = this.server.schema.document.first(); + const { approvedBy } = doc.attrs; + + assert.true(approvedBy?.includes(TEST_USER_EMAIL)); + }); + + test("approvers can reject an FRD", async function (this: AuthenticatedDocumentRouteTestContext, assert) { + this.server.create("document", { + objectID: 1, + isDraft: false, + status: "In review", + docType: "FRD", + owners: [TEST_USER_2_EMAIL], + approvers: [TEST_USER_EMAIL], + }); + + await visit("/document/1"); + + await click(REJECT_FRD_BUTTON); + + assert.dom(REJECT_FRD_BUTTON).doesNotExist("footer controls are removed"); + + assert.dom(SIDEBAR_FOOTER_PRIMARY_BUTTON_READ_ONLY).hasText("Rejected"); + + assert + .dom(FLASH_MESSAGE_SELECTOR) + .exists({ count: 1 }) + .hasAttribute("data-test-flash-notification-type", "success") + .containsText("rejected"); + + const doc = this.server.schema.document.first(); + const { changesRequestedBy } = doc.attrs; + + assert.true(changesRequestedBy?.includes(TEST_USER_EMAIL)); + }); + test("non-owner viewers of shareable drafts cannot edit the metadata of a draft", async function (this: AuthenticatedDocumentRouteTestContext, assert) { this.server.create("document", { objectID: 1, From 9932bcf4c511839eb5c316e7d5c7418c4a314403 Mon Sep 17 00:00:00 2001 From: Jeff Daley Date: Thu, 8 Feb 2024 09:23:23 -0500 Subject: [PATCH 20/27] Update sidebar.hbs --- web/app/components/document/sidebar.hbs | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/web/app/components/document/sidebar.hbs b/web/app/components/document/sidebar.hbs index da1f536a1..ed08cf5d9 100644 --- a/web/app/components/document/sidebar.hbs +++ b/web/app/components/document/sidebar.hbs @@ -418,11 +418,11 @@
      {{else}} - {{#let (and this.isDraft this.isOwner) as |publishScenario|}} - {{#if (or publishScenario this.isApprover)}} + {{#let (and this.isDraft this.isOwner) as |canPublish|}} + {{#if (or canPublish this.isApprover)}}
      - {{#if publishScenario}} + {{#if canPublish}} {{! Publish for review... }} {{else}} - {{! Approver scenario }} + {{! isApprover }} + {{! Read-only / isRunning state }} {{#if (or From 4731241621bb9209518dc066a9a1a82fbf233a54 Mon Sep 17 00:00:00 2001 From: Jeff Daley Date: Thu, 8 Feb 2024 09:41:02 -0500 Subject: [PATCH 21/27] Add documentation; revert editableField changes --- web/app/components/document/sidebar.ts | 28 ++++++++++++-------- web/app/components/editable-field.hbs | 4 +-- web/app/components/editable-field.ts | 36 +++++++------------------- 3 files changed, 28 insertions(+), 40 deletions(-) diff --git a/web/app/components/document/sidebar.ts b/web/app/components/document/sidebar.ts index f0ce4a5b7..626480e8f 100644 --- a/web/app/components/document/sidebar.ts +++ b/web/app/components/document/sidebar.ts @@ -447,14 +447,12 @@ export default class DocumentSidebarComponent extends Component { - this.approvers = newApprovers; - await this.save.perform("approvers", this.approvers); - }); - saveCustomField = task( async ( fieldName: string, @@ -882,6 +875,12 @@ export default class DocumentSidebarComponent extends Component { try { @@ -907,6 +906,13 @@ export default class DocumentSidebarComponent extends Component { try { await this.fetchSvc.fetch( diff --git a/web/app/components/editable-field.hbs b/web/app/components/editable-field.hbs index 8f30675bd..097d3addc 100644 --- a/web/app/components/editable-field.hbs +++ b/web/app/components/editable-field.hbs @@ -17,7 +17,7 @@ @onChange={{this.onChange}} @onKeydown={{fn this.onPeopleSelectKeydown this.maybeUpdateValue}} {{dismissible - dismiss=(fn this.maybeUpdateValue this.newValue) + dismiss=(fn this.maybeUpdateValue this.value) related=this.relatedButtons shouldIgnoreEscape=true }} @@ -52,7 +52,7 @@ @text="Save" @icon="check" @isIconOnly={{true}} - {{on "click" (fn this.maybeUpdateValue this.newValue)}} + {{on "click" (fn this.maybeUpdateValue this.value)}} /> { - this.newValue = this.cachedValue; - this.onChange(this.newValue as string[]); + this.value = this.cachedValue; + this.onChange(this.value as string[]); }); } @@ -236,7 +226,7 @@ export default class EditableFieldComponent extends Component { this.disableEditing(); }); } - - protected updateValue = task(async () => { - await this.args.onSave(this.newValue); - this.newValue = null; - }); } declare module "@glint/environment-ember-loose/registry" { From 38e2efd11ab930e9b5c1d20aed6a8154cf726315 Mon Sep 17 00:00:00 2001 From: Jeff Daley Date: Thu, 8 Feb 2024 09:44:19 -0500 Subject: [PATCH 22/27] Update editable-field-test.ts --- web/tests/integration/components/editable-field-test.ts | 4 ---- 1 file changed, 4 deletions(-) diff --git a/web/tests/integration/components/editable-field-test.ts b/web/tests/integration/components/editable-field-test.ts index a76da14c6..e9503d010 100644 --- a/web/tests/integration/components/editable-field-test.ts +++ b/web/tests/integration/components/editable-field-test.ts @@ -158,10 +158,6 @@ module("Integration | Component | editable-field", function (hooks) { .exists("the element is rendered as a div when editing is disabled"); }); - test("the value will update when the passed-in value changes (STRING)", async function (this: EditableFieldComponentTestContext, assert) { - // TODO: - }); - test("it cancels when the escape key is pressed", async function (this: EditableFieldComponentTestContext, assert) { const defaultText = "foo"; From 1582649a5046dc9c92b9a82a1db870ea201acd92 Mon Sep 17 00:00:00 2001 From: Jeff Daley Date: Thu, 8 Feb 2024 10:08:38 -0500 Subject: [PATCH 23/27] Add more tests and Mirage config --- web/app/components/document/sidebar.hbs | 2 ++ web/mirage/config.ts | 22 ++++++++++++++- .../acceptance/authenticated/document-test.ts | 28 +++++++++++++++++++ 3 files changed, 51 insertions(+), 1 deletion(-) diff --git a/web/app/components/document/sidebar.hbs b/web/app/components/document/sidebar.hbs index ed08cf5d9..6da5cdb3d 100644 --- a/web/app/components/document/sidebar.hbs +++ b/web/app/components/document/sidebar.hbs @@ -432,6 +432,7 @@ /> {{! Delete... }} { + const document = schema.document.findBy({ + objectID: request.params.document_id, + }); + + if (document) { + document.destroy(); + return new Response(200, {}, {}); + } + + return new Response(404, {}, {}); + }); + /************************************************************************* * * Document approvals @@ -601,7 +615,7 @@ export default function (mirageConfig) { }); /** - * Used when rejecting an FRD or requesting changes to any other document. + * Used when rejecting an FRD. */ this.delete("/approvals/:document_id", (schema, request) => { const document = schema.document.findBy({ @@ -744,6 +758,12 @@ export default function (mirageConfig) { description: "Summarize a problem statement and outline a phased approach to addressing it.", }, + { + name: "FRD", + longName: "Funding Request", + description: + "Capture a budget request, along with the business justification and expected returns.", + }, ]); } else { return new Response( diff --git a/web/tests/acceptance/authenticated/document-test.ts b/web/tests/acceptance/authenticated/document-test.ts index d56083b73..3637198c3 100644 --- a/web/tests/acceptance/authenticated/document-test.ts +++ b/web/tests/acceptance/authenticated/document-test.ts @@ -73,6 +73,8 @@ const SIDEBAR_PUBLISH_FOR_REVIEW_BUTTON_SELECTOR = "[data-test-sidebar-publish-for-review-button"; const PUBLISH_FOR_REVIEW_MODAL_SELECTOR = "[data-test-publish-for-review-modal]"; +const DELETE_BUTTON = "[data-test-delete-draft-button]"; +const DELETE_MODAL = "[data-test-delete-draft-modal]"; const DOCUMENT_MODAL_PRIMARY_BUTTON_SELECTOR = "[data-test-document-modal-primary-button]"; const PUBLISHING_FOR_REVIEW_MESSAGE_SELECTOR = @@ -504,6 +506,32 @@ module("Acceptance | authenticated/document", function (hooks) { assertEditingIsDisabled(assert); }); + test("drafts can be deleted", async function (this: AuthenticatedDocumentRouteTestContext, assert) { + this.server.create("document", { + objectID: 1, + }); + + await visit("/document/1?draft=true"); + + await click(DELETE_BUTTON); + + assert.dom(DELETE_MODAL).exists("the user is shown a confirmation screen"); + + assert.dom(DOCUMENT_MODAL_PRIMARY_BUTTON_SELECTOR).hasText("Yes, delete"); + + await click(DOCUMENT_MODAL_PRIMARY_BUTTON_SELECTOR); + + assert.dom(DELETE_MODAL).doesNotExist("the modal is dismissed"); + + assert.dom(FLASH_MESSAGE_SELECTOR).containsText("Document draft deleted"); + + assert.equal( + currentURL(), + "/my/documents", + 'the user is redirected to the "my documents" page', + ); + }); + test("an approver can remove themselves from the approver role", async function (this: AuthenticatedDocumentRouteTestContext, assert) { this.server.create("document", { objectID: 1, From 39c914709b94cbac2c872d0af7c37410abf21860 Mon Sep 17 00:00:00 2001 From: Jeff Daley Date: Thu, 8 Feb 2024 10:20:59 -0500 Subject: [PATCH 24/27] Add and test for tooltips --- web/app/components/document/sidebar.hbs | 3 ++- web/tests/acceptance/authenticated/document-test.ts | 10 +++++++++- 2 files changed, 11 insertions(+), 2 deletions(-) diff --git a/web/app/components/document/sidebar.hbs b/web/app/components/document/sidebar.hbs index 6da5cdb3d..e7252c2ef 100644 --- a/web/app/components/document/sidebar.hbs +++ b/web/app/components/document/sidebar.hbs @@ -434,10 +434,10 @@ {{else}} @@ -491,6 +491,7 @@ @color="critical" @icon="thumbs-down" @isIconOnly={{true}} + {{tooltip "Reject"}} {{on "click" (perform this.rejectFRD)}} /> {{/if}} diff --git a/web/tests/acceptance/authenticated/document-test.ts b/web/tests/acceptance/authenticated/document-test.ts index 3637198c3..f3276da1a 100644 --- a/web/tests/acceptance/authenticated/document-test.ts +++ b/web/tests/acceptance/authenticated/document-test.ts @@ -506,13 +506,17 @@ module("Acceptance | authenticated/document", function (hooks) { assertEditingIsDisabled(assert); }); - test("drafts can be deleted", async function (this: AuthenticatedDocumentRouteTestContext, assert) { + test("you can delete a draft", async function (this: AuthenticatedDocumentRouteTestContext, assert) { this.server.create("document", { objectID: 1, }); await visit("/document/1?draft=true"); + await triggerEvent(DELETE_BUTTON, "mouseenter"); + + assert.dom(TOOLTIP_SELECTOR).hasText("Delete..."); + await click(DELETE_BUTTON); assert.dom(DELETE_MODAL).exists("the user is shown a confirmation screen"); @@ -612,6 +616,10 @@ module("Acceptance | authenticated/document", function (hooks) { await visit("/document/1"); + await triggerEvent(REJECT_FRD_BUTTON, "mouseenter"); + + assert.dom(TOOLTIP_SELECTOR).hasText("Reject"); + await click(REJECT_FRD_BUTTON); assert.dom(REJECT_FRD_BUTTON).doesNotExist("footer controls are removed"); From a877fb713c5a3584f7e04a780219577e80033de5 Mon Sep 17 00:00:00 2001 From: Jeff Daley Date: Thu, 8 Feb 2024 10:22:52 -0500 Subject: [PATCH 25/27] Update sidebar.hbs --- web/app/components/document/sidebar.hbs | 1 + 1 file changed, 1 insertion(+) diff --git a/web/app/components/document/sidebar.hbs b/web/app/components/document/sidebar.hbs index e7252c2ef..817f5df97 100644 --- a/web/app/components/document/sidebar.hbs +++ b/web/app/components/document/sidebar.hbs @@ -435,6 +435,7 @@ data-test-delete-draft-button @text="Delete..." @icon="trash" + @color="secondary" @isIconOnly={{true}} class="basis-0" {{tooltip "Delete..."}} From 6b559467fcec1a5c7af40a8ef5dbbd971a562e7a Mon Sep 17 00:00:00 2001 From: Jeff Daley Date: Thu, 8 Feb 2024 10:50:42 -0500 Subject: [PATCH 26/27] Fix tooltip bug --- web/app/modifiers/tooltip.ts | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/web/app/modifiers/tooltip.ts b/web/app/modifiers/tooltip.ts index 8a8f0e1d1..1ae282bd3 100644 --- a/web/app/modifiers/tooltip.ts +++ b/web/app/modifiers/tooltip.ts @@ -486,8 +486,11 @@ export default class TooltipModifier extends Modifier @action hideContent() { if (this.tooltip) { this.tooltip.remove(); - this.tooltip = null; this.updateState(TooltipState.Closed); + + schedule("afterRender", () => { + this.tooltip = null; + }); } } From 99b20bf09f295a0d5bbba878c34555b26052cba4 Mon Sep 17 00:00:00 2001 From: Jeff Daley Date: Thu, 8 Feb 2024 14:26:35 -0500 Subject: [PATCH 27/27] Pass `onClose` to docPublishedModal --- web/app/components/document/sidebar.hbs | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/web/app/components/document/sidebar.hbs b/web/app/components/document/sidebar.hbs index 817f5df97..680e16b94 100644 --- a/web/app/components/document/sidebar.hbs +++ b/web/app/components/document/sidebar.hbs @@ -695,7 +695,11 @@ {{/if}} {{#if this.docPublishedModalIsShown}} - +