Build info

.github/workflows/CICD-dev.yml

@@ -26,17 +26,25 @@ jobs:
       with:
         username: ${{ secrets.DOCKERHUB_USERNAME }}
         password: ${{ secrets.DOCKERHUB_TOKEN }}  
-    
+
     - name: Set up Docker Buildx
       uses: docker/setup-buildx-action@v3
-
+
+    - name: Set build date
+      run: echo "BUILD_DATE=$(date -u +"%Y-%m-%dT%H:%M:%SZ")" >> $GITHUB_ENV
+
     - name: Build/Push Dev inaturalistapi
       uses: docker/build-push-action@v5
       with:
         context: .
         file: ./Dockerfile
         push: true
         tags: ${{ secrets.DOCKERHUB_USERNAME }}/inaturalistapi:${{ github.ref_name }}
+        build-args: |
+          GIT_BRANCH=${{ github.ref_name }}
+          GIT_COMMIT=${{ github.sha }}
+          IMAGE_TAG=${{ secrets.DOCKERHUB_USERNAME }}/inaturalistapi:${{ github.ref_name }}
+          BUILD_DATE=${{ env.BUILD_DATE }}
 
     - name: Build/Push Dev inaturalistapi-cleanup
       uses: docker/build-push-action@v5
@@ -45,7 +53,12 @@ jobs:
         file: ./Dockerfile-cleanup
         push: true
         tags: ${{ secrets.DOCKERHUB_USERNAME }}/inaturalistapi-cleanup:${{ github.ref_name }}
-
+        build-args: |
+          GIT_BRANCH=${{ github.ref_name }}
+          GIT_COMMIT=${{ github.sha }}
+          IMAGE_TAG=${{ secrets.DOCKERHUB_USERNAME }}/inaturalistapi-cleanup:${{ github.ref_name }}
+          BUILD_DATE=${{ env.BUILD_DATE }}
+
   refresh-dev-staging-deployment:
     name: Refresh Dev Staging Deployment
     needs: build-and-push-dev-docker-image

.github/workflows/CICD-main.yml

@@ -28,7 +28,10 @@ jobs:
 
     - name: Set up Docker Buildx
       uses: docker/setup-buildx-action@v3
-
+
+    - name: Set build date
+      run: echo "BUILD_DATE=$(date -u +"%Y-%m-%dT%H:%M:%SZ")" >> $GITHUB_ENV
+
     - name: Build/Push Main inaturalistapi
       uses: docker/build-push-action@v5
       with:
@@ -38,6 +41,11 @@ jobs:
         tags: |
           ${{ secrets.DOCKERHUB_USERNAME }}/inaturalistapi:${{ github.sha }}
           ${{ secrets.DOCKERHUB_USERNAME }}/inaturalistapi:latest
+        build-args: |
+          GIT_BRANCH=${{ github.ref_name }}
+          GIT_COMMIT=${{ github.sha }}
+          IMAGE_TAG=${{ secrets.DOCKERHUB_USERNAME }}/inaturalistapi:latest
+          BUILD_DATE=${{ env.BUILD_DATE }}
 
     - name: Build/Push Main inaturalistapi-cleanup
       uses: docker/build-push-action@v5
@@ -48,7 +56,12 @@ jobs:
         tags: |
           ${{ secrets.DOCKERHUB_USERNAME }}/inaturalistapi-cleanup:${{ github.sha }}
           ${{ secrets.DOCKERHUB_USERNAME }}/inaturalistapi-cleanup:latest
-
+          build-args: |
+          GIT_BRANCH=${{ github.ref_name }}
+          GIT_COMMIT=${{ github.sha }}
+          IMAGE_TAG=${{ secrets.DOCKERHUB_USERNAME }}/inaturalistapi-cleanup:latest
+          BUILD_DATE=${{ env.BUILD_DATE }}
+
   refresh-main-staging-deployment:
     name: Refresh Main Staging Deployment
     needs: build-and-push-main-docker-image

Dockerfile

@@ -32,6 +32,21 @@ RUN mkdir /home/inaturalist/api/log
 RUN mkdir /home/inaturalist/api/cache
 RUN mkdir -p /home/inaturalist/api/public/uploads
 
+ARG GIT_BRANCH
+ARG GIT_COMMIT
+ARG IMAGE_TAG
+ARG BUILD_DATE
+
+ENV GIT_BRANCH=${GIT_BRANCH}
+ENV GIT_COMMIT=${GIT_COMMIT}
+ENV IMAGE_TAG=${IMAGE_TAG}
+ENV BUILD_DATE=${BUILD_DATE}
+
+RUN echo "GIT_BRANCH=${GIT_BRANCH}" > /home/inaturalist/api/build_info
+RUN echo "GIT_COMMIT=${GIT_COMMIT}" >> /home/inaturalist/api/build_info
+RUN echo "IMAGE_TAG=${IMAGE_TAG}" >> /home/inaturalist/api/build_info
+RUN echo "BUILD_DATE=${BUILD_DATE}" >> /home/inaturalist/api/build_info
+
 FROM base as test
 
 ENV NODE_ENV=test

lib/controllers/v2/app_build_info_controller.js

