graphile-schema 2.10.4 → 2.10.6

package/build-introspection.d.ts

@@ -4,9 +4,10 @@ export type { BuildSchemaOptions as BuildIntrospectionOptions };
 /**
  * Build introspection metadata for all tables visible in the given schemas.
  *
- * Internally calls `buildSchemaSDL()` which triggers the MetaSchemaPlugin
- * gather hook, populating `_cachedTablesMeta` as a side-effect. The cached
- * metadata is then returned as a plain array of `TableMeta` objects.
+ * Internally calls `buildSchemaArtifacts()`, which returns SDL and `_meta`
+ * metadata from one correlated build boundary — both derived from the same
+ * final executable `GraphQLSchema` — so concurrent builds in one process
+ * cannot return each other's metadata.
  *
  * The result includes every table's fields, types, constraints, indexes,
  * relations, inflection names, and query entry-points — the same data

package/build-introspection.js

@@ -1,14 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.buildIntrospectionJSON = buildIntrospectionJSON;
-const graphile_settings_1 = require("graphile-settings");
 const build_schema_1 = require("./build-schema");
 /**
  * Build introspection metadata for all tables visible in the given schemas.
  *
- * Internally calls `buildSchemaSDL()` which triggers the MetaSchemaPlugin
- * gather hook, populating `_cachedTablesMeta` as a side-effect. The cached
- * metadata is then returned as a plain array of `TableMeta` objects.
+ * Internally calls `buildSchemaArtifacts()`, which returns SDL and `_meta`
+ * metadata from one correlated build boundary — both derived from the same
+ * final executable `GraphQLSchema` — so concurrent builds in one process
+ * cannot return each other's metadata.
  *
  * The result includes every table's fields, types, constraints, indexes,
  * relations, inflection names, and query entry-points — the same data
@@ -27,6 +27,5 @@ const build_schema_1 = require("./build-schema");
  * ```
  */
 async function buildIntrospectionJSON(opts) {
-    await (0, build_schema_1.buildSchemaSDL)(opts);
-    return [...graphile_settings_1._cachedTablesMeta];
+    return (await (0, build_schema_1.buildSchemaArtifacts)(opts)).tablesMeta;
 }

package/build-schema.d.ts

@@ -1,7 +1,30 @@
 import type { GraphileConfig } from 'graphile-config';
+import type { TableMeta } from 'graphile-settings';
 export type BuildSchemaOptions = {
     database?: string;
     schemas: string[];
     graphile?: Partial<GraphileConfig.Preset>;
+    /**
+     * @internal Test-only. Awaited after the schema's `_meta` metadata has been
+     * collected and before artifacts are returned, so regression tests can
+     * deterministically interleave concurrent builds.
+     */
+    _onMetaCollected?: () => Promise<void>;
 };
+export type BuildSchemaArtifacts = {
+    /** SDL printed from the final executable schema. */
+    sdl: string;
+    /**
+     * `_meta` table metadata belonging to the same `GraphQLSchema` the SDL was
+     * printed from. Empty when the meta plugin is disabled (no `_meta` field).
+     */
+    tablesMeta: TableMeta[];
+};
+/**
+ * Build the GraphQL schema for a database and return its SDL together with
+ * the `_meta` table metadata from one correlated build boundary. Both values
+ * are derived from the same final executable `GraphQLSchema` instance, so
+ * concurrent builds in one process can never cross-contaminate results.
+ */
+export declare function buildSchemaArtifacts(opts: BuildSchemaOptions): Promise<BuildSchemaArtifacts>;
 export declare function buildSchemaSDL(opts: BuildSchemaOptions): Promise<string>;

package/build-schema.js

@@ -3,6 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildSchemaArtifacts = buildSchemaArtifacts;
 exports.buildSchemaSDL = buildSchemaSDL;
 const deepmerge_1 = __importDefault(require("deepmerge"));
 const graphql_1 = require("graphql");
@@ -10,7 +11,13 @@ const graphile_settings_1 = require("graphile-settings");
 const graphile_build_1 = require("graphile-build");
 const pg_cache_1 = require("pg-cache");
 const pg_env_1 = require("pg-env");
