Как выполнить загрузку файлов в приложении React-Relay?

Ответ 1

Сначала вам нужно написать обновление Relay в вашем компоненте веб-интерфейса. Вот так:

onDrop: function(files) {
  files.forEach((file)=> {
    Relay.Store.commitUpdate(
      new AddImageMutation({
        file,
        images: this.props.User,
      }),
      {onSuccess, onFailure}
    );
  });
},

А затем добавьте мутацию в интерфейс:

class AddImageMutation extends Relay.Mutation {
   static fragments = {
     images: () => Relay.QL'
       fragment on User {
         id,
       }',
     };

   getMutation() {
     return Relay.QL'mutation{ introduceImage }';
   }

   getFiles() {
     return {
       file: this.props.file,
     };
   }

   getVariables() {
     return {
       imageName: this.props.file.name,
     };
   }

   getFatQuery() {
     return Relay.QL'
       fragment on IntroduceImagePayload {
         User {
           images(first: 30) {
             edges {
               node {
                 id,
               }
             }
           }
         },
         newImageEdge,
       }
     ';
   }

   getConfigs() {
     return [{
       type: 'RANGE_ADD',
       parentName: 'User',
       parentID: this.props.images.id,
       connectionName: 'images',
       edgeName: 'newImageEdge',
       rangeBehaviors: {
         '': 'prepend',
       },
     }];
   }
 }

И наконец, реализуйте обработчик на сервере/схеме.

const imageMutation = Relay.mutationWithClientMutationId({
  name: 'IntroduceImage',
  inputFields: {
    imageName: {
      type: new GraphQL.GraphQLNonNull(GraphQL.GraphQLString),
    },
  },
  outputFields: {
    newImageEdge: {
      type: ImageEdge,
      resolve: (payload, args, options) => {
        const file = options.rootValue.request.file;
        //write the image to you disk
        return uploadFile(file.buffer, filePath, filename)
        .then(() => {
          /* Find the offset for new edge*/
          return Promise.all(
            [(new myImages()).getAll(),
              (new myImages()).getById(payload.insertId)])
          .spread((allImages, newImage) => {
            const newImageStr = JSON.stringify(newImage);
            /* If edge is in list return index */
            const offset = allImages.reduce((pre, ele, idx) => {
              if (JSON.stringify(ele) === newImageStr) {
                return idx;
              }
              return pre;
            }, -1);

            return {
              cursor: offset !== -1 ? Relay.offsetToCursor(offset) : null,
              node: newImage,
            };
          });
        });
      },
    },
    User: {
      type: UserType,
      resolve: () => (new myImages()).getAll(),
    },
  },
  mutateAndGetPayload: (input) => {
    //break the names to array.
    let imageName = input.imageName.substring(0, input.imageName.lastIndexOf('.'));
    const mimeType = input.imageName.substring(input.imageName.lastIndexOf('.'));
    //wirte the image to database
    return (new myImages())
    .add(imageName)
    .then(id => {
    //prepare to wirte disk
      return {
        insertId: id,
        imgNmae: imageName,
      };
    });
  },
});

Весь код выше вы можете найти их в моем репо https://github.com/bfwg/relay-gallery Также есть живая демонстрация https://fanjin.io

Ответ 2

Я нашел объяснение в документах. Вы можете подклассировать Relay.Mutation и реализовать функцию getFiles.

Кроме того, express-graphql предоставляет пример в своих тестовых примерах, как обращаться с этим на стороне сервера.

Ответ 3

Я просто делюсь выводами Марка-Андре Жиру из своего блога который является специфичным для Rails, поэтому я постараюсь сделать это более общий, и предоставляя детали ответа, предоставленного @Nick.

Есть 2 части:

• Клиентский код Javascript
• Код сервера на стороне сервера

Клиентский Javascript Code

Клиентский код далее состоит из двух частей:

• Мутация для загрузки файла, которая расширяет Relay.Mutation(UploadFileMutation)

  // The actual mutation
  class UploadFileMutation extends Relay.Mutation {
    getFiles() {
      return {
        file: this.props.file,
      };
    }
  
    // ... Rest of your mutation
  }
  

• Компонент, содержащий компонент React (FileUploader) для отображения пользовательского интерфейса для выбора файла и вызывает мутацию для загрузки

  // A react component to upload a file
  class FileUploader extends React.Component {
    onSubmit() {
      const name = this.refs.name.value;
      const file = this.refs.fileInput.files.item(0);
      Relay.Store.update(
        new UploadFileMutation({
          name: name,
          file: file,
        })
      );
    }
  
    // ... Rest of React component, e.g., render()
  }
  

Серверный код, специфичный для сервера

