Postgraphile+Express下非公开Schema Introspection异常及隐藏失效问题

问题现象 #

• 已通过数据库注释设置隐藏public schema中部分表的introspection，但Express集成启动服务后，这些表仍可被introspect
• 仅指定private作为目标Schema时，该Schema下的内容完全无法通过introspection展示
• 使用Postgraphile CLI启动服务时，introspection表现正常，手动隐藏的内容不会被展示

正常工作的CLI启动命令 #

postgraphile --jwt-token-identifier public.jwt_token --jwt-secret 'secret' -c 'postgres://postgres:postgres@localhost:5432/my-db' -s public,private  --watch --enhance-graphiql --dynamic-json    

Express集成的Postgraphile配置（TypeScript） #

const postgraphileOptions: PostGraphileOptions = {
  subscriptions: true,
  watchPg: true,
  dynamicJson: true,
  setofFunctionsContainNulls: false,
  ignoreRBAC: false,
  showErrorStack: 'json',
  extendedErrors: ['hint', 'detail', 'errcode'],
  appendPlugins: [require('@graphile-contrib/pg-simplify-inflector')],
  exportGqlSchemaPath: 'schema.graphql',
  graphiql: true,
  enhanceGraphiql: true,
  allowExplain(_req: any) {
    // TODO: customise condition!
    return true;
  },
  enableQueryBatching: true,
  legacyRelations: 'omit',
  // pgSettings(req: any) {
  //   /* TODO */
  // },
  jwtSignOptions: { algorithm: 'RS256' },
  jwtPgTypeIdentifier: 'public.jwt_token',
  jwtSecret: 'secret',
};

app.use(
  postgraphile(
    process.env.DATABASE_URL || 'postgres://postgres:postgres@localhost:5432/my-db',
    'private',
    { ...postgraphileOptions }
  )
);

异常原因及修复建议 #

1. Schema指定不匹配 #

CLI命令同时加载了public和private两个Schema，但Express配置仅指定private。Postgraphile需要加载目标Schema才能应用数据库注释中的隐藏规则，且默认会加载所有可见Schema（导致public表仍被展示）。

修复：将Express中Schema参数改为数组，同时指定两个Schema：

app.use(
  postgraphile(
    process.env.DATABASE_URL || 'postgres://postgres:postgres@localhost:5432/my-db',
    ['public', 'private'], // 改为数组，匹配CLI的Schema范围
    { ...postgraphileOptions }
  )
);

2. JWT算法不一致 #

CLI默认使用HS256算法验证JWT，但Express配置中指定了RS256。开启RBAC（ignoreRBAC: false）时，算法不匹配会导致权限验证失败，无法访问private Schema内容。

修复：将jwtSignOptions的算法改为HS256，与CLI保持一致：

jwtSignOptions: { algorithm: 'HS256' },

3. 旧Schema缓存影响 #

Express启动时生成的schema.graphql可能是旧缓存文件，watchPg未正确触发重新生成，导致Schema未更新。

修复：删除schema.graphql文件，重启服务，让Postgraphile重新生成最新Schema。

4. 其他验证点 #

• 确认Express使用的数据库用户与CLI完全一致，避免权限差异导致Schema可见性问题
• 临时移除@graphile-contrib/pg-simplify-inflector插件，验证是否为插件导致的Schema处理逻辑差异

内容的提问来源于stack exchange，提问作者Randall Spencer