fix: hide exact quota values from account response (#16)

Closes #1

- hide exact quota values from GET /api/account
- keep only the approximate quota bucket in the public account payload
- add a regression test for the public account response contract
- document that completed tasks should end with a PR

Co-authored-by: sirily <sirily@git.shararam.party>
Reviewed-on: #16
This commit was merged in pull request #16.
This commit is contained in:
2026-03-10 15:52:16 +03:00
parent 55472de23d
commit 431a60f9c8
7 changed files with 162 additions and 70 deletions

View File

@@ -5,6 +5,8 @@
"type": "module",
"scripts": {
"build": "tsc -p tsconfig.json",
"pretest": "pnpm build",
"test": "node --test dist/**/*.test.js",
"start": "node dist/main.js"
},
"dependencies": {

View File

@@ -0,0 +1,65 @@
import test from "node:test";
import assert from "node:assert/strict";
import { serializePublicAccountOverview } from "./account-response.js";
test("serializePublicAccountOverview exposes only approximate quota fields", () => {
const response = serializePublicAccountOverview({
user: {
id: "user_1",
email: "user@example.com",
isAdmin: false,
createdAt: new Date("2026-03-10T12:00:00.000Z"),
},
subscription: {
id: "sub_1",
status: "active",
renewsManually: true,
activatedAt: new Date("2026-03-10T12:00:00.000Z"),
currentPeriodStart: new Date("2026-03-10T12:00:00.000Z"),
currentPeriodEnd: new Date("2026-04-09T12:00:00.000Z"),
plan: {
id: "plan_1",
code: "basic",
displayName: "Basic",
monthlyPriceUsd: 29,
billingCurrency: "USDT",
isActive: true,
},
},
quota: {
approximateBucket: 80,
},
});
assert.deepEqual(response, {
user: {
id: "user_1",
email: "user@example.com",
isAdmin: false,
createdAt: "2026-03-10T12:00:00.000Z",
},
subscription: {
id: "sub_1",
status: "active",
renewsManually: true,
activatedAt: "2026-03-10T12:00:00.000Z",
currentPeriodStart: "2026-03-10T12:00:00.000Z",
currentPeriodEnd: "2026-04-09T12:00:00.000Z",
plan: {
id: "plan_1",
code: "basic",
displayName: "Basic",
monthlyPriceUsd: 29,
billingCurrency: "USDT",
isActive: true,
},
},
quota: {
approximateBucket: 80,
},
});
assert.equal("usedSuccessfulRequests" in (response.quota ?? {}), false);
assert.equal("monthlyRequestLimit" in (response.quota ?? {}), false);
assert.equal("monthlyRequestLimit" in (response.subscription?.plan ?? {}), false);
});

View File

@@ -0,0 +1,71 @@
export interface PublicAccountOverviewLike {
user: {
id: string;
email: string;
isAdmin: boolean;
createdAt: Date;
};
subscription: {
id: string;
status: string;
renewsManually: boolean;
activatedAt?: Date;
currentPeriodStart?: Date;
currentPeriodEnd?: Date;
canceledAt?: Date;
plan: {
id: string;
code: string;
displayName: string;
monthlyPriceUsd: number;
billingCurrency: string;
isActive: boolean;
};
} | null;
quota: {
approximateBucket: number;
} | null;
}
export function serializePublicAccountOverview(overview: PublicAccountOverviewLike) {
return {
user: {
id: overview.user.id,
email: overview.user.email,
isAdmin: overview.user.isAdmin,
createdAt: overview.user.createdAt.toISOString(),
},
subscription: overview.subscription
? {
id: overview.subscription.id,
status: overview.subscription.status,
renewsManually: overview.subscription.renewsManually,
...(overview.subscription.activatedAt
? { activatedAt: overview.subscription.activatedAt.toISOString() }
: {}),
...(overview.subscription.currentPeriodStart
? { currentPeriodStart: overview.subscription.currentPeriodStart.toISOString() }
: {}),
...(overview.subscription.currentPeriodEnd
? { currentPeriodEnd: overview.subscription.currentPeriodEnd.toISOString() }
: {}),
...(overview.subscription.canceledAt
? { canceledAt: overview.subscription.canceledAt.toISOString() }
: {}),
plan: {
id: overview.subscription.plan.id,
code: overview.subscription.plan.code,
displayName: overview.subscription.plan.displayName,
monthlyPriceUsd: overview.subscription.plan.monthlyPriceUsd,
billingCurrency: overview.subscription.plan.billingCurrency,
isActive: overview.subscription.plan.isActive,
},
}
: null,
quota: overview.quota
? {
approximateBucket: overview.quota.approximateBucket,
}
: null,
};
}

View File

@@ -18,6 +18,7 @@ import {
createGenerationRequest,
type CreateGenerationRequestInput,
} from "@nproxy/domain";
import { serializePublicAccountOverview } from "./account-response.js";
const config = loadConfig();
const port = Number.parseInt(process.env.PORT ?? "3000", 10);
@@ -159,7 +160,7 @@ const server = createServer(async (request, response) => {
return;
}
sendJson(response, 200, serializeAccountOverview(overview));
sendJson(response, 200, serializePublicAccountOverview(overview));
return;
}
@@ -493,63 +494,6 @@ function serializeUserSession(
};
}
function serializeAccountOverview(overview: {
user: {
id: string;
email: string;
isAdmin: boolean;
createdAt: Date;
};
subscription: {
id: string;
status: string;
renewsManually: boolean;
activatedAt?: Date;
currentPeriodStart?: Date;
currentPeriodEnd?: Date;
canceledAt?: Date;
plan: {
id: string;
code: string;
displayName: string;
monthlyRequestLimit: number;
monthlyPriceUsd: number;
billingCurrency: string;
isActive: boolean;
};
} | null;
quota: {
approximateBucket: number;
usedSuccessfulRequests: number;
monthlyRequestLimit: number;
} | null;
}) {
return {
user: serializeAuthenticatedUser(overview.user),
subscription: overview.subscription
? {
id: overview.subscription.id,
status: overview.subscription.status,
renewsManually: overview.subscription.renewsManually,
...(overview.subscription.activatedAt
? { activatedAt: overview.subscription.activatedAt.toISOString() }
: {}),
...(overview.subscription.currentPeriodStart
? { currentPeriodStart: overview.subscription.currentPeriodStart.toISOString() }
: {}),
...(overview.subscription.currentPeriodEnd
? { currentPeriodEnd: overview.subscription.currentPeriodEnd.toISOString() }
: {}),
...(overview.subscription.canceledAt
? { canceledAt: overview.subscription.canceledAt.toISOString() }
: {}),
plan: overview.subscription.plan,
}
: null,
quota: overview.quota,
};
}
function serializeBillingInvoice(invoice: {
id: string;
subscriptionId?: string;