@niledatabase/server 5.0.0-alpha.31 → 5.0.0-alpha.33

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-import pg, { PoolConfig, PoolClient } from 'pg';
+import pg, { Pool, PoolConfig, PoolClient } from 'pg';
 
 type LogFunction = (message: string | unknown, meta?: Record<string, unknown>) => void;
 type Loggable = {
@@ -523,6 +523,14 @@ declare class Server {
     tenants: Tenants;
     auth: Auth;
     constructor(config?: NileConfig);
+    /**
+     * Query the database with the current context
+     */
+    query: Pool['query'];
+    /**
+     * Return a db object that can be used to talk to the database
+     * Does not have a context by default
+     */
     get db(): pg.Pool & {
         clearConnections: () => void;
     };
@@ -534,14 +542,16 @@ declare class Server {
     get handlers(): NileHandlers;
     get paths(): ConfigurablePaths;
     set paths(paths: ConfigurablePaths);
-    /** Allows setting of context outside of the request lifecycle
-     * Basically means you want to disregard cookies and do everything manually
-     * If we elect to DDL, we don't want to use tenant id or user id, so remove those.
+    /**
+     * Sets the context for a particular set of requests or db calls to be sure the context is fully managed for the entire lifecycle
      */
-    withContext(context?: PartialContext): Promise<this>;
-    withContext<T>(context: PartialContext, fn: (sdk: this) => Promise<T>): Promise<T>;
+    withContext(): Promise<this>;
+    withContext<T>(context: PartialContext, fn: AsyncCallback<this, T>): Promise<T>;
+    withContext(context: PartialContext): Promise<this>;
+    withContext<T>(fn: AsyncCallback<this, T>): Promise<T>;
     /**
      * Creates a context without a user id and a tenant id, but keeps the headers around for auth at least.
+     * This is useful for DDL/DML, since most extensions will set the context by default
      */
     noContext(): Promise<this>;
     noContext<T>(fn: (sdk: this) => Promise<T>): Promise<T>;
@@ -552,6 +562,7 @@ declare class Server {
     getContext(): Context;
 }
 declare function create<T = Server>(config?: NileConfig): T;
+type AsyncCallback<TInstance, TResult> = (sdk: TInstance) => Promise<TResult>;
 
 type Opts = {
     basePath?: string;
@@ -561,13 +572,12 @@ type Context = {
     headers: Headers;
     tenantId: string | undefined | null;
     userId: string | undefined | null;
-    preserveHeaders: boolean;
 };
 type PartialContext = {
     headers?: null | Headers;
     tenantId?: string | undefined | null;
     userId?: string | undefined | null;
-    preserveHeaders?: boolean;
+    useLastContext?: boolean;
 };
 type CTX = {
     run: <T>(ctx: Partial<Context>, fn: () => T) => T;
@@ -583,6 +593,8 @@ type ExtensionResult<TParams> = {
     onResponse?: (params: TParams, ctx: CTX) => void | Promise<void>;
     onHandleRequest?: (params?: TParams) => RouteReturn | Promise<RouteReturn>;
     onConfigure?: (params?: TParams) => void;
+    withUserId?: () => string;
+    withTenantId?: () => string;
     replace?: {
         handlers: (handlers: NileHandlers) => Any;
     };
@@ -595,7 +607,9 @@ declare enum ExtensionState {
     onHandleRequest = "onHandleRequest",
     onRequest = "onRequest",
     onResponse = "onResponse",
-    withContext = "withContext"
+    withContext = "withContext",
+    withTenantId = "withTenantId",
+    withUserId = "withUserId"
 }
 type NilePoolConfig = PoolConfig & {
     afterCreate?: AfterCreate;
@@ -692,9 +706,9 @@ type NileConfig = {
     /** Hooks executed before and after each request. */
     extensions?: Extension[];
     /**
-     * Preserve incoming request headers when running extensions.
+     * Re-use the last set context
      */
-    preserveHeaders?: boolean;
+    useLastContext?: boolean;
 };
 type NileDb = NilePoolConfig & {
     tenantId?: string;

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import pg, { PoolConfig, PoolClient } from 'pg';
+import pg, { Pool, PoolConfig, PoolClient } from 'pg';
 
 type LogFunction = (message: string | unknown, meta?: Record<string, unknown>) => void;
 type Loggable = {
@@ -523,6 +523,14 @@ declare class Server {
     tenants: Tenants;
     auth: Auth;
     constructor(config?: NileConfig);
+    /**
+     * Query the database with the current context
+     */
+    query: Pool['query'];
+    /**
+     * Return a db object that can be used to talk to the database
+     * Does not have a context by default
+     */
     get db(): pg.Pool & {
         clearConnections: () => void;
     };
@@ -534,14 +542,16 @@ declare class Server {
     get handlers(): NileHandlers;
     get paths(): ConfigurablePaths;
     set paths(paths: ConfigurablePaths);
-    /** Allows setting of context outside of the request lifecycle
-     * Basically means you want to disregard cookies and do everything manually
-     * If we elect to DDL, we don't want to use tenant id or user id, so remove those.
+    /**
+     * Sets the context for a particular set of requests or db calls to be sure the context is fully managed for the entire lifecycle
      */
-    withContext(context?: PartialContext): Promise<this>;
-    withContext<T>(context: PartialContext, fn: (sdk: this) => Promise<T>): Promise<T>;
+    withContext(): Promise<this>;
+    withContext<T>(context: PartialContext, fn: AsyncCallback<this, T>): Promise<T>;
+    withContext(context: PartialContext): Promise<this>;
+    withContext<T>(fn: AsyncCallback<this, T>): Promise<T>;
     /**
      * Creates a context without a user id and a tenant id, but keeps the headers around for auth at least.
+     * This is useful for DDL/DML, since most extensions will set the context by default
      */
     noContext(): Promise<this>;
     noContext<T>(fn: (sdk: this) => Promise<T>): Promise<T>;
@@ -552,6 +562,7 @@ declare class Server {
     getContext(): Context;
 }
 declare function create<T = Server>(config?: NileConfig): T;
+type AsyncCallback<TInstance, TResult> = (sdk: TInstance) => Promise<TResult>;
 
 type Opts = {
     basePath?: string;
@@ -561,13 +572,12 @@ type Context = {
     headers: Headers;
     tenantId: string | undefined | null;
     userId: string | undefined | null;
-    preserveHeaders: boolean;
 };
 type PartialContext = {
     headers?: null | Headers;
     tenantId?: string | undefined | null;
     userId?: string | undefined | null;
-    preserveHeaders?: boolean;
+    useLastContext?: boolean;
 };
 type CTX = {
     run: <T>(ctx: Partial<Context>, fn: () => T) => T;
@@ -583,6 +593,8 @@ type ExtensionResult<TParams> = {
     onResponse?: (params: TParams, ctx: CTX) => void | Promise<void>;
     onHandleRequest?: (params?: TParams) => RouteReturn | Promise<RouteReturn>;
     onConfigure?: (params?: TParams) => void;
+    withUserId?: () => string;
+    withTenantId?: () => string;
     replace?: {
         handlers: (handlers: NileHandlers) => Any;
     };
@@ -595,7 +607,9 @@ declare enum ExtensionState {
     onHandleRequest = "onHandleRequest",
     onRequest = "onRequest",
     onResponse = "onResponse",
-    withContext = "withContext"
+    withContext = "withContext",
+    withTenantId = "withTenantId",
+    withUserId = "withUserId"
 }
 type NilePoolConfig = PoolConfig & {
     afterCreate?: AfterCreate;
@@ -692,9 +706,9 @@ type NileConfig = {
     /** Hooks executed before and after each request. */
     extensions?: Extension[];
     /**
-     * Preserve incoming request headers when running extensions.
+     * Re-use the last set context
      */
-    preserveHeaders?: boolean;
+    useLastContext?: boolean;
 };
 type NileDb = NilePoolConfig & {
     tenantId?: string;

package/dist/index.js

@@ -14,6 +14,8 @@ var ExtensionState = /* @__PURE__ */ ((ExtensionState2) => {
   ExtensionState2["onRequest"] = "onRequest";
   ExtensionState2["onResponse"] = "onResponse";
   ExtensionState2["withContext"] = "withContext";
+  ExtensionState2["withTenantId"] = "withTenantId";
+  ExtensionState2["withUserId"] = "withUserId";
   return ExtensionState2;
 })(ExtensionState || {});
 var APIErrorErrorCodeEnum = {
@@ -226,6 +228,14 @@ function bindRunExtensions(instance) {
         if (extensionConfig.disableExtensions?.includes(ext.id)) {
           continue;
         }
+        if (ext.withTenantId && toRun === "withTenantId" /* withTenantId */) {
+          ctx.set({
+            tenantId: await ext.withTenantId()
+          });
+        }
+        if (ext.withUserId && toRun === "withUserId" /* withUserId */) {
+          ctx.set({ userId: await ext.withUserId() });
+        }
         if (ext.withContext && toRun === "withContext" /* withContext */) {
           await ext.withContext(ctx);
         }
@@ -241,10 +251,6 @@ function bindRunExtensions(instance) {
         const [param] = Array.isArray(params) ? params : [params];
         if (ext.onRequest && toRun === "onRequest" /* onRequest */) {
           const { ...previousContext } = ctx.get();
-          const preserveHeaders = previousContext.preserveHeaders;
-          if (preserveHeaders) {
-            ctx.set({ preserveHeaders: false });
-          }
           if (!_init) {
             continue;
           }
@@ -255,7 +261,7 @@ function bindRunExtensions(instance) {
             const cookie = updatedContext.headers.get("cookie");
             if (cookie && param.headers) {
               const updatedCookies = mergeCookies(
-                preserveHeaders ? previousHeaders?.get("cookie") : null,
+                previousHeaders?.get("cookie"),
                 updatedContext.headers.get("cookie")
               );
               param.headers.set("cookie", updatedCookies);
@@ -300,6 +306,11 @@ function mergeCookies(...cookieStrings) {
 }
 async function runExtensionContext(config) {
   await config?.extensionCtx?.runExtensions("withContext" /* withContext */, config);
+  await config?.extensionCtx?.runExtensions(
+    "withTenantId" /* withTenantId */,
+    config
+  );
+  await config?.extensionCtx?.runExtensions("withUserId" /* withUserId */, config);
 }
 
 // src/api/utils/request-context.ts
@@ -308,8 +319,7 @@ var storage = new async_hooks.AsyncLocalStorage();
 var defaultContext = {
   headers: new Headers(),
   tenantId: void 0,
-  userId: void 0,
-  preserveHeaders: false
+  userId: void 0
 };
 var lastUsedContext = defaultContext;
 var ctx = {
@@ -359,8 +369,6 @@ var ctx = {
     }
     if ("tenantId" in partial) store.tenantId = partial.tenantId;
     if ("userId" in partial) store.userId = partial.userId;
-    if ("preserveHeaders" in partial)
-      store.preserveHeaders = Boolean(partial.preserveHeaders);
     silly(`[SET] ${serializeContext(store)}`);
     lastUsedContext = { ...store };
   },
@@ -378,8 +386,7 @@ function withNileContext(config, fn, name = "unknown") {
     const context2 = {
       headers: mergedHeaders,
       tenantId: existing.tenantId,
-      userId: existing.userId,
-      preserveHeaders: existing.preserveHeaders ?? false
+      userId: existing.userId
     };
     silly(`${name} [INITIAL - Request] ${serializeContext(context2)}`);
     return ctx.run(context2, fn);
@@ -392,12 +399,10 @@ function withNileContext(config, fn, name = "unknown") {
   }
   const hasTenantId = "tenantId" in initialContext;
   const hasUserId = "userId" in initialContext;
-  const hasPreserveHeaders = "preserveHeaders" in initialContext;
   const context = {
     headers: mergedHeaders,
     tenantId: hasTenantId ? initialContext.tenantId : existing.tenantId,
-    userId: hasUserId ? initialContext.userId : existing.userId,
-    preserveHeaders: hasPreserveHeaders ? Boolean(initialContext.preserveHeaders) : existing.preserveHeaders ?? false
+    userId: hasUserId ? initialContext.userId : existing.userId
   };
   silly(`${name} [INITIAL - Partial<Context>] ${serializeContext(context)}`);
   return ctx.run(context, async () => {
@@ -414,8 +419,7 @@ function serializeContext(context) {
   return JSON.stringify({
     headers,
     tenantId: context.tenantId,
-    userId: context.userId,
-    preserveHeaders: context.preserveHeaders
+    userId: context.userId
   });
 }
 function parseCookieHeader(header) {
@@ -2020,8 +2024,7 @@ var Config = class {
     this.context = {
       tenantId: config?.tenantId,
       userId: config?.userId,
-      headers: config?.headers ? new Headers(config.headers) : new Headers(),
-      preserveHeaders: false
+      headers: config?.headers ? new Headers(config.headers) : new Headers()
     };
     this.routes = {
       ...appRoutes(config?.routePrefix),
@@ -2113,17 +2116,17 @@ var updateHeaders = (val) => {
 var watchHeaders = (cb) => eventer.subscribe("headers" /* Headers */, cb);
 
 // src/db/PoolProxy.ts
-function createProxyForPool(pool, config) {
-  const { info, error } = config.logger("[pool]");
+function createProxyForPool(pool, config, logger, context) {
+  const { info, error } = logger("[pool]");
   return new Proxy(pool, {
     get(target, property) {
       if (property === "query") {
-        if (!config.db.connectionString) {
-          if (!config.db.user || !config.db.password) {
+        if (!config.connectionString) {
+          if (!config.user || !config.password) {
             error(
               "Cannot connect to the database. User and/or password are missing. Generate them at https://console.thenile.dev"
             );
-          } else if (!config.db.database) {
+          } else if (!config.database) {
             error(
               "Unable to obtain database name. Is process.env.NILEDB_POSTGRES_URL set?"
             );
@@ -2132,7 +2135,7 @@ function createProxyForPool(pool, config) {
         const caller = target[property];
         return function query(...args) {
           let log = "[QUERY]";
-          const { userId, tenantId } = config.context;
+          const [tenantId, userId] = context;
           if (tenantId) {
             log = `${log}[TENANT:${tenantId}]`;
           }
@@ -2155,39 +2158,44 @@ var NileDatabase = class {
   tenantId;
   userId;
   id;
-  config;
+  logger;
   timer;
-  constructor(config, id) {
-    const { warn: warn2, info, debug } = config.logger("[NileInstance]");
+  config;
+  constructor(config, logger, id) {
+    this.logger = logger("[NileInstance]");
     this.id = id;
     const poolConfig = {
       min: 0,
       max: 10,
       idleTimeoutMillis: 3e4,
-      ...config.db
+      ...config
     };
     const { afterCreate, ...remaining } = poolConfig;
-    config.db = poolConfig;
-    this.config = config;
-    const cloned = { ...this.config.db };
+    this.config = remaining;
+    const cloned = { ...config };
     cloned.password = "***";
-    debug(`Connection pool config ${JSON.stringify(cloned)}`);
-    this.pool = createProxyForPool(new pg__default.default.Pool(remaining), this.config);
+    this.logger.debug(`Connection pool config ${JSON.stringify(cloned)}`);
+    this.pool = createProxyForPool(
+      new pg__default.default.Pool(remaining),
+      this.config,
+      logger,
+      id === "base" ? [] : id.split(":")
+    );
     if (typeof afterCreate === "function") {
-      warn2(
+      this.logger.warn(
         "Providing an pool configuration will stop automatic tenant context setting."
       );
     }
     this.startTimeout();
     this.pool.on("connect", async (client) => {
-      debug(`pool connected ${this.id}`);
+      this.logger.debug(`pool connected ${this.id}`);
       this.startTimeout();
       const afterCreate2 = makeAfterCreate(
-        config,
-        `${this.id}-${this.timer}`
+        logger,
+        `${this.id}|${this.timer}`
       );
       afterCreate2(client, (err) => {
-        const { error } = config.logger("[after create callback]");
+        const { error } = logger("[after create callback]");
         if (err) {
           clearTimeout(this.timer);
           error("after create failed", {
@@ -2200,7 +2208,7 @@ var NileDatabase = class {
     });
     this.pool.on("error", (err) => {
       clearTimeout(this.timer);
-      info(`pool ${this.id} failed`, {
+      this.logger.info(`pool ${this.id} failed`, {
         message: err.message,
         stack: err.stack
       });
@@ -2210,27 +2218,27 @@ var NileDatabase = class {
       if (destroy) {
         clearTimeout(this.timer);
         evictPool(this.id);
-        debug(`destroying pool ${this.id}`);
+        this.logger.debug(`destroying pool ${this.id}`);
       }
     });
   }
   startTimeout() {
-    const { debug } = this.config.logger("[NileInstance]");
+    const { debug } = this.logger;
     if (this.timer) {
       clearTimeout(this.timer);
     }
     this.timer = setTimeout(() => {
       debug(
-        `Pool reached idleTimeoutMillis. ${this.id} evicted after ${Number(this.config.db.idleTimeoutMillis) ?? 3e4}ms`
+        `Pool reached idleTimeoutMillis. ${this.id} evicted after ${Number(this.config.idleTimeoutMillis) ?? 3e4}ms`
       );
       this.pool.end(() => {
         clearTimeout(this.timer);
         evictPool(this.id);
       });
-    }, Number(this.config.db.idleTimeoutMillis) ?? 3e4);
+    }, Number(this.config.idleTimeoutMillis) ?? 3e4);
   }
   shutdown() {
-    const { debug } = this.config.logger("[NileInstance]");
+    const { debug } = this.logger;
     debug(`attempting to shut down ${this.id}`);
     clearTimeout(this.timer);
     this.pool.end(() => {
@@ -2239,8 +2247,8 @@ var NileDatabase = class {
   }
 };
 var NileInstance_default = NileDatabase;
-function makeAfterCreate(config, id) {
-  const { error, warn: warn2, debug } = config.logger("[afterCreate]");
+function makeAfterCreate(logger, id) {
+  const { error, warn: warn2, debug } = logger("[afterCreate]");
   return (conn, done) => {
     conn.on("error", function errorHandler(e) {
       error(`Connection ${id} was terminated by server`, {
@@ -2249,8 +2257,9 @@ function makeAfterCreate(config, id) {
       });
       done(e, conn);
     });
-    const { tenantId, userId } = ctx.getLastUsed();
-    if (tenantId) {
+    const [context] = id.split("|");
+    const [tenantId, userId] = context.split(":");
+    if (tenantId !== "base") {
       const query = [`SET nile.tenant_id = '${tenantId}'`];
       if (userId) {
         if (!tenantId) {
@@ -2315,9 +2324,9 @@ var DBManager = class {
       warn2(`missed eviction of ${id}`);
     }
   };
-  getConnection = (config) => {
+  getConnection = (config, noContext = false) => {
     const { info } = Logger(config)("[DBManager]");
-    const { tenantId, userId } = ctx.getLastUsed();
+    const { tenantId, userId } = noContext ? {} : ctx.getLastUsed();
     const id = this.makeId(tenantId, userId);
     const existing = this.connections.get(id);
     info(`# of instances: ${this.connections.size}`);
@@ -2326,7 +2335,7 @@ var DBManager = class {
       existing.startTimeout();
       return existing.pool;
     }
-    const newOne = new NileInstance_default(config, id);
+    const newOne = new NileInstance_default(config.db, config.logger, id);
     this.connections.set(id, newOne);
     info(`created new ${id}`);
     info(`# of instances: ${this.connections.size}`);
@@ -2733,7 +2742,7 @@ var Auth = class {
         ].filter(Boolean).join("; ");
         const uHeaders = new Headers({ cookie });
         updateHeaders(uHeaders);
-        ctx.set({ headers: uHeaders, preserveHeaders: true });
+        ctx.set({ headers: uHeaders });
       } else {
         error("Unable to set context after sign in", {
           headers: signInRes.headers
@@ -2855,7 +2864,7 @@ async function obtainCsrf(config, rawResponse = false) {
         parseToken(res.headers)
       ].filter(Boolean).join("; ");
       headers.set("cookie", cookie);
-      ctx.set({ headers, preserveHeaders: true });
+      ctx.set({ headers });
       updateHeaders(headers);
     }
     if (!rawResponse) {
@@ -2874,7 +2883,7 @@ async function obtainCsrf(config, rawResponse = false) {
     }
     const cookie = cookieParts.filter(Boolean).join("; ");
     headers.set("cookie", cookie);
-    ctx.set({ headers, preserveHeaders: true });
+    ctx.set({ headers });
     updateHeaders(new Headers({ cookie }));
   }
   if (rawResponse) {
@@ -3164,12 +3173,12 @@ var Tenants = class {
       try {
         const json = await me.json();
         if ("id" in json) {
-          ctx.set({ userId: json.id, preserveHeaders: true });
+          ctx.set({ userId: json.id });
         }
       } catch {
       }
       if (typeof req === "string") {
-        ctx.set({ tenantId: req, preserveHeaders: true });
+        ctx.set({ tenantId: req });
       } else {
         this.#handleContext(req);
       }
@@ -3179,7 +3188,7 @@ var Tenants = class {
   async addMember(req, rawResponse) {
     return withNileContext(this.#config, async () => {
       if (typeof req === "string") {
-        ctx.set({ userId: req, preserveHeaders: true });
+        ctx.set({ userId: req });
       } else {
         this.#handleContext(req);
       }
@@ -3197,7 +3206,7 @@ var Tenants = class {
     return withNileContext(this.#config, async () => {
       this.#handleContext(req);
       if (typeof req === "string") {
-        ctx.set({ userId: req, preserveHeaders: true });
+        ctx.set({ userId: req });
       }
       const res = await fetchTenantUser(this.#config, "DELETE");
       return responseHandler(res, rawResponse);
@@ -3320,10 +3329,10 @@ var Tenants = class {
   #handleContext(req) {
     if (typeof req === "object") {
       if ("tenantId" in req) {
-        ctx.set({ tenantId: req.tenantId, preserveHeaders: true });
+        ctx.set({ tenantId: req.tenantId });
       }
       if ("userId" in req) {
-        ctx.set({ userId: req.userId, preserveHeaders: true });
+        ctx.set({ userId: req.userId });
       }
     }
   }
@@ -3410,7 +3419,7 @@ function updateConfig(response, config) {
     ...config,
     origin,
     headers: headers ?? void 0,
-    preserveHeaders: true
+    useLastContext: true
   };
 }
 
@@ -3442,7 +3451,6 @@ var Server = class {
     watchHeaders((headers) => {
       if (headers) {
         this.#config.context.headers = new Headers(headers);
-        this.#config.context.preserveHeaders = true;
         this.#reset();
       }
     });
@@ -3450,7 +3458,6 @@ var Server = class {
       ...this.#config.handlers,
       withContext: handlersWithContext(this.#config)
     };
-    this.#config.context.preserveHeaders = config?.preserveHeaders ?? false;
     this.#config.context.tenantId = getTenantId({ config: this.#config });
     this.#manager = new DBManager(this.#config);
     this.#handleHeaders(config);
@@ -3476,9 +3483,21 @@ var Server = class {
       }
     }
   }
-  get db() {
+  /**
+   * Query the database with the current context
+   */
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  query = (queryStream, values) => {
     this.#config.context = { ...this.getContext() };
     const pool = this.#manager.getConnection(this.#config);
+    return pool.query(queryStream, values);
+  };
+  /**
+   * Return a db object that can be used to talk to the database
+   * Does not have a context by default
+   */
+  get db() {
+    const pool = this.#manager.getConnection(this.#config, true);
     return Object.assign(pool, {
       clearConnections: () => {
         this.#manager.clear(this.#config);
@@ -3516,18 +3535,18 @@ var Server = class {
   set paths(paths) {
     this.#config.paths = paths;
   }
-  async withContext(context, fn) {
-    const { ...initialContext } = context ?? defaultContext;
-    this.#config.context = { ...initialContext };
-    const preserve = (context && "preserveHeaders" in context && context.preserveHeaders) ?? true;
+  async withContext(contextOrFn, maybeFn) {
+    const isFn = typeof contextOrFn === "function";
+    const context = isFn ? {} : contextOrFn ?? {};
+    const fn = isFn ? contextOrFn : maybeFn;
+    const preserve = "useLastContext" in context ? context.useLastContext : true;
     if (preserve) {
       this.#config.context = { ...this.getContext(), ...context };
+    } else {
+      this.#config.context = { ...defaultContext, ...context };
     }
     return withNileContext(this.#config, async () => {
-      if (fn) {
-        return fn(this);
-      }
-      return this;
+      return fn ? fn(this) : this;
     });
   }
   async noContext(fn) {