@@ -0,0 +1,45 @@
+// eslint-disable-next-line camelcase
+const { build_info } = require( "inaturalistjs" );
+const process = require( "process" );
+const fetch = require( "node-fetch" );
+const InaturalistAPI = require( "../../inaturalist_api" );
+const util = require( "../../util" );
+const config = require( "../../../config" );
+
+const index = async req => {
+  if ( !req.userSession || ( req.userSession && !req.userSession.isAdmin ) ) {
+    throw util.httpError( 401, "Unauthorized" );
+  }
+  // Get Rails Build Info
+  // eslint-disable-next-line camelcase
+  const railsBuildInfoJSON = await InaturalistAPI.iNatJSWrap( build_info.get, req );
+  // Get API Build Info
+  const apiBuildInfoJSON = {
+    git_branch: process.env.GIT_BRANCH,
+    git_commit: process.env.GIT_COMMIT,
+    image_tag: process.env.IMAGE_TAG,
+    build_date: process.env.BUILD_DATE
+  };
+  // Get Vision Build Info
+  let visionBuildInfoJSON = {};
+  try {
+    const response = await fetch( `${config.imageProcesing.tensorappURL}/build_info` );
+    if ( !response.ok ) {
+      throw util.httpError( 500, "Error" );
+    }
+    visionBuildInfoJSON = await response.json( );
+  } catch ( error ) {
+    throw util.httpError( 500, "Error" );
+  }
+  // Application Build Info
+  const appBuildInfoJSON = {
+    rails: railsBuildInfoJSON,
+    api: apiBuildInfoJSON,
+    vision: visionBuildInfoJSON
+  };
+  return appBuildInfoJSON;
+};
+
+module.exports = {
+  index
+};

lib/controllers/v2/build_info_controller.js

@@ -0,0 +1,19 @@
+const process = require( "process" );
+const util = require( "../../util" );
+
+const index = async req => {
+  if ( !req.userSession || ( req.userSession && !req.userSession.isAdmin ) ) {
+    throw util.httpError( 401, "Unauthorized" );
+  }
+  const buildInfoJSON = {
+    git_branch: process.env.GIT_BRANCH,
+    git_commit: process.env.GIT_COMMIT,
+    image_tag: process.env.IMAGE_TAG,
+    build_date: process.env.BUILD_DATE
+  };
+  return buildInfoJSON;
+};
+
+module.exports = {
+  index
+};

openapi/paths/v2/app_build_info.js

@@ -0,0 +1,36 @@
+const AppBuildInfoController = require( "../../../lib/controllers/v2/app_build_info_controller" );
+
+module.exports = sendWrapper => {
+  async function GET( req, res ) {
+    const results = await AppBuildInfoController.index( req );
+    sendWrapper( req, res, null, results );
+  }
+
+  GET.apiDoc = {
+    tags: ["AppBuildInfo"],
+    summary: "Display application build information",
+    security: [{
+      userJwtRequired: []
+    }],
+    responses: {
+      200: {
+        description: "Application build information",
+        content: {
+          "application/json": {
+            schema: {
+              $ref: "#/components/schemas/AppBuildInfo"
+            }
+          }
+        }
+      },
+      default: {
+        $ref: "#/components/responses/Error"
+      }
+    },
+    "x-unpublished": true
+  };
+
+  return {
+    GET
+  };
+};

openapi/paths/v2/build_info.js

@@ -0,0 +1,36 @@
+const BuildInfoController = require( "../../../lib/controllers/v2/build_info_controller" );
+
+module.exports = sendWrapper => {
+  async function GET( req, res ) {
+    const results = await BuildInfoController.index( req );
+    sendWrapper( req, res, null, results );
+  }
+
+  GET.apiDoc = {
+    tags: ["BuildInfo"],
+    summary: "Display build information",
+    security: [{
+      userJwtRequired: []
+    }],
+    responses: {
+      200: {
+        description: "Build information",
+        content: {
+          "application/json": {
+            schema: {
+              $ref: "#/components/schemas/BuildInfo"
+            }
+          }
+        }
+      },
+      default: {
+        $ref: "#/components/responses/Error"
+      }
+    },
+    "x-unpublished": true
+  };
+
+  return {
+    GET
+  };
+};

openapi/schema/request/app_build_info.js

@@ -0,0 +1,3 @@
+const Joi = require( "joi" );
+
+module.exports = Joi.object( ).keys( {} );

openapi/schema/request/build_info.js

@@ -0,0 +1,3 @@
+const Joi = require( "joi" );
+
+module.exports = Joi.object( ).keys( {} );

openapi/schema/response/app_build_info.js

@@ -0,0 +1,22 @@
+const Joi = require( "joi" );
+
+module.exports = Joi.object( ).keys( {
+  rails: Joi.object( ).keys( {
+    git_branch: Joi.string( ),
+    git_commit: Joi.string( ),
+    image_tag: Joi.string( ),
+    build_date: Joi.string( )
+  } ),
+  api: Joi.object( ).keys( {
+    git_branch: Joi.string( ),
+    git_commit: Joi.string( ),
+    image_tag: Joi.string( ),
+    build_date: Joi.string( )
+  } ),
+  vision: Joi.object( ).keys( {
+    git_branch: Joi.string( ),
+    git_commit: Joi.string( ),
+    image_tag: Joi.string( ),
+    build_date: Joi.string( )
+  } )
+} ).unknown( false );

openapi/schema/response/build_info.js

@@ -0,0 +1,8 @@
+const Joi = require( "joi" );
+
+module.exports = Joi.object( ).keys( {
+  git_branch: Joi.string( ),
+  git_commit: Joi.string( ),
+  image_tag: Joi.string( ),
+  build_date: Joi.string( )
+} ).unknown( false );

package.json

@@ -41,7 +41,7 @@
     "geoip-lite": "^1.4.3",
     "h3-js": "^4.1.0",
     "handlebars": "^4.7.7",
-    "inaturalistjs": "github:inaturalist/inaturalistjs",
+    "inaturalistjs": "github:inaturalist/inaturalistjs#2fc60fb0870f35427c225b73745a5c492b41637a",
     "intl": "^1.2.5",
     "joi": "^17.5.0",
     "joi-to-swagger": "^6.1.1",