[PortalDB][Attempt 2] POC PostgREST implementation with API Autogen (#467)

This is a stripped down version of #452 so it's easier to review & understand.

**Reviewing** - The key thing to review are the new `.sql` files.

**Testing** - `cd ./portal-db; make quickstart` and follow the instructions.

Demo: https://github.com/user-attachments/assets/11d15f28-154d-4e90-a212-dbbf9ffd291e

---

Co-authored-by: Pascal van Leeuwen <[email protected]>
Co-authored-by: commoddity <[email protected]>
Co-authored-by: fred <[email protected]>

Author: 4 people

.github/workflows/upload-pages-artifact.yml

@@ -22,7 +22,7 @@ jobs:
       - name: Set up Node.js
         uses: actions/setup-node@v4
         with:
-          node-version: 18
+          node-version: 20
           cache: "yarn"
           cache-dependency-path: docusaurus/yarn.lock
 
@@ -53,7 +53,7 @@ jobs:
       - name: Set up Node.js
         uses: actions/setup-node@v4
         with:
-          node-version: 18
+          node-version: 20
           cache: "yarn"
           cache-dependency-path: docusaurus/yarn.lock
 

.gitignore

@@ -80,5 +80,8 @@ install.log
 # Generated by ./e2e/scripts/shannon-preliminary-services-test.sh
 supplier_report_*.json
 
+# Portal DB
+pg_dump.sql
+
 # Benchmark Results
 bench_results

Makefile

@@ -4,14 +4,33 @@
 
 # TODO(@olshansk): Remove "Shannon" and just use "Pocket".
 
+# Patterns for classified help categories (automatically used by help-unclassified)
+HELP_PATTERNS := \
+	'^(help|help-unclassified):' \
+	'^path_(build|run):' \
+	'^config.*:' \
+	'^(path_up.*|path_down|install_tools.*|localnet_.*):' \
+	'^load_test.*:' \
+	'^(test_unit|test_all|go_lint):' \
+	'^e2e_test.*:' \
+	'^bench.*:' \
+	'^(get_disqualified_endpoints|grove_get_disqualified_endpoints|shannon_preliminary_services_test_help|shannon_preliminary_services_test|source_shannon_preliminary_services_helpers):' \
+	'^(portal_db_help):' \
+	'^proto.*:' \
+	'^release_.*:' \
+	'^(go_docs|docusaurus.*|gen_.*_docs):' \
+	'^test_(request|healthz|disqualified|load).*:' \
+	'^bench_.*:' \
+	'^claudesync.*:'
+
 .PHONY: help
 .DEFAULT_GOAL := help
 help: ## Prints all the targets in all the Makefiles
 	@echo ""
 	@echo "$(BOLD)$(CYAN)🌐 PATH (Path API & Toolkit Harness) Makefile Targets$(RESET)"
 	@echo ""
 	@echo "$(BOLD)=== 📋 Information & Discovery ===$(RESET)"
-	@grep -h -E '^help:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "$(CYAN)%-40s$(RESET) %s\n", $$1, $$2}'
+	@grep -h -E '^(help|help-unclassified):.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "$(CYAN)%-40s$(RESET) %s\n", $$1, $$2}'
 	@echo ""
 	@echo "$(BOLD)=== 🔨 Build & Run ===$(RESET)"
 	@grep -h -E '^path_(build|run):.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "$(CYAN)%-40s$(RESET) %s\n", $$1, $$2}'
@@ -20,7 +39,7 @@ help: ## Prints all the targets in all the Makefiles
 	@grep -h -E '^config.*:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "$(CYAN)%-40s$(RESET) %s\n", $$1, $$2}'
 	@echo ""
 	@echo "$(BOLD)=== 🛠️ Development Environment ===$(RESET)"
-	@grep -h -E '^(path_up|path_down|install_tools.*|localnet_.*):.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "$(CYAN)%-40s$(RESET) %s\n", $$1, $$2}'
+	@grep -h -E '^(path_up.*|path_down|install_tools.*|localnet_.*):.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "$(CYAN)%-40s$(RESET) %s\n", $$1, $$2}'
 	@echo ""
 	@echo "$(BOLD)=== 🚀 Load Testing ===$(RESET)"
 	@grep -h -E '^load_test.*:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "$(CYAN)%-40s$(RESET) %s\n", $$1, $$2}'
@@ -36,16 +55,14 @@ help: ## Prints all the targets in all the Makefiles
 	@grep -h -E '^(get_disqualified_endpoints|grove_get_disqualified_endpoints|shannon_preliminary_services_test_help|shannon_preliminary_services_test|source_shannon_preliminary_services_helpers):.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "$(CYAN)%-40s$(RESET) %s\n", $$1, $$2}'
 	@echo ""
 	@echo "$(BOLD)=== 🗄️ Portal Database ===$(RESET)"
-	@grep -h -E '^portal_db.*:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "$(CYAN)%-40s$(RESET) %s\n", $$1, $$2}'
+	@grep -h -E '^(portal_db_help):.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "$(CYAN)%-40s$(RESET) %s\n", $$1, $$2}'
 	@echo ""
 	@echo "$(BOLD)=== 📦 Protocol Buffers ===$(RESET)"
 	@grep -h -E '^proto.*:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "$(CYAN)%-40s$(RESET) %s\n", $$1, $$2}'
 	@echo ""
 	@echo "$(BOLD)=== 🚢 Release Management ===$(RESET)"
 	@grep -h -E '^release_.*:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "$(CYAN)%-40s$(RESET) %s\n", $$1, $$2}'
 	@echo ""
-	@echo "$(BOLD)=== 🔧 Utilities ===$(RESET)"
-	@echo ""
 	@echo "$(BOLD)=== 📚 Documentation ===$(RESET)"
 	@grep -h -E '^(go_docs|docusaurus.*|gen_.*_docs):.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "$(CYAN)%-40s$(RESET) %s\n", $$1, $$2}'
 	@echo ""
@@ -59,6 +76,23 @@ help: ## Prints all the targets in all the Makefiles
 	@grep -h -E '^claudesync.*:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "$(CYAN)%-40s$(RESET) %s\n", $$1, $$2}'
 	@echo ""
 
+.PHONY: help-unclassified
+help-unclassified: ## Show all unclassified targets
+	@echo ""
+	@echo "$(BOLD)$(CYAN)📦 Unclassified Targets$(RESET)"
+	@echo ""
+	@grep -h -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sed 's/:.*//g' | sort -u > /tmp/all_targets.txt
+	@( \
+		for pattern in $(HELP_PATTERNS); do \
+			grep -h -E "$$pattern.*?## .*\$$" $(MAKEFILE_LIST) 2>/dev/null || true; \
+		done \
+	) | sed 's/:.*//g' | sort -u > /tmp/classified_targets.txt
+	@comm -23 /tmp/all_targets.txt /tmp/classified_targets.txt | while read target; do \
+		grep -h -E "^$$target:.*?## .*\$$" $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "$(CYAN)%-40s$(RESET) %s\n", $$1, $$2}'; \
+	done
+	@rm -f /tmp/all_targets.txt /tmp/classified_targets.txt
+	@echo ""
+
 #############################
 #### PATH Build Targets   ###
 #############################
