@smartive/datocms-utils 2.3.3 → 3.0.0-next.10

package/src/cache-tags-redis.ts

@@ -1,96 +0,0 @@
-import { Redis } from 'ioredis';
-import { type CacheTag } from './types';
-
-let redis: Redis | null = null;
-
-const getRedis = (): Redis => {
-  redis ??= new Redis(process.env.REDIS_URL!, {
-    maxRetriesPerRequest: 3,
-    lazyConnect: true,
-  });
-
-  return redis;
-};
-
-const keyPrefix = process.env.REDIS_KEY_PREFIX ? `${process.env.REDIS_KEY_PREFIX}:` : '';
-
-/**
- * Stores the cache tags of a query in Redis.
- *
- * For each cache tag, adds the query ID to a Redis Set. Sets are unordered
- * collections of unique strings, perfect for tracking which queries use which tags.
- *
- * @param {string} queryId Unique query ID
- * @param {CacheTag[]} cacheTags Array of cache tags
- *
- */
-export const storeQueryCacheTags = async (queryId: string, cacheTags: CacheTag[]): Promise<void> => {
-  if (!cacheTags?.length) {
-    return;
-  }
-
-  const redis = getRedis();
-  const pipeline = redis.pipeline();
-
-  for (const tag of cacheTags) {
-    pipeline.sadd(`${keyPrefix}${tag}`, queryId);
-  }
-
-  await pipeline.exec();
-};
-
-/**
- * Retrieves the query IDs that reference any of the specified cache tags.
- *
- * Uses Redis SUNION to efficiently find all queries associated with the given tags.
- *
- * @param {CacheTag[]} cacheTags Array of cache tags to check
- * @returns Array of unique query IDs
- *
- */
-export const queriesReferencingCacheTags = async (cacheTags: CacheTag[]): Promise<string[]> => {
-  if (!cacheTags?.length) {
-    return [];
-  }
-
-  const redis = getRedis();
-  const keys = cacheTags.map((tag) => `${keyPrefix}${tag}`);
-
-  return redis.sunion(...keys);
-};
-
-/**
- * Deletes the specified cache tags from Redis.
- *
- * This removes the cache tag keys entirely. When queries are revalidated and
- * run again, fresh cache tag mappings will be created.
- *
- * @param {CacheTag[]} cacheTags Array of cache tags to delete
- * @returns Number of keys deleted, or null if there was an error
- *
- */
-export const deleteCacheTags = async (cacheTags: CacheTag[]): Promise<number> => {
-  if (!cacheTags?.length) {
-    return 0;
-  }
-
-  const redis = getRedis();
-  const keys = cacheTags.map((tag) => `${keyPrefix}${tag}`);
-
-  return redis.del(...keys);
-};
-
-/**
- * Wipes out all cache tags from Redis.
- *
- * ⚠️ **Warning**: This will delete all cache tag data. Use with caution!
- */
-export const truncateCacheTags = async (): Promise<void> => {
-  const redis = getRedis();
-  const pattern = `${keyPrefix}*`;
-  const keys = await redis.keys(pattern);
-
-  if (keys.length > 0) {
-    await redis.del(...keys);
-  }
-};

package/src/cache-tags.ts

@@ -1,88 +0,0 @@
-import { sql } from '@vercel/postgres';
-import { type CacheTag } from './types';
-
-export { generateQueryId, parseXCacheTagsResponseHeader } from './utils';
-
-/**
- * Stores the cache tags of a query in the database.
- *
- * @param {string} queryId Unique query ID
- * @param {CacheTag[]} cacheTags Array of cache tags
- * @param {string} tableId Database table ID
- */
-export const storeQueryCacheTags = async (queryId: string, cacheTags: CacheTag[], tableId: string) => {
-  if (!cacheTags?.length) {
-    return;
-  }
-
-  const tags = cacheTags.flatMap((_, i) => [queryId, cacheTags[i]]);
-  const placeholders = cacheTags.map((_, i) => `($${2 * i + 1}, $${2 * i + 2})`).join(',');
-
-  await sql.query(`INSERT INTO ${tableId} VALUES ${placeholders} ON CONFLICT DO NOTHING`, tags);
-};
-
-/**
- * Retrieves the queries that reference cache tags.
- *
- * @param {CacheTag[]} cacheTags Array of cache tags
- * @param {string} tableId Database table ID
- * @returns Array of query IDs
- */
-export const queriesReferencingCacheTags = async (cacheTags: CacheTag[], tableId: string): Promise<string[]> => {
-  if (!cacheTags?.length) {
-    return [];
-  }
-
-  const placeholders = cacheTags.map((_, i) => `$${i + 1}`).join(',');
-
-  const { rows }: { rows: { query_id: string }[] } = await sql.query(
-    `SELECT DISTINCT query_id FROM ${tableId} WHERE cache_tag IN (${placeholders})`,
-    cacheTags,
-  );
-
-  return rows.map((row) => row.query_id);
-};
-
-/**
- * Deletes the specified cache tags from the database.
- *
- * This removes the cache tag keys entirely. When queries are revalidated and
- * run again, fresh cache tag mappings will be created.
- *
- * @param {CacheTag[]} cacheTags Array of cache tags to delete
- * @param {string} tableId Database table ID
- *
- */
-export const deleteCacheTags = async (cacheTags: CacheTag[], tableId: string) => {
-  if (cacheTags.length === 0) {
-    return;
-  }
-  const placeholders = cacheTags.map((_, i) => `$${i + 1}`).join(',');
-
-  await sql.query(`DELETE FROM ${tableId} WHERE cache_tag IN (${placeholders})`, cacheTags);
-};
-
-/**
- * Deletes the cache tags of a query from the database.
- *
- * @param {string} queryId Unique query ID
- * @param {string} tableId Database table ID
- * @deprecated Use `deleteCacheTags` instead.
- */
-export const deleteQueries = async (queryIds: string[], tableId: string) => {
-  if (!queryIds?.length) {
-    return;
-  }
-  const placeholders = queryIds.map((_, i) => `$${i + 1}`).join(',');
-
-  await sql.query(`DELETE FROM ${tableId} WHERE query_id IN (${placeholders})`, queryIds);
-};
-
-/**
- * Wipes out all cache tags from the database.
- *
- * @param {string} tableId Database table ID
- */
-export async function truncateCacheTags(tableId: string) {
-  await sql.query(`DELETE FROM ${tableId}`);
-}

package/src/types.ts

@@ -1,24 +0,0 @@
-/**
- * A branded type for cache tags. This is created by intersecting `string`
- * with `{ readonly _: unique symbol }`, making it a unique type.
- * Although it is fundamentally a string, it is treated as a distinct type
- * due to the unique symbol.
- */
-export type CacheTag = string & { readonly _: unique symbol };
-
-/**
- * A type representing the structure of a webhook payload for cache tag invalidation.
- * It includes the entity type, event type, and the entity details which contain
- * the cache tags to be invalidated.
- */
-export type CacheTagsInvalidateWebhook = {
-  entity_type: 'cda_cache_tags';
-  event_type: 'invalidate';
-  entity: {
-    id: 'cda_cache_tags';
-    type: 'cda_cache_tags';
-    attributes: {
-      tags: CacheTag[];
-    };
-  };
-};