-async function buildSchemaSDL(opts) {
+/**
+ * Build the GraphQL schema for a database and return its SDL together with
+ * the `_meta` table metadata from one correlated build boundary. Both values
+ * are derived from the same final executable `GraphQLSchema` instance, so
+ * concurrent builds in one process can never cross-contaminate results.
+ */
+async function buildSchemaArtifacts(opts) {
     const database = opts.database ?? 'constructive';
     const schemas = Array.isArray(opts.schemas) ? opts.schemas : [];
     const config = (0, pg_env_1.getPgEnvOptions)({ database });
@@ -41,5 +48,28 @@ async function buildSchemaSDL(opts) {
         ],
     };
     const { schema } = await (0, graphile_build_1.makeSchema)(preset);
-    return (0, graphql_1.printSchema)((0, graphql_1.lexicographicSortSchema)(schema));
+    // MetaSchemaPlugin validates executable names lazily against the schema that
+    // will actually be executed. Trigger that resolver after every finalizer has
+    // run, then read the metadata memoized for this exact GraphQLSchema instance.
+    let tablesMeta = [];
+    if (schema.getQueryType()?.getFields()._meta) {
+        const result = await (0, graphql_1.graphql)({
+            schema,
+            source: '{ _meta { tables { name } } }',
+        });
+        if (result.errors?.length) {
+            throw new AggregateError(result.errors, 'Failed to build schema metadata');
+        }
+        tablesMeta = (0, graphile_settings_1.getTablesMetaForSchema)(schema) ?? [];
+    }
+    if (opts._onMetaCollected) {
+        await opts._onMetaCollected();
+    }
+    return {
+        sdl: (0, graphql_1.printSchema)((0, graphql_1.lexicographicSortSchema)(schema)),
+        tablesMeta
+    };
+}
+async function buildSchemaSDL(opts) {
+    return (await buildSchemaArtifacts(opts)).sdl;
 }

package/esm/build-introspection.d.ts

@@ -4,9 +4,10 @@ export type { BuildSchemaOptions as BuildIntrospectionOptions };
 /**
  * Build introspection metadata for all tables visible in the given schemas.
  *
- * Internally calls `buildSchemaSDL()` which triggers the MetaSchemaPlugin
- * gather hook, populating `_cachedTablesMeta` as a side-effect. The cached
- * metadata is then returned as a plain array of `TableMeta` objects.
+ * Internally calls `buildSchemaArtifacts()`, which returns SDL and `_meta`
+ * metadata from one correlated build boundary — both derived from the same
+ * final executable `GraphQLSchema` — so concurrent builds in one process
+ * cannot return each other's metadata.
  *
  * The result includes every table's fields, types, constraints, indexes,
  * relations, inflection names, and query entry-points — the same data

package/esm/build-introspection.js

@@ -1,11 +1,11 @@
-import { _cachedTablesMeta } from 'graphile-settings';
-import { buildSchemaSDL } from './build-schema';
+import { buildSchemaArtifacts } from './build-schema';
 /**
  * Build introspection metadata for all tables visible in the given schemas.
  *
- * Internally calls `buildSchemaSDL()` which triggers the MetaSchemaPlugin
- * gather hook, populating `_cachedTablesMeta` as a side-effect. The cached
- * metadata is then returned as a plain array of `TableMeta` objects.
+ * Internally calls `buildSchemaArtifacts()`, which returns SDL and `_meta`
+ * metadata from one correlated build boundary — both derived from the same
+ * final executable `GraphQLSchema` — so concurrent builds in one process
+ * cannot return each other's metadata.
  *
  * The result includes every table's fields, types, constraints, indexes,
  * relations, inflection names, and query entry-points — the same data
@@ -24,6 +24,5 @@ import { buildSchemaSDL } from './build-schema';
  * ```
  */
 export async function buildIntrospectionJSON(opts) {
-    await buildSchemaSDL(opts);
-    return [..._cachedTablesMeta];
+    return (await buildSchemaArtifacts(opts)).tablesMeta;
 }

package/esm/build-schema.d.ts

@@ -1,7 +1,30 @@
 import type { GraphileConfig } from 'graphile-config';
