Skip to content

Commit b7550bf

Browse files
BrunoQuaresmaBrunoQuaresma
authored
chore(site): remove unecessary types and move types to where they are used (#9621)
1 parent 0e28397 commit b7550bf

21 files changed

+70
-87
lines changed

‎site/src/api/api.ts

+27-6
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
import axios from "axios";
22
import dayjs from "dayjs";
3-
import * as Types from "./types";
4-
import { DeploymentConfig } from "./types";
53
import * as TypesGen from "./typesGenerated";
64
import { delay } from "utils/delay";
75
import userAgentParser from "ua-parser-js";
@@ -365,8 +363,8 @@ export const createTemplate = async (
365363
export const updateActiveTemplateVersion = async (
366364
templateId: string,
367365
data: TypesGen.UpdateActiveTemplateVersion,
368-
): Promise<Types.Message> => {
369-
const response = await axios.patch<Types.Message>(
366+
) => {
367+
const response = await axios.patch<TypesGen.Response>(
370368
`/api/v2/templates/${templateId}/versions`,
371369
data,
372370
);
@@ -547,7 +545,7 @@ export const deleteWorkspace = (
547545

548546
export const cancelWorkspaceBuild = async (
549547
workspaceBuildId: TypesGen.WorkspaceBuild["id"],
550-
): Promise<Types.Message> => {
548+
): Promise<TypesGen.Response> => {
551549
const response = await axios.patch(
552550
`/api/v2/workspacebuilds/${workspaceBuildId}/cancel`,
553551
);
@@ -595,7 +593,7 @@ export const restartWorkspace = async ({
595593

596594
export const cancelTemplateVersionBuild = async (
597595
templateVersionId: TypesGen.TemplateVersion["id"],
598-
): Promise<Types.Message> => {
596+
): Promise<TypesGen.Response> => {
599597
const response = await axios.patch(
600598
`/api/v2/templateversions/${templateVersionId}/cancel`,
601599
);
@@ -985,6 +983,29 @@ export const getDeploymentSSHConfig =
985983
return response.data;
986984
};
987985

986+
// The Deployment types are not generated on from the Go generator yet because
987+
// it does not know how to generate OptionSet
988+
export interface DeploymentGroup {
989+
readonly name: string;
990+
readonly parent?: DeploymentGroup;
991+
readonly description: string;
992+
readonly children: DeploymentGroup[];
993+
}
994+
export interface DeploymentOption {
995+
readonly name: string;
996+
readonly description: string;
997+
readonly flag: string;
998+
readonly flag_shorthand: string;
999+
readonly value: unknown;
1000+
readonly hidden: boolean;
1001+
readonly group?: DeploymentGroup;
1002+
}
1003+
1004+
export type DeploymentConfig = {
1005+
readonly config: TypesGen.DeploymentValues;
1006+
readonly options: DeploymentOption[];
1007+
};
1008+
9881009
export const getDeploymentValues = async (): Promise<DeploymentConfig> => {
9891010
const response = await axios.get(`/api/v2/deployment/config`);
9901011
return response.data;

‎site/src/api/types.ts

-40
This file was deleted.

‎site/src/components/DeploySettingsLayout/DeploySettingsLayout.tsx

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import { deploymentConfigMachine } from "xServices/deploymentConfig/deploymentCo
1010
import { RequirePermission } from "components/RequirePermission/RequirePermission";
1111
import { usePermissions } from "hooks/usePermissions";
1212
import { Outlet } from "react-router-dom";
13-
import { DeploymentConfig } from "api/types";
13+
import { DeploymentConfig } from "api/api";
1414

1515
type DeploySettingsContextValue = {
1616
deploymentValues: DeploymentConfig;

‎site/src/components/DeploySettingsLayout/OptionsTable.tsx

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,14 @@ import TableCell from "@mui/material/TableCell";
55
import TableContainer from "@mui/material/TableContainer";
66
import TableHead from "@mui/material/TableHead";
77
import TableRow from "@mui/material/TableRow";
8-
import { DeploymentOption } from "api/types";
98
import {
109
OptionDescription,
1110
OptionName,
1211
OptionValue,
1312
} from "components/DeploySettingsLayout/Option";
1413
import { FC } from "react";
1514
import { optionValue } from "./optionValue";
15+
import { DeploymentOption } from "api/api";
1616

1717
const OptionsTable: FC<{
1818
options: DeploymentOption[];

‎site/src/components/DeploySettingsLayout/optionValue.test.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1+
import { DeploymentOption } from "api/api";
12
import { optionValue } from "./optionValue";
2-
import { DeploymentOption } from "api/types";
33

44
const defaultOption: DeploymentOption = {
55
name: "",

‎site/src/components/DeploySettingsLayout/optionValue.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import { DeploymentOption } from "api/types";
1+
import { DeploymentOption } from "api/api";
22
import { intervalToDuration, formatDuration } from "date-fns";
33

44
// optionValue is a helper function to format the value of a specific deployment options

‎site/src/pages/DeploySettingsPage/GeneralSettingsPage/GeneralSettingsPageView.tsx

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
import Box from "@mui/material/Box";
2-
import { DeploymentOption } from "api/types";
32
import { DAUsResponse } from "api/typesGenerated";
43
import { ErrorAlert } from "components/Alert/ErrorAlert";
54
import { DAUChart, DAUTitle } from "components/DAUChart/DAUChart";
@@ -9,6 +8,7 @@ import { Stack } from "components/Stack/Stack";
98
import { ChartSection } from "./ChartSection";
109
import { useDeploymentOptions } from "utils/deployOptions";
1110
import { docs } from "utils/docs";
11+
import { DeploymentOption } from "api/api";
1212

1313
export type GeneralSettingsPageViewProps = {
1414
deploymentOptions: DeploymentOption[];

‎site/src/pages/DeploySettingsPage/NetworkSettingsPage/NetworkSettingsPageView.stories.tsx

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import { DeploymentGroup } from "api/types";
1+
import { DeploymentGroup } from "api/api";
22
import { NetworkSettingsPageView } from "./NetworkSettingsPageView";
33
import type { Meta, StoryObj } from "@storybook/react";
44

‎site/src/pages/DeploySettingsPage/NetworkSettingsPage/NetworkSettingsPageView.tsx

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import { DeploymentOption } from "api/types";
1+
import { DeploymentOption } from "api/api";
22
import {
33
Badges,
44
EnabledBadge,

‎site/src/pages/DeploySettingsPage/SecuritySettingsPage/SecuritySettingsPageView.stories.tsx

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import { DeploymentGroup, DeploymentOption } from "api/types";
1+
import { DeploymentGroup, DeploymentOption } from "api/api";
22
import { SecuritySettingsPageView } from "./SecuritySettingsPageView";
33
import type { Meta, StoryObj } from "@storybook/react";
44

‎site/src/pages/DeploySettingsPage/SecuritySettingsPage/SecuritySettingsPageView.tsx

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import { DeploymentOption } from "api/types";
1+
import { DeploymentOption } from "api/api";
22
import {
33
Badges,
44
DisabledBadge,

‎site/src/pages/DeploySettingsPage/UserAuthSettingsPage/UserAuthSettingsPageView.stories.tsx

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import { DeploymentGroup } from "api/types";
1+
import { DeploymentGroup } from "api/api";
22
import { UserAuthSettingsPageView } from "./UserAuthSettingsPageView";
33
import type { Meta, StoryObj } from "@storybook/react";
44

‎site/src/pages/DeploySettingsPage/UserAuthSettingsPage/UserAuthSettingsPageView.tsx

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import { DeploymentOption } from "api/types";
1+
import { DeploymentOption } from "api/api";
22
import {
33
Badges,
44
DisabledBadge,

‎site/src/pages/TerminalPage/TerminalPage.test.tsx

+1-5
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@ import {
88
MockWorkspaceAgent,
99
} from "testHelpers/entities";
1010
import { TextDecoder, TextEncoder } from "util";
11-
import { ReconnectingPTYRequest } from "../../api/types";
1211
import {
1312
renderWithAuth,
1413
waitForLoaderToBeRemoved,
@@ -142,10 +141,7 @@ describe("TerminalPage", () => {
142141
// Then
143142
await ws.connected;
144143
const msg = await ws.nextMessage;
145-
const req: ReconnectingPTYRequest = JSON.parse(
146-
new TextDecoder().decode(msg as Uint8Array),
147-
);
148-
144+
const req = JSON.parse(new TextDecoder().decode(msg as Uint8Array));
149145
expect(req.height).toBeGreaterThan(0);
150146
expect(req.width).toBeGreaterThan(0);
151147
ws.close();

‎site/src/testHelpers/entities.ts

+7-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
1-
import { withDefaultFeatures, GetLicensesResponse } from "api/api";
1+
import {
2+
withDefaultFeatures,
3+
GetLicensesResponse,
4+
DeploymentConfig,
5+
} from "api/api";
26
import { FieldError } from "api/errors";
37
import { everyOneGroup } from "utils/groups";
4-
import * as Types from "api/types";
58
import * as TypesGen from "api/typesGenerated";
69
import range from "lodash/range";
710
import { Permissions } from "xServices/auth/authXService";
@@ -1114,7 +1117,7 @@ export const MockWorkspaceRequest: TypesGen.CreateWorkspaceRequest = {
11141117
],
11151118
};
11161119

1117-
export const MockUserAgent: Types.UserAgent = {
1120+
export const MockUserAgent = {
11181121
browser: "Chrome 99.0.4844",
11191122
device: "Other",
11201123
ip_address: "11.22.33.44",
@@ -2049,7 +2052,7 @@ export const MockPermissions: Permissions = {
20492052
editWorkspaceProxies: true,
20502053
};
20512054

2052-
export const MockDeploymentConfig: Types.DeploymentConfig = {
2055+
export const MockDeploymentConfig: DeploymentConfig = {
20532056
config: {
20542057
enable_terraform_debug_mode: true,
20552058
},

‎site/src/testHelpers/handlers.ts

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
import { rest } from "msw";
2-
import { WorkspaceBuildTransition } from "../api/types";
32
import { CreateWorkspaceBuildRequest } from "../api/typesGenerated";
43
import { permissionsToCheck } from "../xServices/auth/authXService";
54
import * as M from "./entities";
@@ -238,7 +237,7 @@ export const handlers = [
238237
stop: M.MockWorkspaceBuildStop,
239238
delete: M.MockWorkspaceBuildDelete,
240239
};
241-
const result = transitionToBuild[transition as WorkspaceBuildTransition];
240+
const result = transitionToBuild[transition];
242241
return res(ctx.status(200), ctx.json(result));
243242
}),
244243
rest.get("/api/v2/workspaces/:workspaceId/builds", async (req, res, ctx) => {

‎site/src/utils/deployOptions.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1+
import { DeploymentOption, DeploymentGroup } from "api/api";
12
import { useMemo } from "react";
2-
import { DeploymentGroup, DeploymentOption } from "../api/types";
33

44
const deploymentOptions = (
55
options: DeploymentOption[],

‎site/src/xServices/deploymentConfig/deploymentConfigMachine.ts

+5-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
11
import { DAUsResponse } from "./../../api/typesGenerated";
2-
import { getDeploymentValues, getDeploymentDAUs } from "api/api";
2+
import {
3+
getDeploymentValues,
4+
getDeploymentDAUs,
5+
DeploymentConfig,
6+
} from "api/api";
37
import { createMachine, assign } from "xstate";
4-
import { DeploymentConfig } from "api/types";
58

69
export const deploymentConfigMachine = createMachine(
710
{

‎site/src/xServices/template/templateVariablesXService.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@ import {
66
} from "api/api";
77
import {
88
CreateTemplateVersionRequest,
9+
Response,
910
Template,
1011
TemplateVersion,
1112
TemplateVersionVariable,
1213
} from "api/typesGenerated";
1314
import { assign, createMachine } from "xstate";
1415
import { delay } from "utils/delay";
15-
import { Message } from "api/types";
1616

1717
type TemplateVariablesContext = {
1818
organizationId: string;
@@ -57,7 +57,7 @@ export const templateVariablesMachine = createMachine(
5757
data: TemplateVersion;
5858
};
5959
updateTemplate: {
60-
data: Message;
60+
data: Response;
6161
};
6262
},
6363
},

‎site/src/xServices/terminal/terminalXService.ts

+9-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,12 @@
11
import { assign, createMachine } from "xstate";
2-
import * as API from "../../api/api";
3-
import * as Types from "../../api/types";
4-
import * as TypesGen from "../../api/typesGenerated";
2+
import * as API from "api/api";
3+
import * as TypesGen from "api/typesGenerated";
4+
5+
interface ReconnectingPTYRequest {
6+
readonly data?: string;
7+
readonly height?: number;
8+
readonly width?: number;
9+
}
510

611
export interface TerminalContext {
712
workspaceError?: unknown;
@@ -33,7 +38,7 @@ export type TerminalEvent =
3338
workspaceName?: string;
3439
username?: string;
3540
}
36-
| { type: "WRITE"; request: Types.ReconnectingPTYRequest }
41+
| { type: "WRITE"; request: ReconnectingPTYRequest }
3742
| { type: "READ"; data: ArrayBuffer }
3843
| { type: "DISCONNECT" };
3944

‎site/src/xServices/workspace/workspaceXService.ts

+6-10
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,9 @@ import { getErrorMessage } from "api/errors";
22
import dayjs from "dayjs";
33
import { workspaceScheduleBannerMachine } from "xServices/workspaceSchedule/workspaceScheduleBannerXService";
44
import { assign, createMachine, send } from "xstate";
5-
import * as API from "../../api/api";
6-
import * as Types from "../../api/types";
7-
import * as TypesGen from "../../api/typesGenerated";
8-
import {
9-
displayError,
10-
displaySuccess,
11-
} from "../../components/GlobalSnackbar/utils";
5+
import * as API from "api/api";
6+
import * as TypesGen from "api/typesGenerated";
7+
import { displayError, displaySuccess } from "components/GlobalSnackbar/utils";
128

139
const latestBuild = (builds: TypesGen.WorkspaceBuild[]) => {
1410
// Cloning builds to not change the origin object with the sort()
@@ -65,7 +61,7 @@ export interface WorkspaceContext {
6561
missedParameters?: TypesGen.TemplateVersionParameter[];
6662
// error creating a new WorkspaceBuild
6763
buildError?: unknown;
68-
cancellationMessage?: Types.Message;
64+
cancellationMessage?: TypesGen.Response;
6965
cancellationError?: unknown;
7066
// debug
7167
createBuildLogLevel?: TypesGen.CreateWorkspaceBuildRequest["log_level"];
@@ -171,10 +167,10 @@ export const workspaceMachine = createMachine(
171167
data: TypesGen.WorkspaceBuild;
172168
};
173169
cancelWorkspace: {
174-
data: Types.Message;
170+
data: TypesGen.Response;
175171
};
176172
activateWorkspace: {
177-
data: Types.Message;
173+
data: TypesGen.Response;
178174
};
179175
listening: {
180176
data: TypesGen.ServerSentEvent;

0 commit comments

Comments
 (0)