upcoming: [M3-9088] - Add and update `/v4/networking` endpoints and types for Linode Interfaces #11559

coliu-akamai · 2025-01-23T18:18:12Z

Description 📝

Updates existing and adds new /v4/networking endpoints for the Linode Interfaces project in accordance with API spec

Added a changeset for the Manager package after updating some factories. Is this changeset necessary? can remove it otherwise

How to test 🧪

Confirm changes match the API spec
Confirm generating a compliant firewall still works as expected

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

packages/api-v4/src/firewalls/types.ts

coliu-akamai · 2025-01-23T20:06:48Z

packages/api-v4/src/networking/types.ts

+  vpc_nat_1_1?: {
+    address: string;
+    subnet_id: number;
+    vpc_id: number;
+  } | null;


adding this field (looks like we were missing it previously). It got returned either as the object or a null value (or was omitted) when I tested the endpoint

coliu-akamai · 2025-01-23T20:16:43Z

packages/api-v4/src/firewalls/firewalls.ts

 */
-export const getTemplate = (templateSlug: string) =>
+export const getTemplate = (templateSlug: FirewallTemplateSlug) =>


These two endpoints (getTemplates and getTemplate) were added during the Securing VMs project (see internal ticket - I linked the spec there). I updated the templateSlug type to be more specific - I believe these are the three templates that exist so far, but am not sure. Since there may be a possibility for more slugs I'm not aware of, happy to switch back to string too

I've currently typed it as
export type FirewallTemplateSlug = 'akamai-non-prod' | 'vpc' | 'public'
See internal comments on spec about some naming updates - when testing the endpoint, I saw that vpc and public are the returned slugs

coliu-akamai · 2025-01-23T20:17:47Z

packages/api-v4/src/firewalls/types.ts

-  entities: {
-    id: number;
-    type: FirewallDeviceEntityType;
-    label: string;
-    url: string;
-  }[];


replacing this with FirewallDeviceEntity since it already exists

export interface FirewallDeviceEntity { id: number; type: FirewallDeviceEntityType; label: string; url: string; }

bnussman-akamai

Looks great! Thanks for those extra fixes in addition to the new types

packages/manager/src/factories/firewalls.ts

packages/api-v4/src/firewalls/types.ts

Co-authored-by: Banks Nussman <[email protected]>

github-actions · 2025-01-24T17:25:38Z

Coverage Report: ✅
Base Coverage: 79.07%
Current Coverage: 79.07%

packages/api-v4/src/firewalls/types.ts

coliu-akamai · 2025-01-27T20:26:37Z

some updates:

commented on internal spec asking about the fingerprint/version fields for some FirewallTemplate type clarification
in the meantime, created separate type FirewallTemplateRules and updated FirewallRules (keeping fingerprint/version as non optional fields to be up to date with what the api returns)

linode-gh-bot · 2025-01-27T22:57:59Z

Cloud Manager UI test results

🎉 482 passing tests on test run #12 ↗︎

❌ Failing	✅ Passing	↪️ Skipped	🕐 Duration
`0 Failing`	`482 Passing`	`2 Skipped`	`103m 21s`

cypress · 2025-01-27T23:39:15Z

Cloud Manager E2E Run #7132

Run Properties: Passed #7132 • b721a04380: upcoming: [M3-9088] - Add and update `/v4/networking` endpoints and types for Li...

Project	`Cloud Manager E2E`
Branch Review	`develop`
Run status	`Passed #7132`
Run duration	`28m 13s`
Commit	b721a04380: upcoming: [M3-9088] - Add and update `/v4/networking` endpoints and types for Li...
Committer	`Connie Liu`
View all properties for this run ↗︎

Test results
Failures	`0`
Flaky	`1`
Pending	`2`
Skipped	`0`
Passing	`482`
View all changes introduced in this branch ↗︎

coliu-akamai added the Linode Interfaces label Jan 23, 2025

coliu-akamai self-assigned this Jan 23, 2025

coliu-akamai commented Jan 23, 2025

View reviewed changes

coliu-akamai marked this pull request as ready for review January 23, 2025 20:58

coliu-akamai requested a review from a team as a code owner January 23, 2025 20:58

coliu-akamai requested review from carrillo-erik, abailly-akamai and bnussman-akamai and removed request for a team January 23, 2025 20:58

coliu-akamai added the Ready for Review label Jan 23, 2025

coliu-akamai added 4 commits January 24, 2025 11:47

update firewall template endpoints

6b0dcb1

existing /networking endpoints and fix resulting type errors

ea620a9

add changesets, fix some types

