Skip to content

chore: update generated array type definitions in TypeScript to be readonly #12947

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

Merged
merged 11 commits into from
Apr 15, 2024
Merged

chore: update generated array type definitions in TypeScript to be readonly #12947

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
3d6a2e6
chore: types generated handling readonly slices
Emyrk Apr 11, 2024
72d8788
add -update flag to update goldens
Emyrk Apr 11, 2024
dfd6068
revert excess gens
Emyrk Apr 11, 2024
bade802
fix: update most UI types to account for readonly modifiers
Parkreiner Apr 12, 2024
a622347
fix: remove accidental mutation from NavBarView
Parkreiner Apr 12, 2024
96693af
fix: remove mutation warning for BatchUpdateConfirmation stories
Parkreiner Apr 12, 2024
e4ea53a
fix: remove mutation warning for BactchUpdateConfirmation
Parkreiner Apr 12, 2024
6f69ae4
fix: format ActiveUserChart
Parkreiner Apr 12, 2024
0f6556c
fix: update import to make linter happy
Parkreiner Apr 12, 2024
a1040d7
fix: update fmt issue
Parkreiner Apr 12, 2024
1b1d6f6
fix: disable file write lint rule from unit test
Parkreiner Apr 15, 2024
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
10 changes: 8 additions & 2 deletions scripts/apitypings/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -814,11 +814,17 @@ func (g *Generator) typescriptType(ty types.Type) (TypescriptType, error) {
return TypescriptType{}, xerrors.Errorf("array: %w", err)
}
genValue := ""

// Always wrap in parentheses for proper scoped types.
// Running prettier on this output will remove redundant parenthesis,
// so this makes our decision-making easier.
// The example that breaks without this is:
// readonly readonly string[][]
if underlying.GenericValue != "" {
genValue = underlying.GenericValue + "[]"
genValue = "(readonly " + underlying.GenericValue + "[])"
}
return TypescriptType{
ValueType: underlying.ValueType + "[]",
ValueType: "(readonly " + underlying.ValueType + "[])",
GenericValue: genValue,
AboveTypeLine: underlying.AboveTypeLine,
GenericTypes: underlying.GenericTypes,
Expand Down
11 changes: 10 additions & 1 deletion scripts/apitypings/main_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
package main

import (
"flag"
"os"
"path/filepath"
"strings"
Expand All @@ -15,6 +16,9 @@ import (
"github.com/stretchr/testify/require"
)

// updateGoldenFiles is a flag that can be set to update golden files.
var updateGoldenFiles = flag.Bool("update", false, "Update golden files")

func TestGeneration(t *testing.T) {
t.Parallel()
files, err := os.ReadDir("testdata")
Expand All @@ -37,7 +41,12 @@ func TestGeneration(t *testing.T) {
require.NoErrorf(t, err, "read file %s", golden)
expectedString := strings.TrimSpace(string(expected))
output = strings.TrimSpace(output)
require.Equal(t, expectedString, output, "matched output")
if *updateGoldenFiles {
err := os.WriteFile(golden, []byte(output), 0644)
require.NoError(t, err, "write golden file")
} else {
require.Equal(t, expectedString, output, "matched output")
}
})
}
}
4 changes: 2 additions & 2 deletions scripts/apitypings/testdata/enums/enums.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
package codersdk

type (
Enum string
Enums []Enum
Enum string
EnumSliceType []Enum
)

const (
Expand Down
2 changes: 1 addition & 1 deletion scripts/apitypings/testdata/enums/enums.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// From codersdk/enums.go
export type Enums = Enum[]
export type EnumSliceType = (readonly Enum[])

// From codersdk/enums.go
export type Enum = "bar" | "baz" | "foo" | "qux"
Expand Down
12 changes: 6 additions & 6 deletions scripts/apitypings/testdata/genericmap/genericmap.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
package codersdk

type Foo struct {
Bar string `json:"bar"`
}

type Buzz struct {
Foo `json:"foo"`
Bazz string `json:"bazz"`
}

type Custom interface {
Foo | Buzz
type Foo struct {
Bar string `json:"bar"`
}

type FooBuzz[R Custom] struct {
Something []R `json:"something"`
}

type Custom interface {
Foo | Buzz
}

// Not yet supported
//type FooBuzzMap[R Custom] struct {
// Something map[string]R `json:"something"`
Expand Down
4 changes: 2 additions & 2 deletions scripts/apitypings/testdata/genericmap/genericmap.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ export interface Foo {

// From codersdk/genericmap.go
export interface FooBuzz<R extends Custom> {
readonly something: R[]
readonly something: (readonly R[])
}

// From codersdk/genericmap.go
export type Custom = Foo | Buzz
export type Custom = Foo | Buzz
4 changes: 2 additions & 2 deletions scripts/apitypings/testdata/generics/generics.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,9 @@ export interface Static {
}

// From codersdk/generics.go
export type Custom = string | boolean | number | string[] | null
export type Custom = string | boolean | number | (readonly string[]) | null

// From codersdk/generics.go
export type Single = string

export type comparable = boolean | number | string | any
export type comparable = boolean | number | string | any
10 changes: 10 additions & 0 deletions scripts/apitypings/testdata/genericslice/genericslice.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
package codersdk

type Bar struct {
Bar string
}

type Foo[R any] struct {
Slice []R
TwoD [][]R
}
10 changes: 10 additions & 0 deletions scripts/apitypings/testdata/genericslice/genericslice.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
// From codersdk/genericslice.go
export interface Bar {
readonly Bar: string
}

// From codersdk/genericslice.go
export interface Foo<R extends any> {
Copy link
Member

@Parkreiner Parkreiner Apr 15, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not for the future: R extends any actually doesn't do anything at all. Since any is a top type, everything in TypeScript extends any, so the type constraint provides zero protection

At some point, we'd probably want to turn this into

export interface Foo<R = unknown> {
  // Stuff
}

readonly Slice: (readonly R[])
readonly TwoD: (readonly (readonly R[])[])
}
Loading