mirror of
https://github.com/outline/outline.git
synced 2026-11-22 05:51:43 +03:00
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.
123 lines
4.1 KiB
TypeScript
123 lines
4.1 KiB
TypeScript
// @vitest-isolate true
|
|
import type S3Storage from "./S3Storage";
|
|
|
|
const { mockEnv, mockGetS3SignedUrl, mockGetCloudFrontSignedUrl } = vi.hoisted(
|
|
() => ({
|
|
mockEnv: {
|
|
AWS_CLOUDFRONT_URL: undefined as string | undefined,
|
|
AWS_CLOUDFRONT_KEY_PAIR_ID: undefined as string | undefined,
|
|
AWS_CLOUDFRONT_PRIVATE_KEY: undefined as string | undefined,
|
|
AWS_S3_UPLOAD_BUCKET_URL: "http://s3:4569",
|
|
AWS_S3_UPLOAD_BUCKET_NAME: "bucket",
|
|
AWS_S3_ACCELERATE_URL: "",
|
|
AWS_REGION: "us-east-1",
|
|
AWS_S3_FORCE_PATH_STYLE: true,
|
|
},
|
|
mockGetS3SignedUrl: vi.fn(),
|
|
mockGetCloudFrontSignedUrl: vi.fn(),
|
|
})
|
|
);
|
|
|
|
vi.mock("@server/env", () => ({
|
|
default: mockEnv,
|
|
}));
|
|
|
|
vi.mock("@aws-sdk/signature-v4-crt", () => ({}));
|
|
|
|
vi.mock("@aws-sdk/s3-request-presigner", () => ({
|
|
getSignedUrl: mockGetS3SignedUrl,
|
|
}));
|
|
|
|
vi.mock("@aws-sdk/cloudfront-signer", () => ({
|
|
getSignedUrl: mockGetCloudFrontSignedUrl,
|
|
}));
|
|
|
|
vi.mock("@aws-sdk/client-s3", () => ({
|
|
S3Client: class MockS3Client {
|
|
send = vi.fn();
|
|
},
|
|
DeleteObjectCommand: vi.fn(),
|
|
GetObjectCommand: vi.fn(),
|
|
HeadObjectCommand: vi.fn(),
|
|
CopyObjectCommand: vi.fn(),
|
|
}));
|
|
|
|
describe("S3Storage CloudFront signed URLs", () => {
|
|
let Storage: typeof S3Storage;
|
|
|
|
beforeEach(async () => {
|
|
vi.resetModules();
|
|
mockEnv.AWS_CLOUDFRONT_URL = undefined;
|
|
mockEnv.AWS_CLOUDFRONT_KEY_PAIR_ID = undefined;
|
|
mockEnv.AWS_CLOUDFRONT_PRIVATE_KEY = undefined;
|
|
mockGetS3SignedUrl.mockReset();
|
|
mockGetCloudFrontSignedUrl.mockReset();
|
|
mockGetS3SignedUrl.mockResolvedValue("https://s3.example/presigned");
|
|
mockGetCloudFrontSignedUrl.mockReturnValue("https://cf.example/signed");
|
|
|
|
Storage = (await import("./S3Storage")).default;
|
|
});
|
|
|
|
it("should return a CloudFront signed URL when signing is configured", async () => {
|
|
mockEnv.AWS_CLOUDFRONT_URL = "https://d111.cloudfront.net";
|
|
mockEnv.AWS_CLOUDFRONT_KEY_PAIR_ID = "K2ABCDEF";
|
|
mockEnv.AWS_CLOUDFRONT_PRIVATE_KEY = "-----BEGIN RSA PRIVATE KEY-----";
|
|
|
|
const storage = new Storage();
|
|
const url = await storage.getSignedUrl("uploads/test.png");
|
|
|
|
expect(url).toBe("https://cf.example/signed");
|
|
expect(mockGetCloudFrontSignedUrl).toHaveBeenCalledWith(
|
|
expect.objectContaining({
|
|
url: "https://d111.cloudfront.net/uploads/test.png",
|
|
keyPairId: "K2ABCDEF",
|
|
privateKey: "-----BEGIN RSA PRIVATE KEY-----",
|
|
})
|
|
);
|
|
expect(mockGetS3SignedUrl).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it("should fall back to S3 when CloudFront signing credentials are missing", async () => {
|
|
mockEnv.AWS_CLOUDFRONT_URL = "https://d111.cloudfront.net";
|
|
|
|
const storage = new Storage();
|
|
const url = await storage.getSignedUrl("uploads/test.png");
|
|
|
|
expect(url).toBe("http://localhost:4569/bucket/uploads/test.png");
|
|
expect(mockGetCloudFrontSignedUrl).not.toHaveBeenCalled();
|
|
expect(mockGetS3SignedUrl).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it("should fall back to S3 when CloudFront signing fails", async () => {
|
|
mockEnv.AWS_CLOUDFRONT_URL = "https://d111.cloudfront.net";
|
|
mockEnv.AWS_CLOUDFRONT_KEY_PAIR_ID = "K2ABCDEF";
|
|
mockEnv.AWS_CLOUDFRONT_PRIVATE_KEY = "-----BEGIN RSA PRIVATE KEY-----";
|
|
mockGetCloudFrontSignedUrl.mockImplementationOnce(() => {
|
|
throw new Error("signing failed");
|
|
});
|
|
|
|
const storage = new Storage();
|
|
const url = await storage.getSignedUrl("uploads/test.png");
|
|
|
|
expect(url).toBe("http://localhost:4569/bucket/uploads/test.png");
|
|
expect(mockGetS3SignedUrl).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it("should decode a base64-encoded private key in AWS_CLOUDFRONT_PRIVATE_KEY", async () => {
|
|
mockEnv.AWS_CLOUDFRONT_URL = "https://d111.cloudfront.net";
|
|
mockEnv.AWS_CLOUDFRONT_KEY_PAIR_ID = "K2ABCDEF";
|
|
mockEnv.AWS_CLOUDFRONT_PRIVATE_KEY = Buffer.from(
|
|
"-----BEGIN RSA PRIVATE KEY-----"
|
|
).toString("base64");
|
|
|
|
const storage = new Storage();
|
|
await storage.getSignedUrl("uploads/test.png");
|
|
|
|
expect(mockGetCloudFrontSignedUrl).toHaveBeenCalledWith(
|
|
expect.objectContaining({
|
|
privateKey: "-----BEGIN RSA PRIVATE KEY-----",
|
|
})
|
|
);
|
|
});
|
|
});
|