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

Fixed the issue where flags that require special handling were being overwritten. #2613

Merged
merged 5 commits into from
Dec 2, 2024
Merged

Fixed the issue where flags that require special handling were being overwritten. #2613

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ea8fa50
When the `primary-network-endpoint` flag exists, it will report an "I…
yoozo Nov 29, 2024
63c52fc
changlog
yoozo Nov 29, 2024
d59293f
some Improve
yoozo Dec 2, 2024
651cc70
change log
yoozo Dec 2, 2024
c87544a
Fix the use of an invalid CID in unit test
yoozo Dec 2, 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
3 changes: 3 additions & 0 deletions packages/node-core/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

### Fixed
- When the `primary-network-endpoint` flag exists, it will report an "Invalid endpoint" error.(#2612)
yoozo marked this conversation as resolved.
Show resolved Hide resolved

## [15.0.3] - 2024-11-26
### Fixed
- Workers crashing because of lazy monitor write (#2607)
Expand Down
2 changes: 2 additions & 0 deletions packages/node-core/src/configure/configure.module.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,9 @@ describe('Configure', () => {
const option = {headers: {'api-key': '<your-api-key>'}};
const {primaryNetworkEndpoint} = yargsToIConfig({
'primary-network-endpoint': 'https://example.com',
primaryNetworkEndpoint: 'https://example.com',
Copy link
Collaborator

Choose a reason for hiding this comment

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

I don't think this is a sufficient test. The issue was the snake case being overwritten not support for snakeCase

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

The fields we get from yargs will include both snake_case and camelCase.

'primary-network-endpoint-config': JSON.stringify(option),
primaryNetworkEndpointConfig: JSON.stringify(option),
});

expect(primaryNetworkEndpoint).toEqual(['https://example.com', option]);
Expand Down
16 changes: 10 additions & 6 deletions packages/node-core/src/configure/configure.module.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ export function yargsToIConfig(yargs: Args, nameMapping: Record<string, string>
return Object.entries(yargs).reduce((acc, [key, value]) => {
if (['_', '$0'].includes(key)) return acc;

if (key === 'network-registry') {
if (isMatchFlag(key, ['network-registry'])) {
Copy link
Collaborator

Choose a reason for hiding this comment

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

This fix is prone to the same error occuring again. If another flag is added and there is now implicit behaviour as to what this does the same issue could be introduced again with another flag.

I think it would be better to not compare using key and instead use the modified key (nameMapping[key] ?? camelCase(key))

try {
value = JSON.parse(value as string);
} catch (e) {
Expand All @@ -61,7 +61,7 @@ export function yargsToIConfig(yargs: Args, nameMapping: Record<string, string>
}

// Merge network endpoints and possible endpoint configs
if (key === 'network-endpoint') {
if (isMatchFlag(key, ['network-endpoint'])) {
const endpointConfig = processEndpointConfig(yargs['network-endpoint-config']);
if (typeof value === 'string') {
value = [value];
Expand All @@ -76,16 +76,16 @@ export function yargsToIConfig(yargs: Args, nameMapping: Record<string, string>
);
}
}
if (key === 'primary-network-endpoint') {
if (isMatchFlag(key, ['primary-network-endpoint'])) {
const endpointConfig = processEndpointConfig(yargs['primary-network-endpoint-config']);
value = [value, endpointConfig[0] ?? {}];
}
if (['network-endpoint-config', 'primary-network-endpoint-config'].includes(key)) return acc;
if (isMatchFlag(key, ['network-endpoint-config', 'primary-network-endpoint-config'])) return acc;

if (key === 'disable-historical' && value) {
if (isMatchFlag(key, ['disable-historical']) && value) {
acc.historical = false;
}
if (key === 'historical' && value === 'false') {
if (isMatchFlag(key, ['historical']) && value === 'false') {
value = false;
}

Expand All @@ -94,6 +94,10 @@ export function yargsToIConfig(yargs: Args, nameMapping: Record<string, string>
}, {} as any);
}

function isMatchFlag(key: string, targets: string[]): boolean {
return targets.some((target) => key === target || key === camelCase(target));
}

function warnDeprecations(argv: Args) {
if (argv['subquery-name']) {
logger.warn('Note that argument --subquery-name has been deprecated in favour of --db-schema');
Expand Down
3 changes: 3 additions & 0 deletions packages/node/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

### Fixed
- When the `primary-network-endpoint` flag exists, it will report an "Invalid endpoint" error.(#2612)

## [5.4.2] - 2024-11-26
### Fixed
- Not using grouped events (#2607)
Expand Down
Loading