Fix daily and weekly job credit reliability

api/spec/integration-db.ts

@@ -0,0 +1,132 @@
+import dotenv from 'dotenv';
+import { Knex } from 'knex';
+
+// `knexfile` loads this same file, but these helpers read DB_* directly to decide whether
+// they are allowed to write, so they cannot rely on that import having happened first.
+// jest's cwd is `api/`, so `../.env` is the repository root env the API itself uses.
+dotenv.config({ path: '../.env' });
+
+/**
+ * Whether a spec may create and delete fixture rows in the configured database.
+ *
+ * `DB_HOST`/`DB_DATABASE` only prove that *a* database is reachable, and the API's
+ * ordinary environment defines both -- pointed at a shared or production schema where
+ * fixture INSERTs and cleanup DELETEs must never run. Writing therefore additionally
+ * requires `CTR_INTEGRATION_TEST_DB` to name the configured database exactly: an
+ * explicit, per-environment statement that this specific schema is disposable, rather
+ * than an inference drawn from configuration that happens to be present.
+ */
+export function integrationDbAuthorized(env: NodeJS.ProcessEnv = process.env): boolean {
+  return Boolean(
+    env.DB_HOST
+    && env.DB_DATABASE
+    && env.CTR_INTEGRATION_TEST_DB
+    && env.CTR_INTEGRATION_TEST_DB === env.DB_DATABASE,
+  );
+}
+
+/**
+ * `describe` for a block that writes to the database, downgraded to `describe.skip`
+ * when the opt-in above has not been given. Skipped blocks report as skipped, never as
+ * a silent pass.
+ */
+export const describeWithDb = integrationDbAuthorized() ? describe : describe.skip;
+
+/** Marks every row this run creates, so cleanup can never reach a row it did not make. */
+export const FIXTURE_TAG = 'b1itest';
+
+let sequence = 0;
+
+/** A name unique to this process and call, prefixed so cleanup can find it again. */
+export function fixtureName(label: string): string {
+  sequence += 1;
+  return `${FIXTURE_TAG}-${label}-${process.pid}-${sequence}`;
+}
+
+/** Fields of a fixture role that a test actually cares about. */
+export interface RoleFixture {
+  name: string;
+  income_cc: number;
+  income_xp: number;
+}
+
+/** A fixture member, with the wallet the payout paths credit. */
+export interface MemberFixture {
+  id: number;
+  walletId: number;
+  username: string;
+}
+
+/** Inserts a role and returns its id. */
+export async function createRole(knex: Knex, role: RoleFixture): Promise<number> {
+  const [id] = await knex('role').insert(role);
+  return id;
+}
+
+/**
+ * Inserts a member and its wallet.
+ * @param knex connection to write through
+ * @param overrides member columns to set, most usefully the two credit timestamps
+ */
+export async function createMember(
+  knex: Knex,
+  overrides: Record<string, unknown> = {},
+): Promise<MemberFixture> {
+  const username = fixtureName('member');
+  const [walletId] = await knex('wallet').insert({ balance: 1000 });
+  const [id] = await knex('member').insert({
+    username,
+    email: `${username}@example.invalid`,
+    password: 'not-a-real-hash',
+    wallet_id: walletId,
+    ...overrides,
+  });
+  return { id, walletId, username };
+}
+
+/** Assigns a role to a member, optionally scoped to a place. */
+export async function assignRole(
+  knex: Knex,
+  memberId: number,
+  roleId: number,
+  placeId: number = null,
+): Promise<void> {
+  await knex('role_assignment').insert({
+    member_id: memberId,
+    role_id: roleId,
+    place_id: placeId,
+  });
+}
+
+/** A timestamp `days` days before now, for setting a credit timestamp out of its window. */
+export function daysAgo(days: number): Date {
+  const when = new Date();
+  when.setDate(when.getDate() - days);
+  return when;
+}
+
+/**
+ * Deletes every row created by `createMember`/`createRole` in this schema.
+ *
+ * Keyed off {@link FIXTURE_TAG} rather than off ids collected during the run, so a spec
+ * that died part way through still cleans up after itself on the next run.
+ */
+export async function cleanUpFixtures(knex: Knex): Promise<void> {
+  const members = await knex('member')
+    .select('id', 'wallet_id')
+    .where('username', 'like', `${FIXTURE_TAG}-%`);
+  const memberIds = members.map(member => member.id);
+  const walletIds = members.map(member => member.wallet_id);
+  if (memberIds.length) {
+    await knex('role_assignment').whereIn('member_id', memberIds).del();
+    await knex('member').whereIn('id', memberIds).del();
+  }
+  if (walletIds.length) {
+    await knex('transaction').whereIn('recipient_wallet_id', walletIds).del();
+    await knex('wallet').whereIn('id', walletIds).del();
+  }
+  await knex('role_assignment')
+    .whereIn('role_id', knex('role').select('id').where('name', 'like', `${FIXTURE_TAG}-%`))
+    .del();
+  await knex('role').where('name', 'like', `${FIXTURE_TAG}-%`).del();
+}

api/src/controllers/member.controller.ts

@@ -7,7 +7,6 @@ import * as badwords from 'badwords-list';
 
 import { sendPasswordResetEmail, sendPasswordResetUnknownEmail } from '../libs';
 import { MemberService, HomeService, PlaceService } from '../services';
-import { SessionInfo } from 'session-info.interface';
 import {parseInt} from 'lodash';
 
 class MemberController {
@@ -98,7 +97,7 @@ class MemberController {
     }
   }
 
-  public async check3d(request: Request, response: Response): Promise<any> {
+  public async check3d(request: Request, response: Response): Promise<void> {
     const session = this.memberService.decryptSession(request, response);
     if(!session) return;
     try {
@@ -110,7 +109,7 @@ class MemberController {
     }
   }
 
-  public async getActivePlaces(request: Request, response: Response): Promise<any> {
+  public async getActivePlaces(request: Request, response: Response): Promise<void> {
     const session = this.memberService.decryptSession(request, response);
     if(!session) return;
     try {
@@ -313,7 +312,7 @@ class MemberController {
         const token = await this.memberService.getMemberToken(session.id);
         const { banned, banInfo } = await this.memberService.isBanned(session.id);
         if (!banned) {
-          await this.memberService.maybeGiveDailyCredits(session.id);
+          await this.memberService.giveDailyCreditsForLogin(session.id);
           const homeInfo = await this.homeService.getHome(session.id);
           const chatdefault = await this.memberService.getMemberChat(session.id);
           session.hasHome = !!homeInfo;
@@ -462,7 +461,7 @@ class MemberController {
     }
   }
 
-  public async getOnlineUsers(request: Request, response: Response): Promise<any> {
+  public async getOnlineUsers(request: Request, response: Response): Promise<void> {
     const session = this.memberService.decryptSession(request, response);
     if (!session) return;
     try {
@@ -491,7 +490,7 @@ class MemberController {
     }
   }
 
-  public async getStorage(request: Request, response: Response): Promise<any> {
+  public async getStorage(request: Request, response: Response): Promise<void> {
     const session = this.memberService.decryptSession(request, response);
     if (!session) return;
     const member_id = parseInt(request.body.member_id);
@@ -504,7 +503,7 @@ class MemberController {
     }
   }
 
-  public async updateStorage(request: Request, response: Response): Promise<any> {
+  public async updateStorage(request: Request, response: Response): Promise<void> {
     const session = this.memberService.decryptSession(request, response);
     if(!session) return;
     try {