Skip to content

Improve Type Safety in @netlify/config #6896

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

Draft
google-labs-jules wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Improve Type Safety in @netlify/config #6896

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
315 changes: 228 additions & 87 deletions package-lock.json
View file
Open in desktop

Large diffs are not rendered by default.

4 changes: 3 additions & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@
"test": "lerna run test",
"test:ci": "lerna run test:ci",
"format": "prettier --write .",
"format:ci": "prettier --check ."
"format:ci": "prettier --check .",
"postinstall": "patch-package"
},
"workspaces": [
"packages/*"
Expand Down Expand Up @@ -59,6 +60,7 @@
"eslint-plugin-n": "^17.19.0",
"execa": "^8.0.1",
"lerna": "^8.2.2",
"patch-package": "^8.0.0",
"prettier": "^3.0.0",
"typescript-eslint": "^8.34.0"
},
Expand Down
1 change: 1 addition & 0 deletions packages/config/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,7 @@
"c8": "^10.0.0",
"has-ansi": "^6.0.0",
"is-ci": "^4.0.0",
"is-git-repo": "^0.1.2",
"tmp-promise": "^3.0.2",
"typescript": "^5.0.0"
},
Expand Down
10 changes: 3 additions & 7 deletions packages/config/src/api/site_info.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
import { NetlifyAPI } from '@netlify/api'

import * as z from 'zod'

