Atividades confiáveis na Web que priorizam o modo off-line

Demián Renzulli

Na primeira vez que um usuário inicia um app da Web progressivo (PWA, na sigla em inglês) usando a atividade da Web confiável, o service worker ainda não estará disponível, já que o processo de registro ainda não foi realizado. Além disso, se o usuário não tiver conectividade durante a primeira inicialização do app, a página de erro de rede será mostrada em vez da experiência off-line personalizada.

Um exemplo desse cenário pode ocorrer depois que o usuário faz o download da PWA na Play Store. Se o usuário não tiver conectividade ao tentar abrir o app pela primeira vez, o worker de serviço ainda não estará disponível para mostrar a página de substituição off-line. A página de erro padrão será mostrada, resultando em uma experiência ruim.

Este guia explica como mostrar sua própria atividade nessa situação, verificando o status da rede antes de iniciar a atividade da Web confiável.

Criar uma LauncherActivity personalizada

A primeira etapa é criar uma atividade de inicialização personalizada. Essa Activity vai conter a tela off-line para mostrar se não há conectividade na primeira vez que um usuário abrir o app.

Chame a atividade OfflineFirstTWALauncherActivity e faça com que ela estenda: com.google.androidbrowserhelper.trusted.LauncherActivity.

import com.google.androidbrowserhelper.trusted.LauncherActivity;

public class OfflineFirstTWALauncherActivity extends LauncherActivity {

}

Em seguida, registre a atividade em AndroidManifest.xml:

<activity android:name=".OfflineFirstTWALauncherActivity" android:theme="@style/Theme.Design.NoActionBar">
    <intent-filter>
        <action android:name="android.intent.action.MAIN" />
        <category android:name="android.intent.category.LAUNCHER" />
    </intent-filter>
    <!-- Edit android:value to change the url opened by the Trusted Web Activity -->
    <meta-data android:name="android.support.customtabs.trusted.DEFAULT_URL" android:value="https://airhorner.com" />
    <!-- This intent-filter adds the Trusted Web Activity to the Android Launcher -->
    <intent-filter>
        <action android:name="android.intent.action.VIEW" />
        <category android:name="android.intent.category.DEFAULT" />
        <category android:name="android.intent.category.BROWSABLE" />
        <!-- Edit android:host to handle links to the target URL -->
        <data android:host="airhorner.com" android:scheme="https" />
    </intent-filter>
</activity>

O código anterior registra OfflineFirstTWALauncherActivity como uma atividade de inicialização e define https://airhorner.com como o URL a ser aberto quando o TWA for lançado.

Lidar com cenários off-line

Primeiro, na atividade, substitua o método shouldLaunchImmediately() e faça com que ele retorne false, para que a atividade confiável na Web não seja iniciada imediatamente. Também é possível adicionar verificações extras antes do lançamento inicial:

@Override
protected boolean shouldLaunchImmediately() {
    // launchImmediately() returns `false` so we can check connection
    // and then render a fallback page or launch the Trusted Web Activity with `launchTwa()`.
    return false;
}

Substitua o método onCreate() para verificar o status da rede antes do lançamento do TWA. Adicione uma chamada para tryLaunchTwa(), um método auxiliar que conterá essa lógica:

@Override
protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    tryLaunchTwa();
}

Em seguida, implemente tryLaunchTwa():

private void tryLaunchTwa() {
    // If TWA has already launched successfully, launch TWA immediately.
    // Otherwise, check connection status. If online, launch the Trusted Web Activity with `launchTwa()`.
    // Otherwise, if offline, render the offline fallback screen.
    if (hasTwaLaunchedSuccessfully()) {
        launchTwa();
    } else if (isOnline()) {
        firstTimeLaunchTwa();
    } else {
        renderOfflineFallback();
    }
}

O código anterior lida com três cenários:

• Se o TWA já foi lançado, o service worker foi registrado e o PWA poderá responder off-line. Nesse caso, chame launchTwa(), definido na classe pai, para iniciar a Atividade confiável na Web diretamente.
• Se a TWA não foi iniciada anteriormente e o usuário estiver on-line, inicie a Atividade Confiável na Web pela primeira vez usando o método firstTimeLaunchTwa() que você vai implementar mais tarde.
• Se o TWA ainda não tiver sido iniciado e o usuário estiver off-line, renderize a tela de substituição off-line nativa.

Implementar métodos auxiliares

A etapa final é implementar os métodos auxiliares chamados pelo código anterior. Confira o código para verificar o estado off-line isOnline():

private boolean isOnline() {
    ConnectivityManager connectivityManager = (ConnectivityManager) getSystemService(Context.CONNECTIVITY_SERVICE);
    NetworkInfo activeNetworkInfo = connectivityManager.getActiveNetworkInfo();
    return activeNetworkInfo != null && activeNetworkInfo.isConnected();
}

Em seguida, implemente hasTwaLaunchedSuccessfully(), que verifica se o TWA foi lançado pelo menos uma vez:

private boolean hasTwaLaunchedSuccessfully() {
    // Return `true` if the preference "twa_launched_successfully" has already been set.
    SharedPreferences sharedPref = getSharedPreferences(getString(R.string.twa_offline_first_preferences_file_key), Context.MODE_PRIVATE);
    return sharedPref.getBoolean(getString(R.string.twa_launched_successfully), false);
}

O código anterior chama launchTWA() da classe pai e salva a flag twa_launched_successfully nas preferências compartilhadas. Isso indica que a TWA foi lançada com sucesso, pelo menos uma vez.

O método auxiliar restante, renderOfflineFallback(), renderiza uma tela off-line do Android.

private void renderOfflineFallback() {
    setContentView(R.layout.activity_offline_first_twa);

    Button retryBtn = this.findViewById(R.id.retry_btn);
    retryBtn.setOnClickListener(new View.OnClickListener() {
        public void onClick(View v) {
            // Check connection status. If online, launch the Trusted Web Activity for the first time.
            if (isOnline()) firstTimeLaunchTwa();
        }
    });
}

Para esta demonstração, definimos o layout activity_offline_first_twa, que contém um botão para tentar novamente, que será usado para executar firstTimeLaunchTwa() após verificar a conexão.

Conclusão

• Na primeira vez que um usuário inicia um Progressive Web App (PWA) pela Trusted Web Activity, o service worker ainda não está disponível.
• Para evitar mostrar a tela padrão off-line se o usuário não tiver conectividade, detecte a condição off-line e mostre uma tela de fallback off-line.
• Neste guia, você aprendeu a implementar essa estratégia. Se você quer conferir o código usado neste guia, confira a solução completa na demonstração da TWA offline.