upcoming: [M3-9424] - Review nodebalancers validation schemas #11910

harsh-akamai · 2025-03-24T12:50:40Z

Description 📝

Update validation schemas for the changes in POST endpoints in /v4/nodebalancers (& /v4beta/nodebalancers) for NB-VPC Integration

How to test 🧪

Verification steps

Verify the changes match the APISpec linked in the parent ticket

Author Checklists

As an Author, to speed up the review process, I considered 🤔

👀 Doing a self review
❔ Our contribution guidelines
🤏 Splitting feature into small PRs
➕ Adding a changeset
🧪 Providing/improving test coverage
🔐 Removing all sensitive information from the code and PR description
🚩 Using a feature flag to protect the release
👣 Providing comprehensive reproduction steps
📑 Providing or updating our documentation
🕛 Scheduling a pair reviewing session
📱 Providing mobile support
♿ Providing accessibility support

I have read and considered all applicable items listed above.

As an Author, before moving this PR from Draft to Open, I confirmed ✅

All unit tests are passing
TypeScript compilation succeeded without errors
Code passes all linting rules

…hub.com/harsh-akamai/manager into M3-9424-review-nb-vpc-validation-schema

dwiley-akamai · 2025-03-24T15:47:07Z

packages/validation/src/vpcs.schema.ts

