Create top-level README.

.gitignore

@@ -1,6 +1,7 @@
 .DS_Store
 .terraform
 node_modules
+/api/deploy
 /web/dist
 /dist
 

Makefile

@@ -23,8 +23,7 @@ dist/hff-entry-forms-web-${VERSION}.${TARGET_ENV}.tar.gz:
 	tar czf dist/hff-entry-forms-web-${VERSION}.${TARGET_ENV}.tar.gz -C web/dist .
 
 deploy-api:
-	make -C api build-image push-image
+	TARGET_ENV=${TARGET_ENV} make -C api build-image push-image publish
-	cd operations/terraform && terraform apply -target module.${TARGET_ENV}_env.aws_ecs_task_definition.hff_entry_forms_api -target module.${TARGET_ENV}_env.aws_ecs_service.hff_entry_forms_api
 
 deploy-web: dist/hff-entry-forms-web-${VERSION}.${TARGET_ENV}.tar.gz
 	mkdir -p temp-deploy/hff-entry-forms-web-${VERSION}

README.md

@@ -0,0 +1,79 @@
+# HFF Entry Forms
+
+## Local Development
+
+### Web
+
+```sh
+cd web
+npm install
+make serve & # or run in a separate terminal/pane
+make build # as-needed to rebuild (not using hot-reload)
+```
+
+### API
+
+```sh
+cd api
+make serve
+
+make serve-docker   # alternatively
+```
+
+## Procedures
+
+### Version Bump
+
+1. Ensure you know the current deployed version and the current "marked
+   version." Check the current deployed version by hitting the live API:
+
+       curl https://forms-api.hopefamilyfellowship.com/v1/version
+
+   and by querying ECR:
+
+       aws ecr describe-images --repository-name 063932952339.dkr.ecr.us-west-2.amazonaws.com/hff_entry_forms_api
+
+   Check the current "marked version" by looking at the latest git tag:
+
+       git tag -n
+
+2. If necessary, bump the version using:
+
+       make update-version
+
+   This will invoke `operations/update-version.sh` which:
+
+   - updates `web/package.json`,
+   - updates `web/package-lock.json`,
+   - updates `api/src/hff_entry_forms_apipkg/version.nim`,
+   - updates `api/hff_entry_forms_api.nimble`,
+   - commits all of the above, and
+   - tags the commit with the new version.
+
+#### Release Candidates (`-rcX` versions)
+
+When we are preparing to release version a new version, we first create release
+candidates. So, in preparation for releasing, for example, version 1.2.4, we
+do the following:
+
+```sh
+# Development is concluded, ready to release 1.2.4
+$ make update-version
+Last Version: 1.2.3
+New Version: 1.2.4-rc1
+
+$ TARGET_ENV=dev make deploy
+# verify successful build and deployment
+# validate the release in the dev environment
+
+$ make update-version
+Last Version: 1.2.4-rc1
+New Version: 1.2.4
+
+$ TARGET_ENV=dev make deploy
+# verify successful build and deployment
+
+$ TARGET_ENV=prod make deploy
+# verify successful build and deployment
+# validate the release in the prod environment
+```

api/Dockerfile

@@ -1,5 +1,4 @@
 FROM 063932952339.dkr.ecr.us-west-2.amazonaws.com/alpine-nim:nim-1.6.10 AS build
-MAINTAINER jonathan@jdbernard.com
 
 COPY hff_entry_forms_api.nimble /hff_entry_forms_api/
 COPY src /hff_entry_forms_api/src

api/Makefile

@@ -13,6 +13,8 @@ endif
 # The server to target when publishing the API
 TARGET_SERVER ?= sobeck.jdb-software.com
 
+TARGET_ENV ?= local
+
 # The Notion integration token.
 AUTH_SECRET ?= 123abc
 
@@ -90,19 +92,19 @@ echo-vars:
 		"PORT=$(PORT)\n" \
 		"INTEGRATION_TOKEN=$(INTEGRATION_TOKEN)\n"
 
-publis:
+publish:
 	-rm -r deploy
 	-mkdir deploy
 	m4 \
 		-D "HFF_ENTRY_FORMS_API_VERSION=$(VERSION)" \
 		-D "TARGET_ENV=$(TARGET_ENV)" \
