@memberjunction/server 6.2.0-edge.3 → 6.2.0-edge.4

package/src/auth/newUsers.ts

@@ -1,7 +1,9 @@
-import { ApplicationInfo, DatabaseProviderBase, EntitySaveOptions, LogError, LogStatus, Metadata, RunView, RunViewResult, UserInfo } from "@memberjunction/core";
+import { ApplicationInfo, CompositeKey, EntitySaveOptions, IMetadataProvider, LogError, LogStatus, RunView, RunViewResult, UserInfo } from "@memberjunction/core";
+import { RecordCloneEngine } from "@memberjunction/record-cloning";
 import { RegisterClass } from "@memberjunction/global";
 import { ResolveConfiguredPrincipal } from "./principals.js";
 import { configInfo } from "../config.js";
+import { CreateIsolatedProvider } from "../isolatedProvider.js";
 import { MJUserEntity, MJUserRoleEntity, MJUserApplicationEntity, MJUserApplicationEntityEntity, MJApplicationEntityType, MJApplicationEntityEntityType, UserInfoEngine } from "@memberjunction/core-entities";
 
 export class NewUserBase {
@@ -16,8 +18,21 @@ export class NewUserBase {
                 return null;
             }
 
-            const md: Metadata = new Metadata(); // global-provider-ok: new-user creation runs in the JWT auth flow, before AppContext.providers is built
-            const user = await md.GetEntityObject<MJUserEntity>('MJ: Users', contextUser) // To-Do - change this to be a different defined user for the user creation process
+            // Everything here, metadata lookups, entity objects and the transaction, goes through ONE
+            // isolated provider. This runs in the JWT auth flow, before AppContext.providers exists, and
+            // the global Metadata.Provider is shared by every concurrent request: a transaction opened
+            // there nests into anyone else's and swallows their writes (see CreateIsolatedProvider).
+            const provider = await CreateIsolatedProvider();
+
+            // A configured template user is copied whole; a plain user is created only if it can't be.
+            const template = configInfo?.userHandling?.newUserTemplate;
+            if (template?.email) {
+                const fromTemplate = await this.createFromTemplate(provider, contextUser, template.email, template.preset, firstName, lastName, email, linkedRecordType, linkedEntityId, linkedEntityRecordId);
+                if (fromTemplate) return fromTemplate;
+                LogError(`Could not create ${email} from template user ${template.email}; creating a plain user instead`);
+            }
+
+            const user = await provider.GetEntityObject<MJUserEntity>('MJ: Users', contextUser) // To-Do - change this to be a different defined user for the user creation process
             user.NewRecord();
             user.Name = email;
             user.IsActive = true;
@@ -38,7 +53,6 @@ export class NewUserBase {
             // Create the user and all of its role/application/app-entity records atomically.
             // If any Save fails partway through, the whole provisioning rolls back so we never
             // leave a half-created user with partial roles/applications behind.
-            const provider = Metadata.Provider as DatabaseProviderBase; // global-provider-ok: new-user creation runs in the JWT auth flow, before AppContext.providers is built
             await provider.BeginTransaction();
             try {
                 if (!await user.Save()) {
@@ -48,13 +62,13 @@ export class NewUserBase {
                 if(configInfo.userHandling && configInfo.userHandling.newUserRoles){
                     LogStatus(`User ${user.Email} created, assigning roles`);
                     for (const role of configInfo.userHandling.newUserRoles) {
-                        const userRole = md.Roles.find(r => r.Name === role);
+                        const userRole = provider.Roles.find(r => r.Name === role);
                         if (!userRole) {
                             LogError(`Role ${role} not found in the database, cannot assign to new user ${user.Name}`);
                             continue;
                         }
 
-                        const userRoleEntity: MJUserRoleEntity = await md.GetEntityObject<MJUserRoleEntity>('MJ: User Roles', contextUser);
+                        const userRoleEntity: MJUserRoleEntity = await provider.GetEntityObject<MJUserRoleEntity>('MJ: User Roles', contextUser);
                         userRoleEntity.NewRecord();
                         userRoleEntity.UserID = user.ID;
                         userRoleEntity.RoleID = userRole.ID;
@@ -73,7 +87,7 @@ export class NewUserBase {
                     if (configInfo.userHandling.UserApplications && configInfo.userHandling.UserApplications.length > 0) {
                         for (const appName of configInfo.userHandling.UserApplications) {
                             const toLowerCase: string = appName.trim().toLocaleLowerCase();
-                            const application: ApplicationInfo | undefined = md.Applications.find(a => a.Name.trim().toLocaleLowerCase() === toLowerCase);
+                            const application: ApplicationInfo | undefined = provider.Applications.find(a => a.Name.trim().toLocaleLowerCase() === toLowerCase);
                             if (application) {
                                 applicationsToCreate.push(application);
                             } else {
@@ -85,12 +99,12 @@ export class NewUserBase {
                         // Bug F2: use the shared selector, which filters to Active apps flagged
                         // DefaultForNewUser (in DefaultSequence order). This path previously omitted the
                         // Status = 'Active' check, so an inactive default app could be provisioned here.
-                        applicationsToCreate = UserInfoEngine.GetDefaultApplicationsForNewUser(md);
+                        applicationsToCreate = UserInfoEngine.GetDefaultApplicationsForNewUser(provider);
                         LogStatus(`Found ${applicationsToCreate.length} active applications with DefaultForNewUser=true`);
                     }
 
                     for (const [appIndex, application] of applicationsToCreate.entries()) {
-                        const userApplication: MJUserApplicationEntity = await md.GetEntityObject<MJUserApplicationEntity>('MJ: User Applications', contextUser);
+                        const userApplication: MJUserApplicationEntity = await provider.GetEntityObject<MJUserApplicationEntity>('MJ: User Applications', contextUser);
                         userApplication.NewRecord();
                         userApplication.UserID = user.ID;
                         userApplication.ApplicationID = application.ID;
@@ -102,7 +116,7 @@ export class NewUserBase {
                         }
                         LogStatus(`Created User Application ${application.Name} for new user ${user.Name}`);
 
-                        const rv: RunView = new RunView();
+                        const rv: RunView = RunView.FromMetadataProvider(provider);
                         // Boolean literal goes through the active provider's dialect:
                         //   SQL Server emits `= 1`, PostgreSQL emits `= TRUE`.
                         // This keeps the filter server-side (no client-side `.filter()`
@@ -125,7 +139,7 @@ export class NewUserBase {
                         LogStatus(`Creating ${defaultForNewUserEntities.length} User Application Entities for User Application ${application.Name} for new user ${user.Name}`);
 
                         for(const [index, appEntity] of defaultForNewUserEntities.entries()){
-                            const userAppEntity: MJUserApplicationEntityEntity = await md.GetEntityObject<MJUserApplicationEntityEntity>('MJ: User Application Entities', contextUser);
+                            const userAppEntity: MJUserApplicationEntityEntity = await provider.GetEntityObject<MJUserApplicationEntityEntity>('MJ: User Application Entities', contextUser);
                             userAppEntity.NewRecord();
                             userAppEntity.UserApplicationID = userApplication.ID;
                             userAppEntity.EntityID = appEntity.EntityID;
@@ -153,4 +167,78 @@ export class NewUserBase {
             return undefined;
         }
     }
+
+    /**
+     * Creates the new user as a copy of the template user `templateEmail`, through the `MJ: Users`
+     * clone `preset`: its roles, apps, views, settings, dashboards and conversations come with it, owned
+     * by the new user. The clone engine creates users inactive for review; a user signing in is active.
+     *
+     * @returns the new user, or null when the template is missing, isn't flagged IsTemplate, or the copy
+     *          fails (the reason is logged and the caller falls back to a plain user).
+     */
+    protected async createFromTemplate(
+        provider: IMetadataProvider,
+        contextUser: UserInfo,
+        templateEmail: string,
+        preset: string,
+        firstName: string,
+        lastName: string,
+        email: string,
+        linkedRecordType: string,
+        linkedEntityId?: string,
+        linkedEntityRecordId?: string
+    ): Promise<MJUserEntity | null> {
+        const lookup = await RunView.FromMetadataProvider(provider).RunView<{ ID: string; IsTemplate: boolean }>(
+            {
+                EntityName: 'MJ: Users',
+                ExtraFilter: `Email = '${templateEmail.replace(/'/g, "''")}'`,
+                Fields: ['ID', 'IsTemplate'],
+                ResultType: 'simple',
+                MaxRows: 1,
+            },
+            contextUser
+        );
+        const templateUser = lookup.Success ? lookup.Results[0] : undefined;
+        if (!templateUser) {
+            LogError(`userHandling.newUserTemplate: no user has the email ${templateEmail}`);
+            return null;
+        }
+        if (!templateUser.IsTemplate) {
+            LogError(`userHandling.newUserTemplate: ${templateEmail} is not marked as a template user (IsTemplate)`);
+            return null;
+        }
+
+        const result = await new RecordCloneEngine(provider).Clone(
+            {
+                EntityName: 'MJ: Users',
+                SourceRecordKey: CompositeKey.FromID(templateUser.ID),
+                Preset: preset,
+                PromptedValues: { Email: email, FirstName: firstName, LastName: lastName },
+                Options: { Reason: `New user ${email} created at first sign-in from template ${templateEmail}` },
+            },
+            contextUser
+        );
+        const newKey = result.Roots?.[0]?.TargetKey.KeyValuePairs.find((kvp) => kvp.FieldName === 'ID')?.Value;
+        if (!result.Success || !newKey) {
+            const reasons = result.Warnings.filter((w) => w.Severity === 'Error').map((w) => w.Message);
+            LogError(`userHandling.newUserTemplate: copying ${templateEmail} failed: ${result.ErrorMessage || reasons.join('; ') || result.ResultCode}`);
+            return null;
+        }
+
+        const user = await provider.GetEntityObject<MJUserEntity>('MJ: Users', contextUser);
+        if (!(await user.Load(String(newKey)))) {
+            LogError(`userHandling.newUserTemplate: the copy of ${templateEmail} for ${email} could not be loaded`);
+            return null;
+        }
+        user.IsActive = true;
+        user.LinkedRecordType = linkedRecordType;
+        if (linkedEntityId) user.LinkedEntityID = linkedEntityId;
+        if (linkedEntityRecordId) user.LinkedEntityRecordID = linkedEntityRecordId;
+        if (!(await user.Save())) {
+            LogError(`userHandling.newUserTemplate: could not activate ${email}: ${user.LatestResult?.CompleteMessage ?? 'unknown error'}`);
+            return null;
+        }
+        LogStatus(`Created user ${email} from template ${templateEmail} (${result.RecordsCloned ?? result.Created?.length ?? 0} records copied)`);
+        return user;
+    }
 }

package/src/config.ts

@@ -38,6 +38,19 @@ const userHandlingInfoSchema = z.object({
   contextUserForNewUserCreation: z.string().optional().default(''),
   CreateUserApplicationRecords: z.boolean().optional().default(false),
   UserApplications: z.array(z.string()).optional().default([]),
+  /**
+   * Build each auto-created user as a copy of a template user (`User.IsTemplate`), so new people start
+   * with its pinned apps, views, settings, dashboards and conversations. `email` names the template;
+   * `preset` is the `MJ: Users` clone preset to apply (default `template`). The copy takes the roles
+   * and apps of the template, so `newUserRoles`, `CreateUserApplicationRecords` and `UserApplications`
+   * apply only when the template can't be used, in which case a plain user is created as before.
+   */
+  newUserTemplate: z
+    .object({
+      email: z.string(),
+      preset: z.string().optional().default('template'),
+    })
+    .optional(),
 });
 
 const databaseSettingsInfoSchema = z.object({
@@ -254,6 +267,38 @@ const cacheSettingsSchema = z.object({
    * every signed-in user may read every row of every entity.
    */
   recordDataBroadcastEntities: z.array(z.string()).optional().default([]),
+  /**
+   * Expiry, in seconds, of entries in the shared Redis cache (used when REDIS_URL is set). The
+   * REDIS_TTL_SECONDS environment variable overrides it. 0 stores entries without expiry. When
+   * neither is set, the Redis provider's default applies (one hour).
+   */
+  sharedCacheTTLSeconds: z.number().int().nonnegative().optional(),
+  /**
+   * How often, in seconds, loaded engines compare their rows with the database and reload what
+   * changed without an MJ event (direct SQL, other applications). With a shared cache one server
+   * does it per interval. 0 = disabled. Default: 300 (5 minutes).
+   */
+  engineSweepIntervalSeconds: z.number().int().nonnegative().optional().default(300),
+  /**
+   * How often, in seconds, the user cache compares two row counts and the newest update timestamp
+   * with the database and reloads only when they differ. The cache already refreshes on MJ writes
+   * (locally and, with a shared cache, on other servers); this covers changes made outside MJ.
+   * 0 = disabled. Default: 300 (5 minutes).
+   */
+  userCacheCheckIntervalSeconds: z.number().int().nonnegative().optional().default(300),
+  /**
+   * How often to compare this process's metadata with the database, in seconds (0 disables).
+   * Costs nothing unless an entity the metadata is built from declares
+   * `TrustServerCacheCompletely = false`; see `ProviderBase.SweepMetadataAgainstDatabase`.
+   */
+  metadataSweepIntervalSeconds: z.number().int().nonnegative().optional().default(300),
+  /**
+   * How long, in seconds, a server holds the shared warm-up turn while it loads its engines, so
+   * servers starting together load one at a time and the rest find the cache warm. The lease is
+   * renewed while the load runs; this value is both its expiry and how long another server waits
+   * for it. 0 disables the turn-taking. Default: 30.
+   */
+  startupWarmupLeaseSeconds: z.number().int().nonnegative().optional().default(30),
 });
 
 const loggingSettingsSchema = z.object({
@@ -684,9 +729,87 @@ const telephonySchema = z.object({
   teams: teamsMeetingsSchema.optional(),
 }).passthrough();
 
+/**
+ * Mid-session identity verification for realtime sessions (see `src/realtimeSessions/README.md`).
+ *
+ * A person talking to an agent proves they control an email address WITHOUT leaving the conversation:
+ * the server emails a one-time link plus a short code, records the verification on the session, extends
+ * the session's limits, and tells the live session through a session event. The session's principal is
+ * never changed.
+ *
+ * Off by default: nothing is emailed and `/realtime/verify` is not mounted until `enabled` is true AND a
+ * `communicationProvider` is configured. Policy set here is the BASE layer; the config cascade
+ * (`channels.config.IdentityVerification`) snapshotted onto each session at mint overrides it per knob.
+ */
+const identityVerificationSchema = z.object({
+  /** Master switch. When false the verify routes are not mounted and the GraphQL operations refuse. */
+  enabled: zodBooleanWithTransforms().default(false),
+  /** CommunicationEngine provider that delivers the verification email (e.g. 'SendGrid', 'Microsoft Graph'). Required to send. */
+  communicationProvider: z.string().optional(),
+  /** From address of the verification email. */
+  fromAddress: z.string().optional(),
+  /**
+   * Server-only secret the typed verification code is HMAC'd under before it is stored on the session
+   * (at least 16 characters; 32+ random characters recommended). REQUIRED: without it verification is
+   * unavailable, because a session's owner can read their own session row and a bare hash of a six-digit
+   * code can be reversed offline. Never exposed to clients. Rotating it voids pending verifications only.
+   */
+  hmacSecret: z.string().optional().default(process.env.MJ_REALTIME_VERIFICATION_SECRET || ''),
+  /**
+   * `send` (default) delivers the email. `dry-run` builds and logs the message through the communication
+   * provider WITHOUT delivering it — for rehearsal and integration environments, where a test reads the
+   * emailed link and code from the `MJ: Communication Logs` row. Never use `dry-run` in production: the
+   * Communication Log then holds live credentials and no one is emailed.
+   */
+  deliveryMode: z.enum(['send', 'dry-run']).optional().default('send'),
+  /**
+   * Base URL the emailed link is built from (`<publicBaseUrl>/realtime/verify/<token>`). Defaults to the
+   * server's `publicUrl`, or `baseUrl:graphqlPort` when that is unset — the same derivation magic links use.
+   */
+  publicBaseUrl: z.string().optional(),
+  /**
+   * The internal user the server acts as to read/write the session, send the email and write the audit
+   * row, matched against `User.Name` then `User.Email` (falls back to the system user, then the lowest-ID
+   * active Owner). The verify link is public, so it has no caller identity of its own.
+   */
+  contextUserForVerification: z.string().optional(),
+  /** Base policy layer; each knob here is overridden by the per-session cascade layer. */
+  policy: z.object({
+    requireBusinessDomain: z.boolean().optional(),
+    blockedDomains: z.array(z.string()).optional(),
+    consumerDomains: z.array(z.string()).optional(),
+    linkTtlMinutes: z.coerce.number().optional(),
+    maxSendsPerSession: z.coerce.number().optional(),
+    maxCodeAttempts: z.coerce.number().optional(),
+    unverifiedMaxSeconds: z.coerce.number().optional(),
+    verifiedMaxSeconds: z.coerce.number().optional(),
+  }).optional().default({}),
+  /** Send-side and attempt-side limits (per instance, in memory; per-session limits are persisted and exact). */
+  rateLimits: z.object({
+    /** Window (ms) for the three send limits. Default 1 hour. */
+    sendWindowMs: z.coerce.number().optional().default(3_600_000),
+    /** Verification emails per client IP per window. Default 10. 0 disables. */
+    perIpSends: z.coerce.number().optional().default(10),
+    /** Verification emails per recipient domain per window. Default 30. 0 disables. */
+    perEmailDomainSends: z.coerce.number().optional().default(30),
+    /** Verification emails per recipient address per window — stops the feature being used to mail-bomb one inbox. Default 3. 0 disables. */
+    perEmailSends: z.coerce.number().optional().default(3),
+    /** Window (ms) for code attempts. Default 10 minutes. */
+    codeAttemptWindowMs: z.coerce.number().optional().default(600_000),
+    /** Code submissions per session per window. Default 10. 0 disables. */
+    perSessionCodeAttempts: z.coerce.number().optional().default(10),
+    /** Window (ms) of the public `/realtime/verify` route limiter. Default 60s. */
+    redeemWindowMs: z.coerce.number().optional().default(60_000),
+    /** `/realtime/verify` requests per IP per window. Default 30. */
+    redeemPerIp: z.coerce.number().optional().default(30),
+  }).optional().default({}),
+}).passthrough();
+
 const realtimeSchema = z.object({
   /** Master switch. When false, the WebRTC SDP broker router is not mounted. Defaults to true. */
   enabled: zodBooleanWithTransforms().default(true),
+  /** Mid-session identity verification (off by default). */
+  identityVerification: identityVerificationSchema.optional().default({}),
 }).passthrough();
 
 const configInfoSchema = z.object({
@@ -751,6 +874,7 @@ export type MagicLinkConfig = z.infer<typeof magicLinkSchema>;
 export type WidgetConfig = z.infer<typeof widgetSchema>;
 export type TelephonyConfig = z.infer<typeof telephonySchema>;
 export type RealtimeConfig = z.infer<typeof realtimeSchema>;
+export type IdentityVerificationConfig = z.infer<typeof identityVerificationSchema>;
 export type TwilioTelephonyConfig = z.infer<typeof twilioTelephonySchema>;
 export type VonageTelephonyConfig = z.infer<typeof vonageTelephonySchema>;
 export type RingCentralTelephonyConfig = z.infer<typeof ringcentralTelephonySchema>;
@@ -926,6 +1050,7 @@ export const DEFAULT_SERVER_CONFIG: Partial<ConfigInfo> = {
     defaultTTLSeconds: 0,
     evictionSweepIntervalSeconds: 300,
     verboseLogging: false,
+    engineSweepIntervalSeconds: 300,
   },
 
   // Logging settings defaults — variables logging is always off unless the operator

package/src/context.ts

@@ -781,6 +781,7 @@ export const ContextFunction =
       dataSources,
       userPayload,
       providers,
+      ClientIp: expressReq.ip,
     };
   };
 
@@ -811,21 +812,25 @@ async function createPerRequestProviders(
     { provider: p, type: 'Read-Write' }
   ];
 
-  if (isPostgres) {
-    const rp = await tryCreateReadOnlyPostgresProvider();
-    if (rp) {
-      providers.push({ provider: rp, type: 'Read-Only' });
-    }
-  } else {
-    const rp = await tryCreateReadOnlyProvider(dataSources);
-    if (rp) {
-      providers.push({ provider: rp, type: 'Read-Only' });
-    }
+  const rp = await CreateReadOnlyProvider(dataSources);
+  if (rp) {
+    providers.push({ provider: rp, type: 'Read-Only' });
   }
 
   return providers;
 }
 
+/**
+ * Opens a provider on the read-only database login, for the current platform. Resolves null when no
+ * read-only login is configured; it never falls back to the read-write pool.
+ * @param dataSources the data sources MJAPI opened at startup
+ */
+export async function CreateReadOnlyProvider(dataSources: DataSourceInfo[]): Promise<DatabaseProviderBase | null> {
+  return resolveDbPlatformFromEnv() === 'postgresql'
+    ? tryCreateReadOnlyPostgresProvider()
+    : tryCreateReadOnlyProvider(dataSources);
+}
+
 /**
  * Creates a PostgreSQL per-request provider, sharing the connection pool
  * from the primary provider to avoid pool exhaustion.