sync offline actions

Ações de sincronização

Esta é uma biblioteca nativa do React criada para lidar com sincronizações com back -end. Imagine que alguma ação é despachada e, naquele momento você não tinha internet; com esta biblioteca, você poderá capturar essa ocurrença, salve as informações relacionadas à ação e enviá -la novamente quando a conexão estiver sendo restaurada. A melhor parte disso é que esta biblioteca é muito fácil de usar.

Começando

Requisitos

redux

react-redux

@react-native-community/netinfo > Você terá que instalar esta biblioteca antes, aqui estão as etapas: informações da rede

@react-native-community/async-storage

Instale a biblioteca

 yarn add sync-offline-actions

ou npm:

 npm install --save sync-offline-actions

Como usá -lo

Fornecemos quatro ferramentas para que você possa lidar com o comportamento do seu projeto. Esses são:

RestaureofflinActions

Este é um componente, que você terá que usar na raiz do seu projeto. É totalmente necessário que você use esse componente na raiz do seu projeto, porque ele precisa existir em um componente que está sempre vivo. Este componente terá que envolver os outros componentes que você tem na raiz do seu projeto, por exemplo:

 import { RestoreOfflineActions } from 'sync-offline-actions' ;
import actions from '@redux/some/actions' ;

// Some stuff

// Render/return
    < RestoreOfflineActions
      sections = { [
        { generalCondition : /* Condition of something */ , actions : { name : 'login' , associatedAction : actions . login } }
      ] } >
        < AppNavigator />
  </ RestoreOfflineActions >

As sections de suporte são totalmente obrigatórias para usar isso. Vamos ver a estrutura:

Você passará uma variedade de seções do seu aplicativo. Cada seção pode ter várias ações que você deseja despachar se tivessem acontecido. Por exemplo, imagine que quero definir algumas ações para a seção de Authorization do meu aplicativo e algumas ações para a seção do App . Definirei a condição para cada seção no valor da generalCondition . Eu terei uma matriz como esta:

 sections={[
   { generalCondition: /* Condition to know if the user is not logged in */, actions: [{ name: 'someAction', associatedAction: actions.someAction }] },
   { generalCondition: /* Condition to know if the user is logged in */, actions: [{ name: 'otherAction', associatedAction: actions.otherAction }, {name: 'otherAction2', associatedAction: actions.otherAction2 }] }
]}

Cada seção possui ações associadas. Cada ação terá um name (veremos a importância desse nome posteriormente) e uma associatedAction , esta última será a ação que você deseja despachar quando a conexão for restaurada.

SaveActionToBesync

Esta é uma função para salvar os momentos, ações ou Ocurrencys que serão despachados posteriormente. Aqui estão alguns exemplos de uso:

 // actions.js

import { saveActionToBeSync } from 'sync-offline-actions' ;

// Some code

// Imagine that you have an action and that action which send a request to back, that action will fail and you will want to save that request to do it later. You will do

saveActionToBeSync ( 'someAction' , [ arg1 , arg2 , arg3 ] ) ;

//Thunk Action example

function myThunkActionCreator ( id , someValue ) {
 return async ( dispatch , getState ) => {
  dispatch ( { type : "REQUEST_STARTED" } ;
  let response ;
  try {
      response = myAjaxLib . post ( "/someEndpoint" , { id , data : someValue } ) ;
  } catch ( error ) {
      saveActionToBeSync ( 'someThunkAction' , [ id , someValue ] ) ; // here we register the failed event that want to dispatch when the connection is restored
      dispatch ( { type : "REQUEST_FAILED" , error } ) ;
  }
  dispatch ( { type : "REQUEST_SUCCEEDED" , payload : response } ) ;
 }
}

// redux-recompose example

login : ( authData : AuthData ) => ( {
    type : actions . LOGIN ,
    target : TARGETS . CURRENT_USER ,
    service : AuthService . login ,
    payload : authData ,
    successSelector : ( ) => null ,
    injections : [
      withPostFailure ( ( ) => {
        //Check the reason of the failure
        saveActionToBeSync ( 'login' , [ authData ] ) ;
      } )
    ]
  } ) ,

O primeiro argumento do método será o nome que você usou antes para declarar as ações das seções no componente RestoreOfflineActions . O segundo argumento será uma variedade de arguments , quando a conexão for restaurada, a associatedAction associada ao name do primeiro argumento será chamada com a lista de argumentos do segundo argumento. É mais simples do que parece.

Recomendação

Recomendamos que você tenha um arquivo constante, onde você pode salvar os nomes das ações para poder ter esses nomes mais organizados, algo assim:

 // some constant file
export const OFFLINE_ACTION_NAMES = {
  SOME_ACTION : "someAction" ,
  OTHER_ACTION : "otherAction" ,
} ;

Importante

Todos os Ocurrencys serão excluídos após a restauração de uma conexão e algumas ações forem despachadas. Não é que as ações de algumas seções não foram despachadas, elas serão excluídas de qualquer maneira. Por favor, informe -nos por meio de um problema se você não concordar com esse comportamento.

Mais ferramentas

Essas ferramentas são uma vantagem para esta biblioteca, mas não estão relacionadas com a funcionalidade real disso, elas podem ajudá -lo a facilitar seu trabalho.

com Netinfo

Este é um hoc para pedir o estado da conexão. Aqui está um exemplo de uso:

 import { withNetInfo } from "sync-offline-actions" ;

class SomeComponent extends Component {
  /*some code*/
  someMethod = ( ) => {
    const { isConnected } = this . props ;
    /*Do something*/
  } ;
}

export default withNetInfo ( SomeComponent ) ;

O suporte isConnected injetado como um suporte de SomeComponent por causa do hoc com Netinfo, o suporte será atualizado com as alterações da rede.

UseNetinfo

Este é um alfândega com a mesma funcionalidade do withNetInfo , exemplo de uso:

 import { useNetInfo } from "sync-offline-actions" ;

const SomeFunction = ( ) => {
  const isConnected = useNetInfo ( ) ;
  // More of the function
} ;

Em seguida, o isConnected será atualizado com as últimas alterações da conexão.

Obrigado a

O povo de @react-native-community/netinfo

Contribuindo

1. Bifurcá -lo
2. Crie sua filial de recursos ( git checkout -b my-new-feature )
3. Comprometa suas alterações ( git commit -am 'Add some feature' )
4. Empurre para o ramo ( git push origin my-new-feature )
5. Crie um novo pedido de tração

Sobre

Este projeto foi criado por Felipe Rodriguez Esturo. É afetado por:

Licença

As ações de sincronização estão disponíveis sob a licença do MIT.

 Copyright (c) 2020 Felipe Rodriguez Esturo <[email protected]>

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.