+import type { TableMeta } from 'graphile-settings';
 export type BuildSchemaOptions = {
     database?: string;
     schemas: string[];
     graphile?: Partial<GraphileConfig.Preset>;
+    /**
+     * @internal Test-only. Awaited after the schema's `_meta` metadata has been
+     * collected and before artifacts are returned, so regression tests can
+     * deterministically interleave concurrent builds.
+     */
+    _onMetaCollected?: () => Promise<void>;
 };
+export type BuildSchemaArtifacts = {
+    /** SDL printed from the final executable schema. */
+    sdl: string;
+    /**
+     * `_meta` table metadata belonging to the same `GraphQLSchema` the SDL was
+     * printed from. Empty when the meta plugin is disabled (no `_meta` field).
+     */
+    tablesMeta: TableMeta[];
+};
+/**
+ * Build the GraphQL schema for a database and return its SDL together with
+ * the `_meta` table metadata from one correlated build boundary. Both values
+ * are derived from the same final executable `GraphQLSchema` instance, so
+ * concurrent builds in one process can never cross-contaminate results.
+ */
+export declare function buildSchemaArtifacts(opts: BuildSchemaOptions): Promise<BuildSchemaArtifacts>;
 export declare function buildSchemaSDL(opts: BuildSchemaOptions): Promise<string>;

package/esm/build-schema.js

@@ -1,10 +1,16 @@
 import deepmerge from 'deepmerge';
-import { lexicographicSortSchema, printSchema } from 'graphql';
-import { ConstructivePreset, makePgService } from 'graphile-settings';
+import { graphql, lexicographicSortSchema, printSchema } from 'graphql';
+import { ConstructivePreset, getTablesMetaForSchema, makePgService } from 'graphile-settings';
 import { makeSchema } from 'graphile-build';
 import { getPgPool } from 'pg-cache';
 import { getPgEnvOptions } from 'pg-env';
-export async function buildSchemaSDL(opts) {
+/**
+ * Build the GraphQL schema for a database and return its SDL together with
+ * the `_meta` table metadata from one correlated build boundary. Both values
+ * are derived from the same final executable `GraphQLSchema` instance, so
+ * concurrent builds in one process can never cross-contaminate results.
+ */
+export async function buildSchemaArtifacts(opts) {
     const database = opts.database ?? 'constructive';
     const schemas = Array.isArray(opts.schemas) ? opts.schemas : [];
     const config = getPgEnvOptions({ database });
@@ -35,5 +41,28 @@ export async function buildSchemaSDL(opts) {
         ],
     };
     const { schema } = await makeSchema(preset);
-    return printSchema(lexicographicSortSchema(schema));
+    // MetaSchemaPlugin validates executable names lazily against the schema that
+    // will actually be executed. Trigger that resolver after every finalizer has
+    // run, then read the metadata memoized for this exact GraphQLSchema instance.
+    let tablesMeta = [];
+    if (schema.getQueryType()?.getFields()._meta) {
+        const result = await graphql({
+            schema,
+            source: '{ _meta { tables { name } } }',
+        });
+        if (result.errors?.length) {
+            throw new AggregateError(result.errors, 'Failed to build schema metadata');
+        }
+        tablesMeta = getTablesMetaForSchema(schema) ?? [];
+    }
+    if (opts._onMetaCollected) {
+        await opts._onMetaCollected();
+    }
+    return {
+        sdl: printSchema(lexicographicSortSchema(schema)),
+        tablesMeta
+    };
+}
+export async function buildSchemaSDL(opts) {
+    return (await buildSchemaArtifacts(opts)).sdl;
 }

package/esm/index.d.ts

@@ -1,7 +1,6 @@
-export { buildSchemaSDL } from './build-schema';
-export type { BuildSchemaOptions } from './build-schema';
+export { buildSchemaArtifacts, buildSchemaSDL } from './build-schema';
+export type { BuildSchemaArtifacts, BuildSchemaOptions } from './build-schema';
 export { buildIntrospectionJSON } from './build-introspection';