-		-D "TARGET_PORT=$(TARGET_PORT)" \
+		-D "TARGET_PORT=$(PORT)" \
 		hff_entry_forms_api.service \
 		> deploy/hff_entry_forms_api.$(TARGET_ENV).service
-	-ssh deployer@$(TARGET_SERVER) "docker stop hff_entry_forms.$(TARGET_ENV).service && sudo systemctl stop hff_entry_forms.$(TARGET_ENV)"
+	-ssh deployer@$(TARGET_SERVER) "docker stop hff_entry_forms_api.$(TARGET_ENV).service && sudo systemctl stop hff_entry_forms_api.$(TARGET_ENV)"
-	ssh deployer@$(TARGET_SERVER) "aws ecr get-login-password --region us-west-2 | docker login --username AWS --password-stdin $(ECR_ACCOUNT_URL) && docker pull $(ECR_ACCOUNT_URL)/hff_entry_forms:$(VERSION)"
+	ssh deployer@$(TARGET_SERVER) "aws ecr get-login-password --region us-west-2 | docker login --username AWS --password-stdin $(ECR_ACCOUNT_URL) && docker pull $(ECR_ACCOUNT_URL)/hff_entry_forms_api:$(VERSION)"
 	scp \
-		deploy/hff_entry_forms.$(TARGET_ENV).service \
+		deploy/hff_entry_forms_api.$(TARGET_ENV).service \
-		deployer@$(TARGET_SERVER):/etc/systemd/system/hff_entry_forms.$(TARGET_ENV).service
+		deployer@$(TARGET_SERVER):/etc/systemd/system/hff_entry_forms_api.$(TARGET_ENV).service
 	ssh deployer@$(TARGET_SERVER) "sudo systemctl daemon-reload"
-	ssh deployer@$(TARGET_SERVER) "sudo systemctl start hff_entry_forms.$(TARGET_ENV)"
+	ssh deployer@$(TARGET_SERVER) "sudo systemctl start hff_entry_forms_api.$(TARGET_ENV)"

api/hff_entry_forms_api.nimble

@@ -1,6 +1,6 @@
 # Package
 
-version       = "0.3.2"
+version       = "0.3.3"
 author        = "Jonathan Bernard"
 description   = "Hope Family Fellowship entry forms."
 license       = "GPL-3.0-or-later"

api/hff_entry_forms_api.service

@@ -9,7 +9,7 @@ Restart=always
 ExecStartPre=-/usr/bin/docker rm %n
 ExecStart=/usr/bin/docker run --rm -p TARGET_PORT:80 --name %n \
   --env-file /etc/hff_entry_forms/TARGET_ENV.env \
-  063932952339.dkr.ecr.us-west-2.amazonaws.com/hff_entry_forms:HFF_ENTRY_FORMS_VERSION
+  063932952339.dkr.ecr.us-west-2.amazonaws.com/hff_entry_forms_api:HFF_ENTRY_FORMS_API_VERSION
 ExecStop=/usr/bin/docker stop --name %n
 
 [Install]

api/src/hff_entry_forms_api.nim

@@ -1,4 +1,5 @@
-import cliutils, docopt, json, logging, sequtils, strutils, tables
+import std/[json, logging, os, sequtils, strutils, tables]
+import cliutils, docopt
 
 import hff_entry_forms_apipkg/api
 import hff_entry_forms_apipkg/version
@@ -26,12 +27,13 @@ proc loadConfig(args: Table[string, docopt.Value]): HffEntryFormsApiConfig =
   let cfg = CombinedConfig(docopt: args, json: json)
 
   result = HffEntryFormsApiConfig(
-    debug: args["--debug"],
+    debug: cfg.hasKey("debug") and cfg.getVal("debug") == "true",
     eventParentId: cfg.getVal("event-parent-id"),
     integrationToken: cfg.getVal("integration-token"),
-    knownOrigins: cfg.getVal("known-origins")[1..^2].split(',').mapIt(it[1..^2]),
+    knownOrigins: cfg.getVal("known-origins")[1..^2].split(',').mapIt(it.strip[1..^2]),
     notionApiBaseUrl: cfg.getVal("notion-api-base-url"),
     notionVersion: cfg.getVal("notion-version"),
+    notionConfigDbId: cfg.getVal("notion-config-db-id"),
     port: parseInt(cfg.getVal("port", "8300")))
 
 when isMainModule:
