Skip to content

chore(o11y): update server jobs to use structured logging #6387

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kschelonka merged 3 commits into from
Jan 6, 2026
Merged

chore(o11y): update server jobs to use structured logging #6387

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9948416
chore(o11y): update server jobs to use structured logging
kschelonka Dec 31, 2025
219d180
chore: move initializeEnvVars logic to config.ts
kschelonka Jan 5, 2026
8a548e5
Merge branch 'main' into mntor-5099
kschelonka Jan 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
0 src/initializeEnvVars.js → src/initializeEnvVars.ts
View file
Open in desktop
File renamed without changes.
137 changes: 0 additions & 137 deletions src/scripts/cronjobs/deleteSubsNoFxaUid.ts
View file
Open in desktop

This file was deleted.

147 changes: 83 additions & 64 deletions src/scripts/cronjobs/syncBreaches.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,15 @@
* node src/scripts/syncBreaches.js
*/

import * as Sentry from "@sentry/node";

Sentry.init({
dsn: config.sentryDsn,
tracesSampleRate: 1.0,
});

import { readdir } from "node:fs/promises";
import os from "node:os";
import Sentry from "@sentry/nextjs";
import { fetchHibpBreaches, HibpGetBreachesResponse } from "../../utils/hibp";
import {
getAllBreaches,
Expand All @@ -25,23 +31,23 @@ import {
} from "../../db/redis/client.js";
import { uploadToS3 } from "../../utils/s3.js";
import { config } from "../../config";
import { logger as baseLogger } from "../../app/functions/server/logging";

const SENTRY_SLUG = "cron-sync-breaches";

Sentry.init({
dsn: config.sentryDsn,
tracesSampleRate: 1.0,
});

const checkInId = Sentry.captureCheckIn({
monitorSlug: SENTRY_SLUG,
status: "in_progress",
});

const logger = baseLogger.child({ module: "syncBreaches" });

export async function getBreachIcons(breaches: HibpGetBreachesResponse) {
// make logofolder if it doesn't exist
// TODO: clean up unused folder and existing logo logic
// MNTOR-5166
Copy link
Collaborator

@Vinnl Vinnl Jan 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Praise: thanks for filing this one, good improvements there.

const logoFolder = os.tmpdir();
console.log(`Logo folder: ${logoFolder}`);
logger.debug(`Logo folder: ${logoFolder}`);

// read existing logos
const existingLogos = await readdir(logoFolder);
Expand All @@ -51,99 +57,112 @@ export async function getBreachIcons(breaches: HibpGetBreachesResponse) {
const breachName = breach.Name;

if (!breachDomain || breachDomain.length === 0) {
console.log("empty domain: ", breachName);
logger.info("Breach has empty domain", { breachName });
await updateBreachFaviconUrl(breachName, null);
continue;
}
const logoFilename = breachDomain.toLowerCase() + ".ico";
// TODO: Check S3 bucket, not file system, for existing logos
// MNTOR-5166
if (existingLogos.includes(logoFilename)) {
console.log("skipping ", logoFilename);
logger.info("skipping ", logoFilename);
await updateBreachFaviconUrl(
breachName,
`https://s3.amazonaws.com/${config.s3Bucket}/${logoFilename}`,
);
continue;
}
console.log(`fetching: ${logoFilename}`);
logger.info("Fetching logo", { logoFilename });
const res = await fetch(
`https://icons.duckduckgo.com/ip3/${breachDomain}.ico`,
);
if (res.status !== 200) {
// update logo path with null
console.log(`Logo does not exist for: ${breachName} ${breachDomain}`);
logger.info("Logo does not exist", { breachName, breachDomain });
await updateBreachFaviconUrl(breachName, null);
continue;
}

try {
// TODO: Do not reupload to S3 if logo already exists
// MNTOR-5166
await uploadToS3(logoFilename, Buffer.from(await res.arrayBuffer()));
await updateBreachFaviconUrl(
breachName,
`https://s3.amazonaws.com/${config.s3Bucket}/${logoFilename}`,
);
} catch (e) {
console.error(e);
logger.error(e);
continue;
}
}
}

// Get breaches and upserts to DB
const breachesResponse = await fetchHibpBreaches();
const seen = new Set();
breachesResponse.forEach((breach) => {
seen.add(breach.Name + breach.BreachDate);

// sanity check: corrupt data structure
if (!isValidBreach(breach)) {
throw new Error(
"Breach data structure is not valid: " + JSON.stringify(breach),
async function run() {
// Get breaches and upserts to DB
const breachesResponse = await fetchHibpBreaches();
const seen = new Set();
breachesResponse.forEach((breach) => {
seen.add(breach.Name + breach.BreachDate);

// sanity check: corrupt data structure
if (!isValidBreach(breach)) {
const invalidMsg = "Breach data structure is not valid";
logger.error(invalidMsg, { breach });
throw new Error(`${invalidMsg}: ` + JSON.stringify(breach));
}
});

logger.info("Breaches found", { total: length, unique: seen.size });

// sanity check: no duplicate breaches with Name + BreachDate
if (seen.size !== breachesResponse.length) {
const dupeMsg = "Breaches contain duplicates";
logger.error(dupeMsg, {
unique: seen.size,
total: breachesResponse.length,
});
throw new Error(`${dupeMsg}. Stopping script...`);
} else {
await upsertBreaches(breachesResponse);

// get
const result = await getAllBreaches();
logger.info(
"Number of breaches in the database after upsert:",
result.length,
);
}
});

console.log("Breaches found: ", breachesResponse.length);
console.log("Unique breaches based on Name + BreachDate", seen.size);

// sanity check: no duplicate breaches with Name + BreachDate
if (seen.size !== breachesResponse.length) {
throw new Error("Breaches contain duplicates. Stopping script...");
} else {
await upsertBreaches(breachesResponse);

// get
const result = await getAllBreaches();
console.log(
"Number of breaches in the database after upsert:",
result.length,
);

// try to refresh Redis cache of all breaches
try {
const rClient = redisClient();
await rClient.set(
REDIS_ALL_BREACHES_KEY,
JSON.stringify(result),
"EX",
BREACHES_EXPIRY_SECONDS,
);
} catch (e) {
Sentry.captureMessage(
`Update Redis failed for syncBreaches.ts: ${e as string}`,
);
console.error(
`Update Redis failed for syncBreaches.ts: ${(e as Error).stack}`,
);
// try to refresh Redis cache of all breaches
try {
const rClient = redisClient();
await rClient.set(
REDIS_ALL_BREACHES_KEY,
JSON.stringify(result),
"EX",
BREACHES_EXPIRY_SECONDS,
);
} catch (e) {
logger.error("Update Redis failed for syncBreaches.ts", { error: e });
}
}
await getBreachIcons(breachesResponse);
}

await getBreachIcons(breachesResponse);

Sentry.captureCheckIn({
checkInId,
monitorSlug: SENTRY_SLUG,
status: "ok",
});
try {
await run();
Sentry.captureCheckIn({
checkInId,
monitorSlug: SENTRY_SLUG,
status: "ok",
});
} catch (error) {
Sentry.captureCheckIn({
checkInId,
monitorSlug: SENTRY_SLUG,
status: "error",
});
throw error;
}
setTimeout(process.exit, 1000);

/**
Expand Down
Loading
Loading