Files
outline/server/test/support.ts
T
Tom Moor 6ac407de84 chore: Run server tests with a shared module registry (#13799)
Adds a server-shared Vitest project with isolate disabled and moves every
server test into it by default. Files that mock or reset modules opt out
with a header marker and stay in the isolated project.

Restores env values that leaked between files: the test URL is reset after
each file, and tests that mutate env restore the previous value. The test
server no longer closes the shared sequelize pool.
2026-09-18 17:45:39 -04:00

164 lines
4.5 KiB
TypeScript

import fs from "node:fs/promises";
import os from "node:os";
import path from "node:path";
import { randomUUID } from "node:crypto";
import { faker } from "@faker-js/faker";
import type { Transaction } from "sequelize";
import { ZipFile } from "yazl";
import { afterEach, beforeEach, vi } from "vitest";
import sharedEnv from "@shared/env";
import { createContext } from "@server/context";
import env from "@server/env";
import type { User } from "@server/models";
import onerror from "@server/onerror";
import { BaseTask } from "@server/queues/tasks/base/BaseTask";
import webService from "@server/services/web";
import { sequelize } from "@server/storage/database";
import type { APIContext } from "@server/types";
import { AuthenticationType } from "@server/types";
import ZipHelper from "@server/utils/ZipHelper";
import TestServer from "./TestServer";
export function getTestServer() {
const app = webService();
onerror(app);
const server = new TestServer(app);
afterAll(() => server.close());
return server;
}
/**
* Set the environment to be self hosted.
*/
export function setSelfHosted() {
env.URL = sharedEnv.URL = `https://${faker.internet.domainName()}`;
}
/**
* Set the environment to be cloud hosted.
*/
export function setCloudHosted() {
env.URL = sharedEnv.URL = "https://app.outline.dev";
}
/**
* Mock scheduling for all task subclasses in the current test file.
*
* @returns the schedule mock for assertions.
*/
export function mockTaskSchedule() {
const schedule = vi.fn<BaseTask<object>["schedule"]>();
beforeEach(() => {
schedule.mockReset();
vi.spyOn(BaseTask.prototype, "schedule").mockImplementation(schedule);
});
afterEach(() => {
vi.restoreAllMocks();
});
return schedule;
}
export function withAPIContext<T>(
user: User,
fn: (ctx: APIContext) => T
): Promise<T> {
return sequelize.transaction(async (transaction: Transaction) => {
const state = {
auth: {
user,
type: AuthenticationType.APP,
token: user.getSessionToken(),
},
transaction,
};
return fn({
...createContext({ user, transaction }),
state,
request: {
ip: faker.internet.ip(),
},
} as APIContext);
});
}
/**
* Read a zip archive returned from an API endpoint into memory.
*
* @param res The response to read the archive from.
* @returns a map of entry filename to the entry contents as a string.
*/
export async function readZipResponse(
res: Awaited<ReturnType<TestServer["post"]>>
): Promise<Record<string, string>> {
const filePath = path.join(os.tmpdir(), `test-${randomUUID()}.zip`);
await fs.writeFile(filePath, Buffer.from(await res.arrayBuffer()));
try {
const entries: Record<string, string> = {};
await ZipHelper.walk(filePath, async (entry) => {
entries[entry.fileName] = (
await entry.readBuffer(1024 * 1024)
).toString();
});
return entries;
} finally {
await fs.rm(filePath, { force: true });
}
}
/**
* Build a zip archive in memory from a map of entry path to contents. Useful
* for describing an archive's structure inline in a test rather than carrying
* an opaque binary fixture.
*
* @param files Map of path within the archive to its contents.
* @returns The zip archive as a Buffer.
*/
export function buildZip(
files: Record<string, string | Buffer>
): Promise<Buffer> {
return new Promise((resolve, reject) => {
const zip = new ZipFile();
const chunks: Buffer[] = [];
zip.outputStream.on("data", (chunk: Buffer) => chunks.push(chunk));
zip.outputStream.on("end", () => resolve(Buffer.concat(chunks)));
zip.outputStream.on("error", reject);
for (const [name, contents] of Object.entries(files)) {
zip.addBuffer(
Buffer.isBuffer(contents) ? contents : Buffer.from(contents, "utf8"),
name
);
}
zip.end();
});
}
/**
* Helper function to convert an object to form-urlencoded string.
* Useful for testing OAuth endpoints that expect application/x-www-form-urlencoded content type.
*
* @param obj Object to convert to form-urlencoded string
* @returns Form-urlencoded string representation of the object
*/
export function toFormData(
obj: Record<string, string | number | boolean | null | undefined>
): string {
return Object.entries(obj)
.filter(
(entry): entry is [string, string | number | boolean] =>
entry[1] !== undefined && entry[1] !== null
)
.map(
([key, value]) =>
`${encodeURIComponent(key)}=${encodeURIComponent(value)}`
)
.join("&");
}