feat: getGithubReleaseStatus public api and tests

abose · abose · commit a55cd286a952 · 2023-03-02T10:51:48.000-03:00
diff --git a/src/api/getGithubReleaseStatus.js b/src/api/getGithubReleaseStatus.js
@@ -0,0 +1,72 @@
+// Refer https://json-schema.org/understanding-json-schema/index.html
+import {FIELD_RELEASE_ID, RELEASE_DETAILS_TABLE} from "../constants.js";
+import db from "../db.js";
+
+const schema = {
+    schema: {
+        querystring: {
+            type: 'object',
+            required: ['owner', "repo", "tag"],
+            properties: {
+                owner: {
+                    type: 'string',
+                    minLength: 1,
+                    maxLength: 256
+                }, repo: {
+                    type: 'string',
+                    minLength: 1,
+                    maxLength: 256
+                }, tag: {
+                    type: 'string',
+                    minLength: 1,
+                    maxLength: 256
+                }
+            }
+        },
+        response: {
+            200: { //HTTP_STATUS_CODES.OK
+                type: 'object',
+                required: ['status', 'errors'],
+                properties: {
+                    status: {type: 'string'},
+                    errors: {type: 'array', "items": {"type": "string"}},
+                    published: {type: 'boolean'},
+                    githubIssue: {type: 'string'},
+                    lastUpdatedDateUTC: {type: 'number'}
+                }
+            }
+        }
+    }
+};
+
+export function getGetGithubReleaseStatusSchema() {
+    return schema;
+}
+
+export async function getGithubReleaseStatus(request, _reply) {
+    // ?owner=${release.owner}&repo=${release.repo}&tag=${release.tag}
+    const owner = request.query.owner;
+    const repo = request.query.repo;
+    const tag = request.query.tag;
+    const releaseRef = `${owner}/${repo}/${tag}`;
+    const queryObj = {};
+    queryObj[FIELD_RELEASE_ID] = releaseRef;
+    let existingRelease = await db.getFromIndex(RELEASE_DETAILS_TABLE, queryObj);
+    if (!existingRelease.isSuccess) {
+        // unexpected error
+        throw new Error("Error getting release details from db: " + releaseRef);
+    }
+    existingRelease = existingRelease.documents.length === 1 ? existingRelease.documents[0] : null;
+    const response = {
+        status: "NO_SUCH_RELEASE",
+        errors: [`Release not found. IF this is a recent release, please wait for 1 minute before checking again.`]
+    };
+    if (existingRelease) {
+        response.published = existingRelease.published || false;
+        response.status = existingRelease.status;
+        response.errors = existingRelease.errors;
+        response.githubIssue = "" + existingRelease.githubIssue;
+        response.lastUpdatedDateUTC = existingRelease.lastUpdatedDateUTC;
+    }
+    return response;
+}
diff --git a/src/api/publishGithubRelease.js b/src/api/publishGithubRelease.js
@@ -337,7 +337,7 @@ async function _UpdateReleaseInfo(release, existingReleaseInfo) {
             let {documentId, isSuccess } = await db.put(RELEASE_DETAILS_TABLE, releaseInfo);
             releaseInfo.documentId = documentId;
             console.log(`Putting release ${releaseRef} details to db success: ${isSuccess}, documentId: ${documentId}`);
-            return  await _getReleaseInfo(release);
+            return await _getReleaseInfo(release);
         }
     } catch (e) {
         console.error("Error while putting error status of release. ", e);
diff --git a/src/server.js b/src/server.js
@@ -30,6 +30,7 @@ import {getPublishGithubReleaseSchema, publishGithubRelease} from "./api/publish
 import path from 'path';
 import { fileURLToPath } from 'url';
 import {initGitHubClient} from "./github.js";
+import {getGetGithubReleaseStatusSchema, getGithubReleaseStatus} from "./api/getGithubReleaseStatus.js";
 
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = path.dirname(__filename);
@@ -89,6 +90,12 @@ server.get('/publishGithubRelease', getPublishGithubReleaseSchema(), function (r
     return publishGithubRelease(request, reply);
 });
 
+// public getGithubReleaseStatus api
+addUnAuthenticatedAPI('/getGithubReleaseStatus');
+server.get('/getGithubReleaseStatus', getGetGithubReleaseStatusSchema(), function (request, reply) {
+    return getGithubReleaseStatus(request, reply);
+});
+
 // An authenticated version of the hello api
 server.get('/helloAuth', getHelloSchema(), function (request, reply) {
     return hello(request, reply);
diff --git a/src/www/index.html b/src/www/index.html
@@ -2,9 +2,9 @@
 <html lang="en">
 <head>
     <meta charset="UTF-8">
-    <title>Hello HTML</title>
+    <title>phcode.dev Extension Publish</title>
 </head>
 <body>
-Hello World
+phcode.dev extension publish services.
 </body>
 </html>
diff --git a/test/unit/api/getGithubReleaseStatus.spec.js b/test/unit/api/getGithubReleaseStatus.spec.js
@@ -0,0 +1,80 @@
+/*global describe, it*/
+import mockedFunctions from "../setupMocks.js";
+import * as chai from 'chai';
+import {getGithubReleaseStatus, getGetGithubReleaseStatusSchema} from "../../../src/api/getGithubReleaseStatus.js";
+import {getSimpleGetReply, getSimpleGETRequest} from '../data/simple-request.js';
+import Ajv from "ajv";
+import db from "../../../src/db.js";
+
+export const AJV = new Ajv();
+
+
+let expect = chai.expect;
+
+describe('unit Tests for getGithubReleaseStatus api', function () {
+    function _getRequest(owner="owner", repo ="repo", tag= "tag") {
+        let request = getSimpleGETRequest();
+        request.query.owner = owner;
+        request.query.repo = repo;
+        request.query.tag = tag;
+        return request;
+    }
+
+    it('should getGithubReleaseStatus return no such release if no release', async function () {
+        let helloResponse = await getGithubReleaseStatus(_getRequest(), getSimpleGetReply());
+        expect(helloResponse).eql({
+            "errors": [
+                "Release not found. IF this is a recent release, please wait for 1 minute before checking again."
+            ],
+            "status": "NO_SUCH_RELEASE"
+        });
+    });
+
+    it('should getGithubReleaseStatus return existing release details', async function () {
+        db.getFromIndex = function (_tableName) {
+            return {
+                isSuccess: true,
+                documents: [{
+                    published: false,
+                    status: "PROCESSING",
+                    errors: ["oops"],
+                    githubIssue: "5",
+                    lastUpdatedDateUTC: 1234
+                }]};
+        };
+        let helloResponse = await getGithubReleaseStatus(_getRequest(), getSimpleGetReply());
+        expect(helloResponse).eql({
+            "errors": [
+                "oops"
+            ],
+            "githubIssue": "5",
+            "lastUpdatedDateUTC": 1234,
+            "published": false,
+            "status": "PROCESSING"
+        });
+    });
+
+    it('should validate schemas for sample request/responses', async function () {
+        let request = _getRequest();
+        // request
+        const requestValidator = AJV.compile(getGetGithubReleaseStatusSchema().schema.querystring);
+        expect(requestValidator(request.query)).to.be.true;
+        // response
+        const successResponseValidator = AJV.compile(getGetGithubReleaseStatusSchema().schema.response["200"]);
+        let response = await getGithubReleaseStatus(_getRequest(), getSimpleGetReply());
+        expect(successResponseValidator(response)).to.be.true;
+    });
+
+    it('should throw if db non success getGithubReleaseStatus', async function () {
+        db.getFromIndex = function (_tableName) {
+            return {isSuccess: false};
+        };
+        let error;
+        try{
+            await getGithubReleaseStatus(_getRequest(), getSimpleGetReply());
+        } catch(e){
+            error = e;
+        }
+        expect(error).to.exist;
+    });
+});
diff --git a/test/unit/api/publishGithubRelease.spec.js b/test/unit/api/publishGithubRelease.spec.js
@@ -42,13 +42,33 @@ describe('unit Tests for publishGithubRelease api', function () {
         S3.getObject = _getObject;
     });
 
+    let documents = {}, docID = 0;
     beforeEach(function () {
+        documents = {};
         request = getSimpleGETRequest();
         reply = getSimpleGetReply();
         request.query.releaseRef = "org/repo:refs/tags/gitTag";
-        db.getFromIndex = function (_tableName) {
+        db.put = function (tableName, document) {
+            let newDocID = "" + docID++;
+            documents[tableName + ":" + newDocID] = document;
+            return {isSuccess: true, documentId: newDocID};
+        };
+        db.getFromIndex = function (tableName, queryObject) {
+            let keys = Object.keys(documents);
+            let foundDocs =[];
+            for(let key of keys){
+                if(key.startsWith(tableName+":")){
+                    let doc = documents[key];
+                    let qKeys = Object.keys(queryObject);
+                    for (let qkey of qKeys){
+                        if(doc[qkey] === queryObject[qkey]){
+                            foundDocs.push(doc);
+                        }
+                    }
+                }
+            }
             return {isSuccess: true,
-                documents:[]
+                documents:foundDocs
             };
         };
         db.query = function () {
diff --git a/test/unit/setupMocks.js b/test/unit/setupMocks.js
@@ -29,6 +29,21 @@ async function githubRequestFnMock(url, options) {
         }
         throw {status: 404};
     }
+    if(url.startsWith("POST /repos/") && url.endsWith("/issues") ){ // issue related api
+        return  {
+            data: {
+                number: 1,
+                html_url: "https://github.com/owner/repo/issues/1"
+            }
+        };
+    }
+    if(url.startsWith("POST /repos/") && url.endsWith("/comments") ){ // issue related api
+        return  {
+            data: {
+                html_url: "https://github.com/owner/repo/issues/1#issuecomment-1370538185"
+            }
+        };
+    }
 }
 
 const MOCKED_ENV_VAR = "mocked_env_var";

Original file line number	Diff line number	Diff line change
`@@ -337,7 +337,7 @@ async function _UpdateReleaseInfo(release, existingReleaseInfo) {`
`337`	`337`	`let {documentId, isSuccess } = await db.put(RELEASE_DETAILS_TABLE, releaseInfo);`
`338`	`338`	`releaseInfo.documentId = documentId;`
`339`	`339`	console.log(`Putting release ${releaseRef} details to db success: ${isSuccess}, documentId: ${documentId}`);
`340`		`- return await _getReleaseInfo(release);`
	`340`	`+ return await _getReleaseInfo(release);`
`341`	`341`	`}`
`342`	`342`	`} catch (e) {`
`343`	`343`	`console.error("Error while putting error status of release. ", e);`