Apollo-link: [Recurso] método apollo-link-http GET remover caracteres ignorados

Criado em 10 jun. 2019  ·  3Comentários  ·  Fonte: apollographql/apollo-link

Para um projeto no qual estou trabalhando, estamos usando o método GET para fazer o benefício da chamada do cache HTTP. Isso está funcionando com sucesso, mas notamos que o parâmetro de consulta contém caracteres que não são necessários para executar a consulta.

Exemplo
Abaixo um exemplo em que estamos usando graphql-tag para analisar a consulta. Novas linhas são incluídas para facilitar a leitura da consulta.

import gql from 'graphql-tag';

const HERO_QUERY = gql`
  query HERO_QUERY {
    hero {
      name
      friends {
        name
      }
    }
  }
`;

O comportamento real resulta na seguinte solicitação HTTP:

GET /graphql?query=query%20HERO_QUERY%20%7B%0A%20%20hero%20%7B%0A%20%20%20%20name%0A%20%20%20%20friends%20%7B%0A%20%20%20%20%20%20name%0A%20%20%20%20%20%20__typename%0A%20%20%20%20%7D%0A%20%20%20%20__typename%0A%20%20%7D%0A%7D%0A&operationName=HERO_QUERY&variables=%7B%7D HTTP/1.1
Host: localhost:3000
Connection: keep-alive
content-type: application/json

O comportamento esperado é uma consulta GET sem caracteres desnecessários:

GET /graphql?query=query%20HERO_QUERY%7Bhero%7Bname%20friends%7Bname%7D%7D%7D&operationName=HERO_QUERY&variables=%7B%7D HTTP/1.1
Host: localhost:3000
Connection: keep-alive
content-type: application/json

No momento, não vejo uma maneira / capacidade de implementar uma solução alternativa para obter o mesmo resultado. Se esta solicitação fizer sentido, posso fornecer um PR para fazer as modificações necessárias.

https://github.com/apollographql/apollo-link/blob/951217bad34c91f89c1f167cc809bd0cc18fd922/packages/apollo-link-http/src/httpLink.ts#L198 -L203

O corpo de rewriteURIForGET pode ser removido antes de passar pelo encodeURIComponent .

Seria possível reutilizar a lógica que é usada no pacote graphql onde há um método utilitário disponível stripIgnoredCharacters .

O pacote graphql já está referenciado em apollo-link-http e pode ser reutilizado ou a lógica personalizada pode ser incluída diretamente para higienizar a consulta.

Comentários muito úteis

Acabamos corrigindo o apollo-link-http-common por meio de https://www.npmjs.com/package/patch-package para usar stripIgnoredCharacters logo após a impressora ser usada:

patches / apollo-link-http-common + 0.2.13.patch

diff --git a/node_modules/apollo-link-http-common/lib/index.js b/node_modules/apollo-link-http-common/lib/index.js
index 05cd095..c79da1b 100644
--- a/node_modules/apollo-link-http-common/lib/index.js
+++ b/node_modules/apollo-link-http-common/lib/index.js
@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 var tslib_1 = require("tslib");
 var printer_1 = require("graphql/language/printer");
+var utilities_1 = require("graphql/utilities/stripIgnoredCharacters");
 var ts_invariant_1 = require("ts-invariant");
 var defaultHttpOptions = {
     includeQuery: true,
@@ -91,6 +92,7 @@ exports.selectHttpOptionsAndBody = function (operation, fallbackConfig) {
         body.extensions = extensions;
     if (http.includeQuery)
         body.query = printer_1.print(query);
+        body.query = utilities_1.stripIgnoredCharacters(body.query);
     return {
         options: options,
         body: body,

Todos 3 comentários

Tentei fazer a modificação fora da biblioteca apollo-link-http criando uma extensão ApolloLink para remover a consulta antes que ela seja passada para createHttpLink mas sem sorte, infelizmente.

import { ApolloLink } from 'apollo-link';
import gql from 'graphql-tag';
import { print } from 'graphql/language/printer';
import { stripIgnoredCharacters } from 'graphql/utilities/stripIgnoredCharacters';

class CreateShortQueryLink extends ApolloLink {
  request(operation, forward) {
    const strippedQuery = stripIgnoredCharacters(print(operation.query));

    const request = {
      ...operation,
      getContext: operation.getContext,
      setContext: operation.setContext,
      query: gql(strippedQuery),
    };

    return forward(request);
  }
}

const link = ApolloLink.from([
  new CreateShortQueryLink(),
  createHttpLink({ uri: 'http://localhost:3000/graphql' }),
]);

Parece que print de graphql/language/printer está adicionando novamente os caracteres desnecessários.

print(gql('query Posts{posts(orderBy:id_DESC){id title __typename}}'))

// outputs
query Posts{posts(orderBy:id_DESC){id title __typename}} query Posts {
  posts(orderBy: id_DESC) {
    id
    title
    __typename
  }
}

Este mesmo método print parece ser usado também por apollo-link-http-common que é usado em apollo-link-http para criar a consulta GET.

https://github.com/apollographql/apollo-link/blob/c32e170b72ae1a94cea1c633f977d2dbfcada0e1/packages/apollo-link-http-common/src/index.ts#L239

Também tentei o acima com algo como:

export const createMinifyLink = () => {
  return new ApolloLink((operation: Operation, forward: NextLink) => {
    const stripped = stripIgnoredCharacters(operation.query.loc!.source);
    return forward({
      ...operation,
      getContext: operation.getContext,
      setContext: operation.setContext,
      query: gql(stripped),
    });
  });
};

Mas receba muitos avisos sobre a reutilização de nomes de fragmentos e problemas de gravação no armazenamento.

Eu usaria um interceptor HTTP, mas você tem problemas com hashes diferentes ao usar APQ. Tenho consultas de 44 KB e cheias de %20%20%20 . Acho que se eu pudesse remover os caracteres ignorados, provavelmente teria metade do tamanho.

Você não pode nem mesmo pré-processá-lo porque o ApolloClient apenas adiciona __typename e o torna a embelezar:

export function stripIgnoredCharactersGql(literals: string[], ...placeholders: any[]) {
  const strippedLiterals = literals.map(str => stripIgnoredCharacters(str));
  return gql(strippedLiterals, ...placeholders);
}

export const configQuery = stripIgnoredCharactersGql`
  query {
    hello {
      world
    }
  }
`;

Acabamos corrigindo o apollo-link-http-common por meio de https://www.npmjs.com/package/patch-package para usar stripIgnoredCharacters logo após a impressora ser usada:

patches / apollo-link-http-common + 0.2.13.patch

diff --git a/node_modules/apollo-link-http-common/lib/index.js b/node_modules/apollo-link-http-common/lib/index.js
index 05cd095..c79da1b 100644
--- a/node_modules/apollo-link-http-common/lib/index.js
+++ b/node_modules/apollo-link-http-common/lib/index.js
@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 var tslib_1 = require("tslib");
 var printer_1 = require("graphql/language/printer");
+var utilities_1 = require("graphql/utilities/stripIgnoredCharacters");
 var ts_invariant_1 = require("ts-invariant");
 var defaultHttpOptions = {
     includeQuery: true,
@@ -91,6 +92,7 @@ exports.selectHttpOptionsAndBody = function (operation, fallbackConfig) {
         body.extensions = extensions;
     if (http.includeQuery)
         body.query = printer_1.print(query);
+        body.query = utilities_1.stripIgnoredCharacters(body.query);
     return {
         options: options,
         body: body,
Esta página foi útil?
0 / 5 - 0 avaliações