Release v1.139.0 - release → staging

.github/workflows/ci.yml

@@ -17,6 +17,7 @@ jobs:
             "linode-manager",
             "@linode/api-v4",
             "@linode/queries",
+            "@linode/shared",
             "@linode/ui",
             "@linode/utilities",
             "@linode/validation",
@@ -233,6 +234,30 @@ jobs:
       - run: pnpm install --frozen-lockfile
       - run: pnpm run --filter @linode/queries test
 
+  test-shared:
+    runs-on: ubuntu-latest
+    needs: build-sdk
+    steps:
+      - uses: actions/checkout@v4
+      - uses: pnpm/action-setup@v4
+        with:
+          run_install: false
+          version: 10
+      - uses: actions/setup-node@v4
+        with:
+          node-version: "20.17"
+          cache: "pnpm"
+      - uses: actions/download-artifact@v4
+        with:
+          name: packages-api-v4-lib
+          path: packages/api-v4/lib
+      - uses: actions/download-artifact@v4
+        with:
+          name: packages-validation-lib
+          path: packages/validation/lib
+      - run: pnpm install --frozen-lockfile
+      - run: pnpm run --filter @linode/shared test
+
   typecheck-ui:
     runs-on: ubuntu-latest
     needs: build-sdk
@@ -289,6 +314,30 @@ jobs:
       - run: pnpm install --frozen-lockfile
       - run: pnpm run --filter @linode/queries typecheck
 
+  typecheck-shared:
+    runs-on: ubuntu-latest
+    needs: build-sdk
+    steps:
+      - uses: actions/checkout@v4
+      - uses: pnpm/action-setup@v4
+        with:
+          run_install: false
+          version: 10
+      - uses: actions/setup-node@v4
+        with:
+          node-version: "20.17"
+          cache: "pnpm"
+      - uses: actions/download-artifact@v4
+        with:
+          name: packages-api-v4-lib
+          path: packages/api-v4/lib
+      - uses: actions/download-artifact@v4
+        with:
+          name: packages-validation-lib
+          path: packages/validation/lib
+      - run: pnpm install --frozen-lockfile
+      - run: pnpm run --filter @linode/shared typecheck
+
   typecheck-manager:
     runs-on: ubuntu-latest
     needs: build-sdk
@@ -342,7 +391,7 @@ jobs:
       - run: pnpm install --frozen-lockfile
       - run: npm config set //registry.npmjs.org/:_authToken ${NPM_TOKEN}
         env:
-          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}
       - run: pnpm publish -r --filter @linode/api-v4 --filter @linode/validation --no-git-checks --access public
       - name: slack-notify
         uses: rtCamp/action-slack-notify@master

.gitignore

@@ -128,6 +128,7 @@ packages/manager/test-report.xml
 **/manager/cypress/downloads/
 **/manager/cypress/results/
 **/manager/cypress/screenshots/
+**/manager/cypress/reports/
 
 packages/manager/cypress/fixtures/example.json
 

README.md