4ecb67d

update types

f2efad0

coliu-akamai force-pushed the m3-9088 branch from 0fd613b to f2efad0 Compare January 24, 2025 16:48

bnussman-akamai approved these changes Jan 24, 2025

View reviewed changes

packages/manager/src/factories/firewalls.ts Outdated Show resolved Hide resolved

packages/api-v4/src/firewalls/types.ts Outdated Show resolved Hide resolved

Update packages/manager/src/factories/firewalls.ts

f16b77d

Co-authored-by: Banks Nussman <[email protected]>

add comment for follow up, remove unneeded constant

ab3f5ae

coliu-akamai added Add'tl Approval Needed Waiting on another approval! and removed Ready for Review labels Jan 24, 2025

abailly-akamai approved these changes Jan 27, 2025

View reviewed changes

packages/api-v4/src/firewalls/types.ts Outdated Show resolved Hide resolved

coliu-akamai added 2 commits January 27, 2025 12:08

new type for FirewallTemplate rules + todo comment

1052278

update fields/types for Firewall Rules - double check query updates...

9c5476b

coliu-akamai requested a review from a team as a code owner January 27, 2025 18:10

coliu-akamai requested review from jdamore-linode and removed request for a team January 27, 2025 18:10

bnussman-akamai removed the Add'tl Approval Needed Waiting on another approval! label Jan 27, 2025

bnussman-akamai added the Approved Multiple approvals and ready to merge! label Jan 27, 2025

update versioning in updateFirewallRules query cache

1054436

bruh (at myself!!!)

ddd0ced

coliu-akamai force-pushed the m3-9088 branch from 99e7bf8 to ddd0ced Compare January 27, 2025 21:51

update comments

ffb8d72

coliu-akamai merged commit b721a04 into linode:develop Jan 27, 2025
23 checks passed

coliu-akamai deleted the m3-9088 branch January 27, 2025 23:08

hkhalil-akamai mentioned this pull request Feb 5, 2025

Release v1.136.0 - release → staging #11623

Merged

dwiley-akamai mentioned this pull request Feb 11, 2025

Release v1.136.0 - staging → master #11645

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

upcoming: [M3-9088] - Add and update `/v4/networking` endpoints and types for Linode Interfaces #11559

upcoming: [M3-9088] - Add and update `/v4/networking` endpoints and types for Linode Interfaces #11559

coliu-akamai commented Jan 23, 2025 •

edited

Loading

coliu-akamai Jan 23, 2025 •

edited

Loading

coliu-akamai Jan 23, 2025 •

edited

Loading

coliu-akamai Jan 23, 2025 •

edited

Loading

bnussman-akamai left a comment

github-actions bot commented Jan 24, 2025 •

edited

Loading

coliu-akamai commented Jan 27, 2025 •

edited

Loading

linode-gh-bot commented Jan 27, 2025

cypress bot commented Jan 27, 2025

upcoming: [M3-9088] - Add and update /v4/networking endpoints and types for Linode Interfaces #11559

upcoming: [M3-9088] - Add and update /v4/networking endpoints and types for Linode Interfaces #11559

Conversation

coliu-akamai commented Jan 23, 2025 • edited Loading

Description 📝

How to test 🧪

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

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

coliu-akamai Jan 23, 2025 • edited Loading

Choose a reason for hiding this comment

coliu-akamai Jan 23, 2025 • edited Loading

Choose a reason for hiding this comment

coliu-akamai Jan 23, 2025 • edited Loading

Choose a reason for hiding this comment

bnussman-akamai left a comment

Choose a reason for hiding this comment

github-actions bot commented Jan 24, 2025 • edited Loading

coliu-akamai commented Jan 27, 2025 • edited Loading

linode-gh-bot commented Jan 27, 2025

Cloud Manager UI test results

🎉 482 passing tests on test run #12 ↗︎

cypress bot commented Jan 27, 2025

Cloud Manager E2E Run #7132

upcoming: [M3-9088] - Add and update `/v4/networking` endpoints and types for Linode Interfaces #11559

upcoming: [M3-9088] - Add and update `/v4/networking` endpoints and types for Linode Interfaces #11559

coliu-akamai commented Jan 23, 2025 •

edited

Loading

coliu-akamai Jan 23, 2025 •

edited

Loading

coliu-akamai Jan 23, 2025 •

edited

Loading

coliu-akamai Jan 23, 2025 •

edited

Loading

github-actions bot commented Jan 24, 2025 •

edited

Loading

coliu-akamai commented Jan 27, 2025 •

edited

Loading