Skip to content

feat: restrict service creation by characters and length #6585

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
merged 15 commits into from
Mar 11, 2025
Merged

feat: restrict service creation by characters and length #6585

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
5d3bbef
feat: restrict service creation by characters and length
jdolle Mar 5, 2025
6e71690
Allow 1 character service names
jdolle Mar 6, 2025
b7c1ec1
Add slash to error message
jdolle Mar 6, 2025
2b17d4f
Fix checking if the service is already pushed
jdolle Mar 6, 2025
16ab676
Merge branch 'main' into console-655
jdolle Mar 6, 2025
b735d62
Add service name validation on schema check
jdolle Mar 6, 2025
fdafc38
Remove extra comma
jdolle Mar 6, 2025
8ef9e75
Add changelog
jdolle Mar 6, 2025
7604c80
Fix typecheck
jdolle Mar 6, 2025
25164bd
Merge branch 'main' into console-655
jdolle Mar 7, 2025
807e398
Add integration tests
jdolle Mar 7, 2025
b083461
Merge branch 'main' into console-655
jdolle Mar 10, 2025
a2ec63d
Remove / from list of valid service name characters
jdolle Mar 10, 2025
8b17f30
Update error message and snapshots
jdolle Mar 10, 2025
2e46942
Format
jdolle Mar 10, 2025
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
6 changes: 6 additions & 0 deletions .changeset/rotten-scissors-matter.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
'hive': patch
'@graphql-hive/cli': patch
---

Restrict new service names to 64 characters, alphanumberic, \_, -, and /
237 changes: 237 additions & 0 deletions integration-tests/tests/cli/__snapshots__/schema.spec.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,85 @@ stdout--------------------------------------------:
ℹ Available at http://__URL__
`;

exports[`FEDERATION > check validates the service name > onlyNumbers 1`] = `
:::::::::::::::: CLI FAILURE OUTPUT :::::::::::::::
exitCode------------------------------------------:
1
stderr--------------------------------------------:
__NONE__
stdout--------------------------------------------:
✖ Detected 1 error

- Invalid service name. Service name must be 64 characters or less, must start with a letter, and can only contain alphanumeric characters, dash (-), or underscore (_).


`;

exports[`FEDERATION > check validates the service name > specialCharacters 1`] = `
:::::::::::::::: CLI FAILURE OUTPUT :::::::::::::::
exitCode------------------------------------------:
1
stderr--------------------------------------------:
__NONE__
stdout--------------------------------------------:
✖ Detected 1 error

- Invalid service name. Service name must be 64 characters or less, must start with a letter, and can only contain alphanumeric characters, dash (-), or underscore (_).


`;

exports[`FEDERATION > check validates the service name > success 1`] = `
:::::::::::::::: CLI SUCCESS OUTPUT :::::::::::::::::

stdout--------------------------------------------:
✔ Schema registry is empty, nothing to compare your schema with.
View full report:
http://__URL__
`;

exports[`FEDERATION > publish validates the service name > onlyNumbers 1`] = `
:::::::::::::::: CLI FAILURE OUTPUT :::::::::::::::
exitCode------------------------------------------:
2
stderr--------------------------------------------:
› Error: Schema publish failed. [300]
› > See https://__URL__ for
› a complete list of error codes and recommended fixes.
› To disable this message set HIVE_NO_ERROR_TIP=1
stdout--------------------------------------------:
✖ Detected 1 error

- Invalid service name. Service name must be 64 characters or less, must start with a letter, and can only contain alphanumeric characters, dash (-), or underscore (_).


`;

exports[`FEDERATION > publish validates the service name > specialCharacters 1`] = `
:::::::::::::::: CLI FAILURE OUTPUT :::::::::::::::
exitCode------------------------------------------:
2
stderr--------------------------------------------:
› Error: Schema publish failed. [300]
› > See https://__URL__ for
› a complete list of error codes and recommended fixes.
› To disable this message set HIVE_NO_ERROR_TIP=1
stdout--------------------------------------------:
✖ Detected 1 error

- Invalid service name. Service name must be 64 characters or less, must start with a letter, and can only contain alphanumeric characters, dash (-), or underscore (_).


`;

exports[`FEDERATION > publish validates the service name > success 1`] = `
:::::::::::::::: CLI SUCCESS OUTPUT :::::::::::::::::

stdout--------------------------------------------:
✔ Published initial schema.
ℹ Available at http://__URL__
`;

exports[`FEDERATION > publishing invalid schema SDL provides meaningful feedback for the user. > schemaPublish 1`] = `
:::::::::::::::: CLI FAILURE OUTPUT :::::::::::::::
exitCode------------------------------------------:
Expand Down Expand Up @@ -256,6 +335,85 @@ stdout--------------------------------------------:
ℹ Available at http://__URL__
`;

exports[`SINGLE > check validates the service name > onlyNumbers 1`] = `
:::::::::::::::: CLI FAILURE OUTPUT :::::::::::::::
exitCode------------------------------------------:
1
stderr--------------------------------------------:
__NONE__
stdout--------------------------------------------:
✖ Detected 1 error

