145 lines
3.7 KiB
JavaScript
145 lines
3.7 KiB
JavaScript
// Suggestion API
|
|
//
|
|
// eg. /$suggest/v1?url=https://github.com/badges/shields
|
|
//
|
|
// Tests for this endpoint are in services/suggest/suggest.spec.js. The
|
|
// endpoint is called from frontend/components/suggestion-and-search.js.
|
|
|
|
'use strict'
|
|
|
|
const { URL } = require('url')
|
|
const request = require('request')
|
|
|
|
function twitterPage(url) {
|
|
if (url.protocol === null) {
|
|
return null
|
|
}
|
|
|
|
const schema = url.protocol.slice(0, -1)
|
|
const host = url.host
|
|
const path = url.pathname
|
|
return {
|
|
name: 'Twitter',
|
|
link: `https://twitter.com/intent/tweet?text=Wow:&url=${encodeURIComponent(
|
|
url.href
|
|
)}`,
|
|
badge: `https://img.shields.io/twitter/url/${schema}/${host}${path}.svg?style=social`,
|
|
}
|
|
}
|
|
|
|
function githubIssues(user, repo) {
|
|
const repoSlug = `${user}/${repo}`
|
|
return {
|
|
name: 'GitHub issues',
|
|
link: `https://github.com/${repoSlug}/issues`,
|
|
badge: `https://img.shields.io/github/issues/${repoSlug}.svg`,
|
|
}
|
|
}
|
|
|
|
function githubForks(user, repo) {
|
|
const repoSlug = `${user}/${repo}`
|
|
return {
|
|
name: 'GitHub forks',
|
|
link: `https://github.com/${repoSlug}/network`,
|
|
badge: `https://img.shields.io/github/forks/${repoSlug}.svg`,
|
|
}
|
|
}
|
|
|
|
function githubStars(user, repo) {
|
|
const repoSlug = `${user}/${repo}`
|
|
return {
|
|
name: 'GitHub stars',
|
|
link: `https://github.com/${repoSlug}/stargazers`,
|
|
badge: `https://img.shields.io/github/stars/${repoSlug}.svg`,
|
|
}
|
|
}
|
|
|
|
async function githubLicense(githubApiProvider, user, repo) {
|
|
const repoSlug = `${user}/${repo}`
|
|
|
|
let link = `https://github.com/${repoSlug}`
|
|
|
|
const { buffer } = await githubApiProvider.requestAsPromise(
|
|
request,
|
|
`/repos/${repoSlug}/license`
|
|
)
|
|
try {
|
|
const data = JSON.parse(buffer)
|
|
if ('html_url' in data) {
|
|
link = data.html_url
|
|
}
|
|
} catch (e) {}
|
|
|
|
return {
|
|
name: 'GitHub license',
|
|
badge: `https://img.shields.io/github/license/${repoSlug}.svg`,
|
|
link,
|
|
}
|
|
}
|
|
|
|
async function findSuggestions(githubApiProvider, url) {
|
|
let promises = []
|
|
if (url.hostname === 'github.com') {
|
|
const userRepo = url.pathname.slice(1).split('/')
|
|
const user = userRepo[0]
|
|
const repo = userRepo[1]
|
|
promises = promises.concat([
|
|
githubIssues(user, repo),
|
|
githubForks(user, repo),
|
|
githubStars(user, repo),
|
|
githubLicense(githubApiProvider, user, repo),
|
|
])
|
|
}
|
|
promises.push(twitterPage(url))
|
|
|
|
const suggestions = await Promise.all(promises)
|
|
|
|
return suggestions.filter(b => b != null)
|
|
}
|
|
|
|
// data: {url}, JSON-serializable object.
|
|
// end: function(json), with json of the form:
|
|
// - badges: list of objects of the form:
|
|
// - link: target as a string URL.
|
|
// - badge: shields image URL.
|
|
// - name: string
|
|
function setRoutes(allowedOrigin, githubApiProvider, server) {
|
|
server.ajax.on('suggest/v1', (data, end, ask) => {
|
|
// The typical dev and production setups are cross-origin. However, in
|
|
// Heroku deploys and some self-hosted deploys these requests may come from
|
|
// the same host.
|
|
const origin = ask.req.headers.origin
|
|
if (origin) {
|
|
if (allowedOrigin.includes(origin)) {
|
|
ask.res.setHeader('Access-Control-Allow-Origin', origin)
|
|
} else {
|
|
ask.res.setHeader('Access-Control-Allow-Origin', 'null')
|
|
end({ err: 'Disallowed' })
|
|
return
|
|
}
|
|
}
|
|
|
|
let url
|
|
try {
|
|
url = new URL(data.url)
|
|
} catch (e) {
|
|
end({ err: `${e}` })
|
|
return
|
|
}
|
|
|
|
findSuggestions(githubApiProvider, url)
|
|
// This interacts with callback code and can't use async/await.
|
|
// eslint-disable-next-line promise/prefer-await-to-then
|
|
.then(badges => {
|
|
end({ badges })
|
|
})
|
|
.catch(err => {
|
|
end({ badges: [], err })
|
|
})
|
|
})
|
|
}
|
|
|
|
module.exports = {
|
|
setRoutes,
|
|
}
|