-export { _cachedTablesMeta } from 'graphile-settings';
 export type { TableMeta, FieldMeta, TypeMeta, IndexMeta, ConstraintsMeta, PrimaryKeyConstraintMeta, UniqueConstraintMeta, ForeignKeyConstraintMeta, RelationsMeta, BelongsToRelation, HasRelation, ManyToManyRelation, InflectionMeta, QueryMeta, } from 'graphile-settings';
 export { fetchEndpointSchemaSDL } from './fetch-endpoint-schema';
 export type { FetchEndpointSchemaOptions } from './fetch-endpoint-schema';

package/esm/index.js

@@ -1,4 +1,3 @@
-export { buildSchemaSDL } from './build-schema';
+export { buildSchemaArtifacts, buildSchemaSDL } from './build-schema';
 export { buildIntrospectionJSON } from './build-introspection';
-export { _cachedTablesMeta } from 'graphile-settings';
 export { fetchEndpointSchemaSDL } from './fetch-endpoint-schema';

package/index.d.ts

@@ -1,7 +1,6 @@
-export { buildSchemaSDL } from './build-schema';
-export type { BuildSchemaOptions } from './build-schema';
+export { buildSchemaArtifacts, buildSchemaSDL } from './build-schema';
+export type { BuildSchemaArtifacts, BuildSchemaOptions } from './build-schema';
 export { buildIntrospectionJSON } from './build-introspection';
-export { _cachedTablesMeta } from 'graphile-settings';
 export type { TableMeta, FieldMeta, TypeMeta, IndexMeta, ConstraintsMeta, PrimaryKeyConstraintMeta, UniqueConstraintMeta, ForeignKeyConstraintMeta, RelationsMeta, BelongsToRelation, HasRelation, ManyToManyRelation, InflectionMeta, QueryMeta, } from 'graphile-settings';
 export { fetchEndpointSchemaSDL } from './fetch-endpoint-schema';
 export type { FetchEndpointSchemaOptions } from './fetch-endpoint-schema';

package/index.js

@@ -1,11 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.fetchEndpointSchemaSDL = exports._cachedTablesMeta = exports.buildIntrospectionJSON = exports.buildSchemaSDL = void 0;
+exports.fetchEndpointSchemaSDL = exports.buildIntrospectionJSON = exports.buildSchemaSDL = exports.buildSchemaArtifacts = void 0;
 var build_schema_1 = require("./build-schema");
+Object.defineProperty(exports, "buildSchemaArtifacts", { enumerable: true, get: function () { return build_schema_1.buildSchemaArtifacts; } });
 Object.defineProperty(exports, "buildSchemaSDL", { enumerable: true, get: function () { return build_schema_1.buildSchemaSDL; } });
 var build_introspection_1 = require("./build-introspection");
 Object.defineProperty(exports, "buildIntrospectionJSON", { enumerable: true, get: function () { return build_introspection_1.buildIntrospectionJSON; } });
-var graphile_settings_1 = require("graphile-settings");
-Object.defineProperty(exports, "_cachedTablesMeta", { enumerable: true, get: function () { return graphile_settings_1._cachedTablesMeta; } });
 var fetch_endpoint_schema_1 = require("./fetch-endpoint-schema");
 Object.defineProperty(exports, "fetchEndpointSchemaSDL", { enumerable: true, get: function () { return fetch_endpoint_schema_1.fetchEndpointSchemaSDL; } });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "graphile-schema",
-  "version": "2.10.4",
+  "version": "2.10.6",
   "author": "Constructive <developers@constructive.io>",
   "description": "Build GraphQL SDL from PostgreSQL databases using PostGraphile v5",
   "main": "index.js",
@@ -32,13 +32,14 @@
     "deepmerge": "^4.3.1",
     "graphile-build": "5.0.2",
     "graphile-config": "1.0.1",
-    "graphile-settings": "^6.11.4",
+    "graphile-settings": "^6.11.6",
     "graphql": "16.13.0",
     "pg-cache": "^3.24.2",
     "pg-env": "^1.27.2"
   },
   "devDependencies": {
     "makage": "^0.3.0",
+    "pgsql-test": "^5.9.6",
     "ts-node": "^10.9.2"
   },
   "keywords": [
@@ -50,5 +51,5 @@
     "introspection",
     "constructive"
   ],
-  "gitHead": "90f447482b056a4949134565db2665f21d11aca3"
+  "gitHead": "45cd961cf956d2d28e4d09b20db4204982c33593"
 }