refactor: add explicit TypeScript return type annotations

Author: 314systems

packages/cloudflare/src/api/cloudflare-context.ts

@@ -245,7 +245,7 @@ async function getCloudflareContextAsync<
  * Note: this function should only be called inside the Next.js config file, and although async it doesn't need to be `await`ed
  * @param options options on how the function should operate and if/where to persist the platform data
  */
-export async function initOpenNextCloudflareForDev(options?: GetPlatformProxyOptions) {
+export async function initOpenNextCloudflareForDev(options?: GetPlatformProxyOptions): Promise<void> {
 	const shouldInitializationRun = shouldContextInitializationRun();
 	if (!shouldInitializationRun) return;
 

packages/cloudflare/src/api/durable-objects/bucket-cache-purge.ts

@@ -26,7 +26,7 @@ export class BucketCachePurge extends DurableObject<CloudflareEnv> {
 		});
 	}
 
-	async purgeCacheByTags(tags: string[]) {
+	async purgeCacheByTags(tags: string[]): Promise<void> {
 		for (const tag of tags) {
 			// Insert the tag into the sql table
 			this.ctx.storage.sql.exec(
@@ -43,7 +43,7 @@ export class BucketCachePurge extends DurableObject<CloudflareEnv> {
 		}
 	}
 
-	override async alarm() {
+	override async alarm(): Promise<void> {
 		let tags = this.ctx.storage.sql
 			.exec<{ tag: string }>(
 				`

packages/cloudflare/src/api/durable-objects/queue.ts

@@ -23,11 +23,11 @@ export class DOQueueHandler extends DurableObject<CloudflareEnv> {
 	// Ongoing revalidations are deduped by the deduplication id
 	// Since this is running in waitUntil, we expect the durable object state to persist this during the duration of the revalidation
 	// TODO: handle incremental cache with only eventual consistency (i.e. KV or R2/D1 with the optional cache layer on top)
-	ongoingRevalidations = new Map<string, Promise<void>>();
+	ongoingRevalidations: Map<string, Promise<void>> = new Map<string, Promise<void>>();
 
 	sql: SqlStorage;
 
-	routeInFailedState = new Map<string, FailedState>();
+	routeInFailedState: Map<string, FailedState> = new Map<string, FailedState>();
 
 	service: NonNullable<CloudflareEnv["WORKER_SELF_REFERENCE"]>;
 
@@ -72,7 +72,7 @@ export class DOQueueHandler extends DurableObject<CloudflareEnv> {
 		debug(`Durable object initialized`);
 	}
 
-	async revalidate(msg: QueueMessage) {
+	async revalidate(msg: QueueMessage): Promise<void> {
 		if (this.ongoingRevalidations.size > 2 * this.maxRevalidations) {
 			warn(
 				`Your durable object has 2 times the maximum number of revalidations (${this.maxRevalidations}) in progress. If this happens often, you should consider increasing the NEXT_CACHE_DO_QUEUE_MAX_REVALIDATION or the number of durable objects with the MAX_REVALIDATE_CONCURRENCY env var.`
@@ -110,7 +110,7 @@ export class DOQueueHandler extends DurableObject<CloudflareEnv> {
 		this.ctx.waitUntil(revalidationPromise);
 	}
 
-	async executeRevalidation(msg: QueueMessage) {
+	async executeRevalidation(msg: QueueMessage): Promise<void> {
 		let response: Response | undefined;
 		try {
 			debug(`Revalidating ${msg.MessageBody.host}${msg.MessageBody.url}`);
@@ -187,7 +187,7 @@ export class DOQueueHandler extends DurableObject<CloudflareEnv> {
 		}
 	}
 
-	override async alarm() {
+	override async alarm(): Promise<void> {
 		const currentDateTime = Date.now();
 		// We fetch the first event that needs to be retried or if the date is expired
 		const nextEventToRetry = Array.from(this.routeInFailedState.values())
@@ -204,7 +204,7 @@ export class DOQueueHandler extends DurableObject<CloudflareEnv> {
 		}
 	}
 
-	async addToFailedState(msg: QueueMessage) {
+	async addToFailedState(msg: QueueMessage): Promise<void> {
 		debug(`Adding ${msg.MessageBody.host}${msg.MessageBody.url} to the failed state`);
 		const existingFailedState = this.routeInFailedState.get(msg.MessageDeduplicationId);
 
@@ -245,7 +245,7 @@ export class DOQueueHandler extends DurableObject<CloudflareEnv> {
 		await this.addAlarm();
 	}
 
-	async addAlarm() {
+	async addAlarm(): Promise<void> {
 		const existingAlarm = await this.ctx.storage.getAlarm({ allowConcurrency: false });
 		if (existingAlarm) return;
 		if (this.routeInFailedState.size === 0) return;
@@ -263,7 +263,7 @@ export class DOQueueHandler extends DurableObject<CloudflareEnv> {
 	// This function is used to restore the state of the durable object
 	// We don't restore the ongoing revalidations because we cannot know in which state they are
 	// We only restore the failed state and the alarm
-	async initState() {
+	async initState(): Promise<void> {
 		if (this.disableSQLite) return;
 		// We store the failed state as a blob, we don't want to do anything with it anyway besides restoring
 		this.sql.exec("CREATE TABLE IF NOT EXISTS failed_state (id TEXT PRIMARY KEY, data TEXT, buildId TEXT)");
@@ -290,7 +290,7 @@ export class DOQueueHandler extends DurableObject<CloudflareEnv> {
 	 * @param msg
 	 * @returns `true` if the route has been revalidated since the lastModified from the message, `false` otherwise
 	 */
-	checkSyncTable(msg: QueueMessage) {
+	checkSyncTable(msg: QueueMessage): boolean {
 		try {
 			if (this.disableSQLite) return false;
 			return (

packages/cloudflare/src/api/overrides/cache-purge/index.ts

@@ -8,7 +8,7 @@ interface PurgeOptions {
 	type: "durableObject" | "direct";
 }
 
-export const purgeCache = ({ type = "direct" }: PurgeOptions) => {
+export const purgeCache = ({ type = "direct" }: PurgeOptions): CDNInvalidationHandler => {
 	return {
 		name: "cloudflare",
 		async invalidatePaths(paths) {
@@ -29,7 +29,7 @@ export const purgeCache = ({ type = "direct" }: PurgeOptions) => {
 			}
 			debugCache("cdnInvalidation", "Invalidated paths:", tags);
 		},
-	} satisfies CDNInvalidationHandler;
+	};
 };
 
 export default purgeCache;

packages/cloudflare/src/api/overrides/incremental-cache/kv-incremental-cache.ts

@@ -27,7 +27,7 @@ export const PREFIX_ENV_NAME = "NEXT_INC_CACHE_KV_PREFIX";
  * when the constructor is called.
  */
 class KVIncrementalCache implements IncrementalCache {
-	readonly name = NAME;
+	readonly name: string = NAME;
 
 	async get<CacheType extends CacheEntryType = "cache">(
 		key: string,

packages/cloudflare/src/api/overrides/incremental-cache/r2-incremental-cache.ts

@@ -24,7 +24,7 @@ export const PREFIX_ENV_NAME = "NEXT_INC_CACHE_R2_PREFIX";
  * environment variable, and defaults to `incremental-cache`.
  */
 class R2IncrementalCache implements IncrementalCache {
-	readonly name = NAME;
+	readonly name: string = NAME;
 
 	async get<CacheType extends CacheEntryType = "cache">(
 		key: string,

packages/cloudflare/src/api/overrides/incremental-cache/regional-cache.ts

@@ -189,7 +189,7 @@ class RegionalCache implements IncrementalCache {
 		return this.localCache;
 	}
 
-	protected getCacheUrlKey(key: string, cacheType?: CacheEntryType) {
+	protected getCacheUrlKey(key: string, cacheType?: CacheEntryType): string {
 		const buildId = process.env.NEXT_BUILD_ID ?? FALLBACK_BUILD_ID;
 		return "http://cache.local" + `/${buildId}/${key}`.replace(/\/+/g, "/") + `.${cacheType ?? "cache"}`;
 	}
@@ -235,7 +235,7 @@ class RegionalCache implements IncrementalCache {
  * @param cache Incremental cache instance.
  * @param opts Options for the regional cache.
  */
-export function withRegionalCache(cache: IncrementalCache, opts: Options) {
+export function withRegionalCache(cache: IncrementalCache, opts: Options): RegionalCache {
 	return new RegionalCache(cache, opts);
 }
 

packages/cloudflare/src/api/overrides/incremental-cache/static-assets-incremental-cache.ts

@@ -21,7 +21,7 @@ export const NAME = "cf-static-assets-incremental-cache";
  * It should only be used for applications that do NOT want revalidation and ONLY want to serve prerendered data.
  */
 class StaticAssetsIncrementalCache implements IncrementalCache {
-	readonly name = NAME;
+	readonly name: string = NAME;
 
 	async get<CacheType extends CacheEntryType = "cache">(
 		key: string,

packages/cloudflare/src/api/overrides/internal.ts

@@ -10,7 +10,7 @@ export type IncrementalCacheEntry<CacheType extends CacheEntryType> = {
 	lastModified: number;
 };
 
-export const debugCache = (name: string, ...args: unknown[]) => {
+export const debugCache = (name: string, ...args: unknown[]): void => {
 	if (process.env.NEXT_PRIVATE_DEBUG_CACHE) {
 		console.log(`[${name}] `, ...args);
 	}
@@ -26,7 +26,7 @@ export type KeyOptions = {
 	buildId: string | undefined;
 };
 
-export function computeCacheKey(key: string, options: KeyOptions) {
+export function computeCacheKey(key: string, options: KeyOptions): string {
 	const { cacheType = "cache", prefix = DEFAULT_PREFIX, buildId = FALLBACK_BUILD_ID } = options;
 	const hash = createHash("sha256").update(key).digest("hex");
 	return `${prefix}/${buildId}/${hash}.${cacheType}`.replace(/\/+/g, "/");
@@ -39,7 +39,7 @@ export function isPurgeCacheEnabled(): boolean {
 	return cdnInvalidation !== undefined && cdnInvalidation !== "dummy";
 }
 
-export async function purgeCacheByTags(tags: string[]) {
+export async function purgeCacheByTags(tags: string[]): Promise<void> {
 	const { env } = getCloudflareContext();
 	// We have a durable object for purging cache
 	// We should use it
@@ -55,7 +55,7 @@ export async function purgeCacheByTags(tags: string[]) {
 	}
 }
 
-export async function internalPurgeCacheByTags(env: CloudflareEnv, tags: string[]) {
+export async function internalPurgeCacheByTags(env: CloudflareEnv, tags: string[]): Promise<string> {
 	if (!env.CACHE_PURGE_ZONE_ID || !env.CACHE_PURGE_API_TOKEN) {
 		// THIS IS A NO-OP
 		error("No cache zone ID or API token provided. Skipping cache purge.");

packages/cloudflare/src/api/overrides/queue/do-queue.ts

@@ -5,7 +5,7 @@ import { getCloudflareContext } from "../../cloudflare-context.js";
 
 export default {
 	name: "durable-queue",
-	send: async (msg: QueueMessage) => {
+	send: async (msg: QueueMessage): Promise<void> => {
 		const durableObject = getCloudflareContext().env.NEXT_CACHE_DO_QUEUE;
 		if (!durableObject) throw new IgnorableError("No durable object binding for cache revalidation");