Skip to content

fix(graphql-server): use services_public.domains in flush service #557

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pyramation merged 1 commit into from
Jan 5, 2026
Merged

fix(graphql-server): use services_public.domains in flush service #557

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 23 additions & 23 deletions graphql/server/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand All @@ -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

Expand All @@ -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`
Expand All @@ -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

Expand Down
15 changes: 11 additions & 4 deletions graphql/server/src/middleware/flush.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,18 @@
import { ConstructiveOptions } from '@constructive-io/graphql-types';
import { Logger } from '@pgpmjs/logger';
import { svcCache } from '@pgpmjs/server-utils';
import { NextFunction,Request, Response } from 'express';
import { NextFunction, Request, Response } from 'express';
import { graphileCache } from 'graphile-cache';
import { getPgPool } from 'pg-cache';
import './types'; // for Request type

const log = new Logger('flush');

export const flush = async (req: Request, res: Response, next: NextFunction): Promise<void> => {
export const flush = async (
req: Request,
res: Response,
next: NextFunction
): Promise<void> => {
if (req.url === '/flush') {
// TODO: check bearer for a flush / special key
graphileCache.delete((req as any).svc_key);
Expand All @@ -19,7 +23,10 @@ export const flush = async (req: Request, res: Response, next: NextFunction): Pr
return next();
};

export const flushService = async (opts: ConstructiveOptions, databaseId: string): Promise<void> => {
export const flushService = async (
opts: ConstructiveOptions,
databaseId: string
): Promise<void> => {
const pgPool = getPgPool(opts.pg);
log.info('flushing db ' + databaseId);

Expand All @@ -38,7 +45,7 @@ export const flushService = async (opts: ConstructiveOptions, databaseId: string

const svc = await pgPool.query(
`SELECT *
FROM meta_public.domains
FROM services_public.domains
WHERE database_id = $1`,
[databaseId]
);
Expand Down