Merge branch 'paul/fixApiKey' into deploy

Author: paullinator

src/demo/clientUtil.ts

@@ -82,7 +82,7 @@ export const getPresetDates = function(): PresetDates {
 }
 
 export const getCustomData = async (
-  appId: string,
+  apiKey: string,
   pluginIds: string[],
   start: string,
   end: string,
@@ -97,7 +97,7 @@ export const getCustomData = async (
   ) {
     trueTimePeriod = 'daymonth'
   }
-  const query = { start, end, appId, pluginIds, timePeriod: trueTimePeriod }
+  const query = { start, end, apiKey, pluginIds, timePeriod: trueTimePeriod }
   const response = await fetch(endPoint, {
     headers: {
       'Content-Type': 'application/json'
@@ -184,10 +184,10 @@ export const getAppId = async (apiKey: string): Promise<AppIdResponse> => {
 }
 
 export const getPartnerIds = async (
-  appId: string
+  apiKey: string
 ): Promise<PartnerIdsResponse> => {
   const partners = Object.keys(Partners)
-  const url = `${apiHost}/v1/getPluginIds?appId=${appId}`
+  const url = `${apiHost}/v1/getPluginIds?apiKey=${apiKey}`
   const response = await fetch(url)
   const json = await response.json()
   const ids = asGetPartnerIds(json)

src/demo/components/Custom.tsx

@@ -79,7 +79,7 @@ class Custom extends Component<CustomProps, CustomState> {
   async componentDidMount(): Promise<void> {
     const { appId, redirect } = await getAppId(this.props.apiKey)
     this.setState({ appId, redirect })
-    const { partnerIds } = await getPartnerIds(this.state.appId)
+    const { partnerIds } = await getPartnerIds(this.props.apiKey)
     this.setState({ partnerIds })
     if (
       typeof this.props.match.params.start === 'string' &&
@@ -98,7 +98,7 @@ class Custom extends Component<CustomProps, CustomState> {
     console.time('getData')
     this.setState({ loading: true })
     const data = await getCustomData(
-      this.state.appId,
+      this.props.apiKey,
       this.state.partnerIds,
       start,
       end

src/demo/components/Preset.tsx

@@ -88,7 +88,7 @@ class Preset extends Component<PresetProps, PresetState> {
   async componentDidMount(): Promise<void> {
     const { appId, redirect } = await getAppId(this.props.apiKey)
     this.setState({ appId, redirect })
-    const { partnerIds } = await getPartnerIds(this.state.appId)
+    const { partnerIds } = await getPartnerIds(this.props.apiKey)
     this.setState({ partnerIds })
     await this.getGraphData()
   }
@@ -108,7 +108,7 @@ class Preset extends Component<PresetProps, PresetState> {
           const startDate = timeRanges[0]
           const endDate = timeRanges[1]
           const newData = await getCustomData(
-            this.state.appId,
+            this.props.apiKey,
             this.state.partnerIds,
             startDate,
             endDate,

src/demo/demo.tsx

@@ -96,7 +96,7 @@ class App extends Component<
 
   async getPluginIds(): Promise<void> {
     const partners = Object.keys(Partners)
-    const url = `${apiHost}/v1/getPluginIds?appId=${this.state.appId}`
+    const url = `${apiHost}/v1/getPluginIds?apiKey=${this.state.apiKey}`
     const response = await fetch(url)
     const json = await response.json()
     const existingPartners = json.filter(pluginId =>

src/routes/v1/analytics.ts

@@ -2,11 +2,12 @@ import { asArray, asObject, asString } from 'cleaners'
 import Router from 'express-promise-router'
 
 import { cacheAnalytic } from '../../dbutils'
+import { validateApiKey } from '../../util/validateApiKey'
 
 const asAnalyticsReq = asObject({
   start: asString,
   end: asString,
-  appId: asString,
+  apiKey: asString,
   pluginIds: asArray(asString),
   timePeriod: asString
 })
@@ -21,7 +22,16 @@ analyticsRouter.post(`/`, async function(req, res) {
     res.status(400).send(`Missing Request Fields`)
     return
   }
-  const { start, end, appId, pluginIds } = analyticsQuery
+  const { start, end, apiKey, pluginIds } = analyticsQuery
+
+  // Validate API key and get appId
+  let appId: string
+  try {
+    appId = await validateApiKey(apiKey)
+  } catch {
+    res.status(401).send(`Invalid API Key`)
+    return
+  }
   const timePeriod = analyticsQuery.timePeriod.toLowerCase()
   const queryStart = new Date(start).getTime() / 1000
   const queryEnd = new Date(end).getTime() / 1000

src/routes/v1/getPluginIds.ts

@@ -2,9 +2,10 @@ import { asObject, asOptional, asString } from 'cleaners'
 import Router from 'express-promise-router'
 
 import { reportsApps } from '../../indexApi'
+import { validateApiKey } from '../../util/validateApiKey'
 
 const asPluginIdsReq = asObject({
-  appId: asString
+  apiKey: asString
 })
 const asPartnerIdsDbReq = asObject({
   partnerIds: asObject(
@@ -25,9 +26,19 @@ getPluginIdsRouter.get('/', async function(req, res) {
     res.status(400).send(`Missing Request fields.`)
     return
   }
+
+  // Validate API key and get appId
+  let appId: string
+  try {
+    appId = await validateApiKey(queryResult.apiKey)
+  } catch {
+    res.status(401).send(`Invalid API Key`)
+    return
+  }
+
   const query = {
     selector: {
-      appId: { $eq: queryResult.appId.toLowerCase() }
+      appId: { $eq: appId.toLowerCase() }
     },
     fields: ['partnerIds'],
     limit: 1

src/routes/v1/getTxInfo.ts

@@ -6,8 +6,14 @@ import { asDbTx, DbTx, Status } from '../../types'
 import { EdgeTokenId } from '../../util/asEdgeTokenId'
 import { HttpError } from '../../util/httpErrors'
 import { trial } from '../../util/trail'
+import { validateApiKey } from '../../util/validateApiKey'
 
 const asGetTxInfoReq = asObject({
+  /**
+   * API key for authentication.
+   */
+  apiKey: asString,
+
   /**
    * Prefix of the destination address.
    * Minimum 3 character; Maximum 5 characters.
@@ -50,6 +56,14 @@ getTxInfoRouter.get('/', async function(req, res) {
     }
   )
 
+  // Validate API key
+  try {
+    await validateApiKey(query.apiKey)
+  } catch {
+    res.status(401).send('Invalid API Key')
+    return
+  }
+
   if (query.addressPrefix.length < 3) {
     res.status(400).send('addressPrefix must be at least 3 characters')
     return

src/util/validateApiKey.ts

@@ -0,0 +1,17 @@
+import { asObject, asString } from 'cleaners'
+
+import { reportsApps } from '../indexApi'
+
+const asApiKeyDbResult = asObject({
+  appId: asString
+})
+
+/**
+ * Validates an API key and returns the corresponding appId.
+ * Throws an error if the API key is not recognized.
+ */
+export async function validateApiKey(apiKey: string): Promise<string> {
+  const dbResult = await reportsApps.get(apiKey)
+  const { appId } = asApiKeyDbResult(dbResult)
+  return appId
+}