83ec5ecd36
Every route had to remember to add the business filter to every query;
nothing stopped one that forgot. The audit for this change found several
that had: the M-Pesa status re-check, the stock ledger's duplicate checks,
the daily-inventory and branch-price upserts, a cash-sale replay lookup,
several load-by-id lookups, and every populate().
- tenantGuard: a Mongoose plugin on all ten business-scoped models. Any
find/update/delete/count/distinct, or an aggregate whose first stage is
not a $match, that does not pin exactly one businessId throws
TenantScopeError before reaching the database ($in, $exists and other
operators do not count).
- crossTenant("reason", fn): the explicit, documented exemption for the
queries that must span businesses - login's email lookup, refresh and
invite-token lookups, the M-Pesa callback, the platform console and the
maintenance scripts. git grep crossTenant lists them all.
- scopedPopulate: populated branch, product and staff names are also
restricted to the business.
- Every flagged query site now names the business (or is exempted with a
reason).
- Tests: a check that every model with a businessId field carries the
guard; the guard refusing unscoped queries of every kind; and a route
sweep where business A sends business B's ids to every read route
(nothing of B's comes back) and every write route (all refused, B's
data unchanged). Test-side database inspections go through db(), an
explicit test exemption. Removing one route's business filter makes the
suite fail.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
114 lines
4.8 KiB
TypeScript
114 lines
4.8 KiB
TypeScript
import { tenantGuard } from "@/lib/server/tenantGuard";
|
|
import { Schema, model, models, Model, Types, Document } from "mongoose";
|
|
|
|
export type PaymentMethod = "CASH" | "MPESA";
|
|
export type PaymentStatus = "PENDING" | "SUCCESS" | "FAILED";
|
|
|
|
export interface ITransaction extends Document {
|
|
_id: Types.ObjectId;
|
|
businessId: Types.ObjectId; // tenant this transaction belongs to
|
|
branchId: Types.ObjectId;
|
|
staffId: Types.ObjectId;
|
|
customerName: string | null;
|
|
customerPhone: string | null; // optional for cash sales; required for M-Pesa
|
|
productId: Types.ObjectId;
|
|
sizeLiters: number; // snapshotted at sale time
|
|
quantity: number;
|
|
unitPrice: number; // snapshotted at sale time
|
|
amountTotal: number;
|
|
paymentMethod: PaymentMethod;
|
|
paymentStatus: PaymentStatus;
|
|
|
|
mpesaDetails: {
|
|
checkoutRequestId: string | null;
|
|
merchantRequestId: string | null;
|
|
receiptNumber: string | null;
|
|
resultCode: number | null;
|
|
resultDesc: string | null;
|
|
};
|
|
|
|
clientUuid: string; // idempotency key for this line: `${saleId}:${lineIndex}` for cash sales
|
|
saleId: string | null; // groups the lines of one multi-item sale (the device's sale UUID)
|
|
lineIndex: number;
|
|
syncedFromOffline: boolean;
|
|
// What the device showed and collected per unit. The server price stays
|
|
// authoritative; a difference (e.g. the price changed while the device
|
|
// was offline) is kept and flagged rather than silently overwritten.
|
|
clientUnitPrice: number | null;
|
|
priceMismatch: boolean;
|
|
|
|
// TAMPER PREVENTION: this is what the device *claimed* the time was when
|
|
// the sale happened — informational only, e.g. for offline-queue
|
|
// ordering in the UI. It is NEVER used for reconciliation, reporting, or
|
|
// as the authoritative sale time, precisely because a delivery worker
|
|
// could set their phone's clock backward/forward to forge history. The
|
|
// authoritative time is `createdAt`, which Mongoose/MongoDB stamps from
|
|
// the SERVER's clock at insert time and which the API never accepts as
|
|
// client input (see transactions.routes.ts / mpesa.routes.ts — neither
|
|
// route reads a timestamp field off the request body).
|
|
clientSubmittedAt: Date | null;
|
|
|
|
createdAt: Date; // authoritative — server clock
|
|
updatedAt: Date;
|
|
}
|
|
|
|
const transactionSchema = new Schema<ITransaction>(
|
|
{
|
|
businessId: { type: Schema.Types.ObjectId, ref: "Business", required: true, index: true },
|
|
branchId: { type: Schema.Types.ObjectId, ref: "Branch", required: true },
|
|
staffId: { type: Schema.Types.ObjectId, ref: "User", required: true },
|
|
customerName: { type: String, default: null, trim: true },
|
|
customerPhone: { type: String, default: null },
|
|
productId: { type: Schema.Types.ObjectId, ref: "Product", required: true },
|
|
sizeLiters: { type: Number, required: true },
|
|
quantity: { type: Number, required: true, min: 1 },
|
|
unitPrice: { type: Number, required: true, min: 0 },
|
|
amountTotal: { type: Number, required: true, min: 0 },
|
|
paymentMethod: { type: String, enum: ["CASH", "MPESA"], required: true },
|
|
paymentStatus: {
|
|
type: String,
|
|
enum: ["PENDING", "SUCCESS", "FAILED"],
|
|
required: true,
|
|
default: "PENDING",
|
|
},
|
|
|
|
mpesaDetails: {
|
|
checkoutRequestId: { type: String, default: null },
|
|
merchantRequestId: { type: String, default: null },
|
|
receiptNumber: { type: String, default: null },
|
|
resultCode: { type: Number, default: null },
|
|
resultDesc: { type: String, default: null },
|
|
},
|
|
|
|
clientUuid: { type: String, required: true },
|
|
saleId: { type: String, default: null },
|
|
lineIndex: { type: Number, default: 0 },
|
|
syncedFromOffline: { type: Boolean, default: false },
|
|
clientUnitPrice: { type: Number, default: null },
|
|
priceMismatch: { type: Boolean, default: false },
|
|
clientSubmittedAt: { type: Date, default: null },
|
|
},
|
|
{ timestamps: true } // createdAt/updatedAt set from the server's Date.now(), not client input
|
|
);
|
|
|
|
// Required indexes: branch_id, created_at, mpesa checkout id.
|
|
transactionSchema.index({ branchId: 1 });
|
|
transactionSchema.index({ createdAt: -1 });
|
|
transactionSchema.index({ "mpesaDetails.checkoutRequestId": 1 });
|
|
// Idempotency: an offline-queued sale replayed twice must never duplicate.
|
|
transactionSchema.index({ clientUuid: 1 }, { unique: true });
|
|
// Practical addition: the actual hot query pattern for both the live feed
|
|
// and reconciliation is "this branch, most recent first" / "this branch,
|
|
// today" — a compound index serves that far better than the two single
|
|
// indexes above combined.
|
|
transactionSchema.index({ branchId: 1, createdAt: -1 });
|
|
transactionSchema.index({ businessId: 1, createdAt: -1 });
|
|
transactionSchema.index({ paymentStatus: 1 });
|
|
transactionSchema.index({ businessId: 1, saleId: 1 });
|
|
|
|
transactionSchema.plugin(tenantGuard);
|
|
|
|
export const Transaction =
|
|
(models.Transaction as Model<ITransaction>) ||
|
|
model<ITransaction>("Transaction", transactionSchema);
|