mirror of
https://github.com/outline/outline.git
synced 2026-11-20 21:23:06 +03:00
* Add missing JSDoc to exported members in app and server utils Documents all exported functions, classes, enums, and constants in app/utils and server/utils that were missing JSDoc, per the project documentation guidelines. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01AsEQYA8zN813thxu7GjjzU * Use @returns tag to match codebase convention Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01AsEQYA8zN813thxu7GjjzU --------- Co-authored-by: Claude <noreply@anthropic.com>
67 lines
1.7 KiB
TypeScript
67 lines
1.7 KiB
TypeScript
import crypto from "node:crypto";
|
|
import env from "@server/env";
|
|
import Collection from "@server/models/Collection";
|
|
import Document from "@server/models/Document";
|
|
import Team from "@server/models/Team";
|
|
import User from "@server/models/User";
|
|
import Redis from "@server/storage/redis";
|
|
import packageInfo from "../../package.json";
|
|
import fetch from "./fetch";
|
|
|
|
const UPDATES_URL = "https://updates.getoutline.com";
|
|
const UPDATES_KEY = "UPDATES_KEY";
|
|
|
|
/**
|
|
* Checks the updates service for available updates and important messages,
|
|
* caching any returned notice in Redis. Sends anonymous usage statistics with
|
|
* the request.
|
|
*/
|
|
export async function checkUpdates() {
|
|
const secret = env.SECRET_KEY.slice(0, 6) + env.URL;
|
|
const id = crypto.createHash("sha256").update(secret).digest("hex");
|
|
const [userCount, teamCount, collectionCount, documentCount] =
|
|
await Promise.all([
|
|
User.count(),
|
|
Team.count(),
|
|
Collection.count(),
|
|
Document.count(),
|
|
]);
|
|
const body = JSON.stringify({
|
|
id,
|
|
version: 1,
|
|
clientVersion: packageInfo.version,
|
|
analytics: {
|
|
userCount,
|
|
teamCount,
|
|
collectionCount,
|
|
documentCount,
|
|
},
|
|
});
|
|
await Redis.defaultClient.del(UPDATES_KEY);
|
|
|
|
try {
|
|
const response = await fetch(UPDATES_URL, {
|
|
method: "POST",
|
|
headers: {
|
|
Accept: "application/json",
|
|
"Content-Type": "application/json",
|
|
},
|
|
body,
|
|
});
|
|
const data = await response.json();
|
|
|
|
if (data.severity) {
|
|
await Redis.defaultClient.set(
|
|
UPDATES_KEY,
|
|
JSON.stringify({
|
|
severity: data.severity,
|
|
message: data.message,
|
|
url: data.url,
|
|
})
|
|
);
|
|
}
|
|
} catch (_e) {
|
|
// no-op
|
|
}
|
|
}
|