@unavatar/core 3.19.3 → 3.19.4

package/package.json

@@ -2,7 +2,7 @@
   "name": "@unavatar/core",
   "description": "Get unified user avatar from social networks, including Instagram, SoundCloud, Telegram, Twitter, YouTube & more.",
   "homepage": "https://unavatar.io",
-  "version": "3.19.3",
+  "version": "3.19.4",
   "main": "src/index.js",
   "exports": {
     ".": "./src/index.js",
@@ -139,7 +139,7 @@
     "ms": "~2.1.3",
     "p-any": "~3.0.0",
     "p-timeout": "~4.1.0",
-    "puppeteer": "~24.40.0",
+    "puppeteer": "~24.41.0",
     "re2": "~1.24.0",
     "srcset": "~4.0.0",
     "stable-regex": "~1.0.1",

package/src/index.js

@@ -43,6 +43,7 @@ module.exports = ({ constants: userConstants, redis, onFetchHTML } = {}) => {
     NOT_FOUND,
     got,
     isReservedIp,
+    githubSearchCache: cache.githubSearchCache,
     itunesSearchCache: cache.itunesSearchCache
   }
   const { providers, providersBy } = require('./providers')(providerCtx)

package/src/providers/github.js

@@ -1,10 +1,146 @@
 'use strict'
 
+const memoize = require('@keyvhq/memoize')
 const { stringify } = require('querystring')
+const isEmail = require('is-email-like')
 
-module.exports = ({ constants }) =>
-  function github (input) {
-    return `https://github.com/${input}.png?${stringify({
-      size: constants.AVATAR_SIZE
-    })}`
+const GITHUB_API_URL = 'https://api.github.com'
+const SEARCH_USERS_PER_PAGE = 10
+const SEARCH_COMMITS_PER_PAGE = 20
+const COMMIT_SEARCH_ACCEPT_HEADER = 'application/vnd.github+json'
+
+const normalizeCacheKey = value => value.trim().toLowerCase()
+const createLookupCacheKey = prefix => value =>
+  `${prefix}:${normalizeCacheKey(value)}`
+
+const fetchJsonBody = async ({ got, url, options }) => {
+  const { body } = await got(url, {
+    responseType: 'json',
+    ...options
+  })
+
+  return body
+}
+
+const getUsernameAvatarUrl = ({ constants, input }) =>
+  `https://github.com/${input}.png?${stringify({
+    size: constants.AVATAR_SIZE
+  })}`
+
+const createSearchUsersByEmail = ({ githubSearchCache, got }) =>
+  memoize(
+    async email => {
+      const body = await fetchJsonBody({
+        got,
+        url: `${GITHUB_API_URL}/search/users?q=${encodeURIComponent(
+          email
+        )}&per_page=${SEARCH_USERS_PER_PAGE}`
+      })
+
+      return body?.items ?? []
+    },
+    githubSearchCache,
+    { key: createLookupCacheKey('search-users') }
+  )
+
+const createGetUser = ({ githubSearchCache, got }) =>
+  memoize(
+    login =>
+      fetchJsonBody({
+        got,
+        url: `${GITHUB_API_URL}/users/${encodeURIComponent(login)}`
+      }),
+    githubSearchCache,
+    { key: createLookupCacheKey('user') }
+  )
+
+const createSearchCommitsByEmail = ({ githubSearchCache, got }) =>
+  memoize(
+    async email => {
+      const body = await fetchJsonBody({
+        got,
+        url: `${GITHUB_API_URL}/search/commits?q=${encodeURIComponent(
+          `author-email:${email}`
+        )}&per_page=${SEARCH_COMMITS_PER_PAGE}`,
+        options: {
+          headers: { accept: COMMIT_SEARCH_ACCEPT_HEADER }
+        }
+      })
+
+      return body?.items ?? []
+    },
+    githubSearchCache,
+    { key: createLookupCacheKey('search-commits') }
+  )
+
+const findExactPublicProfileMatch = async ({
+  email,
+  getUser,
+  searchUsersByEmail
+}) => {
+  const candidates = await searchUsersByEmail(email)
+  const normalizedEmail = email.toLowerCase()
+
+  for (const candidate of candidates) {
+    const user = await getUser(candidate.login)
+
+    if (user?.email?.toLowerCase() === normalizedEmail) {
+      return user.avatar_url
+    }
   }
+}
+
+const findCommitConsensusMatch = async ({ email, searchCommitsByEmail }) => {
+  const commits = await searchCommitsByEmail(email)
+  const counts = new Map()
+
+  for (const item of commits) {
+    const linkedUser = item.author ?? item.committer
+    if (!linkedUser?.login || !linkedUser?.avatar_url) continue
+
+    const entry = counts.get(linkedUser.login) ?? {
+      avatarUrl: linkedUser.avatar_url,
+      count: 0
+    }
+
+    entry.count += 1
+    counts.set(linkedUser.login, entry)
+  }
+
+  let winner
+  for (const entry of counts.values()) {
+    if (!winner || entry.count > winner.count) winner = entry
+  }
+
+  return winner?.avatarUrl
+}
+
+module.exports = ({ constants, githubSearchCache, got }) => {
+  const searchUsersByEmail = createSearchUsersByEmail({
+    githubSearchCache,
+    got
+  })
+  const getUser = createGetUser({ githubSearchCache, got })
+  const searchCommitsByEmail = createSearchCommitsByEmail({
+    githubSearchCache,
+    got
+  })
+
+  return async function github (input) {
+    if (!isEmail(input)) return getUsernameAvatarUrl({ constants, input })
+
+    const exactMatch = await findExactPublicProfileMatch({
+      email: input,
+      getUser,
+      searchUsersByEmail
+    })
+
+    if (exactMatch) return exactMatch
+
+    return findCommitConsensusMatch({ email: input, searchCommitsByEmail })
+  }
+}
+
+module.exports.getUsernameAvatarUrl = getUsernameAvatarUrl
+module.exports.findExactPublicProfileMatch = findExactPublicProfileMatch
+module.exports.findCommitConsensusMatch = findCommitConsensusMatch

package/src/providers/index.js

@@ -1,7 +1,7 @@
 'use strict'
 
 const providersBy = {
-  email: ['gravatar'],
+  email: ['gravatar', 'github'],
   username: [
     'apple-music',
     'behance',

package/src/util/cache.js

@@ -4,6 +4,10 @@ const ms = require('ms')
 
 module.exports = ({ createMultiCache, createRedisCache }) => ({
   dnsCache: createMultiCache(createRedisCache({ namespace: 'dns', ttl: ms('1d') })),
+  githubSearchCache: createRedisCache({
+    namespace: 'github-search',
+    ttl: ms('1d')
+  }),
   pingCache: createMultiCache(createRedisCache({ namespace: 'ping', ttl: ms('1d') })),
   itunesSearchCache: createRedisCache({ namespace: 'itunes-search', ttl: ms('7d') })
 })