@@ -45,6 +45,7 @@ This repository is home to the Akamai Connected **[Cloud Manager](https://cloud.
 - [`@linode/api-v4`](packages/api-v4/)
 - [`@linode/queries`](packages/queries/)
 - [`@linode/search`](packages/search/)
+- [`@linode/shared`](packages/shared/)
 - [`@linode/ui`](packages/ui/)
 - [`@linode/utilities`](packages/utilities/)
 - [`@linode/validation`](packages/validation/)

docker-compose.yml

@@ -49,6 +49,7 @@ x-e2e-env:
 
   # Cypress reporting.
   CY_TEST_JUNIT_REPORT: ${CY_TEST_JUNIT_REPORT}
+  CY_TEST_HTML_REPORT: ${CY_TEST_HTML_REPORT}
   CY_TEST_USER_REPORT: ${CY_TEST_USER_REPORT}
 
   # Cloud Manager build environment.

docs/development-guide/08-testing.md

@@ -210,6 +210,7 @@ Environment variables related to Cypress logging and reporting, as well as repor
 |---------------------------------|----------------------------------------------------|------------------|----------------------------|
 | `CY_TEST_USER_REPORT`           | Log test account information when tests begin      | `1`              | Unset; disabled by default |
 | `CY_TEST_JUNIT_REPORT`          | Enable JUnit reporting                             | `1`              | Unset; disabled by default |
+| `CY_TEST_HTML_REPORT`          | Generate html report containing E2E test results   | `1`              | Unset; disabled by default |
 | `CY_TEST_DISABLE_FILE_WATCHING` | Disable file watching in Cypress UI                | `1`              | Unset; disabled by default |
 | `CY_TEST_DISABLE_RETRIES`       | Disable test retries on failure in CI              | `1`              | Unset; disabled by default |
 | `CY_TEST_FAIL_ON_MANAGED`       | Fail affected tests when Managed is enabled        | `1`              | Unset; disabled by default |

docs/tooling/analytics.md

@@ -14,7 +14,6 @@ Important notes:
 
 - Pendo is only loaded if the user has enabled Performance Cookies via OneTrust *and* if a valid `PENDO_API_KEY` is configured as an environment variable. In our development, staging, and production environments, `PENDO_API_KEY` is available at build time. See **Locally Testing Page Views & Custom Events and/or Troubleshooting Pendo** for set up with local environments.
 - We load the Pendo agent from the CDN, rather than [self-hosting](https://support.pendo.io/hc/en-us/articles/360038969692-Self-hosting-the-Pendo-agent), and we have configured a [CNAME](https://support.pendo.io/hc/en-us/articles/360043539891-CNAME-for-Pendo).
-- We are hashing account and visitor IDs in a way that is consistent with Akamai's standards.
 - At initialization, we do string transformation on select URL patterns to **remove  sensitive data**. When new URL patterns are added to Cloud Manager, verify that existing transforms remove sensitive data; if not, update the transforms.
 - Pendo will respect OneTrust cookie preferences in development, staging, and production environments and does not check cookie preferences in the local environment.
 - Pendo makes use of the existing `data-testid` properties, used in our automated testing, for tagging elements. They are more persistent and reliable than CSS properties, which are liable to change.
@@ -24,7 +23,7 @@ Important notes:
 1. Set the `REACT_APP_PENDO_API_KEY` environment variable in `.env`.
 2. Use the browser tools Network tab, filter requests by "psp.cloud", and check that successful network requests have been made to load Pendo scripts (also visible in the browser tools Sources tab).
 3. In the browser console, type `pendo.validateEnvironment()`.
-4. You should see command output in the console, and it should include a hashed `accountId` and hashed `visitorId`. Each page view change or custom event that fires should be visible as a request in the Network tab.
+4. You should see command output in the console, and it should include an `accountId` and a `visitorId` that correspond with your APIv4 account `euuid` and profile `uid`, respectively. Each page view change or custom event that fires should be visible as a request in the Network tab.
 5. If the console does not output the expected ids and instead outputs something like `Cookies are disabled in Pendo config. Is this expected?` in response to the above command, clear app storage with the browser tools. Once redirected back to Login, update the OneTrust cookie settings to enable cookies via "Manage Preferences" in the banner at the bottom of the screen. Log back into Cloud Manager and Pendo should load.
 
 ## Adobe Analytics

package.json

@@ -19,8 +19,8 @@
     "build:analyze": "pnpm run --filter linode-manager build:analyze",
     "bootstrap": "pnpm install:all && pnpm build:validation && pnpm build:sdk",
     "up:expose": "npm_config_package_import_method=clone-or-copy pnpm install:all && pnpm build:validation && pnpm build:sdk && pnpm start:all:expose",
-    "dev": "concurrently -n api-v4,validation,ui,utilities,queries,manager -c blue,yellow,magenta,cyan,gray,green \"pnpm run --filter @linode/api-v4 start\" \"pnpm run --filter @linode/validation start\" \"pnpm run --filter @linode/ui start\" \"pnpm run --filter @linode/utilities start\" \"pnpm run --filter @linode/queries start\" \"pnpm run --filter linode-manager start\"",
-    "start:all:expose": "concurrently -n api-v4,validation,ui,utilities,queries,manager -c blue,yellow,magenta,cyan,gray,green \"pnpm run --filter @linode/api-v4 start\" \"pnpm run --filter @linode/validation start\" \"pnpm run --filter @linode/ui start\" \"pnpm run --filter @linode/utilities start\" \"pnpm run --filter @linode/queries start\" \"pnpm run --filter linode-manager start:expose\"",
+    "dev": "concurrently -n api-v4,validation,ui,utilities,queries,shared,manager -c blue,yellow,magenta,cyan,gray,blue,green \"pnpm run --filter @linode/api-v4 start\" \"pnpm run --filter @linode/validation start\" \"pnpm run --filter @linode/ui start\" \"pnpm run --filter @linode/utilities start\" \"pnpm run --filter @linode/queries start\" \"pnpm run --filter @linode/shared start\" \"pnpm run --filter linode-manager start\"",
+    "start:all:expose": "concurrently -n api-v4,validation,ui,utilities,queries,shared,manager -c blue,yellow,magenta,cyan,gray,blue,green \"pnpm run --filter @linode/api-v4 start\" \"pnpm run --filter @linode/validation start\" \"pnpm run --filter @linode/ui start\" \"pnpm run --filter @linode/utilities start\" \"pnpm run --filter @linode/queries start\" \"pnpm run --filter @linode/shared start\" \"pnpm run --filter linode-manager start:expose\"",
     "start:manager": "pnpm --filter linode-manager start",
     "start:manager:ci": "pnpm run --filter linode-manager start:ci",
     "docs": "bunx [email protected] dev docs",

packages/api-v4/CHANGELOG.md

@@ -1,3 +1,29 @@
+## [2025-04-08] - v0.137.0
+
+
+### Added:
+
+- DBaaS Advanced Configurations: Add `getDatabaseEngineConfig` request to fetch all advanced configurations and updated types for advanced configs ([#11812](https://github.com/linode/manager/pull/11812))
+
+### Changed:
+
+- DBaaS Advanced Configurations: remove `engine_config` from the DatabaseEngineConfig type ([#11885](https://github.com/linode/manager/pull/11885))
+
+### Fixed:
+
+- Remove trailing slash from outgoing Linode API GET request ([#11939](https://github.com/linode/manager/pull/11939))
+
+### Removed:
+
+- DBaaS: unused functions getDatabaseType, getEngineDatabases, getDatabaseBackup ([#11909](https://github.com/linode/manager/pull/11909))
+
+### Upcoming Features:
+
+- Add `/v4beta/nodebalancers` and `/v4/nodebalancers` endpoints for NB-VPC Integration ([#11832](https://github.com/linode/manager/pull/11832))
+- Update `ipv6` type in `CreateSubnetPayload` and rename `createSubnetSchema` to `createSubnetSchemaIPv4` ([#11896](https://github.com/linode/manager/pull/11896))
+- Update iam apis ([#11919](https://github.com/linode/manager/pull/11919))
+- Add support for IPv6 to `VPCIP` ([#11938](https://github.com/linode/manager/pull/11938))
+
 ## [2025-03-25] - v0.136.0
 
 

packages/api-v4/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@linode/api-v4",
-  "version": "0.136.0",
+  "version": "0.137.0",
   "homepage": "https://github.com/linode/manager/tree/develop/packages/api-v4",
   "bugs": {
     "url": "https://github.com/linode/manager/issues"

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

@@ -23,6 +23,7 @@ import {
   SSLFields,
   UpdateDatabasePayload,
   DatabaseFork,
+  DatabaseEngineConfig,
 } from './types';
 
 /**
@@ -346,3 +347,15 @@ export const resumeDatabase = (engine: Engine, databaseID: number) =>
     ),
     setMethod('POST')
   );
+
+/**
+ * getConfig
+ *
+ * Return detailed list of all the configuration options
+ *
+ */
+export const getDatabaseEngineConfig = (engine: Engine) =>
+  Request<DatabaseEngineConfig>(
+    setURL(`${API_ROOT}/databases/${encodeURIComponent(engine)}/config`),
+    setMethod('GET')
+  );

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

@@ -41,16 +41,38 @@ export type DatabaseStatus =
   | 'resuming'
   | 'suspended'
   | 'suspending';
-
+/** @deprecated TODO (UIE-8214) remove after migration */
 export type DatabaseBackupType = 'snapshot' | 'auto';
-
+/** @deprecated TODO (UIE-8214) remove after migration */
 export interface DatabaseBackup {
   id: number;
   type: DatabaseBackupType;
   label: string;
   created: string;
 }
-
+export interface ConfigurationItem {
+  description?: string;
+  example?: string | number | boolean;
+  minimum?: number; // min value for the number input
+  maximum?: number; // max value for the number input
+  maxLength?: number; // max length for the text input
+  minLength?: number; // min length for the text input
+  pattern?: string;
+  type?: string | [string, null] | string[];
+  enum?: string[];
+  restart_cluster?: boolean;
+}
+
+export type ConfigValue = number | string | boolean;
+
+export type ConfigCategoryValues = Record<string, ConfigValue>;
+export type DatabaseEngineConfig = Record<
+  string,
+  Record<string, ConfigurationItem> | ConfigurationItem
+>;
+export interface DatabaseInstanceAdvancedConfig {
+  [category: string]: ConfigCategoryValues | ConfigValue;
+}
 export interface DatabaseFork {
   source: number;
   restore_time?: string;
@@ -70,26 +92,7 @@ interface DatabaseHosts {
 export interface SSLFields {
   ca_certificate: string;
 }
-// TODO: This will be changed in the next PR
-export interface MySQLAdvancedConfig {
-  binlog_retention_period?: number;
-  advanced?: {
-    connect_timeout?: number;
-    default_time_zone?: string;
-    group_concat_max_len?: number;
-    information_schema_stats_expiry?: number;
-    innodb_print_all_deadlocks?: boolean;
-    sql_mode?: string;
-  };
-}
-// TODO: This will be changed in the next PR
-export interface PostgresAdvancedConfig {
-  advanced?: {
-    max_files_per_process?: number;
-    timezone?: string;
-    pg_stat_monitor_enable?: boolean;
-  };
-}
+
 type MemberType = 'primary' | 'failover';
 
 // DatabaseInstance is the interface for the shape of data returned by the /databases/instances endpoint.
@@ -118,7 +121,7 @@ export interface DatabaseInstance {
   updated: string;
   updates: UpdatesSchedule;
   version: string;
-  engine_config?: MySQLAdvancedConfig | PostgresAdvancedConfig;
+  engine_config: DatabaseInstanceAdvancedConfig;
 }
 
 export type ClusterSize = 1 | 2 | 3;
@@ -231,4 +234,5 @@ export interface UpdateDatabasePayload {
   updates?: UpdatesSchedule;
   type?: string;
   version?: string;
+  engine_config?: DatabaseInstanceAdvancedConfig;
 }

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

@@ -0,0 +1,17 @@
+import { ResourcePage } from 'src/types';
+import { BETA_API_ROOT } from '../constants';
+import Request, { setMethod, setURL } from '../request';
+import { AccountEntity } from './types';
+
+/**
+ * getAccountEntities
+ *
+ * Return all entities for account.
+ *
+ */
+export const getAccountEntities = () => {
+  return Request<ResourcePage<AccountEntity>>(
+    setURL(`${BETA_API_ROOT}/entities`),
+    setMethod('GET')
+  );
+};

packages/api-v4/src/entities/index.ts

@@ -0,0 +1,3 @@
+export * from './entities';
+
+export * from './types';

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

@@ -0,0 +1,17 @@
+export type EntityType =
+  | 'database'
+  | 'domain'
+  | 'firewall'
+  | 'image'
+  | 'linode'
+  | 'longview'
+  | 'nodebalancer'
+  | 'stackscript'
+  | 'volume'
+  | 'vpc';
+
+export interface AccountEntity {
+  label: string;
+  type: EntityType;
+  id: number;
+}

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

@@ -48,7 +48,7 @@ export interface FirewallRuleType {
 export interface FirewallDeviceEntity {
   id: number;
   type: FirewallDeviceEntityType;
-  label: string;
+  label: string | null;
   url: string;
 }
 
@@ -89,10 +89,10 @@ export interface FirewallDevicePayload {
 }
 
 export interface DefaultFirewallIDs {
-  public_interface: number;
-  vpc_interface: number;
-  linode: number;
-  nodebalancer: number;
+  public_interface: number | null;
+  vpc_interface: number | null;
+  linode: number | null;
+  nodebalancer: number | null;
 }
 
 export interface FirewallSettings {

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

@@ -14,9 +14,9 @@ import { IamUserPermissions, IamAccountPermissions } from './types';
 export const getUserPermissions = (username: string) =>
   Request<IamUserPermissions>(
     setURL(
-      `${BETA_API_ROOT}/iam/role-permissions/users/${encodeURIComponent(
+      `${BETA_API_ROOT}/iam/users/${encodeURIComponent(
         username
-      )}`
+      )}/role-permissions`
     ),
     setMethod('GET')
   );