Account Issue Model and Resolution Flow + Troubleshooting guides (#1090)

* Rough draft of issue system

* Simplify design

* Remove stale files from merge conflicts

* STI for issues

* Cleanup

* Improve Synth api key flow

* Stub api key for test

config/brakeman.ignore

@@ -1,6 +1,29 @@
 {
   "ignored_warnings": [
+    {
+      "warning_type": "Dynamic Render Path",
+      "warning_code": 15,
+      "fingerprint": "03a2010b605b8bdb7d4e1566720904d69ef2fbf8e7bc35735b84e161b475215e",
+      "check_name": "Render",
+      "message": "Render path contains parameter value",
+      "file": "app/controllers/issues_controller.rb",
+      "line": 5,
+      "link": "https://brakemanscanner.org/docs/warning_types/dynamic_render_path/",
+      "code": "render(template => \"#{Current.family.issues.find(params[:id]).class.name.underscore.pluralize}/show\", { :layout => \"issues\" })",
+      "render_path": null,
+      "location": {
+        "type": "method",
+        "class": "IssuesController",
+        "method": "show"
+      },
+      "user_input": "params[:id]",
+      "confidence": "Weak",
+      "cwe_id": [
+        22
+      ],
+      "note": ""
+    }
   ],
-  "updated": "2024-08-09 10:16:00 -0400",
+  "updated": "2024-08-16 10:19:50 -0400",
   "brakeman_version": "6.1.2"
 }

config/i18n-tasks.yml

@@ -25,7 +25,7 @@ search:
     - app/assets/builds
 ignore_unused:
   - 'activerecord.attributes.*' # i18n-tasks does not detect these on forms, forms validations (https://github.com/glebm/i18n-tasks/blob/0b4b483c82664f26c5696fb0f6aa1297356e4683/templates/config/i18n-tasks.yml#L146)
-  - 'activerecord.models.account*' # i18n-tasks does not detect use in dynamic model names (e.g. object.model_name.human)
+  - 'activerecord.models.*' # i18n-tasks does not detect use in dynamic model names (e.g. object.model_name.human)
   - 'helpers.submit.*' # i18n-tasks does not detect used at forms
   - 'helpers.label.*' # i18n-tasks does not detect used at forms
   - 'accounts.show.sync_message_*' # messages generated in the sync ActiveJob

config/locales/models/account/sync/en.yml

@@ -0,0 +1,5 @@
+---
+en:
+  account:
+    sync:
+      failed: Sync failed

config/locales/models/issue/en.yml

@@ -0,0 +1,7 @@
+---
+en:
+  activerecord:
+    models:
+      issue/exchange_rate_provider_missing: Exchange rate provider missing
+      issue/exchange_rates_missing: Exchange rates missing
+      issue/unknown: Unknown issue occurred

config/locales/views/layout/en.yml

@@ -8,6 +8,9 @@ en:
       sign_up: create an account
       terms_of_service: Terms of Service
       your_account: Your account
+    issues:
+      action: How to fix this issue
+      description: Issue Description
     sidebar:
       accounts: Accounts
       dashboard: Dashboard

config/routes.rb

@@ -102,6 +102,12 @@ Rails.application.routes.draw do
 
   resources :institutions, except: %i[ index show ]
 
+  resources :issues, only: :show
+
+  namespace :issue do
+    resources :exchange_rate_provider_missings, only: :update
+  end
+
   # For managing self-hosted upgrades and release notifications
   resources :upgrades, only: [] do
     member do

config/tailwind.config.js

@@ -52,27 +52,17 @@ module.exports = {
           to: { "stroke-dashoffset": 0 },
         },
       },
-      typography: {
+      typography: (theme) => ({
         DEFAULT: {
           css: {
             maxWidth: "none",
-            a: {
-              color: "inherit",
-              textDecoration: "underline",
-            },
             h2: {
-              fontSize: "1.125rem",
-              fontWeight: "inherit",
-              lineHeight: "1.75rem",
-              marginBottom: "0.625rem",
-              marginTop: "0.875rem",
+              fontSize: theme("fontSize.xl"),
+              fontWeight: theme("fontWeight.medium"),
             },
-            p: {
-              marginBottom: "0.625rem",
-              marginTop: "0.875rem",
-            },
-            strong: {
-              color: "inherit",
+            h3: {
+              fontSize: theme("fontSize.lg"),
+              fontWeight: theme("fontWeight.medium"),
             },
             li: {
               margin: 0,
@@ -94,7 +84,7 @@ module.exports = {
             },
           },
         },
-      },
+      }),
     },
   },
   plugins: [