@constructive-io/graphql-server 2.11.5 → 2.13.0

package/README.md

@@ -33,13 +33,13 @@ import { GraphQLServer } from '@constructive-io/graphql-server';
 GraphQLServer(
   getEnvOptions({
     pg: { database: 'constructive_db' },
-    server: { host: '0.0.0.0', port: 3000 }
+    server: { host: '0.0.0.0', port: 3000 },
   })
 );
 ```
 
 > **Tip:** Set `PGHOST`, `PGPORT`, `PGUSER`, `PGPASSWORD`, `PGDATABASE` to control DB connectivity.
-See [Configuration](#configuration) for the full list of supported env vars and defaults.
+> See [Configuration](#configuration) for the full list of supported env vars and defaults.
 
 ### Local Development (this repo)
 
@@ -50,9 +50,9 @@ pnpm dev
 ```
 
 This starts the server with env defaults from `@constructive-io/graphql-env`.
-> **Tip:** Set `PGHOST`, `PGPORT`, `PGUSER`, `PGPASSWORD`, `PGDATABASE` to control DB connectivity.
-See [Configuration](#configuration) for the full list of supported env vars and defaults.
 
+> **Tip:** Set `PGHOST`, `PGPORT`, `PGUSER`, `PGPASSWORD`, `PGDATABASE` to control DB connectivity.
+> See [Configuration](#configuration) for the full list of supported env vars and defaults.
 
 ## What it does
 
@@ -79,7 +79,7 @@ Runs an Express server that wires CORS, uploads, domain parsing, auth, and PostG
 
 When `API_ENABLE_META=true` (default):
 
-- The server resolves APIs from `meta_public.domains` using the request host.
+- The server resolves APIs from `services_public.domains` using the request host.
 - Only APIs where `api.is_public` matches `API_IS_PUBLIC` are served.
 - In private mode (`API_IS_PUBLIC=false`), you can override with headers:
   - `X-Api-Name` + `X-Database-Id`
@@ -95,24 +95,24 @@ When `API_ENABLE_META=false`:
 
 Configuration is merged from defaults, config files, and env vars via `@constructive-io/graphql-env`. See `graphql/env/README.md` for the full list and examples.
 
-| Env var | Purpose | Default |
-| --- | --- | --- |
-| `PGHOST` | Postgres host | `localhost` |
-| `PGPORT` | Postgres port | `5432` |
-| `PGUSER` | Postgres user | `postgres` |
-| `PGPASSWORD` | Postgres password | `password` |
-| `PGDATABASE` | Postgres database | `postgres` |
-| `GRAPHILE_SCHEMA` | Comma-separated schemas to expose | empty |
-| `FEATURES_SIMPLE_INFLECTION` | Enable simple inflection | `true` |
-| `FEATURES_OPPOSITE_BASE_NAMES` | Enable opposite base names | `true` |
-| `FEATURES_POSTGIS` | Enable PostGIS support | `true` |
-| `API_ENABLE_META` | Enable meta API routing | `true` |
-| `API_IS_PUBLIC` | Serve public APIs only | `true` |
-| `API_EXPOSED_SCHEMAS` | Schemas when meta routing is disabled | empty |
-| `API_META_SCHEMAS` | Meta schemas to query | `collections_public,meta_public` |
-| `API_ANON_ROLE` | Anonymous role name | `administrator` |
-| `API_ROLE_NAME` | Authenticated role name | `administrator` |
-| `API_DEFAULT_DATABASE_ID` | Default database ID | `hard-coded` |
+| Env var                        | Purpose                               | Default                                                       |
+| ------------------------------ | ------------------------------------- | ------------------------------------------------------------- |
+| `PGHOST`                       | Postgres host                         | `localhost`                                                   |
+| `PGPORT`                       | Postgres port                         | `5432`                                                        |
+| `PGUSER`                       | Postgres user                         | `postgres`                                                    |
+| `PGPASSWORD`                   | Postgres password                     | `password`                                                    |
+| `PGDATABASE`                   | Postgres database                     | `postgres`                                                    |
+| `GRAPHILE_SCHEMA`              | Comma-separated schemas to expose     | empty                                                         |
+| `FEATURES_SIMPLE_INFLECTION`   | Enable simple inflection              | `true`                                                        |
+| `FEATURES_OPPOSITE_BASE_NAMES` | Enable opposite base names            | `true`                                                        |
+| `FEATURES_POSTGIS`             | Enable PostGIS support                | `true`                                                        |
+| `API_ENABLE_META`              | Enable meta API routing               | `true`                                                        |
+| `API_IS_PUBLIC`                | Serve public APIs only                | `true`                                                        |
+| `API_EXPOSED_SCHEMAS`          | Schemas when meta routing is disabled | empty                                                         |
+| `API_META_SCHEMAS`             | Meta schemas to query                 | `services_public,metaschema_public,metaschema_modules_public` |
+| `API_ANON_ROLE`                | Anonymous role name                   | `administrator`                                               |
+| `API_ROLE_NAME`                | Authenticated role name               | `administrator`                                               |
+| `API_DEFAULT_DATABASE_ID`      | Default database ID                   | `hard-coded`                                                  |
 
 ## Testing
 

package/esm/middleware/api.js

@@ -1,4 +1,5 @@
 import { getNodeEnv } from '@constructive-io/graphql-env';
+import { Logger } from '@pgpmjs/logger';
 import { svcCache } from '@pgpmjs/server-utils';
 import { getSchema, GraphileQuery } from 'graphile-query';
 import { getGraphileSettings } from 'graphile-settings';
@@ -7,6 +8,8 @@ import errorPage50x from '../errors/50x';
 import errorPage404Message from '../errors/404-message';
 import { ApiByNameQuery, ApiQuery, ListOfAllDomainsOfDb } from './gql';
 import './types'; // for Request type
+const log = new Logger('api');
+const isDev = () => getNodeEnv() === 'development';
 const transformServiceToApi = (svc) => {
     const api = svc.data.api;
     const schemaNames = api.schemaNamesFromExt?.nodes?.map((n) => n.schemaName) || [];
@@ -92,6 +95,8 @@ export const createApiMiddleware = (opts) => {
             const api = transformServiceToApi(svc);
             req.api = api;
             req.databaseId = api.databaseId;
+            if (isDev())
+                log.debug(`Resolved API: db=${api.dbname}, schemas=[${api.schema?.join(', ')}]`);
             next();
         }
         catch (e) {
@@ -104,7 +109,7 @@ export const createApiMiddleware = (opts) => {
                     .send(errorPage404Message("The resource you're looking for does not exist."));
             }
             else {
-                console.error(e);
+                log.error('API middleware error:', e);
                 res.status(500).send(errorPage50x);
             }
         }
@@ -162,7 +167,7 @@ const queryServiceByDomainAndSubdomain = async ({ opts, key, client, domain, sub
         variables: { domain, subdomain },
     });
     if (result.errors?.length) {
-        console.error(result.errors);
+        log.error('GraphQL query errors:', result.errors);
         return null;
     }
     const nodes = result?.data?.domains?.nodes;
@@ -184,7 +189,7 @@ const queryServiceByApiName = async ({ opts, key, client, databaseId, name, }) =
         variables: { databaseId, name },
     });
     if (result.errors?.length) {
-        console.error(result.errors);
+        log.error('GraphQL query errors:', result.errors);
         return null;
     }
     const data = result?.data;
@@ -229,14 +234,21 @@ export const getApiConfig = async (opts, req) => {
     req.svc_key = key;
     let svc;
     if (svcCache.has(key)) {
+        if (isDev())
+            log.debug(`Cache HIT for key=${key}`);
         svc = svcCache.get(key);
     }
     else {
+        if (isDev())
+            log.debug(`Cache MISS for key=${key}, looking up API`);
         const apiOpts = opts.api || {};
         const allSchemata = apiOpts.metaSchemas || [];
         const validatedSchemata = await validateSchemata(rootPgPool, allSchemata);
         if (validatedSchemata.length === 0) {
-            const message = `No valid schemas found for domain: ${domain}, subdomain: ${subdomain}`;
+            const apiOpts2 = opts.api || {};
+            const message = `No valid schemas found. Configured metaSchemas: [${(apiOpts2.metaSchemas || []).join(', ')}]`;
+            if (isDev())
+                log.debug(message);
             const error = new Error(message);
             error.code = 'NO_VALID_SCHEMAS';
             throw error;

package/esm/middleware/auth.js

@@ -1,6 +1,10 @@
+import { getNodeEnv } from '@constructive-io/graphql-env';
+import { Logger } from '@pgpmjs/logger';
 import { getPgPool } from 'pg-cache';
 import pgQueryContext from 'pg-query-context';
 import './types'; // for Request type
+const log = new Logger('auth');
+const isDev = () => getNodeEnv() === 'development';
 export const createAuthenticateMiddleware = (opts) => {
     return async (req, res, next) => {
         const api = req.api;
@@ -13,8 +17,11 @@ export const createAuthenticateMiddleware = (opts) => {
             database: api.dbname,
         });
         const rlsModule = api.rlsModule;
-        if (!rlsModule)
+        if (!rlsModule) {
+            if (isDev())
+                log.debug('No RLS module configured, skipping auth');
             return next();
+        }
         const authFn = opts.server.strictAuth
             ? rlsModule.authenticateStrict
             : rlsModule.authenticate;
@@ -46,8 +53,11 @@ export const createAuthenticateMiddleware = (opts) => {
                         return;
                     }
                     token = result.rows[0];
+                    if (isDev())
+                        log.debug(`Auth success: role=${token.role}`);
                 }
                 catch (e) {
+                    log.error('Auth error:', e.message);
                     res.status(200).json({
                         errors: [
                             {

package/esm/middleware/flush.js

@@ -29,7 +29,7 @@ export const flushService = async (opts, databaseId) => {
         });
     }
     const svc = await pgPool.query(`SELECT *
-     FROM meta_public.domains
+     FROM services_public.domains
      WHERE database_id = $1`, [databaseId]);
     if (svc.rowCount === 0)
         return;

package/esm/server.js

@@ -1,4 +1,4 @@
-import { getEnvOptions } from '@constructive-io/graphql-env';
+import { getEnvOptions, getNodeEnv } from '@constructive-io/graphql-env';
 import { Logger } from '@pgpmjs/logger';
 import { healthz, poweredBy, trustProxy } from '@pgpmjs/server-utils';
 import { middleware as parseDomains } from '@constructive-io/url-domains';
@@ -13,6 +13,7 @@ import { cors } from './middleware/cors';
 import { flush, flushService } from './middleware/flush';
 import { graphile } from './middleware/graphile';
 const log = new Logger('server');
+const isDev = () => getNodeEnv() === 'development';
 export const GraphQLServer = (rawOpts = {}) => {
     const envOptions = getEnvOptions(rawOpts);
     const app = new Server(envOptions);
@@ -27,6 +28,11 @@ class Server {
         const app = express();
         const api = createApiMiddleware(opts);
         const authenticate = createAuthenticateMiddleware(opts);
+        // Log startup config in dev mode
+        if (isDev()) {
+            log.debug(`Database: ${opts.pg?.database}@${opts.pg?.host}:${opts.pg?.port}`);
+            log.debug(`Meta schemas: ${opts.api?.metaSchemas?.join(', ') || 'default'}`);
+        }
         healthz(app);
         trustProxy(app, opts.server.trustProxy);
         // Warn if a global CORS override is set in production

package/middleware/api.js

@@ -5,6 +5,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getApiConfig = exports.createApiMiddleware = exports.getSubdomain = void 0;
 const graphql_env_1 = require("@constructive-io/graphql-env");
+const logger_1 = require("@pgpmjs/logger");
 const server_utils_1 = require("@pgpmjs/server-utils");
 const graphile_query_1 = require("graphile-query");
 const graphile_settings_1 = require("graphile-settings");
@@ -13,6 +14,8 @@ const _50x_1 = __importDefault(require("../errors/50x"));
 const _404_message_1 = __importDefault(require("../errors/404-message"));
 const gql_1 = require("./gql");
 require("./types"); // for Request type
+const log = new logger_1.Logger('api');
+const isDev = () => (0, graphql_env_1.getNodeEnv)() === 'development';
 const transformServiceToApi = (svc) => {
     const api = svc.data.api;
     const schemaNames = api.schemaNamesFromExt?.nodes?.map((n) => n.schemaName) || [];
@@ -99,6 +102,8 @@ const createApiMiddleware = (opts) => {
             const api = transformServiceToApi(svc);
             req.api = api;
             req.databaseId = api.databaseId;
+            if (isDev())
+                log.debug(`Resolved API: db=${api.dbname}, schemas=[${api.schema?.join(', ')}]`);
             next();
         }
         catch (e) {
@@ -111,7 +116,7 @@ const createApiMiddleware = (opts) => {
                     .send((0, _404_message_1.default)("The resource you're looking for does not exist."));
             }
             else {
-                console.error(e);
+                log.error('API middleware error:', e);
                 res.status(500).send(_50x_1.default);
             }
         }
@@ -170,7 +175,7 @@ const queryServiceByDomainAndSubdomain = async ({ opts, key, client, domain, sub
         variables: { domain, subdomain },
     });
     if (result.errors?.length) {
-        console.error(result.errors);
+        log.error('GraphQL query errors:', result.errors);
         return null;
     }
     const nodes = result?.data?.domains?.nodes;
@@ -192,7 +197,7 @@ const queryServiceByApiName = async ({ opts, key, client, databaseId, name, }) =
         variables: { databaseId, name },
     });
     if (result.errors?.length) {
-        console.error(result.errors);
+        log.error('GraphQL query errors:', result.errors);
         return null;
     }
     const data = result?.data;
@@ -237,14 +242,21 @@ const getApiConfig = async (opts, req) => {
     req.svc_key = key;
     let svc;
     if (server_utils_1.svcCache.has(key)) {
+        if (isDev())
+            log.debug(`Cache HIT for key=${key}`);
         svc = server_utils_1.svcCache.get(key);
     }
     else {
+        if (isDev())
+            log.debug(`Cache MISS for key=${key}, looking up API`);
         const apiOpts = opts.api || {};
         const allSchemata = apiOpts.metaSchemas || [];
         const validatedSchemata = await validateSchemata(rootPgPool, allSchemata);
         if (validatedSchemata.length === 0) {
-            const message = `No valid schemas found for domain: ${domain}, subdomain: ${subdomain}`;
+            const apiOpts2 = opts.api || {};
+            const message = `No valid schemas found. Configured metaSchemas: [${(apiOpts2.metaSchemas || []).join(', ')}]`;
+            if (isDev())
+                log.debug(message);
             const error = new Error(message);
             error.code = 'NO_VALID_SCHEMAS';
             throw error;

package/middleware/auth.js

@@ -4,9 +4,13 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createAuthenticateMiddleware = void 0;
+const graphql_env_1 = require("@constructive-io/graphql-env");
+const logger_1 = require("@pgpmjs/logger");
 const pg_cache_1 = require("pg-cache");
 const pg_query_context_1 = __importDefault(require("pg-query-context"));
 require("./types"); // for Request type
+const log = new logger_1.Logger('auth');
+const isDev = () => (0, graphql_env_1.getNodeEnv)() === 'development';
 const createAuthenticateMiddleware = (opts) => {
     return async (req, res, next) => {
         const api = req.api;
@@ -19,8 +23,11 @@ const createAuthenticateMiddleware = (opts) => {
             database: api.dbname,
         });
         const rlsModule = api.rlsModule;
-        if (!rlsModule)
+        if (!rlsModule) {
+            if (isDev())
+                log.debug('No RLS module configured, skipping auth');
             return next();
+        }
         const authFn = opts.server.strictAuth
             ? rlsModule.authenticateStrict
             : rlsModule.authenticate;
@@ -52,8 +59,11 @@ const createAuthenticateMiddleware = (opts) => {
                         return;
                     }
                     token = result.rows[0];
+                    if (isDev())
+                        log.debug(`Auth success: role=${token.role}`);
                 }
                 catch (e) {
+                    log.error('Auth error:', e.message);
                     res.status(200).json({
                         errors: [
                             {

package/middleware/flush.js

@@ -33,7 +33,7 @@ const flushService = async (opts, databaseId) => {
         });
     }
     const svc = await pgPool.query(`SELECT *
-     FROM meta_public.domains
+     FROM services_public.domains
      WHERE database_id = $1`, [databaseId]);
     if (svc.rowCount === 0)
         return;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@constructive-io/graphql-server",
-  "version": "2.11.5",
+  "version": "2.13.0",
   "author": "Constructive <developers@constructive.io>",
   "description": "Constructive GraphQL Server",
   "main": "index.js",
@@ -39,8 +39,8 @@
     "backend"
   ],
   "dependencies": {
-    "@constructive-io/graphql-env": "^2.8.14",
-    "@constructive-io/graphql-types": "^2.12.10",
+    "@constructive-io/graphql-env": "^2.8.15",
+    "@constructive-io/graphql-types": "^2.12.11",
     "@constructive-io/s3-utils": "^2.4.1",
     "@constructive-io/upload-names": "^2.3.6",
     "@constructive-io/url-domains": "^2.3.7",
@@ -52,15 +52,15 @@
     "express": "^5.2.1",
     "graphile-build": "^4.14.1",
     "graphile-cache": "^1.6.14",
-    "graphile-i18n": "^0.2.46",
-    "graphile-meta-schema": "^0.3.46",
-    "graphile-plugin-connection-filter": "^2.4.46",
-    "graphile-plugin-connection-filter-postgis": "^1.1.47",
-    "graphile-plugin-fulltext-filter": "^2.1.46",
+    "graphile-i18n": "^0.3.0",
+    "graphile-meta-schema": "^0.4.0",
+    "graphile-plugin-connection-filter": "^2.5.0",
+    "graphile-plugin-connection-filter-postgis": "^1.2.0",
+    "graphile-plugin-fulltext-filter": "^2.2.0",
     "graphile-query": "^2.4.7",
-    "graphile-search-plugin": "^0.2.46",
-    "graphile-settings": "^2.10.5",
-    "graphile-simple-inflector": "^0.2.46",
+    "graphile-search-plugin": "^0.3.0",
+    "graphile-settings": "^2.11.0",
+    "graphile-simple-inflector": "^0.3.0",
     "graphile-utils": "^4.14.1",
     "graphql": "15.10.1",
     "graphql-tag": "2.12.6",
@@ -83,5 +83,5 @@
     "nodemon": "^3.1.10",
     "ts-node": "^10.9.2"
   },
-  "gitHead": "5eca40587d2b8e2362a2308bc3fa8c1eecf131da"
+  "gitHead": "97528ad4eb2f60c16785ffb84af7b61c52cb5ad8"
 }

package/server.js

@@ -19,6 +19,7 @@ const cors_1 = require("./middleware/cors");
 const flush_1 = require("./middleware/flush");
 const graphile_1 = require("./middleware/graphile");
 const log = new logger_1.Logger('server');
+const isDev = () => (0, graphql_env_1.getNodeEnv)() === 'development';
 const GraphQLServer = (rawOpts = {}) => {
     const envOptions = (0, graphql_env_1.getEnvOptions)(rawOpts);
     const app = new Server(envOptions);
@@ -34,6 +35,11 @@ class Server {
         const app = (0, express_1.default)();
         const api = (0, api_1.createApiMiddleware)(opts);
         const authenticate = (0, auth_1.createAuthenticateMiddleware)(opts);
+        // Log startup config in dev mode
+        if (isDev()) {
+            log.debug(`Database: ${opts.pg?.database}@${opts.pg?.host}:${opts.pg?.port}`);
+            log.debug(`Meta schemas: ${opts.api?.metaSchemas?.join(', ') || 'default'}`);
+        }
         (0, server_utils_1.healthz)(app);
         (0, server_utils_1.trustProxy)(app, opts.server.trustProxy);
         // Warn if a global CORS override is set in production