As a user I want the frontend code to be maintainable so that I can utilize the site

[sadlerw]

Notes

• from the COR review
• 1: Must have task
• 2: Should probably have task
• 3: Nice to have task

Acceptance criteria

• [x] all issues documented or remediated

Tasks

Frontend

• [x] 1 Make sure Individual methods are documented inline using comments that permit the use tools such as JsDoc." (seth)
• [x] 2 frontend/replace.build.js/ update-version could use some documentation on what it does.(will)
• [x] 3 I know that some config files need to be in the root directory, but I'm wondering if some of the development config files like the karma/ superstatic/ ts config could be moved into their own frontend/development-configurations directory (will)
• [x] 2 in the frontend/e2e/unauthenticated/check-authentication.e2e-spec.ts is there any way to check redirects back to the application from the service provider? understand if that is not possible. -not possible without disabling mocks and using a static account that would need to be maintained as part of each build (passwords updated etc.) (will)
• [x] 3 wondering if we want to move frontend/e2e/authenticated/app.po.ts into the special-uses directory (will)
• [x] 2 Remove commented out test on xmas sidebar: https://github.com/nciinc/fs-permit-platform/blob/sprint-11-development/frontend/e2e/authenticated/christmas-trees/xmas-tree-sidebar.e2e-spec.ts#L63
• [x] 3 this assertion should only display if the date was correctly updated right? https://github.com/nciinc/fs-permit-platform/blob/sprint-11-development/frontend/e2e/authenticated/christmas-trees/xmas-update-district-dates.e2e-spec.ts#L90 Yes (will)
• [x] 2 It seems like frontend/src/assets/img/ species files could be their own directory. We may want to break it out further based off of /maps /side-wide to better navigate this directory. (shekar)
• [x] 3 In the frontend/src/environments do we need separate change request forms? Seems like we'd likely have the same? or is this on account of local development? https://github.com/nciinc/fs-permit-platform/blob/sprint-11-development/frontend/src/environments/environment.prod.ts#L6 - Currently we have to make an environment file - the environments.ts is just a stub and it is currently a requirement in angular-cli that every property be in every file. That might change in future though as it is seen as a short-coming. (will)

Frontend/app

• [x] 3 Would it be worth including an xmas tree application model like this? https://github.com/nciinc/fs-permit-platform/blob/sprint-11-development/frontend/src/app/_models/special-use-application.ts or is that not necessary because there is no edit functionality? - since we are using reactive forms we don't need a model - these classes are probably unnecessary now, but we'd have to look into it and it's intake code. update it's unused, and has been removed from intake code.
• [x] 2 wondering if we want to pull out from Home the shared components like header and footer and then change this to special-use-landing-page as the actual home component is much more specific (seth)
• [x] 3 rename the Login directory to Authentication? or would that result in a naming conflict? (shekar)
• [x] 2 Is the status component the centrally used alert component? Status is a bit of confusing term to me in that regard as it has a specific meaning in the context of special use application approval. (seth)

Pipes

• [x] 2 I'm not sure that ColumnizeArray is still a Pipe that is being used. Please remove if so.(shekar)
• [x] 3 It seems like the filter pipe is inconsistent with other pipes capitalization.(shekar)
• [x] 2 LineBreakFormatter pipe also may no longer be necessary post markdown refactor.(shekar)

  Services

• [x] 1 Would be very helpful to have typeDoc statements for each service (seth)
• [x] 2 Seems like it could be helpful to rename auth-guard and authenication services to clarify that one is about redirecting and one is about authorization? or consolidate the two services into a single service for clarity(shekar)
• [x] 3 Could this util be moved to a pipe? https://github.com/nciinc/fs-permit-platform/blob/sprint-11-development/frontend/src/app/_services/util.service.ts#L68 (shekar)

  Trees

• [x] 1 it would be helpful in the readme/wiki to have a short blerb about the frontend xmas tree structure. i.e. that the application form is in app/application-forms while the rules, admin, guidelines are in app/trees (will)
• [x] 2 would it make sense to put this mapping within assets/content? https://github.com/nciinc/fs-permit-platform/blob/sprint-11-development/frontend/src/app/trees/_services/christmas-trees.service.ts#L72 (will)
• [x] 3 Would handlebars expressions be a more generalizable handler for this rendering? https://github.com/nciinc/fs-permit-platform/blob/sprint-11-development/frontend/src/app/trees/_services/christmas-trees.service.ts#L99
  • yes as discussed (shekar)
• [x] 2 sprint-11-development/frontend/src/app/trees/_services/christmas-trees is now more about the guidelines no? would it make sense to rename this service? (shekar)
• [x] 3 Break line into multiple if possible https://github.com/nciinc/fs-permit-platform/blob/sprint-11-development/frontend/src/app/trees/admin/report/report.component.html#L55 (shekar)
• [x] 2 Don't need an else block here; https://github.com/nciinc/fs-permit-platform/blob/sprint-11-development/frontend/src/app/trees/admin/district-dates/district-dates.component.ts#L83
  • needed as comments (shekar)
• [x] 3 The line break formatter appears to no longer be used in the rules, can we please remove if that is the case. https://github.com/nciinc/fs-permit-platform/blob/sprint-11-development/frontend/src/app/trees/forests/tree-guidelines/tree-rules/tree-rules.component.ts#L3 (shekar)
• [x] 3 Same as above in this one https://github.com/nciinc/fs-permit-platform/blob/sprint-11-development/frontend/src/app/trees/forests/tree-guidelines/tree-cutting-dates/tree-cutting-dates.component.html (shekar)
• [x] 2 Are the species assets now in the assets directory in two places? https://github.com/nciinc/fs-permit-platform/blob/sprint-11-development/frontend/src/app/trees/forests/tree-guidelines/tree-species/tree-species.component.html#L9 - because i know they are also in assets/imgs (shekar)
  • this one the markdown location, so species markdowns are in /assets/content/common/species and images are in assets/img/species

Definition of Done

• [x] Code unit / e2e tested and comply with QWASP
• [x] No new security vulnerabilities
• [x] Internal team code review
• [x] Documentation / readme.md / CircleCI updated
• [x] Docker updated
• [x] Compare finished design with mockup
• [ ] Usability tested

[sadlerw]

@lauraGgit you mention commenting for jsdoc above but we are using typedoc already which will automatically create function entries based on typescript. See http://typedoc.org/guides/doccomments/ We can audit for entries that require additional information other than the defaults, but adding /* / everywhere is not needed afaik.

[shekarpendem]

@lauraGgit For the below item: Need that else to handle forest that don't have areas (also clears previous areas) 2 Don't need an else block here; https://github.com/nciinc/fs-permit-platform/blob/sprint-11-development/frontend/src/app/trees/admin/district-dates/district-dates.component.ts#L83

[shekarpendem]

@lauraGgit For this item: this service is used for the landing (find forest) & guidelines pages. Can be still renamed if you prefer so. 2 sprint-11-development/frontend/src/app/trees/_services/christmas-trees is now more about the guidelines no? would it make sense to rename this service?