Merge pull request #1 from cardanoapi/update/scheduling

Update/scheduling

Author: mesudip

.env.example

@@ -1,2 +1,3 @@
-SERVER_PORT=8081
-SCHEDULE_UPDATE=true
+SERVER_PORT=8080
+SCHEDULE_UPDATE=true
+USE_GH_API=true

.github/workflows/docker-image.yml

@@ -15,12 +15,6 @@ jobs:
       - name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v1
 
-      - name: Get latest Token Registry API Tag
-        id: get_latest_tag
-        run: |
-          latest_tag=$(curl -s https://api.github.com/repos/cardanoapi/token-registry-api/releases/latest | jq -r .tag_name)
-          echo "::set-output name=tag::$latest_tag"
-
       - name: Log in to GitHub Container Registry
         uses: docker/login-action@v1
         with:
@@ -34,6 +28,4 @@ jobs:
           context: .
           file: ./Dockerfile
           push: true
-          tags: ghcr.io/${{ github.repository_owner }}/token-registry-api:${{ steps.get_latest_tag.outputs.tag }}
-          build-args: |
-            DBSYNC_TAG=${{ steps.get_latest_tag.outputs.tag }}
+          tags: ghcr.io/${{ github.repository_owner }}/token-registry-api:latest

Dockerfile

@@ -42,9 +42,10 @@ RUN yarn install --production --frozen-lockfile
 
 # Copy built application files
 COPY --from=build /app/dist/ /app/dist/
+COPY --from=build /app/offchain-metadata/ /app/offchain-metadata/
 
 # Expose the port the app will run on
-EXPOSE 8081
+EXPOSE 8080
 
 # Run the application
 CMD ["node", "dist/index.js"]

README.md

@@ -1,14 +1,37 @@
-# Token Registry API
+# **Token Registry API**  
 
-- Queries token registry's github to get off-chain metadata of tokens
-- https://github.com/cardano-foundation/cardano-token-registry/tree/master/mappings
+The **Token Registry API** queries the Cardano Token Registry's GitHub repository to fetch off-chain metadata of tokens.  
 
-# Steps to run
+🔗 **Token Registry Repository:** [Cardano Token Registry - Mappings](https://github.com/cardano-foundation/cardano-token-registry/tree/master/mappings)  
 
-- specify `SERVER_PORT` in `.env` file (Default is 8081)
-- specify `SCHEDULE_UPDATE` in `.env` file to clone data from token registry and use it as cache
-- `yarn && yarn start`
+---
 
-# Run Image
+## **Steps to Run Locally**  
 
-`docker run -p 8082:8082 -e SCHEDULE_UPDATE=true -e SERVER_PORT=8082 ghcr.io/cardanoapi/token-registry-api:null`
+1. **Set Environment Variables**  
+   - Create a `.env` file and specify the following variables:  
+     - `SERVER_PORT`: Port to run the API (Default: `8080`)  
+     - `SCHEDULE_UPDATE`: Set to `true` to enable scheduled (re-clones the repo every 2 days)
+     - `USE_GH_API`: Set to `true` to directly query github, else uses the cached info from build-time   
+
+2. **Install Dependencies & Start Server**  
+   ```sh
+   yarn && yarn start
+   ```
+3. **Endpoints**
+    - *GET* `/health` : Health info
+    - *GET* `/meetadata/:id` : Offchain metadata info of an asset
+    - *POST* `/clone` : force clone the mappings folder from the token registry repo
+
+---
+
+## **Run with Docker**  
+
+```sh
+docker run -p 8080:8080 \
+  -e SCHEDULE_UPDATE=true \
+  -e USE_GH_API=false \
+  -e SERVER_PORT=8080 \
+  ghcr.io/cardanoapi/token-registry-api:latest
+```
+---

docker-restart.sh

@@ -1,5 +1,5 @@
 docker stop token-registry-api-container         # Stop the existing container
 docker rm token-registry-api-container           # Remove the stopped container
 docker build -t token-registry-api .             # Build the latest image
-docker run -p 8081:8081 -d --name token-registry-api-container --env-file .env token-registry-api  # Start a new container
+docker run -p 8080:8080 -d --name token-registry-api-container --env-file .env token-registry-api  # Start a new container
 docker logs -f token-registry-api-container

src/config.ts

@@ -1,8 +1,18 @@
+require("dotenv").config();
+
 export const REPO_OWNER = "cardano-foundation";
 export const REPO_NAME = "cardano-token-registry";
 export const BRANCH_NAME = "master";
 export const FOLDER_NAME = "mappings";
 export const LOCAL_DIR = "offchain-metadata";
 export const REPO_URL = `https://github.com/${REPO_OWNER}/${REPO_NAME}.git`;
 export const DAYS = 2;
-export const INTERVAL = DAYS * 24 * 60 * 60 * 1000;
+export const INTERVAL = DAYS * 24 * 60 * 60 * 1000;
+
+export const port = process.env.SERVER_PORT ? process.env.SERVER_PORT : 8080;
+export const scheduleUpdate = process.env.SCHEDULE_UPDATE
+  ? process.env.SCHEDULE_UPDATE === "true"
+  : false;
+export const useGithub = process.env.USE_GH_API
+  ? process.env.USE_GH_API === "true"
+  : false;

src/index.ts

@@ -6,19 +6,17 @@ import {
   BRANCH_NAME,
   INTERVAL,
   LOCAL_DIR,
+  port,
   REPO_NAME,
   REPO_OWNER,
   REPO_URL,
+  scheduleUpdate,
+  useGithub,
 } from "./config";
 
-require("dotenv").config();
 const express = require("express");
 
 const app = express();
-const port = process.env.SERVER_PORT ? process.env.SERVER_PORT : 8081;
-const scheduleUpdate = process.env.SCHEDULE_UPDATE
-  ? process.env.SCHEDULE_UPDATE === "true"
-  : false;
 
 // Define the /metadata endpoint
 app.get("/metadata/:id", async (req: any, res: any) => {
@@ -27,7 +25,7 @@ app.get("/metadata/:id", async (req: any, res: any) => {
     if (!id) {
       return res.status(400).json({ error: "missing required parameter 'id'" });
     }
-    if (scheduleUpdate) {
+    if (!useGithub) {
       return await queryCache(LOCAL_DIR, id, res);
     } else {
       const tokenRegistryRequest = `https://raw.githubusercontent.com/${REPO_OWNER}/${REPO_NAME}/refs/heads/${BRANCH_NAME}/mappings/${id}.json`;
@@ -56,7 +54,7 @@ setInterval(async () => {
 
 app.get("/health", async (req: any, res: any) => {
   try {
-    if (scheduleUpdate) {
+    if (!useGithub) {
       return await cacheHealth(res);
     } else {
       return await githubHealth(res);

src/queryCache.ts

@@ -1,6 +1,6 @@
 import path from "path";
 import fs from "fs";
-import { INTERVAL, LOCAL_DIR } from "./config";
+import { INTERVAL, LOCAL_DIR, scheduleUpdate } from "./config";
 import { differenceInSeconds } from "date-fns";
 
 type Health = {
@@ -11,8 +11,8 @@ type Health = {
     date: string;
   }; // last commit details. read from LOCAL_DIR/.commit file
   lastCloned: string; // read this from LOCAL_DIR/.timestamp file
-  nextClone: string; // add INTERVAL milliseconds to the timestamp file and create a date object .toISOstring()
-  eta: string; // calculate the hours:minutes:seconds between current and next time
+  nextClone?: string; // add INTERVAL milliseconds to the timestamp file and create a date object .toISOstring()
+  eta?: string; // calculate the hours:minutes:seconds between current and next time
 };
 
 export async function queryCache(localDir: string, id: string, res: any) {
@@ -71,11 +71,16 @@ export async function cacheHealth(res: any) {
     2,
     "0"
   )}m:${String(seconds).padStart(2, "0")}s`;
+  const nextCloneAndEta = scheduleUpdate
+    ? {
+        nextClone: nextCloneDate.toISOString(),
+        eta: eta,
+      }
+    : {};
   const healthStatus: Health = {
     lastCommit: JSON.parse(lastCommitDetails) as any,
     lastCloned: lastClonedDate.toISOString(),
-    nextClone: nextCloneDate.toISOString(),
-    eta: eta,
+    ...nextCloneAndEta,
   };
   res.status(200).json(healthStatus);
 }