Add /_spacebar/api/version - resolves #1222

This commit is contained in:
Rory&
2026-02-25 10:49:05 +01:00
parent 1d0e9c3501
commit 0a1e4e9d6b
4 changed files with 57 additions and 27 deletions

View File

@@ -16,7 +16,7 @@
along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
import { Config, ConnectionConfig, ConnectionLoader, Email, JSONReplacer, WebAuthn, initDatabase, initEvent, registerRoutes, getDatabase } from "@spacebar/util";
import { Config, ConnectionConfig, ConnectionLoader, Email, JSONReplacer, WebAuthn, initDatabase, initEvent, registerRoutes, getDatabase, getRevInfoOrFail } from "@spacebar/util";
import { Authentication, CORS, ImageProxy, BodyParser, ErrorHandler, initRateLimits, initTranslation } from "./middlewares";
import { Request, Response, Router } from "express";
import { Server, ServerOptions } from "lambert-server";
@@ -141,6 +141,13 @@ export class SpacebarServer extends Server {
res.sendFile(path.join(ASSETS_FOLDER, "openapi.json"));
});
app.get("/_spacebar/api/version", (req, res) => {
res.json({
implementation: "spacebar-server-ts",
version: getRevInfoOrFail(),
});
});
// current well-known location
app.get("/.well-known/spacebar", (req, res) => {
res.json({

View File

@@ -29,37 +29,12 @@ import { config } from "dotenv";
config({ quiet: true });
import { execSync } from "child_process";
import { centerString, Logo } from "@spacebar/util";
import { centerString, getRevInfoOrFail, Logo } from "@spacebar/util";
import fs from "fs";
import path from "path";
const cores = process.env.THREADS ? parseInt(process.env.THREADS) : 1;
function getRevInfoOrFail(): { rev: string | null; lastModified: number } {
const rootDir = path.join(__dirname, "../../");
// sanity check
if (!fs.existsSync(path.join(rootDir, "package.json"))) {
console.log(red("Error: Cannot find package.json in root directory. Are you running from the correct location?"));
}
// use .rev file if it exists
if (fs.existsSync(path.join(__dirname, "../../.rev"))) {
return JSON.parse(fs.readFileSync(path.join(rootDir, ".rev"), "utf-8"));
}
// fall back to invoking git
try {
const rev = execSync(`git -C "${rootDir}" rev-parse HEAD`).toString().trim();
const lastModified = Number(execSync(`git -C "${rootDir}" log -1 --format=%cd --date=unix`).toString().trim());
return {
rev,
lastModified,
};
} catch (e) {
return { rev: null, lastModified: 0 };
}
}
if (cluster.isPrimary) {
const revInfo = getRevInfoOrFail();
Logo.printLogo().then(() => {

47
src/util/util/Version.ts Normal file
View File

@@ -0,0 +1,47 @@
/*
Spacebar: A FOSS re-implementation and extension of the Discord.com backend.
Copyright (C) 2026 Spacebar and Spacebar Contributors
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published
by the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
import path from "path";
import fs from "fs";
import { execSync } from "child_process";
import { red } from "picocolors";
export function getRevInfoOrFail(): { rev: string | null; lastModified: number } {
const rootDir = path.join(__dirname, "../../../");
// sanity check
if (!fs.existsSync(path.join(rootDir, "package.json"))) {
console.log(red("Error: Cannot find package.json in root directory. Are you running from the correct location?"));
}
// use .rev file if it exists
if (fs.existsSync(path.join(rootDir, ".rev"))) {
return JSON.parse(fs.readFileSync(path.join(rootDir, ".rev"), "utf-8"));
}
// fall back to invoking git
try {
const rev = execSync(`git -C "${rootDir}" rev-parse HEAD`).toString().trim();
const lastModified = Number(execSync(`git -C "${rootDir}" log -1 --format=%cd --date=unix`).toString().trim());
return {
rev,
lastModified,
};
} catch (e) {
return { rev: null, lastModified: 0 };
}
}

View File

@@ -55,3 +55,4 @@ export * from "../../schemas/HelperTypes";
export * from "./extensions";
export * from "./Random";
export * from "./Url";
export * from "./Version";