Skip to content

Commit

Permalink
feat: healthz page (#25)
Browse files Browse the repository at this point in the history
Description
---
Add healthz page that just return 200 with `{status:"ok"}`

Motivation and Context
---

How Has This Been Tested?
---
Just run it manually a check healthz

What process can a PR reviewer use to test or verify this change?
---
same as above

<!-- Checklist -->
<!-- 1. Is the title of your PR in the form that would make nice release
notes? The title, excluding the conventional commit
tag, will be included exactly as is in the CHANGELOG, so please think
about it carefully. -->


Breaking Changes
---

- [x] None
- [ ] Requires data directory on base node to be deleted
- [ ] Requires hard fork
- [ ] Other - Please specify

<!-- Does this include a breaking change? If so, include this line as a
footer -->
<!-- BREAKING CHANGE: Description what the user should do, e.g. delete a
database, resync the chain -->
  • Loading branch information
leet4tari authored Feb 27, 2024
2 parents c27acca + 689d112 commit ee1b6d0
Show file tree
Hide file tree
Showing 3 changed files with 57 additions and 0 deletions.
2 changes: 2 additions & 0 deletions app.js
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ var blocksRouter = require("./routes/blocks");
var mempoolRouter = require("./routes/mempool");
var searchCommitmentsRouter = require("./routes/search_commitments");
var searchKernelsRouter = require("./routes/search_kernels");
var healthz = require("./routes/healthz");

var assetsRouter = require("./routes/assets");

Expand Down Expand Up @@ -97,6 +98,7 @@ app.use("/assets", assetsRouter);
app.use("/mempool", mempoolRouter);
app.use("/search_commitments", searchCommitmentsRouter);
app.use("/search_kernels", searchKernelsRouter);
app.use("/healthz", healthz);

// catch 404 and forward to error handler
app.use(function (req, res, next) {
Expand Down
50 changes: 50 additions & 0 deletions routes/healthz.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
// Copyright 2021. The Tari Project
//
// Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
// following conditions are met:
//
// 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following
// disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
// following disclaimer in the documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote
// products derived from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
// INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
// DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
// USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

var { createClient } = require("../baseNodeClient");

var express = require("express");
var router = express.Router();

router.get("/", async function (req, res) {
let client = createClient();
let result;
try {
result = await client.getVersion({});
} catch (error) {
res.status(404);
if (req.query.json !== undefined) {
res.json({ error: error });
} else {
res.render("error", { error: error });
}
return;
}
let json = { version: result.value };
if (req.query.json !== undefined) {
res.json(json);
} else {
res.render("healthz", json);
}
});

module.exports = router;
5 changes: 5 additions & 0 deletions views/healthz.hbs
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
<a href="/">Home</a>
<div>
Version:
<b>{{this.version}}</b>
</div>

0 comments on commit ee1b6d0

Please sign in to comment.