Ideally should be the logic to read/set likes for npmx

Author: fatfingers23

server/api/auth/atproto.get.ts

@@ -10,7 +10,7 @@ export default defineEventHandler(async event => {
   if (!config.sessionPassword) {
     throw createError({
       status: 500,
-      message: 'NUXT_SESSION_PASSWORD not set',
+      message: UNSET_NUXT_SESSION_PASSWORD,
     })
   }
 

server/api/likes/[...pkg].get.ts

@@ -0,0 +1,4 @@
+export default defineEventHandler(async _ => {
+  //TODO: Use the new thing I wrote last night
+  return 0
+})

server/utils/atproto/utils/likes.ts

@@ -0,0 +1,154 @@
+import { getCacheAdatper } from '../../cache'
+import { $nsid as likeNsid } from '#shared/types/lexicons/dev/npmx/feed/like.defs'
+import { SUBJECT_REF_PREFIX } from '~~/shared/utils/constants'
+
+/**
+ * Likes for a npm package on npmx
+ */
+export type PackageLikes = {
+  // The total likes found for the package
+  totalLikes: number
+  // If the logged in user has liked the package, false if not logged in
+  userHasLiked: boolean
+}
+
+const CACHE_PREFIX = 'atproto-likes:'
+const CACHE_PACKAGE_TOTAL_KEY = (packageName: string) => `${CACHE_PREFIX}:${packageName}:total`
+const CACHE_USER_LIKES_KEY = (packageName: string, did: string) =>
+  `${CACHE_PREFIX}${packageName}users:${did}`
+
+const CACHE_MAX_AGE = CACHE_MAX_AGE_ONE_MINUTE * 5
+
+export class PackageLikesService {
+  private readonly constellation: Constellation
+  private readonly cache: CacheAdapter
+
+  constructor(cachedFunction: CachedFetchFunction) {
+    this.constellation = new Constellation(cachedFunction)
+    this.cache = getCacheAdatper(CACHE_PREFIX)
+  }
+
+  /**
+   * Gets the true total count of likes for a npm package from the network
+   * @param subjectRef
+   * @returns
+   */
+  private async constellationLikes(subjectRef: string) {
+    // TODO: I need to see what failed fetch calls do here
+    const { data: totalLinks } = await this.constellation.getLinksDistinctDids(
+      subjectRef,
+      likeNsid,
+      '.subjectRef',
+      //Limit doesn't matter here since we are just counting the total likes
+      1,
+      undefined,
+      CACHE_MAX_AGE_ONE_MINUTE * 10,
+    )
+    return totalLinks.total
+  }
+
+  /**
+   * Checks if the user has liked the npm package from the network
+   * @param subjectRef
+   * @param usersDid
+   * @returns
+   */
+  private async constellationUserHasLiked(subjectRef: string, usersDid: string) {
+    const { data: userLikes } = await this.constellation.getBackLinks(
+      subjectRef,
+      likeNsid,
+      'subjectRef',
+      //Limit doesn't matter here since we are just counting the total likes
+      1,
+      undefined,
+      false,
+      [[usersDid]],
+    )
+    //TODO: need to double check this logic
+    return userLikes.total > 0
+  }
+
+  /**
+   * Gets the likes for a npm package on npmx. Tries a local cahce first, if not found uses constellation
+   * @param packageName
+   * @param usersDid
+   * @returns
+   */
+  async getLikes(packageName: string, usersDid?: string) {
+    //TODO: May need to do some clean up on the package name, and maybe even hash it? some of the charcteres may be a bit odd as keys
+    const cache = getCacheAdatper(CACHE_PREFIX)
+
+    const cachedLikes = await cache.get<PackageLikes>(packageName)
+    if (cachedLikes) {
+      return cachedLikes
+    }
+
+    const subjectRef = `${SUBJECT_REF_PREFIX}/${packageName}`
+
+    const totalLikes = await this.constellationLikes(subjectRef)
+
+    let userHasLiked = false
+
+    if (usersDid) {
+      userHasLiked = await this.constellationUserHasLiked(subjectRef, usersDid)
+    }
+
+    const packageLikes = {
+      totalPackageLikes: totalLikes,
+      userHasLiked,
+    }
+    if (userHasLiked && usersDid) {
+      await cache.set(CACHE_USER_LIKES_KEY(packageName, usersDid), true, CACHE_MAX_AGE)
+    }
+
+    const totalLikesKey = CACHE_PACKAGE_TOTAL_KEY(packageName)
+    await cache.set(totalLikesKey, packageLikes.totalPackageLikes, CACHE_MAX_AGE)
+    return packageLikes
+  }
+
+  /**
+   * Gets the definite answer if the user has liked a npm package. Either from the cache or the network
+   * @param packageName
+   * @param usersDid
+   * @returns
+   */
+  async hasTheUserLikedThePackage(packageName: string, usersDid: string) {
+    const cache = getCacheAdatper(CACHE_PREFIX)
+    const cached = await cache.get<boolean>(CACHE_USER_LIKES_KEY(packageName, usersDid))
+    if (cached !== undefined) {
+      return cached
+    }
+    const userHasLiked = await this.constellationUserHasLiked(
+      `${SUBJECT_REF_PREFIX}/${packageName}`,
+      usersDid,
+    )
+    await cache.set(CACHE_USER_LIKES_KEY(packageName, usersDid), userHasLiked, CACHE_MAX_AGE)
+    return userHasLiked
+  }
+
+  /**
+   * It is asummed it has been checked by this point that if a user has liked a package and the new like was made as a record
+   * to the user's atproto repostiory
+   * @param packageName
+   * @param usersDid
+   */
+  async likeAPackageAndRetunLikes(packageName: string, usersDid: string): Promise<PackageLikes> {
+    const cache = getCacheAdatper(CACHE_PREFIX)
+
+    const totalLikesKey = CACHE_PACKAGE_TOTAL_KEY(packageName)
+    let totalLikes = await cache.get<number>(totalLikesKey)
+    // If a cahce entry was found for total likes increase by 1
+    if (totalLikes !== undefined) {
+      await cache.set(totalLikesKey, totalLikes + 1, CACHE_MAX_AGE)
+    } else {
+      const subjectRef = `${SUBJECT_REF_PREFIX}/${packageName}`
+      totalLikes = await this.constellationLikes(subjectRef)
+    }
+    // We already know the user has not liked the package so set in the cache
+    await cache.set(CACHE_USER_LIKES_KEY(packageName, usersDid), true, CACHE_MAX_AGE)
+    return {
+      totalLikes: totalLikes,
+      userHasLiked: true,
+    }
+  }
+}

server/utils/cache.ts

@@ -93,7 +93,7 @@ export class RedisCacheAdatper implements CacheAdapter {
   }
 }
 
-export function getCache(prefix: string): CacheAdapter {
+export function getCacheAdatper(prefix: string): CacheAdapter {
   const config = useRuntimeConfig()
 
   if (!import.meta.dev && config.upstash?.redisRestUrl && config.upstash?.redisRestToken) {
@@ -103,7 +103,5 @@ export function getCache(prefix: string): CacheAdapter {
     })
     return new RedisCacheAdatper(redis, prefix)
   }
-
-  console.log('using storage')
   return new StorageCacheAdapter()
 }

shared/utils/constants.ts

@@ -30,6 +30,10 @@ export const ERROR_GRAVATAR_EMAIL_UNAVAILABLE = "User's email not accessible."
 export const CONSTELLATION_HOST = 'constellation.microcosm.blue'
 export const SLINGSHOT_HOST = 'slingshot.microcosm.blue'
 
+// ATProtocol
+// Refrence prefix used to link packages to things that are not inherently atproto
+export const SUBJECT_REF_PREFIX = 'https://npmx.dev'
+
 // Theming
 export const ACCENT_COLORS = {
   rose: 'oklch(0.797 0.084 11.056)',