- Invalid service name. Service name must be 64 characters or less, must start with a letter, and can only contain alphanumeric characters, dash (-), underscore (_), or forward slash (/).


`;

exports[`SINGLE > check validates the service name > specialCharacters 1`] = `
:::::::::::::::: CLI FAILURE OUTPUT :::::::::::::::
exitCode------------------------------------------:
1
stderr--------------------------------------------:
__NONE__
stdout--------------------------------------------:
✖ Detected 1 error

- Invalid service name. Service name must be 64 characters or less, must start with a letter, and can only contain alphanumeric characters, dash (-), underscore (_), or forward slash (/).


`;

exports[`SINGLE > check validates the service name > success 1`] = `
:::::::::::::::: CLI SUCCESS OUTPUT :::::::::::::::::

stdout--------------------------------------------:
✔ Schema registry is empty, nothing to compare your schema with.
View full report:
http://__URL__
`;

exports[`SINGLE > publish validates the service name > onlyNumbers 1`] = `
:::::::::::::::: CLI FAILURE OUTPUT :::::::::::::::
exitCode------------------------------------------:
2
stderr--------------------------------------------:
› Error: Schema publish failed. [300]
› > See https://__URL__ for
› a complete list of error codes and recommended fixes.
› To disable this message set HIVE_NO_ERROR_TIP=1
stdout--------------------------------------------:
✖ Detected 1 error

- Invalid service name. Service name must be 64 characters or less, must start with a letter, and can only contain alphanumeric characters, dash (-), underscore (_), or forward slash (/).


`;

exports[`SINGLE > publish validates the service name > specialCharacters 1`] = `
:::::::::::::::: CLI FAILURE OUTPUT :::::::::::::::
exitCode------------------------------------------:
2
stderr--------------------------------------------:
› Error: Schema publish failed. [300]
› > See https://__URL__ for
› a complete list of error codes and recommended fixes.
› To disable this message set HIVE_NO_ERROR_TIP=1
stdout--------------------------------------------:
✖ Detected 1 error

- Invalid service name. Service name must be 64 characters or less, must start with a letter, and can only contain alphanumeric characters, dash (-), underscore (_), or forward slash (/).


`;

exports[`SINGLE > publish validates the service name > success 1`] = `
:::::::::::::::: CLI SUCCESS OUTPUT :::::::::::::::::

stdout--------------------------------------------:
✔ Published initial schema.
ℹ Available at http://__URL__
`;

exports[`SINGLE > publishing invalid schema SDL provides meaningful feedback for the user. > schemaPublish 1`] = `
:::::::::::::::: CLI FAILURE OUTPUT :::::::::::::::
exitCode------------------------------------------:
Expand Down Expand Up @@ -442,6 +600,85 @@ stdout--------------------------------------------:
ℹ Available at http://__URL__
`;

exports[`STITCHING > check validates the service name > onlyNumbers 1`] = `
:::::::::::::::: CLI FAILURE OUTPUT :::::::::::::::
exitCode------------------------------------------:
1
stderr--------------------------------------------:
__NONE__
stdout--------------------------------------------:
✖ Detected 1 error

- Invalid service name. Service name must be 64 characters or less, must start with a letter, and can only contain alphanumeric characters, dash (-), or underscore (_).


`;

exports[`STITCHING > check validates the service name > specialCharacters 1`] = `
:::::::::::::::: CLI FAILURE OUTPUT :::::::::::::::
exitCode------------------------------------------:
1
stderr--------------------------------------------:
__NONE__
stdout--------------------------------------------:
✖ Detected 1 error

- Invalid service name. Service name must be 64 characters or less, must start with a letter, and can only contain alphanumeric characters, dash (-), or underscore (_).


`;

exports[`STITCHING > check validates the service name > success 1`] = `
:::::::::::::::: CLI SUCCESS OUTPUT :::::::::::::::::

stdout--------------------------------------------:
✔ Schema registry is empty, nothing to compare your schema with.
View full report:
http://__URL__
`;

exports[`STITCHING > publish validates the service name > onlyNumbers 1`] = `
:::::::::::::::: CLI FAILURE OUTPUT :::::::::::::::
exitCode------------------------------------------:
2
stderr--------------------------------------------:
› Error: Schema publish failed. [300]
› > See https://__URL__ for
› a complete list of error codes and recommended fixes.
› To disable this message set HIVE_NO_ERROR_TIP=1
stdout--------------------------------------------:
✖ Detected 1 error

