feat(cli): expose graphql endpoint

Author: endersonmaia

.changeset/heavy-penguins-act.md

@@ -0,0 +1,5 @@
+---
+"@cartesi/cli": major
+---
+
+expose graphql endpoint

apps/cli/src/commands/run.ts

@@ -40,6 +40,11 @@ export const registerRunCommand = (program: Command) => {
             false,
         )
         .option("--enable-espresso", "enable espresso development node", false)
+        .option(
+            "--disable-graphql",
+            "disable local graphql service to save machine resources",
+            false,
+        )
         .option(
             "--no-backend",
             "run a node without the application code",
@@ -166,6 +171,11 @@ export const registerRunCommand = (program: Command) => {
                     composeFiles.push("docker-compose-espresso.yaml");
                 }
 
+                // graphql
+                if (!disableExplorer) {
+                    composeFiles.push("docker-compose-graphql.yaml");
+                }
+
                 // load the no-backend compose file
                 if (backend) {
                     composeFiles.push("docker-compose-host.yaml");

apps/cli/src/node/docker-compose-graphql.yaml

@@ -0,0 +1,67 @@
+services:
+    graphql_database_creator:
+        image: postgres:16-alpine
+        command: ["createdb", "graphql"]
+        depends_on:
+            database:
+                condition: service_healthy
+        environment:
+            PGHOST: ${PGHOST:-database}
+            PGPORT: ${PGPORT:-5432}
+            PGUSER: ${PGUSER:-postgres}
+            PGPASSWORD: ${PGPASSWORD:-password}
+            PGDATABASE: ${PGDATABASE:-postgres}
+
+    graphql_database_migration:
+        image: cartesi/sdk:0.12.0-alpha.8
+        environment:
+            POSTGRES_GRAPHQL_DB_URL: &graphql_db_url postgres://${PGUSER:-postgres}:${PGPASSWORD:-password}@${PGHOST:-database}:${PGPORT:-5432}/graphql?sslmode=disable
+        command:
+            - /bin/bash
+            - -c
+            - |
+                migrate                                                      \
+                -source file:///usr/share/cartesi/rollups-graphql/migrations \
+                -database $$POSTGRES_GRAPHQL_DB_URL                          \
+                up
+        depends_on:
+            graphql_database_creator:
+                condition: service_completed_successfully
+
+    graphql:
+        image: cartesi/sdk:0.12.0-alpha.8
+        environment:
+            POSTGRES_GRAPHQL_DB_URL: *graphql_db_url
+            POSTGRES_NODE_DB_URL: postgres://${PGUSER:-postgres}:${PGPASSWORD:-password}@${PGHOST:-database}:${PGPORT:-5432}/${PGDATABASE:-postgres}?sslmode=disable
+        expose:
+            - 8080
+        command: ["cartesi-rollups-graphql"]
+        depends_on:
+            graphql_database_migration:
+                condition: service_completed_successfully
+
+    prompt:
+        image: debian:bookworm-slim
+        environment:
+            PROMPT_TXT_04_GRAPHQL: "GraphQL endpoint running at http://localhost:${CARTESI_LISTEN_PORT}/graphql/"
+
+    traefik-config-generator:
+        environment:
+            TRAEFIK_CONFIG_GRAPHQL: |
+                http:
+                    routers:
+                        graphql:
+                            rule: "PathPrefix(`/graphql`)"
+                            middlewares:
+                                - "remove-graphql-prefix"
+                            service: graphql
+                    middlewares:
+                        remove-graphql-prefix:
+                            replacePathRegex:
+                                regex: "^/graphql/(.*)"
+                                replacement: "/$1"
+                    services:
+                        graphql:
+                            loadBalancer:
+                                servers:
+                                    - url: "http://graphql:8080"

apps/cli/src/node/docker-compose-validator.yaml

@@ -33,7 +33,6 @@ services:
     prompt:
         image: debian:bookworm-slim
         environment:
-            PROMPT_TXT_02_GRAPHQL: "GraphQL running at http://localhost:${CARTESI_LISTEN_PORT}/graphql"
             PROMPT_TXT_03_INSPECT: "Inspect running at http://localhost:${CARTESI_LISTEN_PORT}/inspect/"
 
     traefik-config-generator:
@@ -48,15 +47,4 @@ services:
                         inspect_server:
                             loadBalancer:
                                 servers:
-                                    - url: "http://validator:10012/inspect"
-            TRAEFIK_CONFIG_GRAPHQL_SERVER: |
-                http:
-                    routers:
-                        graphql_server:
-                            rule: "PathPrefix(`/graphql`)"
-                            service: graphql_server
-                    services:
-                        graphql_server:
-                            loadBalancer:
-                                servers:
-                                    - url: "http://validator:10000/graphql"
+                                    - url: "http://validator:10000/inspect"