Код на стороне сервера также состоит из двух частей:

• Часть для обработки загруженного файла в MIME-формате и передать его в мутацию, определенную в схеме GraphQL. Мы предоставляем примеры NodeJS и Rails, которые помогут вам получить решения для других серверов.

Для сервера NodeJS Express (извлечено из express-graqphl тестовых случаев, как указано @Nick):

    import multer from 'multer';

    var app = express();
    var graphqlHTTP = require('express-graphql');

    // Multer provides multipart form data parsing.
    var storage = multer.memoryStorage();

    app.use(urlString(), multer({ storage }).single('file'));

    // Providing the request, which contains the file MIME
    // multipart as `rootValue` to enable it to
    // be accessible from within Schema resolve functions.
    app.use(urlString(), graphqlHTTP(req => {
      return {
        schema: YourMutationSchema,
        rootValue: { request: req }
      };
    }));

Аналогично, для не-JS-сервера, например RubyOnRails:

    def create
      query_string = params[:query]
      query_variables = ensure_hash(params[:variables]) || {}

      query = GraphQL::Query.new(
        YourSchema,
        query_string,
        variables: query_variables,
        # Shove the file MIME multipart into context to make it
        # accessible by GraphQL Schema Mutation resolve methods
        context: { file: request.params[:file] }
     )

2. Мутация может извлечь файл MIME multipart, переданный ему

Для Javascript GraphQL Schema:

    var YourMutationSchema = new GraphQLSchema({
      query: new GraphQLObjectType({
        // ... QueryType Schema
      }),
      mutation: new GraphQLObjectType({
        name: 'MutationRoot',
        fields: {
          uploadFile: {
            type: UploadedFileType,
            resolve(rootValue) {
              // Access file MIME multipart using
              const _file = rootValue.request.file;

              // ... Do something with file
            }
          }
        }
      })
    });

Для Rails GraphQL Schema:

    AddFileMutation = GraphQL::Relay::Mutation.define do
      name "AddFile"
      input_field :name, !types.String

      # ... Add your standard mutation schema stuff here

      resolve -> (args, ctx) {
        # Retrieve the file MIME multipart
        file = ctx[:file]
        raise StandardError.new("Expected a file") unless file

        # ... Do something with file
      }
    end

Ответ 4

Чтобы добавить к другим ответам, с Relay Modern, было небольшое изменение в том, как вы должны отправлять файлы с клиента. Вместо того чтобы иметь getFiles в вашей мутации и передавать файлы конструктору, вы можете использовать что-то вроде следующего:

UploadFileMutation.js

// @flow

import { commitMutation, graphql } from 'react-relay';

import type { Environment } from 'react-relay';
import type { UploadFileInput, UploadFileMutationResponse } from './__generated__/uploadFileMutation.graphql';

const mutation = graphql`
  mutation UploadFileMutation( $input: UploadFileInput! ) {
    UploadFile(input: $input) {
      error
      file {
        url
      }
    }
  }
`;

const getOptimisticResponse = (file: File | Blob) => ({
  UploadFile: {
    error: null,
    file: {
      url: file.uri,
    },
  },
});

function commit(
  environment: Environment,
  { fileName }: UploadFileInput,
  onCompleted: (data: UploadFileMutationResponse) => void,
  onError: () => void,
  uploadables,
) {
  return commitMutation(environment, {
    mutation,
    variables: {
      input: { fileName },
    },
    optimisticResponse: getOptimisticResponse(uploadables.fileToUpload),
    onCompleted,
    onError,
    uploadables,
  });
}

export default { commit };

Использование компонента:

const uploadables = {
  fileToUpload: file, // file is the value of an input field for example
};

UploadFileMutation.commit(
  this.props.relay.environment,
  { fileName },
  onCompleted,
  onError,
  uploadables
);

Опция конфигурации uploadables является скрытой, поскольку в документах нет упоминания о ней, но ее можно найти здесь: https://github.com/facebook/relay/blob/c4430643002ec409d815366b0721ba88ed3a855a/packages/relay-runtime/mutations/commitRelayModernMutation.js#L32

Ответ 5

Хотя вы определенно можете реализовать загрузку файлов в конечную точку API GraphQL, это считается анти-паттерном (вы столкнетесь с проблемами с максимальным размером файла и т.д.).

Лучшей альтернативой будет получение подписанного URL-адреса из API GraphQL для загрузки файла непосредственно из клиентского приложения в Amazon S3, Google Cloud Storage и т.д.

Если серверный код должен сохранить URL-адрес в базе данных после завершения загрузки, он может подписаться на это событие напрямую. Посмотрите уведомление об изменении объекта в Google Cloud в качестве примера.