feat: enhance API and middleware functionality: add public API routes, implement program and course member checks, and improve rate limiting for invite acceptance. Update OpenAPI spec generation to focus on public API endpoints and add new middleware for automation key scopes. Include new documentation for lesson AI features and public API tests.
This commit is contained in:
Rotimi Best
@@ -0,0 +1,267 @@
|
||||
#!/usr/bin/env tsx
|
||||
|
||||
/**
|
||||
* Upload built embed assets to Cloudflare R2 (S3-compatible), same bucket pattern as Storybook.
|
||||
*
|
||||
* Each widget gets its own prefix under `embeds/<widget>/` so future widgets stay isolated.
|
||||
*
|
||||
* @see packages/storybook/scripts/upload-storybook.ts
|
||||
*/
|
||||
|
||||
import 'dotenv/config';
|
||||
|
||||
import { PutObjectCommand, S3Client } from '@aws-sdk/client-s3';
|
||||
import { join, relative } from 'node:path';
|
||||
import { readFileSync, readdirSync, statSync } from 'node:fs';
|
||||
|
||||
const BUCKET = 'assets';
|
||||
|
||||
/** R2 object key prefix (no trailing slash). */
|
||||
const EMBED_WIDGET_PREFIX = 'embeds/question-type-picker';
|
||||
|
||||
/** Cloudflare allows a limited number of URLs per purge request. */
|
||||
const PURGE_URL_BATCH = 30;
|
||||
|
||||
const DEFAULT_CDN_BASE = 'https://assets.cdn.clsrio.com';
|
||||
|
||||
function normalizePublicBaseUrl(raw: string | undefined): string {
|
||||
const value = raw != null && raw.trim() !== '' ? raw.trim() : DEFAULT_CDN_BASE;
|
||||
const trimmed = value.replace(/\/$/, '');
|
||||
if (!trimmed.startsWith('https://')) {
|
||||
throw new Error('EMBED_CDN_BASE_URL must be an https URL (no trailing slash).');
|
||||
}
|
||||
return trimmed;
|
||||
}
|
||||
|
||||
/**
|
||||
* Purge Cloudflare **edge cache** for public URLs that map to R2 objects.
|
||||
* R2 itself has no separate HTTP cache; purging fixes stale responses when the hostname is proxied through Cloudflare.
|
||||
*/
|
||||
async function purgeCloudflareCdnForUrls(urls: string[]): Promise<void> {
|
||||
if (process.env.EMBED_SKIP_CDN_PURGE === '1' || process.env.EMBED_SKIP_CDN_PURGE === 'true') {
|
||||
console.log('Skipping Cloudflare CDN purge (EMBED_SKIP_CDN_PURGE is set).');
|
||||
return;
|
||||
}
|
||||
|
||||
const token = process.env.CLOUDFLARE_API_TOKEN;
|
||||
const zoneId = process.env.CLOUDFLARE_ZONE_ID;
|
||||
|
||||
if (!token || !zoneId) {
|
||||
console.log(
|
||||
'Skipping Cloudflare CDN cache purge. Set CLOUDFLARE_API_TOKEN and CLOUDFLARE_ZONE_ID to purge after upload.'
|
||||
);
|
||||
return;
|
||||
}
|
||||
|
||||
if (urls.length === 0) {
|
||||
return;
|
||||
}
|
||||
|
||||
const uniqueUrls = [...new Set(urls)];
|
||||
|
||||
for (let i = 0; i < uniqueUrls.length; i += PURGE_URL_BATCH) {
|
||||
const batch = uniqueUrls.slice(i, i + PURGE_URL_BATCH);
|
||||
const response = await fetch(`https://api.cloudflare.com/client/v4/zones/${zoneId}/purge_cache`, {
|
||||
method: 'POST',
|
||||
headers: {
|
||||
Authorization: `Bearer ${token}`,
|
||||
'Content-Type': 'application/json'
|
||||
},
|
||||
body: JSON.stringify({ files: batch })
|
||||
});
|
||||
|
||||
const payload: unknown = await response.json().catch(() => ({}));
|
||||
const success =
|
||||
response.ok &&
|
||||
typeof payload === 'object' &&
|
||||
payload !== null &&
|
||||
'success' in payload &&
|
||||
(payload as { success?: boolean }).success === true;
|
||||
|
||||
if (!success) {
|
||||
throw new Error(`Cloudflare CDN purge failed: ${response.status} ${JSON.stringify(payload)}`);
|
||||
}
|
||||
|
||||
console.log(`Purged Cloudflare CDN cache for ${batch.length} URL(s).`);
|
||||
}
|
||||
}
|
||||
|
||||
class EmbedsUploader {
|
||||
private s3Client: S3Client | null = null;
|
||||
private readonly buildDir: string;
|
||||
|
||||
constructor() {
|
||||
this.buildDir = join(process.cwd(), 'dist');
|
||||
this.initializeS3Client();
|
||||
}
|
||||
|
||||
private initializeS3Client(): void {
|
||||
const accessKey = process.env.CLOUDFLARE_ACCESS_KEY;
|
||||
const secretKey = process.env.CLOUDFLARE_SECRET_ACCESS_KEY;
|
||||
const accountId = process.env.CLOUDFLARE_ACCOUNT_ID;
|
||||
|
||||
if (accessKey && secretKey && accountId) {
|
||||
this.s3Client = new S3Client({
|
||||
region: 'auto',
|
||||
endpoint: `https://${accountId}.r2.cloudflarestorage.com`,
|
||||
credentials: {
|
||||
accessKeyId: accessKey,
|
||||
secretAccessKey: secretKey
|
||||
}
|
||||
});
|
||||
console.log('S3 client initialized for Cloudflare R2');
|
||||
} else {
|
||||
throw new Error(
|
||||
'Missing Cloudflare R2 credentials (CLOUDFLARE_ACCESS_KEY, CLOUDFLARE_SECRET_ACCESS_KEY, CLOUDFLARE_ACCOUNT_ID)'
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
private getContentType(filePath: string): string {
|
||||
const ext = filePath.split('.').pop()?.toLowerCase();
|
||||
const contentTypes: Record<string, string> = {
|
||||
html: 'text/html',
|
||||
js: 'application/javascript',
|
||||
mjs: 'application/javascript',
|
||||
json: 'application/json',
|
||||
css: 'text/css',
|
||||
map: 'application/json',
|
||||
txt: 'text/plain'
|
||||
};
|
||||
return contentTypes[ext || ''] || 'application/octet-stream';
|
||||
}
|
||||
|
||||
private getCacheControl(filePath: string): string {
|
||||
if (filePath.endsWith('.html')) {
|
||||
return 'public, max-age=300';
|
||||
}
|
||||
if (filePath.match(/\.(js|mjs)$/)) {
|
||||
const baseName = filePath.split(/[/\\]/).pop() ?? filePath;
|
||||
// Stable bootstrap URL must revalidate quickly so new chunk hashes roll out after deploy.
|
||||
if (baseName === 'question-type-picker.js') {
|
||||
return 'public, max-age=300, must-revalidate';
|
||||
}
|
||||
return 'public, max-age=31536000, immutable';
|
||||
}
|
||||
if (filePath.endsWith('.css')) {
|
||||
return 'public, max-age=3600';
|
||||
}
|
||||
return 'public, max-age=3600';
|
||||
}
|
||||
|
||||
private getAllFiles(dir: string, baseDir: string = dir): string[] {
|
||||
const files: string[] = [];
|
||||
const entries = readdirSync(dir, { withFileTypes: true });
|
||||
|
||||
for (const entry of entries) {
|
||||
const fullPath = join(dir, entry.name);
|
||||
const relativePath = relative(baseDir, fullPath);
|
||||
|
||||
if (entry.isDirectory()) {
|
||||
files.push(...this.getAllFiles(fullPath, baseDir));
|
||||
} else {
|
||||
files.push(relativePath);
|
||||
}
|
||||
}
|
||||
|
||||
return files;
|
||||
}
|
||||
|
||||
async uploadFile(relativePath: string): Promise<void> {
|
||||
if (!this.s3Client) {
|
||||
throw new Error('S3 client not initialized');
|
||||
}
|
||||
|
||||
const fullPath = join(this.buildDir, relativePath);
|
||||
const content = readFileSync(fullPath);
|
||||
const contentType = this.getContentType(relativePath);
|
||||
const cacheControl = this.getCacheControl(relativePath);
|
||||
const key = `${EMBED_WIDGET_PREFIX}/${relativePath.split('\\').join('/')}`;
|
||||
|
||||
const command = new PutObjectCommand({
|
||||
Bucket: BUCKET,
|
||||
Key: key,
|
||||
Body: content,
|
||||
ContentType: contentType,
|
||||
CacheControl: cacheControl
|
||||
});
|
||||
|
||||
await this.s3Client.send(command);
|
||||
console.log(`Uploaded: ${key}`);
|
||||
}
|
||||
|
||||
async uploadAll(): Promise<void> {
|
||||
try {
|
||||
statSync(this.buildDir);
|
||||
} catch {
|
||||
throw new Error(`Build directory not found: ${this.buildDir}. Run pnpm build in apps/embeds first.`);
|
||||
}
|
||||
|
||||
console.log('Uploading embeds to R2...');
|
||||
console.log(`Build directory: ${this.buildDir}`);
|
||||
console.log(`Key prefix: ${EMBED_WIDGET_PREFIX}/`);
|
||||
|
||||
const files = this.getAllFiles(this.buildDir);
|
||||
if (files.length === 0) {
|
||||
throw new Error('No files in dist/. Run pnpm build first.');
|
||||
}
|
||||
|
||||
console.log(`Found ${files.length} files to upload`);
|
||||
|
||||
const batchSize = 10;
|
||||
for (let i = 0; i < files.length; i += batchSize) {
|
||||
const batch = files.slice(i, i + batchSize);
|
||||
await Promise.all(batch.map((file) => this.uploadFile(file)));
|
||||
console.log(`Batch ${Math.floor(i / batchSize) + 1}/${Math.ceil(files.length / batchSize)}`);
|
||||
}
|
||||
|
||||
console.log('Embeds upload completed.');
|
||||
|
||||
const publicBase = normalizePublicBaseUrl(process.env.EMBED_CDN_BASE_URL);
|
||||
const purgeUrls = files.map(
|
||||
(relativePath) => `${publicBase}/${EMBED_WIDGET_PREFIX}/${relativePath.split('\\').join('/')}`
|
||||
);
|
||||
await purgeCloudflareCdnForUrls(purgeUrls);
|
||||
}
|
||||
}
|
||||
|
||||
async function main(): Promise<void> {
|
||||
const args = process.argv.slice(2);
|
||||
|
||||
if (args.includes('--help') || args.includes('-h')) {
|
||||
console.log(`
|
||||
Usage: tsx scripts/upload-embeds.ts
|
||||
|
||||
Uploads apps/embeds/dist/* to R2 under ${EMBED_WIDGET_PREFIX}/
|
||||
|
||||
Environment (same as Storybook R2 upload):
|
||||
CLOUDFLARE_ACCESS_KEY
|
||||
CLOUDFLARE_SECRET_ACCESS_KEY
|
||||
CLOUDFLARE_ACCOUNT_ID
|
||||
|
||||
Optional — purge Cloudflare CDN cache for the public asset host after upload (not R2; use when the domain is orange-clouded):
|
||||
CLOUDFLARE_API_TOKEN (Zone → Cache Purge → Purge)
|
||||
CLOUDFLARE_ZONE_ID
|
||||
EMBED_CDN_BASE_URL (default ${DEFAULT_CDN_BASE})
|
||||
EMBED_SKIP_CDN_PURGE=1 to skip purge
|
||||
|
||||
Bucket: ${BUCKET}
|
||||
`);
|
||||
return;
|
||||
}
|
||||
|
||||
const uploader = new EmbedsUploader();
|
||||
await uploader.uploadAll();
|
||||
}
|
||||
|
||||
const isMain = process.argv[1]?.includes('upload-embeds');
|
||||
if (isMain) {
|
||||
main()
|
||||
.then(() => process.exit(0))
|
||||
.catch((error) => {
|
||||
console.error('Script failed:', error);
|
||||
process.exit(1);
|
||||
});
|
||||
}
|
||||
|
||||
export { EmbedsUploader, EMBED_WIDGET_PREFIX };
|
||||
Reference in New Issue
Block a user