Skip to content
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

Jump to bottom

Debug Ceramic Migration #592

Merged
merged 3 commits into from
Oct 25, 2024
Merged

Debug Ceramic Migration #592

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ca786e4
add migration debugging, owner check, all versions migrated check
kadamidev Oct 23, 2024
586873f
fix me accuumulator
kadamidev Oct 23, 2024
dd761ad
unwind debug commented out logic
kadamidev Oct 23, 2024
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
2 changes: 1 addition & 1 deletion desci-server/nodemon.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@
"ignore": ["log/server.log"],
"verbose": true,
"exec": "node -r ts-node/register --inspect=0.0.0.0:9228",
"delay": 1000,
"delay": 1337,
Copy link
Contributor

Choose a reason for hiding this comment

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

😂

"signal": "SIGTERM"
}
201 changes: 114 additions & 87 deletions desci-server/src/controllers/admin/debug.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,46 +1,44 @@
import { DataType, Node, NodeVersion, PublicDataReference } from '@prisma/client';
import { Request, Response } from 'express';
import { logger as parentLogger } from '../../logger.js';

import { prisma } from '../../client.js';
import { DataType, Node, NodeVersion, PublicDataReference } from '@prisma/client';
import { ensureUuidEndsWithDot } from '../../utils.js';
import { directStreamLookup } from '../../services/ceramic.js';
import { logger as parentLogger } from '../../logger.js';
import { directStreamLookup, RawStream } from '../../services/ceramic.js';
import { getAliasRegistry, getHotWallet } from '../../services/chain.js';
import { getIndexedResearchObjects, IndexedResearchObject } from '../../theGraph.js';
import { _getIndexedResearchObjects, getIndexedResearchObjects, IndexedResearchObject } from '../../theGraph.js';
import { ensureUuidEndsWithDot } from '../../utils.js';

const logger = parentLogger.child({ module: 'ADMIN::DebugController' });

