This repository has been archived by the owner on Apr 26, 2024. It is now read-only.
Interactive discovery #123
There are no files selected for viewing
This file contains 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 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 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 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 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 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 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 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
|
There was a problem hiding this comment. Can be easily tested |
This file contains 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 |
|---|---|---|
| @@ -0,0 +1,153 @@ | ||
| import { ContractParameters, DiscoveryOutput } from '@l2beat/discovery-types' | ||
| import { assign, parse, stringify } from 'comment-json' | ||
| import * as fs from 'fs/promises' | ||
|
|
||
| import { ContractOverrides } from './DiscoveryOverrides' | ||
| import { | ||
| MutableDiscoveryOverrides, | ||
| MutableOverride, | ||
| } from './MutableDiscoveryOverrides' | ||
| import { RawDiscoveryConfig } from './RawDiscoveryConfig' | ||
|
|
||
| export class DiscoveryOverridesBuilder { | ||
| private readonly mutableOverrides: MutableDiscoveryOverrides | ||
|
|
||
| constructor( | ||
| private readonly output: DiscoveryOutput, | ||
| private readonly rawConfigWithComments: RawDiscoveryConfig, | ||
| ) { | ||
| this.mutableOverrides = new MutableDiscoveryOverrides( | ||
| this.rawConfigWithComments, | ||
| ) | ||
| } | ||
|
|
||
| getContracts(): ContractParameters[] { | ||
| return [...this.output.contracts] | ||
|
There was a problem hiding this comment. Why do we need to spread it and later create a new array if the |
||
| } | ||
|
|
||
| getWatchMode(contract: ContractParameters): string[] { | ||
| const isDiscoveryIgnored = this.getIgnoreDiscovery(contract) | ||
|
|
||
| if (isDiscoveryIgnored) { | ||
| return [] | ||
| } | ||
|
|
||
| const overrides = this.getSafeOverride(contract) | ||
|
|
||
| const ignoredInWatchMode = overrides?.ignoreInWatchMode ?? [] | ||
|
|
||
| return ignoredInWatchMode | ||
| } | ||
|
|
||
| getIgnoredRelatives(contract: ContractParameters): string[] { | ||
| const overrides = this.getSafeOverride(contract) | ||
|
|
||
| const ignoredRelatives = overrides?.ignoreRelatives ?? [] | ||
|
|
||
| return ignoredRelatives | ||
| } | ||
|
|
||
| getIgnoredMethods(contract: ContractParameters): string[] { | ||
| const overrides = this.getSafeOverride(contract) | ||
| const ignoredMethods = overrides?.ignoreMethods ?? [] | ||
|
|
||
| return ignoredMethods | ||
| } | ||
|
|
||
| getIgnoreDiscovery(contract: ContractParameters): boolean { | ||
| const overrides = this.getSafeOverride(contract) | ||
|
|
||
| return overrides?.ignoreDiscovery ?? false | ||
| } | ||
|
|
||
| setOverride(contract: ContractParameters, override: MutableOverride): void { | ||
| // Optimistically set overrides | ||
| this.mutableOverrides.set(contract, override) | ||
|
|
||
| const isDiscoveryIgnored = this.getIgnoreDiscovery(contract) | ||
| const ignoredInWatchMode = this.getWatchMode(contract) | ||
| const ignoredMethods = this.getIgnoredMethods(contract) | ||
| const ignoredRelatives = this.getIgnoredRelatives(contract) | ||
|
|
||
| // Wipe all overrides if discovery is ignored | ||
| if (isDiscoveryIgnored) { | ||
| this.mutableOverrides.set(contract, { | ||
| ignoreDiscovery: true, | ||
| ignoreInWatchMode: [], | ||
| ignoreMethods: [], | ||
| ignoreRelatives: [], | ||
| }) | ||
| return | ||
| } | ||
|
|
||
| // Exclude ignoreMethods from watch mode and relatives completely | ||
| const validWatchMode = ignoredInWatchMode.filter( | ||
| (method) => !ignoredMethods.includes(method), | ||
| ) | ||
|
|
||
| const validRelatives = ignoredRelatives.filter( | ||
| (method) => !ignoredMethods.includes(method), | ||
| ) | ||
|
|
||
| this.mutableOverrides.set(contract, { | ||
| ignoreInWatchMode: validWatchMode, | ||
| ignoreRelatives: validRelatives, | ||
| }) | ||
| } | ||
|
|
||
| /** | ||
| * Do not replace whole file, just read most-recent raw, replace and save overrides | ||
| */ | ||
| async flushOverrides(): Promise<void> { | ||
| const path = `discovery/${this.output.name}/${this.output.chain}/config.jsonc` | ||
|
There was a problem hiding this comment. Why are we not using |
||
|
|
||
| const fileContents = await fs.readFile(path, 'utf8') | ||
|
|
||
| const parsed = parse(fileContents) as RawDiscoveryConfig | null | ||
|
|
||
| if (this.mutableOverrides.config.overrides) { | ||
| assign(parsed, { overrides: this.mutableOverrides.config.overrides }) | ||
| } | ||
|
|
||
| if (this.mutableOverrides.config.names) { | ||
| assign(parsed, { names: this.mutableOverrides.config.names }) | ||
| } | ||
|
|
||
| await fs.writeFile(path, stringify(parsed, null, 2)) | ||
| } | ||
|
|
||
| private getOverrideIdentity(contract: ContractParameters): string { | ||
| const hasName = Boolean( | ||
| this.mutableOverrides.config.names?.[contract.address.toString()], | ||
| ) | ||
|
|
||
| if (hasName) { | ||
| return contract.name | ||
| } | ||
|
|
||
| return contract.address.toString() | ||
| } | ||
|
|
||
| private getSafeOverride( | ||
| contract: ContractParameters, | ||
| ): ContractOverrides | null { | ||
| const addressOrName = this.getOverrideIdentity(contract) | ||
|
|
||
| try { | ||
| return this.mutableOverrides.get(addressOrName) | ||
| } catch { | ||
| return null | ||
| } | ||
| } | ||
|
|
||
| public isCustomHandler( | ||
| contract: ContractParameters, | ||
| property: string, | ||
| ): boolean { | ||
| const addressOrName = this.getOverrideIdentity(contract) | ||
|
|
||
| return Object.keys( | ||
| this.mutableOverrides.get(addressOrName).fields ?? {}, | ||
| ).includes(property) | ||
| } | ||
| } | ||
Oops, something went wrong.
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.
We already import
jsonc-parser, either don't usecomment-jsonor replacejsonc-parserwith it