@@ -93,6 +127,15 @@ check_path_config:
 path_run: path_build check_path_config ## Run the path binary as a standalone binary
 	(cd bin; ./path -config ../${CONFIG_PATH})
 
+###############################
+###  Portal Database Help   ###
+###############################
+
+.PHONY: portal_db_help
+portal_db_help: ## Show Portal DB makefile targets
+	@echo "To use these commands: ${CYAN}cd ./portal-db && make <command>${RESET}"
+	@cd ./portal-db && make help
+
 ###############################
 ###    Makefile imports     ###
 ###############################
@@ -104,7 +147,6 @@ include ./makefiles/deps.mk
 include ./makefiles/devtools.mk
 include ./makefiles/docs.mk
 include ./makefiles/localnet.mk
-include ./makefiles/portal-db.mk
 include ./makefiles/test.mk
 include ./makefiles/bench.mk
 include ./makefiles/test_requests.mk

README.md

@@ -35,6 +35,15 @@ For Bug Reports and Enhancement Requests, please open an [Issue](https://github.
 
 For Technical Support please open a ticket in [Grove's Discord](https://discord.gg/build-with-grove).
 
+## Portal DB
+
+The portal DB is the source of truth for running a SaaS using PATH to deploya service similar to [Grove's Portal](https://portal.grove.city)
+
+See the following docs for more information:
+
+- [portal-db](./portal-db/README.md)
+- [portal-db/api](./portal-db/api/README.md)
+
 ---
 
 ## License

docusaurus/docs/develop/path/4_path_localnet.md

@@ -34,9 +34,6 @@ description: Development environment for the full PATH, GUARD & WATCH stack
 - [Development Workflow](#development-workflow)
   - [Hot Reloading](#hot-reloading)
   - [Viewing Logs](#viewing-logs)
-    - [Recommended: **Tilt UI** (http://localhost:10350):](#recommended-tilt-ui-httplocalhost10350)
-    - [**Inside the container**:](#inside-the-container)
-    - [**Using k9s**:](#using-k9s)
 
 ## Overview
 
@@ -73,7 +70,6 @@ make configs_copy_values_yaml   # Copy default .values.yaml
 - `./local/path/.config.yaml` - PATH gateway configuration
 - `./local/path/.values.yaml` - Helm values override file
 
-
 :::note 🌿 Are you a Grove employee 🌿?
 
 <details>
@@ -224,7 +220,6 @@ The PATH Localnet runs as a Docker container that internally manages a complete
 - **Tilt**: Development orchestrator that manages hot reloading and service lifecycle
 - **Kind**: Kubernetes-in-Docker providing the cluster environment
 
-
 ## Make Targets
 
 The PATH Localnet provides several make targets for managing your development environment:
@@ -375,20 +370,20 @@ The PATH Localnet supports hot reloading for rapid development:
 
 Multiple ways to view logs:
 
-#### Recommended: **Tilt UI** (http://localhost:10350):
+1. **Tilt UI** (http://localhost:10350):
 
-   - Real-time log streaming
-   - Filtered by service
-   - Search functionality
+- Real-time log streaming
+- Filtered by service
+- Search functionality
 
-#### **Inside the container**:
+2. **Inside the container**:
 
    ```bash
    make localnet_exec
    kubectl logs -f deployment/path
    ```
 
-#### **Using k9s**:
+3. **Using k9s**:
 
    ```bash
    make localnet_k9s

docusaurus/docusaurus.config.js

@@ -36,7 +36,6 @@ const config = {
   baseUrl: "/",
 
   onBrokenLinks: "throw",
-  onBrokenMarkdownLinks: "warn",
 
   i18n: {
     defaultLocale: "en",

docusaurus/package.json

@@ -14,9 +14,9 @@
     "write-heading-ids": "docusaurus write-heading-ids"
   },
   "dependencies": {
-    "@docusaurus/core": "^3.8.1",
-    "@docusaurus/preset-classic": "^3.8.1",
-    "@docusaurus/theme-mermaid": "^3.8.1",
+    "@docusaurus/core": "^3.9.1",
+    "@docusaurus/preset-classic": "^3.9.1",
+    "@docusaurus/theme-mermaid": "^3.9.1",
     "@easyops-cn/docusaurus-search-local": "^0.46.1",
     "@mdx-js/react": "^3.0.0",
     "clsx": "^2.0.0",
@@ -31,8 +31,8 @@
     "remark-mermaid-plugin": "^1.0.2"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "^3.8.1",
-    "@docusaurus/types": "^3.8.1"
+    "@docusaurus/module-type-aliases": "^3.9.1",
+    "@docusaurus/types": "^3.9.1"
   },
   "browserslist": {
     "production": [