동기화 오류 처리 - React Native SDK

일반 동기화 오류 처리기 추가

일반 동기화 오류 처리기는 동기화 오류를 추적하는 좋은 방법입니다. FlexibleSyncConfiguration 을 사용하여 오류 처리 동작을 정의할 수 있습니다.

일반 동기화 오류 처리기를 추가하려면 다음 단계를 따르세요.

1. 오류 핸들러 함수를 작성합니다.

2. RealmProvider 에 대한 FlexibleSyncConfiguration 객체를 만듭니다.

3. 오류 핸들러를 FlexibleSyncConfiguration 객체의 onError 속성에 전달합니다.

const syncConfigWithErrorHandling = {
  flexible: true,
  onError: (_session, error) => {
    console.log(error);
  },
};
function RealmWithErrorHandling() {
  return (
    <RealmProvider sync={syncConfigWithErrorHandling}>
      <RestOfApp />
    </RealmProvider>
  );
}

보상 쓰기 오류 처리

동기화 오류 핸들러가 앱에 적합한 방식으로 보상 쓰기 오류를 구체적으로 해결하기를 원할 수 있습니다. CompensatingWriteError 클래스는 사용자 지정 오류 핸들러에서 보상 쓰기 오류를 식별하고 이에 대응하는 데 도움이 될 수 있습니다.

보상 쓰기 오류를 처리하려면 다음을 수행합니다.

1. CompensatingWriteError 를 사용하여 보상 쓰기 오류를 식별하는 오류 핸들러 함수를 작성합니다.

2. RealmProvider 에 대한 FlexibleSyncConfiguration 객체를 만듭니다.

3. 오류 핸들러를 FlexibleSyncConfiguration 객체의 onError 속성에 전달합니다.

export const CompensatingWriteErrorHandling = () => {
  const [error, setError] = useState<CompensatingWriteError | undefined>(
    undefined,
  );
  // Create a callback for sync error handling using CompensatingWriteError
  const errorCallback: ErrorCallback = (_session, error) => {
    if (error instanceof CompensatingWriteError) {
      // Handle the compensating write error as needed
      console.debug({
        code: error.code,
        name: error.name,
        category: error.category,
        message: error.message,
        url: error.logUrl,
        writes: error.writes,
      });
      setError(error);
    }
  };
  return (
    <AppProvider id={APP_ID}>
      <UserProvider fallback={LogIn}>
        <RealmProvider
          schema={[Person, Turtle]}
          sync={{
            flexible: true,
            onError: errorCallback,
          }}>
          <CompensatingWriteErrorHandler error={error} />
        </RealmProvider>
      </UserProvider>
    </AppProvider>
  );
};

클라이언트 재설정 모드

영역을 동기화 가능 상태로 복원하기 위해 앱에서 사용해야 하는 클라이언트 재설정 모드 를 지정할 수 있습니다.

• 동기화되지 않은 변경 사항 복구 모드: 이 모드를 선택하면 클라이언트는 동기화되지 않은 변경 사항을 복구하려고 시도합니다. 동기화되지 않은 변경 사항을 삭제하지 않으려면 이 모드를 선택하세요.

• 동기화되지 않은 변경 사항 복구 또는 삭제 모드: 클라이언트는 먼저 아직 동기화되지 않은 변경 사항 복구를 시도합니다. 클라이언트가 동기화되지 않은 데이터를 복구할 수 없는 경우 동기화되지 않은 변경 사항을 삭제하지만 계속 자동으로 클라이언트 재설정을 수행합니다. 동기화되지 않은 변경 사항을 삭제하도록 자동 클라이언트 복구를 활성화하려면 이 모드를 선택합니다.

• 동기화되지 않은 변경 사항 삭제 모드: 마지막 동기화 이후의 변경 사항을 삭제하여 영역을 동기화 가능한 상태로 복원합니다.

• 수동 복구 모드: Realm의 새 복사본을 다운로드하고 동기화할 수 없는 Realm을 백업으로 이동합니다. Realm의 백업 복사본에서 동기화 가능한 새 복사본으로 동기화되지 않은 데이터를 마이그레이션합니다.

자동 및 수동 클라이언트 재설정

Realm SDK는 대부분의 클라이언트 재설정 오류를 자동으로 처리하는 클라이언트 재설정 모드를 제공합니다.

자동 클라이언트 재설정 모드는 영역을 닫거나 알림을 누락하지 않고 로컬 Realm 파일을 동기화 가능한 상태로 복원합니다. The following client reset modes support automatic client resets:

• 동기화되지 않은 변경 사항 복구 모드

• 동기화되지 않은 변경 사항 복구 또는 삭제 모드

• 동기화되지 않은 변경 사항 삭제 모드

이러한 모드의 차이점은 아직 백엔드에 동기화되지 않은 기기의 변경 사항을 처리하는 방법에 따라 달라집니다. 수동 복구 모드만 자동 클라이언트 재설정을 수행하지 않습니다.

동기화되지 않은 변경 사항 복구 모드를 선택하여 대부분의 클라이언트 재설정 시나리오를 자동으로 처리합니다. 이렇게 하면 클라이언트 재설정이 발생할 때 동기화되지 않은 변경 사항을 복구하려고 시도합니다.

앱에 자동으로 처리할 수 없는 특정 클라이언트 재설정 로직이 필요한 경우 자동 클라이언트 재설정 모드 에 수동 클라이언트 재설정 처리기를 추가 해야 할 수 있습니다.

복구를 통한 클라이언트 재설정

클라이언트 복구는 Realm Mobile Sync를 구성할 때 기본적으로 활성화되는 기능입니다. 클라이언트 복구가 활성화되면 Realm은 대부분의 경우 클라이언트 재설정 프로세스를 managed합니다. 클라이언트는 스키마 변경 사항이 없는 경우 동기화되지 않은 변경 사항을 복구하거나 호환성이 손상되지 않는 스키마 변경 사항을 복구할 수 있습니다.

