api Mod Controller Compatibility Info and Required Disclosures system

.devcontainer/create.sh

@@ -0,0 +1,26 @@
+#!/usr/bin/env bash
+set -ex
+
+# Install protoc (used by go:generate) and add it to path
+# Not done in Dockerfile because it seems to lock out writing to some files go needs to write to?
+# https://github.com/ericslandry/grpc/blob/dcc9b228a2189933b0666eeea23852a12225092b/.devcontainer/post-create.sh
+version=25.4
+PB_REL="https://github.com/protocolbuffers/protobuf/releases"
+curl -LO $PB_REL/download/v$version/protoc-$version-linux-x86_64.zip
+unzip protoc-$version-linux-x86_64.zip -d $HOME/.local/
+export PATH="$PATH:$HOME/.local/bin"
+go install google.golang.org/protobuf/cmd/protoc-gen-go@v1.34.2
+go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@v1.3.0
+export PATH="$PATH:$(go env GOPATH)/bin"
+
+# Install libwebp (otherwise go:generate tries and fails to build it itself or something)
+# https://developers.google.com/speed/webp/docs/precompiled
+libwebp_version=1.4.0
+libwebp_file="libwebp-$libwebp_version-linux-x86-64.tar.gz"
+curl -LO "https://storage.googleapis.com/downloads.webmproject.org/releases/webp/$libwebp_file"
+mkdir -p $HOME/libwebp
+tar xzvf $libwebp_file -C $HOME/libwebp
+export PATH="$PATH:$HOME/libwebp/bin"
+
+# Add as a safe git directory
+git config --global --add safe.directory "/workspaces/smr_api"

.devcontainer/devcontainer.json

@@ -1,40 +1,47 @@
 {
-	"name": "Go",
+	"name": "smr-api",
 	"dockerComposeFile": "docker-compose.yml",
 	"service": "app",
-	"workspaceFolder": "/workspace",
+	"workspaceFolder": "/workspaces/smr_api",
+	"onCreateCommand": "./.devcontainer/create.sh",
 	"updateContentCommand": "go mod download && go generate -tags tools -x ./...",
+
 	// Add the IDs of extensions you want installed when the container is created.
-	"extensions": [
-		"golang.Go",
-		"mtxr.sqltools",
-		"mtxr.sqltools-driver-pg"
-	],
-	"settings": {
-		"go.toolsManagement.checkForUpdates": "local",
-		"go.useLanguageServer": true,
-		"go.gopath": "/go",
-		"go.goroot": "/usr/local/go",
-		"sqltools.connections": [
-			{
-				"name": "Container database",
-				"driver": "PostgreSQL",
-				"previewLimit": 50,
-				"server": "localhost",
-				"port": 5432,
-				"database": "postgres",
-				"username": "postgres",
-				"password": "REPLACE_ME"
+	"customizations": {
+		"vscode": {
+			"extensions": [
+				"golang.Go",
+				"mtxr.sqltools",
+				"mtxr.sqltools-driver-pg",
+				"streetsidesoftware.code-spell-checker"
+			],
+			"settings": {
+				"go.toolsManagement.checkForUpdates": "local",
+				"go.useLanguageServer": true,
+				"go.gopath": "/go",
+				"go.goroot": "/usr/local/go",
+				"sqltools.connections": [
+					{
+						"name": "Container database",
+						"driver": "PostgreSQL",
+						"previewLimit": 50,
+						"server": "localhost",
+						"port": 5432,
+						"database": "postgres",
+						"username": "postgres",
+						"password": "REPLACE_ME"
+					}
+				]
 			}
-		]
+		}
 	},
 	"forwardPorts": [
 		5432,
 		6379,
 		9000,
 		9001,
-		5020,
+		5020
 	],
 	// Comment out connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
 	"remoteUser": "vscode"
-}
+}

.devcontainer/docker-compose.yml

@@ -9,7 +9,7 @@ services:
         VARIANT: "1-bullseye"
         NODE_VERSION: "none"
     volumes:
-      - ..:/workspace:cached
+      - ..:/workspaces/smr_api:cached
     cap_add:
       - SYS_PTRACE
     network_mode: service:postgres

.gitattributes

@@ -0,0 +1,9 @@
+# Auto detect text files and perform LF normalization
+#	This keeps unix/windows machines from wanting to change every file
+#	from the other because of the line ending (\r vs \r\n)
+* text=auto
+*.sh text eol=lf
+*.env* text eol=lf
+
+# Atlas migration hashes are different if file get windows line endings
+*.sql text eol=lf

.github/workflows/build.yml

@@ -58,8 +58,11 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ github.token }}
 
+      - name: List file tasks and their permissions
+        run: cd ./.mise/tasks/ && ls -l
+
       - name: Setup
-        run: mise run setup
+        run: mise run setup -ci
 
       - name: Test
         run: mise run test_coverage_junit
@@ -105,7 +108,7 @@ jobs:
           GITHUB_TOKEN: ${{ github.token }}
 
       - name: Setup
-        run: mise run setup
+        run: mise run setup -ci
 
       - name: Download and seed database
         run: |

.github/workflows/generated.yml

@@ -23,8 +23,14 @@ jobs:
       - name: Tidy
         run: go mod tidy
 
