-
Notifications
You must be signed in to change notification settings - Fork 281
Making id and name length configrable so that id and name can be set larger than 128 and 256 respectively #200
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.
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
Changes from 2 commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
4e8b7e1
Making id and name length configrable so that id and name can be set …
b2c9967
Fixing spotless failure
e7bf5a0
Fixing build failure
629c235
Moving ValidationLimits.java from models and injecting it
364a51d
No change in application.yml
291f7e1
Adding spotless fix
c360a81
Using MaestroNameConstraint for both size check as well as pattern ch…
759623f
Revert "Using MaestroNameConstraint for both size check as well as pa…
ffca2a4
Changing name for some classes and variables
54b1338
Merge branch 'main' into id-config
jakhani ccb26bd
Fix spotless formatting
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
51 changes: 51 additions & 0 deletions
51
maestro-common/src/main/java/com/netflix/maestro/models/ValidationLimits.java
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 |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| /* | ||
| * Copyright 2024 Netflix, Inc. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with | ||
| * the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on | ||
| * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations under the License. | ||
| */ | ||
| package com.netflix.maestro.models; | ||
|
|
||
| /** | ||
| * Static holder for configurable validation limits. Validators in maestro-common read from here | ||
| * instead of directly from {@link Constants}. At startup, the Spring layer calls {@link | ||
| * #initialize} to override the defaults with values from application config. | ||
| */ | ||
| public final class ValidationLimits { | ||
| private ValidationLimits() {} | ||
|
|
||
| private static volatile int idLengthLimit = Constants.ID_LENGTH_LIMIT; | ||
| private static volatile int nameLengthLimit = Constants.NAME_LENGTH_LIMIT; | ||
|
|
||
| /** Returns the current ID length limit used by validators. */ | ||
| public static int getIdLengthLimit() { | ||
| return idLengthLimit; | ||
| } | ||
|
|
||
| /** Returns the current name length limit used by validators. */ | ||
| public static int getNameLengthLimit() { | ||
| return nameLengthLimit; | ||
| } | ||
|
|
||
| /** | ||
| * Overrides the default limits. Called once at application startup by the Spring configuration | ||
| * layer. Values must be positive integers. | ||
| */ | ||
| public static void initialize(int idLimit, int nameLimit) { | ||
| if (idLimit <= 0 || nameLimit <= 0) { | ||
| throw new IllegalArgumentException( | ||
| "Validation limits must be positive: idLengthLimit=" | ||
| + idLimit | ||
| + ", nameLengthLimit=" | ||
| + nameLimit); | ||
| } | ||
| idLengthLimit = idLimit; | ||
| nameLengthLimit = nameLimit; | ||
| } | ||
| } | ||
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
72 changes: 72 additions & 0 deletions
72
maestro-common/src/main/java/com/netflix/maestro/validations/MaestroNameSizeConstraint.java
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 |
|---|---|---|
| @@ -0,0 +1,72 @@ | ||
| /* | ||
| * Copyright 2024 Netflix, Inc. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with | ||
| * the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on | ||
| * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations under the License. | ||
| */ | ||
| package com.netflix.maestro.validations; | ||
|
|
||
| import com.netflix.maestro.models.ValidationLimits; | ||
| import jakarta.validation.Constraint; | ||
| import jakarta.validation.ConstraintValidator; | ||
| import jakarta.validation.ConstraintValidatorContext; | ||
| import jakarta.validation.Payload; | ||
| import java.lang.annotation.Documented; | ||
| import java.lang.annotation.ElementType; | ||
| import java.lang.annotation.Retention; | ||
| import java.lang.annotation.RetentionPolicy; | ||
| import java.lang.annotation.Target; | ||
|
|
||
| /** | ||
| * Validates that a name field does not exceed the configurable name length limit. Unlike {@link | ||
| * MaestroNameConstraint}, this annotation only enforces length and does not apply regex or reserved | ||
| * prefix/suffix checks. It is null-safe (null is treated as absent and passes). It replaces | ||
| * {@code @Size(max = Constants.NAME_LENGTH_LIMIT)} on optional model name fields where the limit | ||
| * must be configurable at runtime. | ||
| */ | ||
| @Documented | ||
| @Constraint(validatedBy = MaestroNameSizeConstraint.MaestroNameSizeValidator.class) | ||
| @Target({ElementType.FIELD}) | ||
| @Retention(RetentionPolicy.RUNTIME) | ||
| public @interface MaestroNameSizeConstraint { | ||
| /** input constraint message. */ | ||
| String message() default ""; | ||
|
|
||
| /** input constraint groups. */ | ||
| Class<?>[] groups() default {}; | ||
|
|
||
| /** input constraint payload. */ | ||
| Class<? extends Payload>[] payload() default {}; | ||
|
|
||
| /** Validates that the string length does not exceed the name length limit. */ | ||
| class MaestroNameSizeValidator implements ConstraintValidator<MaestroNameSizeConstraint, String> { | ||
|
|
||
| @Override | ||
| public void initialize(MaestroNameSizeConstraint constraint) {} | ||
|
|
||
| @Override | ||
| public boolean isValid(String value, ConstraintValidatorContext context) { | ||
| if (value == null) { | ||
| return true; // null means absent; use @NotNull separately if the field is required | ||
| } | ||
| int limit = ValidationLimits.getNameLengthLimit(); | ||
| if (value.length() > limit) { | ||
| context | ||
| .buildConstraintViolationWithTemplate( | ||
| String.format( | ||
| "[maestro name] cannot be more than name length limit %s" | ||
| + " - rejected length is [%s] for value [%s]", | ||
| limit, value.length(), value)) | ||
| .addConstraintViolation(); | ||
| return false; | ||
| } | ||
| return true; | ||
| } | ||
| } | ||
| } |
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
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.
Uh oh!
There was an error while loading. Please reload this page.