- Invalid service name. Service name must be 64 characters or less, must start with a letter, and can only contain alphanumeric characters, dash (-), or underscore (_).


`;

exports[`STITCHING > publish validates the service name > specialCharacters 1`] = `
:::::::::::::::: CLI FAILURE OUTPUT :::::::::::::::
exitCode------------------------------------------:
2
stderr--------------------------------------------:
› Error: Schema publish failed. [300]
› > See https://__URL__ for
› a complete list of error codes and recommended fixes.
› To disable this message set HIVE_NO_ERROR_TIP=1
stdout--------------------------------------------:
✖ Detected 1 error

- Invalid service name. Service name must be 64 characters or less, must start with a letter, and can only contain alphanumeric characters, dash (-), or underscore (_).


`;

exports[`STITCHING > publish validates the service name > success 1`] = `
:::::::::::::::: CLI SUCCESS OUTPUT :::::::::::::::::

stdout--------------------------------------------:
✔ Published initial schema.
ℹ Available at http://__URL__
`;

exports[`STITCHING > publishing invalid schema SDL provides meaningful feedback for the user. > schemaPublish 1`] = `
:::::::::::::::: CLI FAILURE OUTPUT :::::::::::::::
exitCode------------------------------------------:
Expand Down
107 changes: 107 additions & 0 deletions integration-tests/tests/cli/schema.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,113 @@ describe.each([ProjectType.Stitching, ProjectType.Federation, ProjectType.Single
},
);

test
.skipIf(projectType === ProjectType.Single)
.concurrent('publish validates the service name', async ({ expect }) => {
const { createOrg } = await initSeed().createOwner();
const { inviteAndJoinMember, createProject } = await createOrg();
await inviteAndJoinMember();
const { createTargetAccessToken } = await createProject(projectType);
const { secret } = await createTargetAccessToken({});

await expect(
schemaPublish([
'--registry.accessToken',
secret,
'--author',
'Kamil',
'--commit',
'abc123',
'--service',
'900',
...serviceUrlArgs,
'fixtures/init-schema.graphql',
]),
).rejects.toMatchSnapshot('onlyNumbers');

await expect(
schemaPublish([
'--registry.accessToken',
secret,
'--author',
'Kamil',
'--commit',
'abc123',
'--service',
'asdf$#%^#@!#',
...serviceUrlArgs,
'fixtures/init-schema.graphql',
]),
).rejects.toMatchSnapshot('specialCharacters');

await expect(
schemaPublish([
'--registry.accessToken',
secret,
'--author',
'Kamil',
'--commit',
'abc123',
'--service',
'valid-name0',
...serviceUrlArgs,
'fixtures/init-schema.graphql',
]),
).resolves.toMatchSnapshot('success');
});

test
.skipIf(projectType === ProjectType.Single)
.concurrent('check validates the service name', async ({ expect }) => {
const { createOrg } = await initSeed().createOwner();
const { inviteAndJoinMember, createProject } = await createOrg();
await inviteAndJoinMember();
const { createTargetAccessToken } = await createProject(projectType);
const { secret } = await createTargetAccessToken({});

await expect(
schemaCheck([
'--registry.accessToken',
secret,
'--author',
'Kamil',
'--commit',
'abc123',
'--service',
'900',
'fixtures/init-schema.graphql',
]),
).rejects.toMatchSnapshot('onlyNumbers');

await expect(
schemaCheck([
'--registry.accessToken',
secret,
'--author',
'Kamil',
'--commit',
'abc123',
'--service',
'asdf$#%^#@!#',
'fixtures/init-schema.graphql',
]),
).rejects.toMatchSnapshot('specialCharacters');

await expect(
schemaCheck([
'--registry.accessToken',
secret,
'--author',
'Kamil',
'--commit',
'abc123',
'--service',
'valid-name0',
'fixtures/init-schema.graphql',
]),
).resolves.toMatchSnapshot('success');
});

test.concurrent(
'publishing invalid schema SDL provides meaningful feedback for the user.',
async ({ expect }) => {
Expand Down
2 changes: 1 addition & 1 deletion packages/services/api/src/modules/schema/providers/schema-helper.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ export function ensureSingleSchema(schema: Schema | Schema[]): SingleSchema {
throw new Error('Expected a single schema');
}

export function ensureCompositeSchemas(schemas: readonly Schema[]): CompositeSchema[] | never {
Copy link
Collaborator Author

@jdolle jdolle Mar 6, 2025

Choose a reason for hiding this comment

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

I assumed this never was because the function threw an array, but it only filters. So I'm not sure why this never is here... removed.

export function ensureCompositeSchemas(schemas: readonly Schema[]): CompositeSchema[] {
return schemas.filter(isCompositeSchema);
}

Expand Down
Loading
Loading