클라이언트 복구를 사용하려면 다음 클라이언트 재설정 모드 중 하나로 영역을 구성하세요.

• 동기화되지 않은 변경 사항 복구 모드

• 동기화되지 않은 변경 사항 복구 또는 삭제

클라이언트 복구가 활성화된 경우 이러한 규칙은 백엔드와 클라이언트가 모두 동일한 객체를 변경할 때 충돌을 해결하는 방법을 포함하여 객체가 통합되는 방식을 결정합니다.

• 로컬에서 생성되었지만 클라이언트 재설정 전에 동기화되지 않은 객체는 동기화됩니다.

• 객체가 서버에서 삭제되었지만 복구 클라이언트에서 수정된 경우 삭제가 우선적으로 적용되고 클라이언트는 업데이트를 삭제합니다.

• 객체가 복구 중인 클라이언트에서는 삭제되고 서버에서는 삭제되지 않는 경우 클라이언트는 서버의 삭제 명령을 적용합니다.

• 동일한 필드에 대한 업데이트가 충돌하는 경우 클라이언트 업데이트가 적용됩니다.

클라이언트 복구 구성에 대한 자세한 내용은 App Services 문서의 클라이언트 복구 를 참조하세요.

앱에서 손상적인 스키마 변경이 발생하면 클라이언트 복구가 성공할 수 없습니다. 단절적 변경은 서버 측 스키마에서 처리할 추가 조치가 필요한 변경 사항입니다. 이 시나리오에서 클라이언트 재설정은 수동 오류 클라이언트 재설정 대체로 대체됩니다.

단절적 스키마 변경과 단절적이지 않은 스키마 변경에 대한 자세한 내용은 App Services 문서에서 단절적 변경과 단절적이지 않은 변경 비교 빠른 참조 를 참조하세요.

동기화되지 않은 변경 사항 삭제 모드

동기화 되지 않은 변경 사항 삭제 모드는 마지막 동기화에 성공한 이후 이루어진 모든 동기화되지 않은 로컬 변경 사항을 영구적으로 삭제합니다. 앱에 자동 클라이언트 복구 와 일치하지 않는 클라이언트 복구 로직이 필요하거나 동기화되지 않은 데이터를 복구하지 않으려는 경우 이 모드를 사용할 수 있습니다.

애플리케이션에서 아직 백엔드에 동기화되지 않은 로컬 데이터를 잃을 수 없는 경우 동기화되지 않은 변경 사항 삭제 모드를 사용하지 마세요.

동기화되지 않은 변경 사항 삭제 모드로 클라이언트 재설정을 처리하려면 clientReset FlexibleSyncConfiguration 의 필드에 ClientResetConfiguration 을 전달합니다. 에 다음 속성을 ClientResetConfiguration 포함합니다.

• mode: "discardUnsyncedChanges" 로 설정합니다.

• onBefore: 선택 사항입니다. SDK가 백엔드에서 클라이언트 재설정 오류를 수신하는 경우, SDK가 이 모드를 실행하기 전에 호출되는 콜백 함수입니다. 영역의 복사본을 제공합니다.

• onAfter: 선택 사항입니다. SDK가 이 모드를 성공적으로 실행한 후 호출되는 콜백 함수입니다. 클라이언트 재설정 전후의 영역 인스턴스를 제공합니다.

다음 예제에서는 동기화되지 않은 변경 사항 삭제 모드를 구현합니다.

수동 모드

수동 모드에서는 클라이언트 재설정 처리기를 직접 정의할 수 있습니다. 자동 복구 로직이 앱에서 작동하지 않고 동기화되지 않은 로컬 데이터를 삭제할 수 없는 경우 수동 클라이언트 재설정 핸들러를 사용할 수 있습니다.

수동 모드로 클라이언트 재설정을 처리하려면 clientReset FlexibleSyncConfiguration 의 필드에 ClientResetConfiguration 을 전달합니다. 에 다음 속성을 ClientResetConfiguration 포함합니다.

• mode: "manual" 로 설정합니다.

• onManual: 선택 사항입니다. 클라이언트 재설정이 발생할 때 호출되는 콜백 함수입니다. 동기화 세션 및 현재 영역의 경로에 대한 정보를 제공합니다. onManual 오류 핸들러를 설정하지 않으면 클라이언트 재설정 오류는 일반 동기화 오류 핸들러로 돌아갑니다.

클라이언트 재설정 처리 테스트

Device Sync를 종료했다가 다시 활성화하여 애플리케이션의 클라이언트 재설정 처리를 수동으로 테스트할 수 있습니다.

동기화를 종료했다가 다시 허용하면 이전에 동기화로 연결한 클라이언트는 클라이언트 재설정을 수행할 때까지 연결할 수 없습니다. 동기화를 종료하면 클라이언트의 동기화를 허용하는 메타데이터가 서버에서 삭제됩니다. 클라이언트는 서버에서 영역의 새 복사본을 다운로드해야 합니다. 서버는 이러한 클라이언트에 클라이언트 재설정 오류를 보냅니다. 따라서 동기화를 종료하면 trigger 클라이언트 재설정 조건이 됩니다.

클라이언트 재설정 처리를 테스트하려면 다음을 수행합니다.

1. 클라이언트 애플리케이션에서 데이터를 쓰고 동기화될 때까지 기다립니다.

2. Realm Mobile Sync를 종료했다가 다시 활성화합니다.

3. 클라이언트 앱을 다시 실행합니다. 앱이 서버에 연결하려고 할 때 클라이언트 재설정 오류가 발생해야 합니다.