feat: add autogenSWRKey option

re #29

Author: croutonn

README.md

@@ -24,6 +24,10 @@ config:
   useSWRInfinite:
     - hoge
     - bar{1,3}
+  # generate keys automatically.
+  # but, ​the cache may not work unless you separate the variables object into an external file and use it,
+  # or use a primitive type for the value of each field.
+  autogenSWRKey: true #(default: false)
 ```
 
 ```typescript

src/config.ts

@@ -25,4 +25,5 @@ export interface RawSWRPluginConfig extends RawClientSideBasePluginConfig {
   rawRequest?: boolean
   excludeQueries?: string | string[]
   useSWRInfinite?: string | string[]
+  autogenSWRKey?: boolean
 }

src/visitor.ts

@@ -15,6 +15,7 @@ export interface SWRPluginConfig extends ClientSideBasePluginConfig {
   rawRequest: boolean
   excludeQueries: string | string[]
   useSWRInfinite: string | string[]
+  autogenSWRKey: boolean
 }
 
 export class SWRVisitor extends ClientSideBaseVisitor<
@@ -39,6 +40,7 @@ export class SWRVisitor extends ClientSideBaseVisitor<
     super(schema, fragments, rawConfig, {
       excludeQueries: rawConfig.excludeQueries || null,
       useSWRInfinite: rawConfig.useSWRInfinite || null,
+      autogenSWRKey: rawConfig.autogenSWRKey || false,
     })
 
     this._enabledInfinite =
@@ -93,7 +95,7 @@ export class SWRVisitor extends ClientSideBaseVisitor<
   }
 
   public get sdkContent(): string {
-    const { excludeQueries } = this.config
+    const { excludeQueries, autogenSWRKey } = this.config
     const disabledexcludeQueries =
       !excludeQueries ||
       (Array.isArray(excludeQueries) && !excludeQueries.length)
@@ -116,22 +118,23 @@ export class SWRVisitor extends ClientSideBaseVisitor<
             (v) => v.type.kind !== Kind.NON_NULL_TYPE || v.defaultValue
           )
         const name = o.node.name.value
+        const pascalName = pascalCase(o.node.name.value)
         const enabledInfinite =
           this._enabledInfinite &&
           glob.isMatch(name, this.config.useSWRInfinite)
         const codes: string[] = []
 
         if (this.config.rawRequest) {
-          codes.push(`use${pascalCase(
-            o.node.name.value
-          )}(key: SWRKeyInterface, variables${optionalVariables ? '?' : ''}: ${
+          codes.push(`use${pascalCase(o.node.name.value)}(${
+            autogenSWRKey ? '' : 'key: SWRKeyInterface, '
+          }variables${optionalVariables ? '?' : ''}: ${
             o.operationVariablesTypes
           }, config?: SWRConfigInterface<SWRRawResponse<${
             o.operationResultType
           }>}>) {
-            return useSWR<SWRRawResponse<${
-              o.operationResultType
-            }>>(key, () => sdk.${o.node.name.value}(variables), config);
+            return useSWR<SWRRawResponse<${o.operationResultType}>>(${
+            autogenSWRKey ? `genKey('${pascalName}', variables)` : 'key'
+          }, () => sdk.${o.node.name.value}(variables), config);
         }`)
 
           if (enabledInfinite) {
@@ -152,14 +155,14 @@ export class SWRVisitor extends ClientSideBaseVisitor<
           return codes
         }
 
-        codes.push(`use${pascalCase(
-          o.node.name.value
-        )}(key: SWRKeyInterface, variables${optionalVariables ? '?' : ''}: ${
+        codes.push(`use${pascalName}(${
+          autogenSWRKey ? '' : 'key: SWRKeyInterface, '
+        }variables${optionalVariables ? '?' : ''}: ${
           o.operationVariablesTypes
         }, config?: SWRConfigInterface<${o.operationResultType}>) {
-  return useSWR<${o.operationResultType}>(key, () => sdk.${
-          o.node.name.value
-        }(variables), config);
+  return useSWR<${o.operationResultType}>(${
+          autogenSWRKey ? `genKey('${pascalName}', variables)` : 'key'
+        }, () => sdk.${o.node.name.value}(variables), config);
 }`)
 
         if (enabledInfinite) {
@@ -197,7 +200,11 @@ export class SWRVisitor extends ClientSideBaseVisitor<
     return `${types.join('\n')}
 export function getSdkWithHooks(client: GraphQLClient, withWrapper: SdkFunctionWrapper = defaultWrapper) {
   const sdk = getSdk(client, withWrapper);
-  return {
+${
+  autogenSWRKey
+    ? '  const genKey = <V extends Record<string, unknown> = Record<string, unknown>>(name: string, object?: V): SWRKeyInterface => [name, ...Object.keys(object || {}).sort().map(key => object[key])];\n'
+    : ''
+}  return {
     ...sdk,
 ${allPossibleActions.join(',\n')}
   };

tests/swr.spec.ts

@@ -317,4 +317,40 @@ export type SdkWithHooks = ReturnType<typeof getSdkWithHooks>;`
       )
     })
   })
+
+  it('Should work `autogenSWRKey` option correctly', async () => {
+    const config: PluginsConfig = {
+      autogenSWRKey: true,
+    }
+    const docs = [{ location: '', document: basicDoc }]
+
+    const content = (await plugin(schema, docs, config, {
+      outputFile: 'graphql.ts',
+    })) as Types.ComplexPluginOutput
+
+    const usage = basicUsage
+    const output = await validate(content, config, docs, schema, usage)
+    expect(output).toContain(
+      `export function getSdkWithHooks(client: GraphQLClient, withWrapper: SdkFunctionWrapper = defaultWrapper) {
+  const sdk = getSdk(client, withWrapper);
+  const genKey = <V extends Record<string, unknown> = Record<string, unknown>>(name: string, object?: V): SWRKeyInterface => [name, ...Object.keys(object || {}).sort().map(key => object[key])];
+  return {
+    ...sdk,
+    useFeed(variables?: FeedQueryVariables, config?: SWRConfigInterface<FeedQuery>) {
+      return useSWR<FeedQuery>(genKey('Feed', variables), () => sdk.feed(variables), config);
+    },
+    useFeed2(variables: Feed2QueryVariables, config?: SWRConfigInterface<Feed2Query>) {
+      return useSWR<Feed2Query>(genKey('Feed2', variables), () => sdk.feed2(variables), config);
+    },
+    useFeed3(variables?: Feed3QueryVariables, config?: SWRConfigInterface<Feed3Query>) {
+      return useSWR<Feed3Query>(genKey('Feed3', variables), () => sdk.feed3(variables), config);
+    },
+    useFeed4(variables?: Feed4QueryVariables, config?: SWRConfigInterface<Feed4Query>) {
+      return useSWR<Feed4Query>(genKey('Feed4', variables), () => sdk.feed4(variables), config);
+    }
+  };
+}
+export type SdkWithHooks = ReturnType<typeof getSdkWithHooks>;`
+    )
+  })
 })