export const debugNodeHandler = async (
req: Request,
res: Response,
) => {
export const debugNodeHandler = async (req: Request, res: Response) => {
const uuid = req.params.uuid;
logger.info({ uuid }, "handling debug query");
logger.info({ uuid }, 'handling debug query');

const result = await debugNode(uuid);
res.send(result);
};

type DebugAllNodesQueryParams = {
event?: "first_publish" | "last_publish",
fromDate?: string,
toDate?: string,
event?: 'first_publish' | 'last_publish';
fromDate?: string;
toDate?: string;
};

type NodeInfo = {
uuid: string,
first_publish: Date,
last_publish: Date,
uuid: string;
first_publish: Date;
last_publish: Date;
};

/** Be gentle with the search scope, as it'll put a fair amount of load on
* the ceramic node
*/
*/
export const debugAllNodesHandler = async (
req: Request<never, never, never, DebugAllNodesQueryParams>,
res: Response,
) => {
const { fromDate, toDate } = req.query;
const event = req.query.event ?? "last_publish";
const event = req.query.event ?? 'last_publish';

const startTime = new Date();

Expand All @@ -61,22 +59,20 @@ export const debugAllNodesHandler = async (
${timeClause};
`);

logger.info(
{ event, fromDate, toDate, nodes },
"found nodes matching debug range",
);
logger.info({ event, fromDate, toDate, nodes }, 'found nodes matching debug range');

const debugData = await Promise.all(
nodes.map(async n => ({
nodes.map(async (n) => ({
first_publish: n.first_publish,
last_publish: n.last_publish,
...await debugNode(n.uuid)
}))
...(await debugNode(n.uuid)),
})),
);

const sortedDebugData = debugData.sort((n1, n2) =>
// Most recent first
n2[event].getTime() - n1[event].getTime()
const sortedDebugData = debugData.sort(
(n1, n2) =>
// Most recent first
n2[event].getTime() - n1[event].getTime(),
);

const endTime = new Date();
Expand All @@ -87,38 +83,34 @@ export const debugAllNodesHandler = async (
startTime,
duration: `${duration}s`,
event,
fromDate: fromDate ?? "undefined",
toDate: toDate ?? "undefined",
fromDate: fromDate ?? 'undefined',
toDate: toDate ?? 'undefined',
},
summary: {
nodesWithErrors: debugData.filter(n => n.hasError).length,
nodesWithErrors: debugData.filter((n) => n.hasError).length,
},
data: sortedDebugData,
};

return res.send(result);
};

const makeTimeClause = (
event: "first_publish" | "last_publish",
fromDate?: string,
toDate?: string
) => {
const makeTimeClause = (event: 'first_publish' | 'last_publish', fromDate?: string, toDate?: string) => {
if (!fromDate && !toDate) {
return "";
return '';
}

let clause = `where all_versions.${event}`;

if (fromDate) {
clause += ` > '${fromDate}'`;
};
}

if (toDate && fromDate) {
clause += `and all_versions.${event} < '${toDate}'`;
} else if (toDate) {
clause += `< '${toDate}'`;
};
}

return clause;
};
Expand All @@ -130,10 +122,10 @@ const debugNode = async (uuid: string) => {
},
include: {
versions: {
orderBy: { createdAt: "desc" }
orderBy: { createdAt: 'desc' },
},
PublicDataReference: {
orderBy: { createdAt: "desc" }
orderBy: { createdAt: 'desc' },
},
},
});
Expand All @@ -143,18 +135,11 @@ const debugNode = async (uuid: string) => {
const database = await debugDb(node);
const shouldBeIndexed = database.nVersions > 0 || stream.nVersions > 0;
const indexer = await debugIndexer(uuid, shouldBeIndexed);
const migrationInfo = await debugMigration(uuid, stream);

const nVersionsAgree = new Set([
database.nVersions ?? 0,
stream.nVersions ?? 0,
indexer.nVersions ?? 0,
]).size === 1;
const nVersionsAgree = new Set([database.nVersions ?? 0, stream.nVersions ?? 0, indexer.nVersions ?? 0]).size === 1;

const hasError = stream.error
|| dpid.error
|| database.error
|| indexer.error
|| !nVersionsAgree;
const hasError = stream.error || dpid.error || database.error || indexer.error || !nVersionsAgree;

return {
createdAt: node.createdAt,
Expand All @@ -165,43 +150,58 @@ const debugNode = async (uuid: string) => {
dpid,
database,
indexer,
migrationInfo,
};
};

type NodeDbClosure = Node & {
versions: NodeVersion[],
PublicDataReference: PublicDataReference[],
versions: NodeVersion[];
PublicDataReference: PublicDataReference[];
};

type DebugStreamResponse = {
present: boolean;
error: boolean;
nVersions?: number;
anchoring?: {
isAnchored: boolean;
timeLeft: number;
};
raw?:
| RawStream
| {
err: string;
status: number;
body: unknown;
msg: string;
cause: Error;
stack: string;
};
};

/** Get stream state response, or an error object */
const debugStream = async (
stream?: string
) => {
const debugStream = async (stream?: string): Promise<DebugStreamResponse> => {
if (!stream) return { present: false, error: false };
const raw = await directStreamLookup(stream);

if ("err" in raw) {
if ('err' in raw) {
return { present: true, error: true, raw };
};
}

const isAnchored = raw.state.anchorStatus === "ANCHORED";
const lastCommitIx = raw.state.log.findLastIndex(l => l.expirationTime);
const isAnchored = raw.state.anchorStatus === 'ANCHORED';
const lastCommitIx = raw.state.log.findLastIndex((l) => l.expirationTime);
const lastCommit = raw.state.log[lastCommitIx];
const tailAnchor = raw.state.log
.slice(lastCommitIx)
.findLast(l => l.type === 2);
const tailAnchor = raw.state.log.slice(lastCommitIx).findLast((l) => l.type === 2);
const timeNow = Math.floor(new Date().getTime() / 1000);
const timeLeft = isAnchored
? lastCommit.expirationTime - tailAnchor.timestamp
: lastCommit.expirationTime - timeNow;
const timeLeft = isAnchored ? lastCommit.expirationTime - tailAnchor.timestamp : lastCommit.expirationTime - timeNow;

const anchoring = {
isAnchored,
timeLeft
timeLeft,
};

// Excluding anchor events
const versions = raw.state.log.filter(l => l.type !== 2);
const versions = raw.state.log.filter((l) => l.type !== 2);

return {
present: true,
Expand All @@ -224,53 +224,80 @@ const debugDpid = async (dpid?: number) => {
} catch (e) {
const err = e as Error;
return { present: true, error: true, name: err.name, msg: err.message, stack: err.stack };
};
}

if (!mappedStream) {
return { present: true, error: true, mappedStream: null };
};
}

return { present: true, error: false, mappedStream };
};

const debugIndexer = async (
uuid: string,
shouldExist: boolean
) => {
/*
* Checks if the theres a signature signer mismatch between the legacy contract RO and the stream
*/
const debugMigration = async (uuid?: string, stream?: DebugStreamResponse) => {
// Establish if there is a token history
const legacyHistory = await _getIndexedResearchObjects([uuid]);
const legacyHistoryPresent = !!legacyHistory?.researchObjects?.length;

if (!legacyHistoryPresent || !stream.present)
return { legacyHistory: legacyHistoryPresent, streamHistory: stream.present };

const streamController =
stream.present && 'state' in stream.raw ? stream.raw.state.metadata.controllers[0].split(':').pop() : undefined;
const legacyOwner = legacyHistory.researchObjects[0].owner;

// Stream Controller === Legacy Contract RO Owner Check
const ownerMatches = streamController?.toLowerCase() === legacyOwner?.toLowerCase();

// All Versions Migrated check
const { researchObjects: streamResearchObjects } = await getIndexedResearchObjects([uuid]);
const streamManifestCidsMap = streamResearchObjects[0].versions.reduce((cids, v) => ({ ...cids, [v.cid]: true }), {});
const streamContainsAllLegacyManifestCids = legacyHistory.researchObjects[0].versions.every(
(v) => streamManifestCidsMap[v.cid],
);

return {
legacyHistory: true,
streamHistory: !!streamController,
ownerMatches,
allVersionsMigrated: streamContainsAllLegacyManifestCids,
};
};

const debugIndexer = async (uuid: string, shouldExist: boolean) => {
let indexResult: { researchObjects: IndexedResearchObject[] };
try {
indexResult = await getIndexedResearchObjects([uuid]);
} catch (e) {
const err = e as Error;
return { error: true, name: err.name, msg: err.message, stack: err.stack };
};
}

const result = indexResult.researchObjects[0];
if (!result) {
return { error: shouldExist, result: null };
};
}

return { error: false, nVersions: result.versions.length, result };
};

const debugDb = async (
node: NodeDbClosure
) => {
const debugDb = async (node: NodeDbClosure) => {
try {
const publishedVersions = node.versions
.filter(nv => nv.transactionId !== null || nv.commitId !== null);
const publishedVersions = node.versions.filter((nv) => nv.transactionId !== null || nv.commitId !== null);
const nVersions = publishedVersions.length;

const pubRefManifests = node.PublicDataReference
.filter(pdr => pdr.type == DataType.MANIFEST)
.map(pdr => pdr.cid);
const pubRefManifests = node.PublicDataReference.filter((pdr) => pdr.type == DataType.MANIFEST).map(
(pdr) => pdr.cid,
);

const publicManifests = publishedVersions.map(v => ({
const publicManifests = publishedVersions.map((v) => ({
cid: v.manifestUrl,
hasPdr: pubRefManifests.includes(v.manifestUrl)
hasPdr: pubRefManifests.includes(v.manifestUrl),
}));

const missingManifestPubRefs = publicManifests.some(m => !m.hasPdr);
const missingManifestPubRefs = publicManifests.some((m) => !m.hasPdr);

return {
error: missingManifestPubRefs,
Expand Down