import { getEnvelope } from '../env/envelope.js'
Expand Down Expand Up @@ -124,8 +123,6 @@ const getSite = async function (
}
try {
const site = await api.getSite({
// @ts-expect-error: Internal parameter that instructs the API to include all the site's
// feature flags in the response.
feature_flags: siteFeatureFlagPrefix,
siteId,
})
Expand All @@ -150,10 +147,9 @@ export type MinimalAccount = {

const getAccounts = async function (api: NetlifyAPI): Promise<MinimalAccount[]> {
try {
const accounts = (await api.listAccountsForUser(
// @ts-expect-error(ndhoule): This is an unpublished, internal querystring parameter
{ minimal: 'true' },
)) as MinimalAccount[] | null
const accounts = (await api.listAccountsForUser({
minimal: 'true',
})) as MinimalAccount[] | null
return Array.isArray(accounts) ? (accounts as MinimalAccount[]) : []
} catch (error) {
return throwUserError(`Failed retrieving user account: ${error.message}. ${ERROR_CALL_TO_ACTION}`)
Expand Down
96 changes: 0 additions & 96 deletions packages/config/tests/api/snapshots/tests.js.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,12 +47,6 @@ Generated by [AVA](https://avajs.dev).
],␊
"value": "0"␊
},␊
"CACHED_COMMIT_REF": {␊
"sources": [␊
"general"␊
],␊
"value": "HEXADECIMAL_ID"␊
},␊
"COMMIT_REF": {␊
"sources": [␊
"general"␊
Expand Down Expand Up @@ -184,12 +178,6 @@ Generated by [AVA](https://avajs.dev).
],␊
"value": "0"␊
},␊
"CACHED_COMMIT_REF": {␊
"sources": [␊
"general"␊
],␊
"value": "HEXADECIMAL_ID"␊
},␊
"COMMIT_REF": {␊
"sources": [␊
"general"␊
Expand Down Expand Up @@ -324,12 +312,6 @@ Generated by [AVA](https://avajs.dev).
],␊
"value": "0"␊
},␊
"CACHED_COMMIT_REF": {␊
"sources": [␊
"general"␊
],␊
"value": "HEXADECIMAL_ID"␊
},␊
"COMMIT_REF": {␊
"sources": [␊
"general"␊
Expand Down Expand Up @@ -461,12 +443,6 @@ Generated by [AVA](https://avajs.dev).
],␊
"value": "0"␊
},␊
"CACHED_COMMIT_REF": {␊
"sources": [␊
"general"␊
],␊
"value": "HEXADECIMAL_ID"␊
},␊
"COMMIT_REF": {␊
"sources": [␊
"general"␊
Expand Down Expand Up @@ -604,12 +580,6 @@ Generated by [AVA](https://avajs.dev).
],␊
"value": "0"␊
},␊
"CACHED_COMMIT_REF": {␊
"sources": [␊
"general"␊
],␊
"value": "HEXADECIMAL_ID"␊
},␊
"COMMIT_REF": {␊
"sources": [␊
"general"␊
Expand Down Expand Up @@ -747,12 +717,6 @@ Generated by [AVA](https://avajs.dev).
],␊
"value": "0"␊
},␊
"CACHED_COMMIT_REF": {␊
"sources": [␊
"general"␊
],␊
"value": "HEXADECIMAL_ID"␊
},␊
"COMMIT_REF": {␊
"sources": [␊
"general"␊
Expand Down Expand Up @@ -921,12 +885,6 @@ Generated by [AVA](https://avajs.dev).
],␊
"value": "0"␊
},␊
"CACHED_COMMIT_REF": {␊
"sources": [␊
"general"␊
],␊
"value": "HEXADECIMAL_ID"␊
},␊
"COMMIT_REF": {␊
"sources": [␊
"general"␊
Expand Down Expand Up @@ -1064,12 +1022,6 @@ Generated by [AVA](https://avajs.dev).
],␊
"value": "0"␊
},␊
"CACHED_COMMIT_REF": {␊
"sources": [␊
"general"␊
],␊
"value": "HEXADECIMAL_ID"␊
},␊
"COMMIT_REF": {␊
"sources": [␊
"general"␊
Expand Down Expand Up @@ -1201,12 +1153,6 @@ Generated by [AVA](https://avajs.dev).
],␊
"value": "0"␊
},␊
"CACHED_COMMIT_REF": {␊
"sources": [␊
"general"␊
],␊
"value": "HEXADECIMAL_ID"␊
},␊
"COMMIT_REF": {␊
"sources": [␊
"general"␊
Expand Down Expand Up @@ -1387,12 +1333,6 @@ Generated by [AVA](https://avajs.dev).
],␊
"value": "0"␊
},␊
"CACHED_COMMIT_REF": {␊
"sources": [␊
"general"␊
],␊
"value": "HEXADECIMAL_ID"␊
},␊
"COMMIT_REF": {␊
"sources": [␊
"general"␊
Expand Down Expand Up @@ -1569,12 +1509,6 @@ Generated by [AVA](https://avajs.dev).
],␊
"value": "0"␊
},␊
"CACHED_COMMIT_REF": {␊
"sources": [␊
"general"␊
],␊
"value": "HEXADECIMAL_ID"␊
},␊
"COMMIT_REF": {␊
"sources": [␊
"general"␊
Expand Down Expand Up @@ -1770,12 +1704,6 @@ Generated by [AVA](https://avajs.dev).
],␊
"value": "0"␊
},␊
"CACHED_COMMIT_REF": {␊
"sources": [␊
"general"␊
],␊
"value": "HEXADECIMAL_ID"␊
},␊
"COMMIT_REF": {␊
"sources": [␊
"general"␊
Expand Down Expand Up @@ -1955,12 +1883,6 @@ Generated by [AVA](https://avajs.dev).
],␊
"value": "0"␊
},␊
"CACHED_COMMIT_REF": {␊
"sources": [␊
"general"␊
],␊
"value": "HEXADECIMAL_ID"␊
},␊
"COMMIT_REF": {␊
"sources": [␊
"general"␊
Expand Down Expand Up @@ -2098,12 +2020,6 @@ Generated by [AVA](https://avajs.dev).
],␊
"value": "0"␊
},␊
"CACHED_COMMIT_REF": {␊
"sources": [␊
"general"␊
],␊
"value": "HEXADECIMAL_ID"␊
},␊
"COMMIT_REF": {␊
"sources": [␊
"general"␊
Expand Down Expand Up @@ -2284,12 +2200,6 @@ Generated by [AVA](https://avajs.dev).
],␊
"value": "0"␊
},␊
"CACHED_COMMIT_REF": {␊
"sources": [␊
"general"␊
],␊
"value": "HEXADECIMAL_ID"␊
},␊
"COMMIT_REF": {␊
"sources": [␊
"general"␊
Expand Down Expand Up @@ -2402,9 +2312,3 @@ Generated by [AVA](https://avajs.dev).
},␊
"token": "test"␊
}`

## Integrations are not returned if failed to fetch integrations

> Snapshot 1

'Failed retrieving extensions for site test: Unexpected status code 500 from fetching extensions. Double-check your login status with \'netlify status\' or contact support with details of your error.'
Binary file modified packages/config/tests/api/snapshots/tests.js.snap
View file
Open in desktop
Binary file not shown.
42 changes: 0 additions & 42 deletions packages/config/tests/base/snapshots/tests.js.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,12 +50,6 @@ Generated by [AVA](https://avajs.dev).
],␊
"value": "0"␊
},␊
"CACHED_COMMIT_REF": {␊
"sources": [␊
"general"␊
],␊
"value": "HEXADECIMAL_ID"␊
},␊
"COMMIT_REF": {␊
"sources": [␊
"general"␊
Expand Down Expand Up @@ -192,12 +186,6 @@ Generated by [AVA](https://avajs.dev).
],␊
"value": "0"␊
},␊
"CACHED_COMMIT_REF": {␊
"sources": [␊
"general"␊
],␊
"value": "HEXADECIMAL_ID"␊
},␊
"COMMIT_REF": {␊
"sources": [␊
"general"␊
Expand Down Expand Up @@ -330,12 +318,6 @@ Generated by [AVA](https://avajs.dev).
],␊
"value": "0"␊
},␊
"CACHED_COMMIT_REF": {␊
"sources": [␊
"general"␊
],␊
"value": "HEXADECIMAL_ID"␊
},␊
"COMMIT_REF": {␊
"sources": [␊
"general"␊
Expand Down Expand Up @@ -472,12 +454,6 @@ Generated by [AVA](https://avajs.dev).
],␊
"value": "0"␊
},␊
"CACHED_COMMIT_REF": {␊
"sources": [␊
"general"␊
],␊
"value": "HEXADECIMAL_ID"␊
},␊
"COMMIT_REF": {␊
"sources": [␊
"general"␊
Expand Down Expand Up @@ -615,12 +591,6 @@ Generated by [AVA](https://avajs.dev).
],␊
"value": "0"␊
},␊
"CACHED_COMMIT_REF": {␊
"sources": [␊
"general"␊
],␊
"value": "HEXADECIMAL_ID"␊
},␊
"COMMIT_REF": {␊
"sources": [␊
"general"␊
Expand Down Expand Up @@ -751,12 +721,6 @@ Generated by [AVA](https://avajs.dev).
],␊
"value": "0"␊
},␊
"CACHED_COMMIT_REF": {␊
"sources": [␊
"general"␊
],␊
"value": "HEXADECIMAL_ID"␊
},␊
"COMMIT_REF": {␊
"sources": [␊
"general"␊
Expand Down Expand Up @@ -887,12 +851,6 @@ Generated by [AVA](https://avajs.dev).
],␊
"value": "0"␊
},␊
"CACHED_COMMIT_REF": {␊
"sources": [␊
"general"␊
],␊
"value": "HEXADECIMAL_ID"␊
},␊
"COMMIT_REF": {␊
"sources": [␊
"general"␊
Expand Down
Binary file modified packages/config/tests/base/snapshots/tests.js.snap
View file
Open in desktop
Binary file not shown.
Loading
Loading