opensource/coder
3
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2026-09-22 05:05:20 +08:00
Code Issues Packages Projects Releases Wiki Activity

refactor: update logic for all metadata query factories (#10356)

Browse Source 
* refactor: simplify metadata patterns

* fix: add return type to me factory

* fix: make sure query key for me is always defined at type level
This commit is contained in:
Michael Smith
2023-10-24 08:42:38 -04:00
committed by GitHub
parent 6b2aee4133
commit 7732ac475a
6 changed files with 27 additions and 43 deletions
Download Patch File Download Diff File Expand all files Collapse all files
site/src/api/queries/appearance.ts
+5 -11
View File
@@ -6,18 +6,12 @@ import { getMetadataAsJSON } from "utils/metadata";
const initialAppearanceData = getMetadataAsJSON<AppearanceConfig>("appearance");
const appearanceConfigKey = ["appearance"] as const;
export const appearance = (queryClient: QueryClient) => {
export const appearance = (): UseQueryOptions<AppearanceConfig> => {
return {
queryKey: appearanceConfigKey,
queryFn: async () => {
const cachedData = queryClient.getQueryData(appearanceConfigKey);
if (cachedData === undefined && initialAppearanceData !== undefined) {
return initialAppearanceData;
}
return API.getAppearance();
},
} satisfies UseQueryOptions<AppearanceConfig>;
queryKey: ["appearance"],
initialData: initialAppearanceData,
queryFn: () => API.getAppearance(),
};
};
export const updateAppearance = (queryClient: QueryClient) => {
site/src/api/queries/buildInfo.ts
+5 -11
View File
@@ -1,4 +1,4 @@
import { QueryClient, type UseQueryOptions } from "react-query";
import { type UseQueryOptions } from "react-query";
import { type BuildInfoResponse } from "api/typesGenerated";
import * as API from "api/api";
import { getMetadataAsJSON } from "utils/metadata";
@@ -6,16 +6,10 @@ import { getMetadataAsJSON } from "utils/metadata";
const initialBuildInfoData = getMetadataAsJSON<BuildInfoResponse>("build-info");
const buildInfoKey = ["buildInfo"] as const;
export const buildInfo = (queryClient: QueryClient) => {
export const buildInfo = (): UseQueryOptions<BuildInfoResponse> => {
return {
queryKey: buildInfoKey,
queryFn: async () => {
const cachedData = queryClient.getQueryData(buildInfoKey);
if (cachedData === undefined && initialBuildInfoData !== undefined) {
return initialBuildInfoData;
}
return API.getBuildInfo();
},
} satisfies UseQueryOptions<BuildInfoResponse>;
initialData: initialBuildInfoData,
queryFn: () => API.getBuildInfo(),
};
};
site/src/api/queries/entitlements.ts
+6 -5
View File
@@ -1,15 +1,16 @@
import { QueryClient } from "react-query";
import { QueryClient, UseQueryOptions } from "react-query";
import * as API from "api/api";
import { Entitlements } from "api/typesGenerated";
import { getMetadataAsJSON } from "utils/metadata";
const ENTITLEMENTS_QUERY_KEY = ["entitlements"];
const initialEntitlementsData = getMetadataAsJSON<Entitlements>("entitlements");
const ENTITLEMENTS_QUERY_KEY = ["entitlements"] as const;
export const entitlements = () => {
export const entitlements = (): UseQueryOptions<Entitlements> => {
return {
queryKey: ENTITLEMENTS_QUERY_KEY,
queryFn: async () =>
getMetadataAsJSON<Entitlements>("entitlements") ?? API.getEntitlements(),
queryFn: () => API.getEntitlements(),
initialData: initialEntitlementsData,
};
};
site/src/api/queries/experiments.ts
+4 -10
View File
@@ -1,22 +1,16 @@
import * as API from "api/api";
import { getMetadataAsJSON } from "utils/metadata";
import { type Experiments } from "api/typesGenerated";
import { QueryClient, type UseQueryOptions } from "react-query";
import { type UseQueryOptions } from "react-query";
const initialExperimentsData = getMetadataAsJSON<Experiments>("experiments");
const experimentsKey = ["experiments"] as const;
export const experiments = (queryClient: QueryClient) => {
export const experiments = (): UseQueryOptions<Experiments> => {
return {
queryKey: experimentsKey,
queryFn: async () => {
const cachedData = queryClient.getQueryData(experimentsKey);
if (cachedData === undefined && initialExperimentsData !== undefined) {
return initialExperimentsData;
}
return API.getExperiments();
},
initialData: initialExperimentsData,
queryFn: () => API.getExperiments(),
} satisfies UseQueryOptions<Experiments>;
};
site/src/api/queries/users.ts
+3 -1
View File
@@ -91,7 +91,9 @@ export const authMethods = () => {
const initialUserData = getMetadataAsJSON<User>("user");
export const me = () => {
export const me = (): UseQueryOptions<User> & {
queryKey: NonNullable<UseQueryOptions<User>["queryKey"]>;
} => {
return {
queryKey: ["me"],
initialData: initialUserData,
site/src/components/Dashboard/DashboardProvider.tsx
+4 -5
View File
@@ -1,4 +1,4 @@
import { useQuery, useQueryClient } from "react-query";
import { useQuery } from "react-query";
import { buildInfo } from "api/queries/buildInfo";
import { experiments } from "api/queries/experiments";
import { entitlements } from "api/queries/entitlements";
@@ -39,11 +39,10 @@ export const DashboardProviderContext = createContext<
>(undefined);
export const DashboardProvider: FC<PropsWithChildren> = ({ children }) => {
const queryClient = useQueryClient();
const buildInfoQuery = useQuery(buildInfo(queryClient));
const buildInfoQuery = useQuery(buildInfo());
const entitlementsQuery = useQuery(entitlements());
const experimentsQuery = useQuery(experiments(queryClient));
const appearanceQuery = useQuery(appearance(queryClient));
const experimentsQuery = useQuery(experiments());
const appearanceQuery = useQuery(appearance());
const isLoading =
!buildInfoQuery.data ||