-      - name: Ensure no changes
-        run: git diff --exit-code
+      - name: Ensure freshly generated hashes match committed ones
+      # Ignore mise.lock because it seems like mise can't generate checksums for platforms that you aren't on -> always diff
+        run: |
+          if ! git diff --exit-code ':!mise.lock'; then
+            echo "Error: Generating migration hashes again produced output that doesn't match those committed to the repo."
+            echo "Run 'mise run migrate_hash' and commit the changes."
+            exit 1
+          fi
 
   go:
     runs-on: ubuntu-latest
@@ -41,5 +47,11 @@ jobs:
       - name: Tidy
         run: go mod tidy
 
-      - name: Ensure no changes
-        run: git diff --exit-code
+      - name: Ensure freshly generated code matches committed code
+      # Ignore mise.lock because it seems like mise can't generate checksums for platforms that you aren't on -> always diff
+        run: |
+          if ! git diff --exit-code ':!mise.lock'; then
+            echo "Error: Regenerating the generated code produced output that doesn't match the code committed to the repo."
+            echo "Run 'mise run generate' and commit the changes."
+            exit 1
+          fi

.mise/tasks/mark_chmod_execute.ps1

@@ -0,0 +1,9 @@
+#MISE description="For developers on Windows, mark all .sh file-based Mise tasks as executable so Linux devs and the CI can use them"
+
+$shFiles = Get-ChildItem -Path "./.mise/tasks" -Filter "*.sh" -File
+
+foreach ($file in $shFiles) {
+    Write-Host "Setting Linux execute permission on $($file.Name)"
+    # https://git-scm.com/docs/git-update-index#Documentation/git-update-index.txt---chmod-x
+    git update-index --add --chmod=+x $file.FullName
+}

.mise/tasks/migrate_diff.sh → .mise/tasks/migrate_diff_linux.sh

@@ -1,7 +1,10 @@
 #!/usr/bin/env bash
+#MISE hide=true
 
 echo -n 'Migration Name: '
 
 read -r migration_name
 
+echo -n "Atlas is running..."
+
 atlas migrate diff "$migration_name" --dir "file://migrations/sql?format=golang-migrate" --to "ent://db/schema" --dev-url "docker://postgres/16/test?search_path=public"

.mise/tasks/migrate_diff_windows.ps1

@@ -0,0 +1,9 @@
+#MISE hide=true
+
+Write-Host -NoNewline 'Migration Name: '
+$migration_name = Read-Host
+Write-Host "Atlas is running..."
+atlas migrate diff "$migration_name" --dir "file://migrations/sql?format=golang-migrate" --to "ent://db/schema" --dev-url "docker://postgres/16/test?search_path=public"
+if (-not $?) {
+	Write-Error "If the above failed due to a checksum error, don't run the command it suggests, instead run ``mise run migrate_hash`` "
+}

.mise/tasks/migrate_new.sh → .mise/tasks/migrate_new_linux.sh

@@ -1,4 +1,5 @@
 #!/usr/bin/env bash
+#MISE hide=true
 
 echo -n 'Migration Name: '
 

.mise/tasks/migrate_new_windows.ps1

@@ -0,0 +1,10 @@
+#MISE hide=true
+
+Write-Host -NoNewline 'Migration Name: '
+$migration_name = Read-Host
+atlas migrate new "$migration_name" --dir "file://migrations/sql?format=golang-migrate"
+if (-not $?) {
+	Write-Error "If the above failed due to a checksum error, don't run the command it suggests, instead run ``mise run migrate_hash`` "
+} else {
+	Write-Host "Created new migration '$migration_name', check the migrations/sql/ directory for the new files"
+}

.mise/tasks/setup_linux.sh

@@ -0,0 +1,25 @@
+#!/usr/bin/env bash
+#USAGE flag "-ci" "Use plain progress output suitable for CI environments"
+#MISE hide=true
+
+ci=false
+while [[ $# -gt 0 ]]; do
+	case "$1" in
+		-ci)
+			ci=true
+			;;
+		*)
+			;;
+	esac
+	shift
+done
+
+progress=$([ "$ci" = true ] && echo "plain" || echo "auto")
+
+docker compose --progress "$progress" --file docker-compose-dev.yml up --detach --wait && echo "Waiting for 5 seconds" && sleep 5
+echo "Setting up MinIO..."
+mc alias set local http://localhost:9000 minio minio123
+mc admin user svcacct remove local/ REPLACE_ME_KEY --dp || echo It is okay for this REMOVE command to fail if the account is not found
+mc admin user svcacct add local minio --access-key REPLACE_ME_KEY --secret-key REPLACE_ME_SECRET
+mc anonymous set public local/smr
+echo "Setup complete"

.mise/tasks/setup_windows.ps1

@@ -0,0 +1,16 @@
+#USAGE flag "-ci" "Use plain progress output suitable for CI environments"
+#MISE hide=true
+
+param(
+	[switch]$ci
+)
+
+$progress = if ($ci) { "plain" } else { "auto" }
+
+docker compose --progress $progress --file docker-compose-dev.yml up --detach --wait && timeout /t 5
+Write-Host "Setting up MinIO... (If it gets stuck here, try restarting WSL via `wsl --shutdown`)"
+mc alias set local http://localhost:9000 minio minio123
+mc admin user svcacct remove local/ REPLACE_ME_KEY --dp || Write-Output "It is okay for this REMOVE command to fail if the account is not found"
+mc admin user svcacct add local minio --access-key REPLACE_ME_KEY --secret-key REPLACE_ME_SECRET
+mc anonymous set public local/smr
+Write-Host "Setup complete"