refactor(server): e2e utilities (#11000)

packages/common/graphql/src/fetcher.ts

@@ -0,0 +1,237 @@
+import { DebugLogger } from '@affine/debug';
+import { GraphQLError } from '@affine/error';
+import type { ExecutionResult } from 'graphql';
+import { isNil, isObject, merge } from 'lodash-es';
+
+import type { GraphQLQuery } from './graphql';
+import type { Mutations, Queries } from './schema';
+
+export type NotArray<T> = T extends Array<unknown> ? never : T;
+
+export type FetchInit = RequestInit & { timeout?: number };
+
+export type _QueryVariables<Q extends GraphQLQuery> =
+  Q['id'] extends Queries['name']
+    ? Extract<Queries, { name: Q['id'] }>['variables']
+    : Q['id'] extends Mutations['name']
+      ? Extract<Mutations, { name: Q['id'] }>['variables']
+      : undefined;
+
+export type QueryVariables<Q extends GraphQLQuery> =
+  _QueryVariables<Q> extends never | Record<string, never>
+    ? never
+    : _QueryVariables<Q>;
+
+export type QueryResponse<Q extends GraphQLQuery> = Extract<
+  Queries | Mutations,
+  { name: Q['id'] }
+>['response'];
+
+type NullableKeys<T> = {
+  [K in keyof T]: null extends T[K] ? K : never;
+}[keyof T];
+
+type NonNullableKeys<T> = {
+  [K in keyof T]: null extends T[K] ? never : K;
+}[keyof T];
+
+export type RecursiveMaybeFields<T> = T extends
+  | number
+  | boolean
+  | string
+  | null
+  | undefined
+  ? T
+  : {
+      [K in NullableKeys<T>]?: RecursiveMaybeFields<T[K]>;
+    } & {
+      [K in NonNullableKeys<T>]: RecursiveMaybeFields<T[K]>;
+    };
+
+type AllowedRequestContext = Omit<RequestInit, 'method' | 'body'>;
+
+export interface RequestBody {
+  operationName?: string;
+  variables: any;
+  query: string;
+  form?: FormData;
+}
+
+type QueryVariablesOption<Q extends GraphQLQuery> =
+  QueryVariables<Q> extends never
+    ? {
+        variables?: undefined;
+      }
+    : { variables: RecursiveMaybeFields<QueryVariables<Q>> };
+
+export type RequestOptions<Q extends GraphQLQuery> = QueryVariablesOption<Q> & {
+  /**
+   * parameter passed to `fetch` function
+   */
+  context?: AllowedRequestContext;
+  /**
+   * Whether keep null or undefined value in variables.
+   *
+   * if `false` given, `{ a: 0, b: undefined, c: null }` will be converted to `{ a: 0 }`
+   *
+   * @default true
+   */
+  keepNilVariables?: boolean;
+  /**
+   * Request timeout in milliseconds
+   * @default 15000
+   */
+  timeout?: number;
+};
+
+export type QueryOptions<Q extends GraphQLQuery> = RequestOptions<Q> & {
+  query: Q;
+};
+export type MutationOptions<M extends GraphQLQuery> = RequestOptions<M> & {
+  mutation: M;
+};
+
+function filterEmptyValue(vars: any) {
+  const newVars: Record<string, any> = {};
+  Object.entries(vars).forEach(([key, value]) => {
+    if (isNil(value)) {
+      return;
+    }
+    if (isObject(value) && !(value instanceof File)) {
+      newVars[key] = filterEmptyValue(value);
+      return;
+    }
+    newVars[key] = value;
+  });
+
+  return newVars;
+}
+
+export function transformToForm(body: RequestBody) {
+  const form = new FormData();
+  const gqlBody: {
+    name?: string;
+    query: string;
+    variables: any;
+    map: any;
+  } = {
+    query: body.query,
+    variables: body.variables,
+    map: {},
+  };
+
+  if (body.operationName) {
+    gqlBody.name = body.operationName;
+  }
+  const map: Record<string, string[]> = {};
+  const files: File[] = [];
+  if (body.variables) {
+    let i = 0;
+    const buildMap = (key: string, value: any) => {
+      if (value instanceof File) {
+        map['' + i] = [key];
+        files[i] = value;
+        i++;
+      } else if (Array.isArray(value)) {
+        value.forEach((v, index) => {
+          buildMap(`${key}.${index}`, v);
+        });
+      } else if (isObject(value)) {
+        Object.entries(value).forEach(([k, v]) => {
+          buildMap(`${key}.${k}`, v);
+        });
+      }
+    };
+    buildMap('variables', body.variables);
+  }
+
+  form.set('operations', JSON.stringify(gqlBody));
+  form.set('map', JSON.stringify(map));
+  for (const [i, file] of files.entries()) {
+    form.set(`${i}`, file);
+  }
+  return form;
+}
+
+function formatRequestBody<Q extends GraphQLQuery>({
+  query,
+  variables,
+  keepNilVariables,
+}: QueryOptions<Q>): RequestBody | FormData {
+  const body: RequestBody = {
+    query: query.query,
+    variables:
+      (keepNilVariables ?? true) ? variables : filterEmptyValue(variables),
+  };
+
+  if (query.op) {
+    body.operationName = query.op;
+  }
+
+  if (query.file) {
+    return transformToForm(body);
+  }
+  return body;
+}
+
+export const gqlFetcherFactory = (
+  endpoint: string,
+  fetcher: (input: string, init?: FetchInit) => Promise<Response> = fetch
+) => {
+  const logger = new DebugLogger('GraphQL');
+  const gqlFetch = async <Query extends GraphQLQuery>(
+    options: QueryOptions<Query>
+  ): Promise<QueryResponse<Query>> => {
+    if (
+      BUILD_CONFIG.appBuildType === 'canary' &&
+      options.query.deprecations?.length
+    ) {
+      options.query.deprecations.forEach(deprecation => {
+        logger.warn(deprecation);
+      });
+    }
+
+    const body = formatRequestBody(options);
+
+    const isFormData = body instanceof FormData;
+    const headers: Record<string, string> = {
+      'x-operation-name': options.query.op,
+    };
+    if (!isFormData) {
+      headers['content-type'] = 'application/json';
+    }
+    const ret = fetcher(
+      endpoint,
+      merge(options.context, {
+        method: 'POST',
+        headers,
+        body: isFormData ? body : JSON.stringify(body),
+        timeout: options.timeout,
+      })
+    ).then(async res => {
+      if (res.headers.get('content-type')?.startsWith('application/json')) {
+        const result = (await res.json()) as ExecutionResult;
+        if (res.status >= 400 || result.errors) {
+          if (result.errors && result.errors.length > 0) {
+            // throw the first error is enough
+            const firstError = result.errors[0];
+            throw new GraphQLError(firstError.message, firstError);
+          } else {
+            throw new GraphQLError('Empty GraphQL error body');
+          }
+        } else if (result.data) {
+          // we have to cast here because the type of result.data is a union type
+          return result.data as any;
+        }
+      }
+
+      throw new GraphQLError(
+        'GraphQL query responds unexpected result, query ' + options.query.op
+      );
+    });
+
+    return ret;
+  };
+
+  return gqlFetch;
+};