feat(ensindexer): extend dependecy info #1157
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -23,7 +23,6 @@ | |
| "typecheck": "tsc --noEmit" | ||
| }, | ||
| "dependencies": { | ||
| "@ensdomains/ensjs": "^4.0.2", | ||
| "@ensnode/datasources": "workspace:*", | ||
| "@ensnode/ensnode-schema": "workspace:*", | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,4 @@ | ||
| import { getVersionInfo } from "@/lib/version-info"; | ||
| import type { ENSIndexerPublicConfig } from "@ensnode/ensnode-sdk"; | ||
| import type { ENSIndexerConfig } from "./types"; | ||
|
|
||
|
|
@@ -11,7 +11,7 @@ import type { ENSIndexerConfig } from "./types"; | |
| export async function buildENSIndexerPublicConfig( | ||
| config: ENSIndexerConfig, | ||
| ): Promise<ENSIndexerPublicConfig> { | ||
| const versionInfo = await getVersionInfo(); | ||
|
|
||
| return { | ||
| databaseSchemaName: config.databaseSchemaName, | ||
|
|
@@ -22,6 +22,6 @@ export async function buildENSIndexerPublicConfig( | |
| isSubgraphCompatible: config.isSubgraphCompatible, | ||
| namespace: config.namespace, | ||
| plugins: config.plugins, | ||
| versionInfo, | ||
| }; | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -1,10 +1,10 @@ | ||||||
| import { existsSync, readFileSync, readdirSync } from "node:fs"; | ||||||
| import { dirname, join } from "node:path"; | ||||||
| import { fileURLToPath } from "node:url"; | ||||||
| import packageJson from "@/../package.json"; | ||||||
| import { getENSRainbowApiClient } from "@/lib/ensraibow-api-client"; | ||||||
| import { VersionInfo } from "@ensnode/ensnode-sdk"; | ||||||
| import { makeVersionInfoSchema } from "@ensnode/ensnode-sdk/internal"; | ||||||
| import { prettifyError } from "zod/v4"; | ||||||
|
|
||||||
| /** | ||||||
|
|
@@ -23,18 +23,23 @@ export function getPackageVersion(packageName: string) { | |||||
| let searchDir = dirname(currentFile); | ||||||
|
|
||||||
| while (true) { | ||||||
| const workspaceFile = join(searchDir, "pnpm-workspace.yaml"); | ||||||
| const isWorkspaceRoot = existsSync(workspaceFile); | ||||||
|
|
||||||
| // Check for node_modules in current directory | ||||||
| const nodeModulesPath = join(searchDir, "node_modules", packageName, "package.json"); | ||||||
| if (existsSync(nodeModulesPath)) { | ||||||
| const packageJson = JSON.parse(readFileSync(nodeModulesPath, "utf8")); | ||||||
| return packageJson.version; | ||||||
| } | ||||||
|
|
||||||
| // Check PNPM's .pnpm virtual store | ||||||
| const pnpmDir = join(searchDir, "node_modules", ".pnpm"); | ||||||
| if (existsSync(pnpmDir)) { | ||||||
| const version = searchPnpmStore(pnpmDir, packageName); | ||||||
| if (version) return version; | ||||||
| } | ||||||
|
|
||||||
| // If we're at workspace root and still haven't found it, stop searching | ||||||
| if (isWorkspaceRoot) { | ||||||
| throw new Error( | ||||||
|
|
@@ -62,18 +67,43 @@ export function getPackageVersion(packageName: string) { | |||||
| } | ||||||
|
|
||||||
| /** | ||||||
| * Search PNPM's .pnpm directory for a package | ||||||
| * PNPM stores packages like: .pnpm/@adraffy+ens-normalize@1.10.1/node_modules/@adraffy/ens-normalize | ||||||
| */ | ||||||
| function searchPnpmStore(pnpmDir: string, packageName: string): string | null { | ||||||
|
Member
There was a problem hiding this comment. It's not clear what this function returns. |
||||||
| try { | ||||||
| const entries = readdirSync(pnpmDir); | ||||||
|
|
||||||
| // Convert package name to PNPM's format: @scope/name -> @scope+name | ||||||
| const normalizedName = packageName.replace("/", "+"); | ||||||
|
|
||||||
| // Find entries that match the package name | ||||||
| // They will be in format: packagename@version or @scope+packagename@version | ||||||
| for (const entry of entries) { | ||||||
| if (entry.startsWith(normalizedName + "@")) { | ||||||
| const pkgPath = join(pnpmDir, entry, "node_modules", packageName, "package.json"); | ||||||
| if (existsSync(pkgPath)) { | ||||||
| const packageJson = JSON.parse(readFileSync(pkgPath, "utf8")); | ||||||
| return packageJson.version; | ||||||
| } | ||||||
| } | ||||||
| } | ||||||
| } catch (error) { | ||||||
| // Ignore errors in this helper | ||||||
| } | ||||||
|
|
||||||
| return null; | ||||||
| } | ||||||
|
|
||||||
| /** | ||||||
| * Get complete {@link VersionInfo} for ENSIndexer app. | ||||||
| */ | ||||||
| export async function getVersionInfo(): Promise<VersionInfo> { | ||||||
|
Member
There was a problem hiding this comment.
Suggested change
Goal: We should note how we're going to have nested "VersionInfo" objects for different apps in our overall architecture. Each app's "VersionInfo" should have a name that makes it explicit exactly which app's "VersionInfo" it is related to. |
||||||
| const ensRainbowApiClient = getENSRainbowApiClient(); | ||||||
| const { versionInfo: ensRainbowVersionInfo } = await ensRainbowApiClient.version(); | ||||||
|
|
||||||
| // ENSRainbow version (fetched from the actual ENSRainbow service instance) | ||||||
|
Member
There was a problem hiding this comment.
Suggested change
|
||||||
| const ensRainbowSchema = ensRainbowVersionInfo.dbSchemaVersion; | ||||||
|
|
||||||
| // ENSIndexer version | ||||||
| const ensIndexerVersion = packageJson.version; | ||||||
|
Member
There was a problem hiding this comment. Suggest moving the logic to get the ENSIndexer version into a separate helper function. |
||||||
|
|
@@ -84,21 +114,21 @@ export async function getDependencyInfo(): Promise<DependencyInfo> { | |||||
| // the version number of ENSIndexer | ||||||
| const ensDbVersion = ensIndexerVersion; | ||||||
|
|
||||||
| const schema = makeVersionInfoSchema(); | ||||||
| const data = { | ||||||
|
Member
There was a problem hiding this comment. Hmm. I'm not so clear on what's going on here. Are we creating what is supposed to be a Or are we just attempting to verify that the If so, then suggest to rename |
||||||
| ensRainbow: ensRainbowVersionInfo.version, | ||||||
|
Member
There was a problem hiding this comment. I believe we should be building nested schemas. In other words:
Member
Author
There was a problem hiding this comment. This update is a bit more nuanced due to a dual nature of
I'll create a ticket for the requested change so we could address it in a separate PR.
Member
Author
There was a problem hiding this comment. |
||||||
| nodejs: process.versions.node, | ||||||
| ponder: getPackageVersion("ponder"), | ||||||
| ensDb: ensDbVersion, | ||||||
| ensIndexer: ensIndexerVersion, | ||||||
| ensNormalize: getPackageVersion("@adraffy/ens-normalize"), | ||||||
| ensRainbowSchema, | ||||||
| } satisfies VersionInfo; | ||||||
|
|
||||||
| const parsed = schema.safeParse(data); | ||||||
|
|
||||||
| if (parsed.error) { | ||||||
| throw new Error(`Cannot deserialize VersionInfo:\n${prettifyError(parsed.error)}\n`); | ||||||
| } | ||||||
|
|
||||||
| return parsed.data; | ||||||
|
|
||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -29,7 +29,6 @@ | |
| "get-test-data": "DATA_VERSION=test ./download-rainbow-tables.sh" | ||
| }, | ||
| "dependencies": { | ||
| "@ensnode/ensrainbow-sdk": "workspace:*", | ||
| "@ensnode/ensnode-sdk": "workspace:*", | ||
| "@hono/node-server": "^1.4.1", | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -85,8 +85,8 @@ The response includes several important configuration categories: | |||||
| - **Feature Flags**: Boolean settings for experimental features and optional | ||||||
| functionality | ||||||
| - **Plugins**: Activated plugins | ||||||
| - **Version Information**: Node.js version, Ponder framework version, | ||||||
|
Member
There was a problem hiding this comment.
Suggested change
|
||||||
| ENSRainbow version and schema details, ENSDb version, ENSIndexer version, [ENS Normalize version](https://www.npmjs.com/package/@adraffy/ens-normalize) | ||||||
|
|
||||||
| ### Example response | ||||||
|
|
||||||
|
|
@@ -102,8 +102,12 @@ The response includes several important configuration categories: | |||||
| 42161, | ||||||
| 534352 | ||||||
| ], | ||||||
| "databaseSchemaName": "alphaSchema0.35.0", | ||||||
| "isSubgraphCompatible": false, | ||||||
| "labelSet": { | ||||||
| "labelSetId": "subgraph", | ||||||
| "labelSetVersion": 0 | ||||||
| }, | ||||||
| "namespace": "mainnet", | ||||||
| "plugins": [ | ||||||
| "subgraph", | ||||||
|
|
@@ -114,11 +118,14 @@ The response includes several important configuration categories: | |||||
| "referrals", | ||||||
| "tokenscope" | ||||||
| ], | ||||||
| "versionInfo": { | ||||||
| "nodejs": "22.18.0", | ||||||
| "ponder": "0.11.43", | ||||||
| "ensDb": "0.35.0", | ||||||
| "ensIndexer": "0.35.0", | ||||||
| "ensNormalize": "1.11.1", | ||||||
| "ensRainbow": "0.34.0", | ||||||
| "ensRainbowSchema": 3 | ||||||
| } | ||||||
| } | ||||||
| ``` | ||||||
|
|
||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -71,7 +71,7 @@ const EXAMPLE_CONFIG_RESPONSE = { | |
| PluginName.ProtocolAcceleration, | ||
| PluginName.Referrals, | ||
| ], | ||
| versionInfo: { | ||
| nodejs: "22.18.0", | ||
| ponder: "0.11.43", | ||
| ensDb: "0.32.0", | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -20,7 +20,7 @@ describe("ENSIndexer: Config", () => { | |
| isSubgraphCompatible: true, | ||
| namespace: "mainnet", | ||
| plugins: [PluginName.Subgraph], | ||
| versionInfo: { | ||
| nodejs: "v22.10.12", | ||
| ponder: "0.11.25", | ||
| ensDb: "0.32.0", | ||
|
|
@@ -64,7 +64,7 @@ describe("ENSIndexer: Config", () => { | |
| isSubgraphCompatible: true, | ||
| namespace: "mainnet", | ||
| plugins: [PluginName.Subgraph], | ||
| versionInfo: { | ||
| nodejs: "v22.10.12", | ||
| ponder: "0.11.25", | ||
| ensDb: "0.32.0", | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This "Serialization Error" case is no longer triggering a serialization error as expected.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice catch!