Lompat ke konten
Capgo - Pembaruan Hidup untuk Aplikasi Capacitor Capgo

Mulai Menggunakan Electron Updater

Panduan ini akan membawa Anda melalui pengaturan @capgo/electron-updater dalam aplikasi Electron Anda untuk memungkinkan pembaruan JavaScript/HTML/CSS secara langsung.

Prasyarat

Bagian berjudul “Prasyarat”
  • Electron 20.0.0 atau lebih tinggi
  • Node.js 18 atau lebih tinggi
  • Akun Capgo (daftar di capgo.app)

Pemasangan

Judul bagian “Pemasangan”

  1. Pasang paket:

    Jendela terminal
    bun add @capgo/electron-updater

  2. Dapatkan ID Aplikasi Anda dari dashboard Capgo. Jika Anda belum membuat aplikasi, jalankan:

    Jendela terminal
    npx @capgo/cli@latest init

Pengaturan

Judul bagian “Pengaturan”

The Electron Updater memerlukan pengaturan di tiga tempat: proses utama, skrip pra-muat, dan proses render.

Proses Utama

Judul Bagian “Proses Utama”
main.ts
import { app, BrowserWindow } from 'electron';
import * as path from 'path';
import {
  ElectronUpdater,
  setupIPCHandlers,
  setupEventForwarding,
} from '@capgo/electron-updater';


// Create updater instance with your Capgo App ID
const updater = new ElectronUpdater({
  appId: 'YOUR_CAPGO_APP_ID', // e.g., 'com.example.myapp'
  autoUpdate: true,
});


app.whenReady().then(async () => {
  const mainWindow = new BrowserWindow({
    width: 1200,
    height: 800,
    webPreferences: {
      preload: path.join(__dirname, 'preload.js'),
      contextIsolation: true,
    },
  });


  // Initialize updater with window and builtin path
  const builtinPath = path.join(__dirname, 'www/index.html');
  await updater.initialize(mainWindow, builtinPath);


  // Setup IPC communication between main and renderer
  setupIPCHandlers(updater);
  setupEventForwarding(updater, mainWindow);


  // Load the current bundle (either builtin or downloaded update)
  await mainWindow.loadFile(updater.getCurrentBundlePath());
});


app.on('window-all-closed', () => {
  if (process.platform !== 'darwin') {
    app.quit();
  }
});

Skrip Pra-muat

Judul Bagian “Skrip Pra-muat”
preload.ts
import { exposeUpdaterAPI } from '@capgo/electron-updater/preload';


// Expose the updater API to the renderer process
exposeUpdaterAPI();

Proses Render

Judul Bagian “Proses Render”
// renderer.ts (or in your app's entry point)
import { requireUpdater } from '@capgo/electron-updater/renderer';


const updater = requireUpdater();


// CRITICAL: Call this on every app launch!
// This confirms the bundle loaded successfully and prevents rollback
await updater.notifyAppReady();


console.log('App ready, current bundle:', await updater.current());

Memeriksa Pembaruan

Judul bagian “Memeriksa Pembaruan”

Dengan autoUpdate: true, pembarui otomatis memeriksa pembaruan. Anda juga dapat memicu periksa manual:

// Check for updates manually
const latest = await updater.getLatest();


if (latest.url && !latest.error) {
  console.log('Update available:', latest.version);


  // Download the update
  const bundle = await updater.download({
    url: latest.url,
    version: latest.version,
    checksum: latest.checksum,
  });


  console.log('Downloaded bundle:', bundle.id);


  // Option 1: Queue for next restart
  await updater.next({ id: bundle.id });


  // Option 2: Apply immediately and reload
  // await updater.set({ id: bundle.id });
}

Mendengarkan Kejadian

Judul Bagian “Mendengarkan Kejadian”

Ikuti kemajuan dan status update dengan kejadian:

// Download progress
updater.addListener('download', (event) => {
  console.log(`Download progress: ${event.percent}%`);
});


// Update available
updater.addListener('updateAvailable', (event) => {
  console.log('New version available:', event.bundle.version);
});


// Download completed
updater.addListener('downloadComplete', (event) => {
  console.log('Download finished:', event.bundle.id);
});


// Update failed
updater.addListener('updateFailed', (event) => {
  console.error('Update failed:', event.bundle.version);
});

Mengunggah Perbaruan

Judul Bagian “Mengunggah Perbaruan”

Gunakan Capgo CLI untuk mengunggah perbaruan:

Jendela Terminal
# Build your app
npm run build


# Upload to Capgo
npx @capgo/cli@latest bundle upload --channel=production

Aplikasi Electron Anda akan secara otomatis mendeteksi dan mengunduh bundle baru pada cek berikutnya.

Menu Debug

Judul Bagian “Menu Debug”

Aktifkan menu debug selama pengembangan:

const updater = new ElectronUpdater({
  appId: 'YOUR_CAPGO_APP_ID',
  debugMenu: true, // Enable debug menu
});

Tekan Ctrl+Shift+D atau Cmd+Shift+D pada Mac) untuk membuka menu debug dan:

  • Lihat informasi bundle saat ini
  • Pindah antara bundle yang tersedia
  • Kembalikan ke versi bawaan
  • Lihat informasi perangkat dan kanal

Opsi Konfigurasi

Bagian berjudul “Opsi Konfigurasi”
const updater = new ElectronUpdater({
  // Required
  appId: 'com.example.app',


  // Server URLs (defaults to Capgo Cloud)
  updateUrl: 'https://plugin.capgo.app/updates',
  channelUrl: 'https://plugin.capgo.app/channel_self',
  statsUrl: 'https://plugin.capgo.app/stats',


  // Behavior
  autoUpdate: true,           // Enable auto-updates
  appReadyTimeout: 10000,     // MS before rollback (default: 10s)
  autoDeleteFailed: true,     // Delete failed bundles
  autoDeletePrevious: true,   // Delete old bundles after successful update


  // Channels
  defaultChannel: 'production',


  // Security
  publicKey: '...',           // For end-to-end encryption


  // Debug
  debugMenu: false,           // Enable debug menu
  disableJSLogging: false,    // Disable console logs


  // Periodic Updates
  periodCheckDelay: 0,        // Seconds between checks (0 = disabled, min 600)
});

Langkah Selanjutnya

Judul Bagian “Langkah Selanjutnya”