@@ -59,11 +61,11 @@ Options:
   # Initialize our service context
   let args = docopt(doc, version = HFF_ENTRY_FORMS_API_VERSION)
 
-  if args["--debug"]:
-    consoleLogger.levelThreshold = lvlDebug
-
   let cfg = loadConfig(args)
 
+  if cfg.debug:
+    consoleLogger.levelThreshold = lvlDebug
+
   if args["serve"]: start(cfg)
 
  except:

api/src/hff_entry_forms_apipkg/api.nim

@@ -39,6 +39,8 @@ template jsonResp(code: HttpCode,
       }
     else: @{:}
 
+  #debug "Request origin: $#\nKnown origins: $#\nAdding headers:\n$#" %
+  #  [ reqOrigin, cfg.knownOrigins.join(" | "), $corsHeaders ]
   halt(
     code,
     headersToSend & corsHeaders & @{

api/src/hff_entry_forms_apipkg/notion_client.nim

@@ -11,7 +11,7 @@ proc getNotionClient(cfg: HffEntryFormsApiConfig): NotionClient =
     notionClient = some(initNotionClient(NotionClientConfig(
       apiVersion: cfg.notionVersion,
       apiBaseUrl: cfg.notionApiBaseUrl,
-      configDbId: "",
+      configDbId: cfg.notionConfigDbId,
       integrationToken: cfg.integrationToken)))
   return notionClient.get
 

api/src/hff_entry_forms_apipkg/service.nim

@@ -12,6 +12,7 @@ type
     knownOrigins*: seq[string]
     notionApiBaseUrl*: string
     notionVersion*: string
+    notionConfigDbId*: string
     port*: int
 
 proc newApiError*(parent: ref Exception = nil, respCode: HttpCode, respMsg: string, msg = ""): ref ApiError =

api/src/hff_entry_forms_apipkg/version.nim

@@ -1 +1 @@
-const HFF_ENTRY_FORMS_API_VERSION* = "0.3.2"
+const HFF_ENTRY_FORMS_API_VERSION* = "0.3.3"

api/test/tmodels.nim

@@ -4,7 +4,7 @@ import hff_entry_forms_apipkg/models
 
 suite "models":
 
-  test "asNotionPage(EventProposal)":
+  test "toPage(EventProposal)":
     let ep = EventProposal(
       name: "Test Event",
       description: "A test event.",
@@ -15,6 +15,6 @@ suite "models":
       date: parse("2021-10-30", "YYYY-MM-dd"),
       budgetInDollars: 56)
 
-    let expectedJson = """{"properties":{"Event":{"title":[{"type":"text","text":{"content":"Test Event"}}]},"Date":{"date":{"start":"2021-10-30T00:00:00.000-05:00"}},"Department":{"multi_select":[{"name":"Testing"}]},"Location":{"rich_text":[{"type":"text","text":{"content":"Hope Family Fellowship"}}]},"Owner":{"rich_text":[{"type":"text","text":{"content":"Jonathan Bernard"}}]},"State":{"select":{"name":"Proposed"}},"Visibility":{"select":{"name":"Public"}}},"children":[{"object":"block","type":"heading_2","heading_2":{"text":[{"type":"text","text":{"content":"Purpose"}}]}},{"object":"block","type":"paragraph","paragraph":{"text":[{"type":"text","text":{"content":"Event example for unit testing."}}]}},{"object":"block","type":"heading_2","heading_2":{"text":[{"type":"text","text":{"content":"Description"}}]}},{"object":"block","type":"paragraph","paragraph":{"text":[{"type":"text","text":{"content":"A test event."}}]}}]}"""
+    let expectedJson = """{"properties":{"Event":{"title":[{"type":"text","text":{"content":"Test Event"}}]},"Date":{"date":{"start":"2021-10-30T00:00:00-05:00"}},"Department":{"multi_select":[{"name":"Testing"}]},"Location":{"rich_text":[{"type":"text","text":{"content":"Hope Family Fellowship"}}]},"Owner":{"rich_text":[{"type":"text","text":{"content":"Jonathan Bernard"}}]},"State":{"select":{"name":"Proposed"}},"Visibility":{"select":{"name":"Public"}}},"children":[{"object":"block","type":"heading_2","heading_2":{"text":[{"type":"text","text":{"content":"Purpose"}}]}},{"object":"block","type":"paragraph","paragraph":{"text":[{"type":"text","text":{"content":"Event example for unit testing."}}]}},{"object":"block","type":"heading_2","heading_2":{"text":[{"type":"text","text":{"content":"Description"}}]}},{"object":"block","type":"paragraph","paragraph":{"text":[{"type":"text","text":{"content":"A test event."}}]}}]}"""
 
-    check $(ep.asNotionPage) == expectedJson
+    check $(ep.toPage) == expectedJson

operations/README.md

@@ -2,10 +2,12 @@
 
 ## System Components
 
-* DNS - hosted on GoDaddy
+* DNS - managed by AWS
-* API Server - hosted on the `ortis` ECS cluster at JDB Software
+* API Server - hosted on `sobeck.jdb-software.com`
 * API Loadbalancer - using the main load balancer for JDB Software
 * Web App - Served by CloudFront from an S3 bucket managed by JDB Software
 * Certificates - Manually created and validated for \*.HFF.com
-* Notion Integration - defined in Notion, token provided via AWS secrets
+* Notion Integration - defined in Notion, token provided via the environment
-  manager to the API instance running on the ortis cluster.
+  specific config files at `/etc/hff_entry_forms/{dev,prod}.env` and passed
+  into the docker container at runtime ad defined in the SystemD service file
+  (see `api/hff_entry_forms_api.service`)

web/README.md

@@ -1,24 +0,0 @@
-# hff-entry-form-web
-
-## Project setup
-```
-npm install
-```
-
-### Compiles and hot-reloads for development
-```
-npm run serve
-```
-
-### Compiles and minifies for production
-```
-npm run build
-```
-
-### Lints and fixes files
-```
-npm run lint
-```
-
-### Customize configuration
-See [Configuration Reference](https://cli.vuejs.org/config/).

web/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hff-entry-form-web",
-  "version": "0.3.2",
+  "version": "0.3.3",
   "private": true,
   "scripts": {
     "serve": "npx servor dist",

web/src/views/ProposeEvent.ts

@@ -1,4 +1,4 @@
-import { defineComponent, Ref, ref } from 'vue';
+import { defineComponent, ref } from 'vue';
 import { logService } from '@jdbernard/logging';
 import {
   default as api,
@@ -28,8 +28,8 @@ export default defineComponent({
   props: {},
   components: { CircleCheckIcon, CircleCrossIcon, HourGlassIcon, SpinnerIcon },
   setup: function TheProposeEventView() {
-    const departments: Ref<{ value: string; color: string }[]> = ref([]);
+    const departments = ref<{ value: string; color: string }[]>([]);
-    const formState: Ref<FormState> = ref('loading');
+    const formState = ref<FormState>('loading');
 
     setTimeout(async () => {
       departments.value = (await api.getEventProposalConfig()).departments;
@@ -62,14 +62,14 @@ export default defineComponent({
       if (await api.proposeEvent(formVal.event)) {
         formState.value = 'success';
         successes.push(
-          `We've recorded the proposed details for ${formVal.event.name}.`
+          `We've recorded the proposed details for ${formVal.event.name}.`,
         );
       } else {
         formState.value = 'error';
         errors.push(
           'We were unable to record the proposed details for ' +
             formVal.event.name +
-            ". Poke Jonathan and tell him it's broken."
+            ". Poke Jonathan and tell him it's broken.",
         );
       }
 

web/src/views/ProposeEvent.vue

@@ -18,7 +18,11 @@
         </label>
         <label>
           <span>Date and time</span>
-          <input type="date" name="date" v-model="formVal.event.date" />
+          <input
+            type="datetime-local"
+            name="date"
+            v-model="formVal.event.date"
+          />
         </label>
         <label>
           <span>Department / Event Type</span>