@@ -97,6 +97,7 @@ export const vpcsValidateIP = ({
    }

    if (isIPv6) {
+      // @todo update the IPv6 prefix if required for NB-VPC integration


Suggested change

// @todo update the IPv6 prefix if required for NB-VPC integration

// @TODO NB-VPC: update the IPv6 prefix if required for NB-VPC integration

dwiley-akamai · 2025-03-24T16:55:17Z

packages/validation/src/nodebalancers.schema.ts

+  ipv6_range: string() //TBD
+    .notRequired()
+    .nullable()
+    .matches(PRIVATE_IP_REGEX, 'Must be a valid private IPv6 address.')


IPv6 has a different format than IPv4, so an IPv6-specific regex will need to be used and we should revert the name change to the existing regex variable

dwiley-akamai · 2025-03-24T17:02:48Z

packages/validation/src/nodebalancers.schema.ts

+    .required('Subnet ID is required.'),
+  ipv4_range: string()
+    .typeError('IPv4 address is required.')
+    .required('IPv4 address is required.')


Is this the case? I would imagine it could have either an IPv4 range or IPv6 range, or both, but not neither. Assuming what I described is accurate, we could use similar logic as what was done for createSubnetSchemaWithIPv6 in vpcs.schema.ts

Sounds right. I've made changes to adapt to the logic present in createSubnetSchemaWithIPv6

dwiley-akamai · 2025-03-24T17:03:44Z

Can we also get a validation changeset?

…dpoints in /v4/nodebalancers (& /v4beta/nodebalancers) for NB-VPC Integration

dwiley-akamai · 2025-04-04T16:44:10Z

packages/validation/src/nodebalancers.schema.ts


 const PORT_WARNING = 'Port must be between 1 and 65535.';
 const LABEL_WARNING = 'Label must be between 3 and 32 characters.';

 export const PRIVATE_IPv4_REGEX = /^10\.|^172\.1[6-9]\.|^172\.2[0-9]\.|^172\.3[0-1]\.|^192\.168\.|^fd/;
+export const PRIVATE_IPv6_REGEX = /^(fc|fd)\./;


I don't think this regex will match valid IPv6 addresses. We should test the regex expressions with a tool like regex101.com to ensure it works as intended. We'll also want it to account for the mask since it's an IPv6 range

The sample IPv6 range fails the regex pattern:

It may be that a comprehensive regex for IPv6 may be challenging or too complex for our purposes, but if that is the case we should note in a comment that we're only testing the beginning letters of it rather than the entire IP.

Noted. I've made changes to the regex and I've also added a comment. Thanks for catching this 🙌

dwiley-akamai · 2025-04-04T17:06:53Z

packages/validation/src/nodebalancers.schema.ts

+    then: (schema) =>
+      schema
+        .required(IP_EITHER_BOTH_NOT_NEITHER)
+        .matches(PRIVATE_IPv4_REGEX, 'Must be a valid private IPv4 address.')


let's store the 'Must be a valid private IPv4 address.' string in a constant since we use it several times

dwiley-akamai · 2025-04-04T17:30:11Z

packages/validation/src/nodebalancers.schema.ts

+const createNodeBalancerVPCsSchema = object({
+  subnet_id: number()
+    .typeError('Subnet ID must be a number.')
+    .required('Subnet ID is required.'),
+  ipv4_range: string().when('ipv6_range', {
+    is: (value: unknown) =>
+      value === '' || value === null || value === undefined,
+    then: (schema) =>
+      schema
+        .required(IP_EITHER_BOTH_NOT_NEITHER)
+        .matches(PRIVATE_IPv4_REGEX, 'Must be a valid private IPv4 address.')
+        .test({
+          name: 'IPv4 CIDR format',
+          message: 'The IPv4 range must be in CIDR format.',
+          test: (value) =>
+            vpcsValidateIP({
+              value,
+              shouldHaveIPMask: true,
+              mustBeIPMask: false,
+            }),
+        }),
+    otherwise: (schema) =>
+      lazy((value: string | undefined) => {
+        switch (typeof value) {
+          case 'undefined':
+            return schema.notRequired().nullable();
+
+          case 'string':
+            return schema
+              .notRequired()
+              .matches(
+                PRIVATE_IPv4_REGEX,
+                'Must be a valid private IPv4 address.'
+              )
+              .test({
+                name: 'IPv4 CIDR format',
+                message: 'The IPv4 range must be in CIDR format.',
+                test: (value) =>
+                  vpcsValidateIP({
+                    value,
+                    shouldHaveIPMask: true,
+                    mustBeIPMask: false,
+                  }),
+              });
+
+          default:
+            return schema.notRequired().nullable();
+        }
+      }),
+  }),
+  ipv6_range: string().when('ipv6_range', {
+    is: (value: unknown) =>
+      value === '' || value === null || value === undefined,
+    then: (schema) =>
+      schema
+        .required(IP_EITHER_BOTH_NOT_NEITHER)
+        .matches(PRIVATE_IPv6_REGEX, 'Must be a valid private IPv6 address.')
+        .test({
+          name: 'valid-ipv6-range',
+          message: 'Must be a valid IPv6 range, e.g. 2001:db8:abcd:0012::0/64.',
+          test: (value) =>
+            vpcsValidateIP({
+              value,
+              shouldHaveIPMask: true,
+              mustBeIPMask: false,
+            }),
+        }),
+  }),
+});


Right now, Cloud Manager doesn't load and we get the following console error:

Suggested change

const createNodeBalancerVPCsSchema = object({

subnet_id: number()

.typeError('Subnet ID must be a number.')

.required('Subnet ID is required.'),

ipv4_range: string().when('ipv6_range', {

is: (value: unknown) =>

value === '' || value === null || value === undefined,

then: (schema) =>

schema

.required(IP_EITHER_BOTH_NOT_NEITHER)

.matches(PRIVATE_IPv4_REGEX, 'Must be a valid private IPv4 address.')

.test({

name: 'IPv4 CIDR format',

message: 'The IPv4 range must be in CIDR format.',

test: (value) =>

vpcsValidateIP({

value,

shouldHaveIPMask: true,

mustBeIPMask: false,

}),

}),

otherwise: (schema) =>

lazy((value: string | undefined) => {

switch (typeof value) {

case 'undefined':

return schema.notRequired().nullable();

case 'string':

return schema

.notRequired()

.matches(

PRIVATE_IPv4_REGEX,

'Must be a valid private IPv4 address.'

)

.test({

name: 'IPv4 CIDR format',

message: 'The IPv4 range must be in CIDR format.',

test: (value) =>

vpcsValidateIP({

value,

shouldHaveIPMask: true,

mustBeIPMask: false,

}),

});

default:

return schema.notRequired().nullable();

}

}),

}),

ipv6_range: string().when('ipv6_range', {

is: (value: unknown) =>

value === '' || value === null || value === undefined,

then: (schema) =>

schema

.required(IP_EITHER_BOTH_NOT_NEITHER)

.matches(PRIVATE_IPv6_REGEX, 'Must be a valid private IPv6 address.')

.test({

name: 'valid-ipv6-range',

message: 'Must be a valid IPv6 range, e.g. 2001:db8:abcd:0012::0/64.',

test: (value) =>

vpcsValidateIP({

value,

shouldHaveIPMask: true,

mustBeIPMask: false,

}),

}),

}),

});

const createNodeBalancerVPCsSchema = object().shape(

{

subnet_id: number()

.typeError('Subnet ID must be a number.')

.required('Subnet ID is required.'),

ipv4_range: string().when('ipv6_range', {

is: (value: unknown) =>

value === '' || value === null || value === undefined,

then: (schema) =>

schema

.required(IP_EITHER_BOTH_NOT_NEITHER)

.matches(PRIVATE_IPv4_REGEX, 'Must be a valid private IPv4 address.')

.test({

name: 'IPv4 CIDR format',

message: 'The IPv4 range must be in CIDR format.',

test: (value) =>

vpcsValidateIP({

value,

shouldHaveIPMask: true,

mustBeIPMask: false,

}),

}),

otherwise: (schema) =>

lazy((value: string | undefined) => {

switch (typeof value) {

case 'undefined':

return schema.notRequired().nullable();

case 'string':

return schema

.notRequired()

.matches(

PRIVATE_IPv4_REGEX,

'Must be a valid private IPv4 address.'

)

.test({

name: 'IPv4 CIDR format',

message: 'The IPv4 range must be in CIDR format.',

test: (value) =>

vpcsValidateIP({

value,

shouldHaveIPMask: true,

mustBeIPMask: false,

}),

});

default:

return schema.notRequired().nullable();

}

}),

}),

ipv6_range: string().when('ipv4_range', {

is: (value: unknown) =>

value === '' || value === null || value === undefined,

then: (schema) =>

schema

.required(IP_EITHER_BOTH_NOT_NEITHER)

.matches(PRIVATE_IPv6_REGEX, 'Must be a valid private IPv6 address.')

.test({

name: 'valid-ipv6-range',

message:

'Must be a valid IPv6 range, e.g. 2001:db8:abcd:0012::0/64.',

test: (value) =>

vpcsValidateIP({

value,

shouldHaveIPMask: true,

mustBeIPMask: false,

}),

}),

}),

},

[

['ipv4_range', 'ipv6_range'],

['ipv6_range', 'ipv4_range'],

]

);

The array at the end prevents the cyclic dependency error.

cpathipa

@harsh-akamai LGTM! Can you resolve the ESLint warning.

cpathipa · 2025-04-10T14:52:00Z

packages/validation/src/nodebalancers.schema.ts

@@ -1,9 +1,12 @@
-import { array, boolean, mixed, number, object, string } from 'yup';
+import { array, boolean, lazy, mixed, number, object, string } from 'yup';


@harsh-akamai Can you look into this ESLint warnings.

…424-review-nb-vpc-validation-schema

hkhalil-akamai · 2025-04-16T14:26:21Z

packages/validation/src/nodebalancers.schema.ts

+    .test(
+      'unique subnet IDs',
+      'Subnet IDs must be unique.',
+      function (value?: any[] | null) {


No need to include a type annotation as yup will infer one for you!

Suggested change

function (value?: any[] | null) {

function (value) {

linode-gh-bot · 2025-04-17T11:14:45Z

Cloud Manager UI test results

🔺 1 failing test on test run #11 ↗︎

❌ Failing	✅ Passing	↪️ Skipped	🕐 Duration
`1 Failing`	`539 Passing`	`4 Skipped`	`104m 7s`

Details

Failing Tests
	Spec	Test
❌	`bucket-details-multicluster.spec.ts`	Cloud Manager Cypress Tests→Object Storage Multicluster Bucket Details Tabs→Properties tab without required capabilities » Object Storage Multicluster Bucket Details Tabs→Properties tab without required capabilities

Troubleshooting

Use this command to re-run the failing tests:

pnpm cy:run -s "cypress/e2e/core/objectStorageMulticluster/bucket-details-multicluster.spec.ts"

upcoming: [M3-9424] - Review NodeBalancers validation schemas

27c04f8

harsh-akamai self-assigned this Mar 24, 2025

Merge branch 'develop' into M3-9424-review-nb-vpc-validation-schema

ba372b4

harsh-akamai marked this pull request as ready for review March 24, 2025 12:51

harsh-akamai requested a review from a team as a code owner March 24, 2025 12:51

harsh-akamai requested review from cpathipa and coliu-akamai and removed request for a team March 24, 2025 12:51

harsh-akamai added the NB-VPC Relating to NodeBalancer-VPC integration label Mar 24, 2025

harsh-akamai requested a review from dwiley-akamai March 24, 2025 12:51

harsh-akamai added 2 commits March 24, 2025 18:34

variable change

535d9a4

Merge branch 'M3-9424-review-nb-vpc-validation-schema' of https://git…

d6f4f72

…hub.com/harsh-akamai/manager into M3-9424-review-nb-vpc-validation-schema

dwiley-akamai reviewed Mar 24, 2025

View reviewed changes

harsh-akamai added 2 commits March 25, 2025 17:29

Added changeset: Update validation schemas for the changes in POST en…

0d1f731

…dpoints in /v4/nodebalancers (& /v4beta/nodebalancers) for NB-VPC Integration

feedback

cc6497c

harsh-akamai requested a review from dwiley-akamai April 3, 2025 11:56

dwiley-akamai requested changes Apr 4, 2025

View reviewed changes

harsh-akamai added 2 commits April 7, 2025 13:06

PR feedback

11de4ab

private ip example

291f89d

harsh-akamai requested a review from dwiley-akamai April 10, 2025 07:02

cpathipa reviewed Apr 10, 2025

View reviewed changes

harsh-akamai added the Add'tl Approval Needed Waiting on another approval! label Apr 14, 2025

harsh-akamai requested a review from a team as a code owner April 16, 2025 06:43

harsh-akamai requested review from dmcintyr-akamai and removed request for a team April 16, 2025 06:43

harsh-akamai force-pushed the M3-9424-review-nb-vpc-validation-schema branch from 211feb4 to 291f89d Compare April 16, 2025 06:48

Merge branch 'develop' of https://github.com/linode/manager into M3-9…

42888b7

…424-review-nb-vpc-validation-schema

harsh-akamai removed the Add'tl Approval Needed Waiting on another approval! label Apr 16, 2025

private IPv6 regex

061da2a

hkhalil-akamai reviewed Apr 16, 2025

View reviewed changes

eslint fixes

b1aaed7

harsh-akamai requested a review from cpathipa April 17, 2025 11:35

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

upcoming: [M3-9424] - Review nodebalancers validation schemas #11910

upcoming: [M3-9424] - Review nodebalancers validation schemas #11910

harsh-akamai commented Mar 24, 2025 •

edited

Loading

dwiley-akamai Mar 24, 2025

dwiley-akamai Mar 24, 2025

harsh-akamai Mar 26, 2025

dwiley-akamai Mar 24, 2025

harsh-akamai Mar 26, 2025

dwiley-akamai commented Mar 24, 2025

dwiley-akamai Apr 4, 2025

dwiley-akamai Apr 10, 2025

harsh-akamai Apr 16, 2025

dwiley-akamai Apr 4, 2025

dwiley-akamai Apr 4, 2025

cpathipa left a comment

cpathipa Apr 10, 2025

hkhalil-akamai Apr 16, 2025

linode-gh-bot commented Apr 17, 2025

	// @todo update the IPv6 prefix if required for NB-VPC integration
	// @TODO NB-VPC: update the IPv6 prefix if required for NB-VPC integration

		@@ -1,9 +1,12 @@
		import { array, boolean, mixed, number, object, string } from 'yup';
		import { array, boolean, lazy, mixed, number, object, string } from 'yup';

upcoming: [M3-9424] - Review nodebalancers validation schemas #11910

Are you sure you want to change the base?

upcoming: [M3-9424] - Review nodebalancers validation schemas #11910

Conversation

harsh-akamai commented Mar 24, 2025 • edited Loading

Description 📝

How to test 🧪

Verification steps

As an Author, to speed up the review process, I considered 🤔

As an Author, before moving this PR from Draft to Open, I confirmed ✅

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dwiley-akamai commented Mar 24, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cpathipa left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

linode-gh-bot commented Apr 17, 2025

Cloud Manager UI test results

🔺 1 failing test on test run #11 ↗︎

Details

Troubleshooting

harsh-akamai commented Mar 24, 2025 •

edited

Loading