The Original Hermes Repository changes

.github/workflows/ci.yml

@@ -23,6 +23,10 @@ jobs:
 
       - name: Set yarn version
         run: make web/set-yarn-version
+        # Workaround: https://github.com/actions/setup-node/issues/531#issuecomment-1819151412
+        env:
+          SKIP_YARN_COREPACK_CHECK: true
+          YARN_IGNORE_NODE: 1
 
       - name: Set up Go
         uses: actions/setup-go@v3

.gitignore

@@ -13,6 +13,7 @@
 node_modules
 /web/.pnp.*
 /web/.yarn/*
+/web/.eslintcache
 /web/dist
 
 # Terraform related

README.md

@@ -1,6 +1,6 @@
 # Hermes
 
-![](https://github.com/hashicorp-forge/hermes/workflows/ci/badge.svg)
+[![CI](https://github.com/hashicorp-forge/hermes/workflows/ci/badge.svg?branch=main)](https://github.com/hashicorp-forge/hermes/actions/workflows/ci.yml?query=branch%3Amain)
 
 > Hermes is not an official HashiCorp project.
 > The repository contains software which is under active development and is in the alpha stage. Please read the “[Project Status](#project-status)” section for more information.
@@ -23,7 +23,7 @@ Hermes was created and is currently maintained by HashiCorp Labs, a small team i
 
 1. Enable the following APIs for [Google Workspace APIs](https://developers.google.com/workspace/guides/enable-apis)
 
-   - Admin SDK API
+   - Admin SDK API (optional, if enabling Google Groups as document approvers)
    - Google Docs API
    - Google Drive API
    - Gmail API
@@ -84,12 +84,20 @@ The Application ID, Search API Key, and Write API Key in Algolia's [API Keys set
 
 Similarly, you will use these values to set the `HERMES_WEB_ALGOLIA_APP_ID` and `HERMES_WEB_ALGOLIA_SEARCH_API_KEY` environment variables at build time.
 
+### Jira (optional)
+
+Jira can be optionally configured to enable linking Hermes projects with Jira issues.
+
+1. [Create an API token](https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/#Create-an-API-token) for Jira.
+
+1. Enable Jira using the `jira` block in the Hermes config file.
+
 ## Development and Usage
 
 ### Requirements
 
 - Go 1.18
-- Node.js 16
+- Node.js 20
 - Yarn ~3.3.0 ([install with corepack](https://yarnpkg.com/getting-started/install))
 
 ### Configuration File
@@ -116,6 +124,8 @@ Hermes can be configured to point to any PostgreSQL database, but for running lo
 make docker/postgres/start
 ```
 
+The database password can be configured via the Hermes config.hcl or the `HERMES_SERVER_POSTGRES_PASSWORD` environment variable.
+
 ### Run the Server
 
 ```sh
@@ -136,10 +146,12 @@ NOTE: when not using a Google service account, this will automatically open a br
 
 - Create a new key (JSON type) for the service account and download it.
 - Go to [Delegating domain-wide authority to the service account](https://developers.google.com/identity/protocols/oauth2/service-account#delegatingauthority) and follow the instructions to enter the OAuth scopes.
-- Add the following OAuth scopes (comma-delimited list):
+- Add the following OAuth scopes (if enabling group approvals, add `https://www.googleapis.com/auth/admin.directory.group.readonly` to the comma-delimited list):
   `https://www.googleapis.com/auth/directory.readonly,https://www.googleapis.com/auth/documents,https://www.googleapis.com/auth/drive,https://www.googleapis.com/auth/gmail.send`
 
-More to come here...
+1. Configure the service account in the `auth` block under the `google_workspace` config block.
+
+1. If enabling group approvals, add the `https://www.googleapis.com/auth/admin.directory.group.readonly` role to the service user configured as the `subject` in the `auth` block (from previous step).
 
 ## Architecture
 
@@ -179,6 +191,5 @@ As the project becomes more stable over the next several releases, we think it w
 
 Here are some higher-level initiatives that we are currently working on:
 
-- Support custom document types.
 - Increase test coverage.
 - Finish migration of using Algolia as a NoSQL database to PostgreSQL as the source of truth for all non-search data.

configs/config.hcl

@@ -2,6 +2,10 @@
 // URL of the application.
 base_url = "http://localhost:8000"
 
+// log_format configures the logging format. Supported values are "standard" or
+// "json".
+log_format = "standard"
+
 // algolia configures Hermes to work with Algolia.
 algolia {
   application_id            = ""
@@ -10,17 +14,23 @@ algolia {
   internal_index_name       = "internal"
   links_index_name          = "links"
   missing_fields_index_name = "missing_fields"
+  projects_index_name       = "projects"
   search_api_key            = ""
   write_api_key             = ""
 }
 
-// document_types configures document types. Currently this block should not be
-// modified, but Hermes will support custom document types in the near future.
-// *** DO NOT MODIFY document_types ***
+// datadog configures Hermes to send metrics to Datadog.
+datadog {
+  enabled = false
+  env     = "local"
+}
+
+// document_types configures document types.
 document_types {
   document_type "RFC" {
     long_name   = "Request for Comments"
     description = "Create a Request for Comments document to present a proposal to colleagues for their review and feedback."
+    flight_icon = "discussion-circle"
     template    = "1Oz_7FhaWxdFUDEzKCC5Cy58t57C4znmC_Qr80BORy1U"
 
     more_info_link {
@@ -49,6 +59,7 @@ document_types {
   document_type "PRD" {
     long_name   = "Product Requirements"
     description = "Create a Product Requirements Document to summarize a problem statement and outline a phased approach to addressing the problem."
+    flight_icon = "target"
     template    = "1oS4q6IPDr3aMSTTk9UDdOnEcFwVWW9kT8ePCNqcg1P4"
 
     more_info_link {
@@ -65,6 +76,13 @@ document_types {
       type = "people"
     }
   }
+
+  // document_type "Memo" {
+  //   long_name = "Memo"
+  //   description = "Create a Memo document to share an idea or brief note with colleagues."
+  //   flight_icon = "radio"
+  //   template = "file-id-for-a-blank-doc"
+  // }
 }
 
 // email configures Hermes to send email notifications.
@@ -76,6 +94,19 @@ email {
   from_address = "[email protected]"
 }
 
+// FeatureFlags contain available feature flags.
+feature_flags {
+  // api_v2 enables v2 of the API.
+  flag "api_v2" {
+    enabled = false
+  }
+
+  // projects enables the projects feature in the UI.
+  flag "projects" {
+    enabled = false
+  }
+}
+
 // google_workspace configures Hermes to work with Google Workspace.
 google_workspace {
   // create_doc_shortcuts enables creating a shortcut in the shortcuts_folder
@@ -85,22 +116,42 @@ google_workspace {
   // docs_folder contains all published documents in a flat structure.
   docs_folder = "my-docs-folder-id"
 
+  // domain is the Google Workspace domain (e.g., "hashicorp.com").
+  domain = "your-domain-dot-com"
+
   // drafts_folder contains all draft documents.
   drafts_folder = "my-drafts-folder-id"
 
+  // group_approvals is the configuration for using Google Groups as document
+  // approvers.
+  group_approvals {
+    // enabled enables using Google Groups as document approvers.
+    enabled = false
+
+    // search_prefix is the prefix to use when searching for Google Groups.
+    // search_prefix = "team-"
+  }
+
   // If create_doc_shortcuts is set to true, shortcuts_folder will contain an
   // organized hierarchy of folders and shortcuts to published files that can be
   // easily browsed directly in Google Drive:
   //   {shortcut_folder}/{doc_type}/{product}/{document}
   shortcuts_folder = "my-shortcuts-folder-id"
 
+  // temporary_drafts_folder is a folder that will brieflly contain document
+  // drafts before they are moved to the drafts_folder. This is used when
+  // create_docs_as_user is true in the auth block, so document notification
+  // settings will be the same as when a user creates their own document.
+  // temporary_drafts_folder = "my-temporary-drafts-folder-id"
+
   // auth is the configuration for interacting with Google Workspace using a
   // service account.
   // auth {
-  //   client_email = ""
-  //   private_key  = ""
-  //   subject      = ""
-  //   token_url    = "https://oauth2.googleapis.com/token"
+  //   client_email        = ""
+  //   create_docs_as_user = true
+  //   private_key         = ""
+  //   subject             = ""
+  //   token_url           = "https://oauth2.googleapis.com/token"
   // }
 
   // oauth2 is the configuration used to authenticate users via Google.
@@ -124,6 +175,25 @@ indexer {
   // update_draft_headers enables the indexer to automatically update document
   // headers for draft documents based on Hermes metadata.
   update_draft_headers = true
+
+  // use_database_for_document_data will use the database instead of Algolia as
+  // the source of truth for document data, if true.
+  use_database_for_document_data = false
+}
+
+// jira is the configuration for Hermes to work with Jira.
+jira {
+  // api_token is the API token for authenticating to Jira.
+  api_token = ""
+
+  // enabled enables integration with Jira.
+  enabled = false
+
+  // url is the URL of the Jira instance (ex: https://your-domain.atlassian.net).
+  url = ""
+
+  // user is the user for authenticating to Jira.
+  user = ""
 }
 
 // okta configures Hermes to authenticate users using an AWS Application Load

go.mod

@@ -12,35 +12,49 @@ require (
 	github.com/hashicorp/go-hclog v1.2.0
 	github.com/hashicorp/go-multierror v1.1.1
 	github.com/hashicorp/hcl/v2 v2.11.1
+	github.com/iancoleman/strcase v0.3.0
 	github.com/mitchellh/cli v1.1.2
+	github.com/mitchellh/mapstructure v1.5.0
 	github.com/pkg/browser v0.0.0-20210911075715-681adbf594b8
 	github.com/stretchr/testify v1.8.1
-	golang.org/x/oauth2 v0.3.0
-	google.golang.org/api v0.103.0
+	golang.org/x/oauth2 v0.8.0
+	google.golang.org/api v0.126.0
+	gopkg.in/DataDog/dd-trace-go.v1 v1.49.1
 	gorm.io/datatypes v1.1.0
 	gorm.io/driver/postgres v1.4.5
 	gorm.io/gorm v1.24.3
 )
 
 require (
-	cloud.google.com/go/compute v1.13.0 // indirect
-	cloud.google.com/go/compute/metadata v0.2.1 // indirect
+	cloud.google.com/go/compute v1.19.3 // indirect
+	cloud.google.com/go/compute/metadata v0.2.3 // indirect
+	github.com/DataDog/datadog-agent/pkg/obfuscate v0.46.0 // indirect
+	github.com/DataDog/datadog-agent/pkg/remoteconfig/state v0.48.0-devel // indirect
+	github.com/DataDog/datadog-go/v5 v5.3.0 // indirect
+	github.com/DataDog/go-libddwaf v1.5.0 // indirect
+	github.com/DataDog/go-tuf v0.3.0--fix-localmeta-fork // indirect
+	github.com/DataDog/sketches-go v1.4.2 // indirect
 	github.com/Masterminds/goutils v1.1.1 // indirect
 	github.com/Masterminds/semver v1.5.0 // indirect
 	github.com/Masterminds/sprig v2.22.0+incompatible // indirect
+	github.com/Microsoft/go-winio v0.6.1 // indirect
 	github.com/agext/levenshtein v1.2.3 // indirect
 	github.com/apparentlymart/go-textseg/v13 v13.0.0 // indirect
 	github.com/armon/go-radix v1.0.0 // indirect
 	github.com/bgentry/speakeasy v0.1.0 // indirect
-	github.com/davecgh/go-spew v1.1.1 // indirect
-	github.com/fatih/color v1.13.0 // indirect
+	github.com/cespare/xxhash/v2 v2.2.0 // indirect
+	github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc // indirect
+	github.com/dustin/go-humanize v1.0.1 // indirect
+	github.com/ebitengine/purego v0.5.0-alpha.1 // indirect
+	github.com/fatih/color v1.15.0 // indirect
 	github.com/go-sql-driver/mysql v1.7.0 // indirect
 	github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da // indirect
-	github.com/golang/protobuf v1.5.2 // indirect
+	github.com/golang/protobuf v1.5.3 // indirect
 	github.com/google/go-cmp v0.5.9 // indirect
+	github.com/google/s2a-go v0.1.4 // indirect
 	github.com/google/uuid v1.3.0 // indirect
-	github.com/googleapis/enterprise-certificate-proxy v0.2.0 // indirect
-	github.com/googleapis/gax-go/v2 v2.7.0 // indirect
+	github.com/googleapis/enterprise-certificate-proxy v0.2.5 // indirect
+	github.com/googleapis/gax-go/v2 v2.11.0 // indirect
 	github.com/hashicorp/errwrap v1.1.0 // indirect
 	github.com/huandu/xstrings v1.3.2 // indirect
 	github.com/imdario/mergo v0.3.12 // indirect
@@ -49,32 +63,43 @@ require (
 	github.com/jackc/pgio v1.0.0 // indirect
 	github.com/jackc/pgpassfile v1.0.0 // indirect
 	github.com/jackc/pgproto3/v2 v2.3.1 // indirect
-	github.com/jackc/pgservicefile v0.0.0-20200714003250-2b9c44734f2b // indirect
+	github.com/jackc/pgservicefile v0.0.0-20221227161230-091c0ba34f0a // indirect
 	github.com/jackc/pgtype v1.13.0 // indirect
 	github.com/jackc/pgx/v4 v4.17.2 // indirect
 	github.com/jinzhu/inflection v1.0.0 // indirect
 	github.com/jinzhu/now v1.1.5 // indirect
-	github.com/kr/text v0.2.0 // indirect
-	github.com/mattn/go-colorable v0.1.12 // indirect
-	github.com/mattn/go-isatty v0.0.14 // indirect
+	github.com/mattn/go-colorable v0.1.13 // indirect
+	github.com/mattn/go-isatty v0.0.19 // indirect
 	github.com/mitchellh/copystructure v1.2.0 // indirect
 	github.com/mitchellh/go-wordwrap v1.0.1 // indirect
 	github.com/mitchellh/reflectwalk v1.0.2 // indirect
+	github.com/outcaste-io/ristretto v0.2.3 // indirect
+	github.com/philhofer/fwd v1.1.2 // indirect
 	github.com/pkg/errors v0.9.1 // indirect
-	github.com/pmezard/go-difflib v1.0.0 // indirect
+	github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2 // indirect
 	github.com/posener/complete v1.2.3 // indirect
-	github.com/rivo/uniseg v0.2.0 // indirect
+	github.com/rivo/uniseg v0.4.4 // indirect
+	github.com/secure-systems-lab/go-securesystemslib v0.5.0 // indirect
+	github.com/tinylib/msgp v1.1.8 // indirect
 	github.com/zclconf/go-cty v1.10.0 // indirect
 	go.opencensus.io v0.24.0 // indirect
-	golang.org/x/crypto v0.10.0 // indirect
-	golang.org/x/net v0.11.0 // indirect
-	golang.org/x/sys v0.9.0 // indirect
-	golang.org/x/text v0.10.0 // indirect
+	go.uber.org/atomic v1.11.0 // indirect
+	go4.org/intern v0.0.0-20230525184215-6c62f75575cb // indirect
+	go4.org/unsafe/assume-no-moving-gc v0.0.0-20230525183740-e7c30c78aeb2 // indirect
+	golang.org/x/crypto v0.12.0 // indirect
+	golang.org/x/mod v0.12.0 // indirect
+	golang.org/x/net v0.14.0 // indirect
+	golang.org/x/sys v0.11.0 // indirect
+	golang.org/x/text v0.12.0 // indirect
+	golang.org/x/time v0.3.0 // indirect
+	golang.org/x/tools v0.12.1-0.20230815132531-74c255bcf846 // indirect
+	golang.org/x/xerrors v0.0.0-20220907171357-04be3eba64a2 // indirect
 	google.golang.org/appengine v1.6.7 // indirect
-	google.golang.org/genproto v0.0.0-20221207170731-23e4bf6bdc37 // indirect
-	google.golang.org/grpc v1.51.0 // indirect
-	google.golang.org/protobuf v1.28.1 // indirect
-	gopkg.in/yaml.v2 v2.4.0 // indirect
+	google.golang.org/genproto/googleapis/api v0.0.0-20230920204549-e6e6cdab5c13 // indirect
+	google.golang.org/genproto/googleapis/rpc v0.0.0-20230920183334-c177e329c48b // indirect
+	google.golang.org/grpc v1.57.0 // indirect
+	google.golang.org/protobuf v1.31.0 // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect
 	gorm.io/driver/mysql v1.4.5 // indirect
+	inet.af/netaddr v0.0.0-20230525184311-b8eac61e914a // indirect
 )