From fdd75178a23553bde76b04b8e332b00c03ec074b Mon Sep 17 00:00:00 2001
From: Jeff Daley <jeffdaley@users.noreply.github.com>
Date: Mon, 18 Mar 2024 14:23:46 -0400
Subject: [PATCH] Update types and descriptions

---
 web/app/adapters/jira-issue.ts                |  3 +-
 web/app/components/project/jira-widget.ts     |  5 ++--
 web/app/components/project/tile.ts            |  9 ++----
 web/app/models/jira-issue.ts                  | 29 ++++++++++---------
 web/app/serializers/jira-issue.ts             |  5 ++--
 web/app/types/project.d.ts                    | 15 ++--------
 .../components/project/jira-widget-test.ts    |  5 ++--
 7 files changed, 31 insertions(+), 40 deletions(-)

diff --git a/web/app/adapters/jira-issue.ts b/web/app/adapters/jira-issue.ts
index 59b67281c..3e2caa740 100644
--- a/web/app/adapters/jira-issue.ts
+++ b/web/app/adapters/jira-issue.ts
@@ -2,6 +2,7 @@ import DS from "ember-data";
 import ApplicationAdapter from "./application";
 import RSVP from "rsvp";
 import ModelRegistry from "ember-data/types/registries/model";
+import JiraIssueModel from "hermes/models/jira-issue";
 
 export default class JiraIssueAdapter extends ApplicationAdapter {
   findRecord<K extends string | number>(
@@ -9,7 +10,7 @@ export default class JiraIssueAdapter extends ApplicationAdapter {
     _type: ModelRegistry[K],
     id: string,
     _snapshot: DS.Snapshot<K>,
-  ): RSVP.Promise<any> {
+  ): RSVP.Promise<JiraIssueModel> {
     const issue = this.fetchSvc
       .fetch(`/api/${this.configSvc.config.api_version}/jira/issues/${id}`)
       .then((response) => response?.json());
diff --git a/web/app/components/project/jira-widget.ts b/web/app/components/project/jira-widget.ts
index 62b9e8284..afc9996ba 100644
--- a/web/app/components/project/jira-widget.ts
+++ b/web/app/components/project/jira-widget.ts
@@ -4,16 +4,17 @@ import { tracked } from "@glimmer/tracking";
 import { inject as service } from "@ember/service";
 import { restartableTask } from "ember-concurrency";
 import FetchService from "hermes/services/fetch";
-import { JiraIssue, JiraPickerResult } from "hermes/types/project";
+import { JiraPickerResult } from "hermes/types/project";
 import ConfigService from "hermes/services/config";
 import { XDropdownListAnchorAPI } from "../x/dropdown-list";
 import { next } from "@ember/runloop";
 import { assert } from "@ember/debug";
+import JiraIssueModel from "hermes/models/jira-issue";
 
 interface ProjectJiraWidgetComponentSignature {
   Element: HTMLDivElement;
   Args: {
-    issue?: JiraPickerResult | JiraIssue;
+    issue?: JiraPickerResult | JiraIssueModel;
     onIssueSelect?: (issue: any) => void;
     onIssueRemove?: () => void;
     isDisabled?: boolean;
diff --git a/web/app/components/project/tile.ts b/web/app/components/project/tile.ts
index 3d4220b17..3a90c780f 100644
--- a/web/app/components/project/tile.ts
+++ b/web/app/components/project/tile.ts
@@ -3,14 +3,11 @@ import { inject as service } from "@ember/service";
 import Component from "@glimmer/component";
 import { tracked } from "@glimmer/tracking";
 import { task } from "ember-concurrency";
+import JiraIssueModel from "hermes/models/jira-issue";
 import ConfigService from "hermes/services/config";
 import FetchService from "hermes/services/fetch";
 import StoreService from "hermes/services/store";
-import {
-  HermesProject,
-  HermesProjectHit,
-  JiraIssue,
-} from "hermes/types/project";
+import { HermesProject, HermesProjectHit } from "hermes/types/project";
 
 export const PROJECT_TILE_MAX_PRODUCTS = 3;
 
@@ -50,7 +47,7 @@ export default class ProjectTileComponent extends Component<ProjectTileComponent
    * Used in the template to determine whether to show Jira-related data.
    * Set by the `fetchJiraIssue` task if the project has a jiraIssueID.
    */
-  @tracked protected jiraIssue: JiraIssue | null = null;
+  @tracked protected jiraIssue: JiraIssueModel | null = null;
 
   /**
    * The project ID used as our LinkTo model.
diff --git a/web/app/models/jira-issue.ts b/web/app/models/jira-issue.ts
index 35466278e..fc164e581 100644
--- a/web/app/models/jira-issue.ts
+++ b/web/app/models/jira-issue.ts
@@ -2,47 +2,50 @@ import Model, { attr } from "@ember-data/model";
 
 export default class JiraIssueModel extends Model {
   /**
-   *
+   * The Jira issue key, e.g., "PROJ-123".
+   * Used as the ID for the JiraIssue model.
    */
   @attr declare key: string;
 
   /**
-   *
+   * The summary of the issue.
    */
-  @attr declare summary: string;
+  @attr declare summary?: string;
 
   /**
-   *
+   * The issue permalink.
    */
   @attr declare url: string;
 
   /**
-   *
+   * The status, e.g., "Open".
    */
   @attr declare status: string;
 
   /**
-   *
+   * The assignee of the issue.
    */
-  @attr declare assignee: string;
+  @attr declare assignee?: string;
 
   /**
-   *
+   * The type of issue, e.g., "Bug".
    */
-  @attr declare issueType: string;
+  @attr declare issueType?: string;
 
   /**
-   *
+   * The URL to the issue type image.
+   * TODO: Host these ourselves to avoid broken images.
    */
   @attr declare issueTypeImage: string;
 
   /**
-   *
+   * The issue priority, e.g., "High".
    */
-  @attr declare priority: string;
+  @attr declare priority?: string;
 
   /**
-   *
+   * The URL to the priority image.
+   * TODO: Host these ourselves to avoid broken images.
    */
   @attr declare priorityImage: string;
 }
diff --git a/web/app/serializers/jira-issue.ts b/web/app/serializers/jira-issue.ts
index ebd9bbba9..9de5f7b4f 100644
--- a/web/app/serializers/jira-issue.ts
+++ b/web/app/serializers/jira-issue.ts
@@ -4,9 +4,8 @@ import JiraIssueModel from "hermes/models/jira-issue";
 
 export default class JiraIssueSerializer extends JSONSerializer {
   /**
-   * The serializer for the `person` model.
-   * Handles `query` and `queryRecord` requests to the EmberData store.
-   * Formats the response to match the JSON spec.
+   * The serializer for the JiraIssue model.
+   * Formats responses to the JSON spec.
    */
   normalizeResponse(
     _store: DS.Store,
diff --git a/web/app/types/project.d.ts b/web/app/types/project.d.ts
index 71fb82d85..21968d1f5 100644
--- a/web/app/types/project.d.ts
+++ b/web/app/types/project.d.ts
@@ -5,18 +5,7 @@ import {
 import { ProjectStatus } from "./project-status";
 import { HermesDocument } from "./document";
 import { AlgoliaHit } from "hermes/services/algolia";
-
-export interface JiraIssue {
-  key: string;
-  url: string;
-  priority: string;
-  priorityImage: string;
-  status: string;
-  assignee?: string;
-  issueType: string;
-  issueTypeImage: string;
-  summary: string;
-}
+import JiraIssueModel from "hermes/models/jira-issue";
 
 export interface JiraPickerResult {
   key: string;
@@ -47,5 +36,5 @@ export interface HermesProjectResources {
 export interface HermesProject
   extends HermesProjectInfo,
     HermesProjectResources {
-  jiraIssue?: JiraIssue;
+  jiraIssue?: JiraIssueModel;
 }
diff --git a/web/tests/integration/components/project/jira-widget-test.ts b/web/tests/integration/components/project/jira-widget-test.ts
index 37c7a5f91..b752f3ff7 100644
--- a/web/tests/integration/components/project/jira-widget-test.ts
+++ b/web/tests/integration/components/project/jira-widget-test.ts
@@ -3,12 +3,13 @@ import { MirageTestContext, setupMirage } from "ember-cli-mirage/test-support";
 import { setupRenderingTest } from "ember-qunit";
 import { click, fillIn, find, render, waitFor } from "@ember/test-helpers";
 import { hbs } from "ember-cli-htmlbars";
-import { JiraIssue, JiraPickerResult } from "hermes/types/project";
+import { JiraPickerResult } from "hermes/types/project";
 import {
   TEST_JIRA_WORKSPACE_URL,
   TEST_JIRA_ISSUE_SUMMARY,
   setWebConfig,
 } from "hermes/mirage/utils";
+import JiraIssueModel from "hermes/models/jira-issue";
 
 const JIRA_ICON = "[data-test-jira-icon]";
 const ADD_JIRA_INPUT = "[data-test-add-jira-input]";
@@ -33,7 +34,7 @@ const PLUS_ICON = "[data-test-add-jira-button-plus]";
 
 interface Context extends MirageTestContext {
   contextIsForm: boolean;
-  issue: JiraPickerResult | JiraIssue;
+  issue: JiraPickerResult | JiraIssueModel;
   isLoading: boolean;
   onIssueSelect: () => void;
   onIssueRemove: () => void;