Endpoint channel di API

I canali sono un meccanismo fondamentale per gestire gli aggiornamenti delle app in Capgo. In modalità self-hosted, è necessario implementare gli endpoint dei canali per gestire l'assegnazione dei dispositivi, le query sui canali e le operazioni di gestione dei canali stessi.

Understanding Channels

I canali ti permettono di:

• Controllare la distribuzione degli update: Assegnare diverse versioni dell'app a vari gruppi di utenti
• A/B testing: Testare nuove feature con segmenti di utenti specifici
• Rollout graduali: Distribuire gli update gradualmente per ridurre i rischi
• Separazione degli ambienti: Separare gli update di development, staging e production

Configurazione

Configura l'URL dell'endpoint del canale nel tuo capacitor.config.json:

{
  "plugins": {
    "CapacitorUpdater": {
      "channelUrl": "https://myserver.com/api/channel_self"
    }
  }
}

Operazioni sui canali

Il plugin esegue diverse operazioni sui canali che il tuo endpoint deve gestire:

1. Elenca i canali compatibili (richiesta GET)

Quando il plugin chiama listChannels(), invia una richiesta GET per recuperare tutti i canali compatibili con il dispositivo. Restituisce i canali che corrispondono all'ambiente del dispositivo (dev/prod, emulatore/dispositivo reale) e che consentono l'accesso pubblico o l'auto-assegnazione.

Formato della richiesta

// GET /api/channel_self
// Headers:
{
  "Content-Type": "application/json"
}

// Query parameters:
interface ListChannelsRequest {
  app_id: string
  platform: "ios" | "android" | "electron"
  is_emulator: boolean
  is_prod: boolean
  key_id?: string
}

Formato della risposta

[
  {
    "id": 1,
    "name": "production",
    "public": true,
    "allow_self_set": false
  },
  {
    "id": 2,
    "name": "beta",
    "public": false,
    "allow_self_set": true
  }
]

Capire i tipi di Channel

La risposta include due flag importanti per ogni channel:

• public: true: Questo è un canale di default. I dispositivi non possono auto-assegnarsi usando setChannel(). Invece, se un dispositivo rimuove l'assegnazione del channel (usando unsetChannel()), riceverà automaticamente gli update da questo channel pubblico se soddisfa le condizioni del dispositivo.

• allow_self_set: true: Questo è un canale auto-assegnabile. I dispositivi possono assegnarsi esplicitamente a questo canale tramite setChannel(). È utile per beta testing, A/B testing o per consentire agli utenti di fare opt-in a specifici percorsi di aggiornamento.

Nota

Un canale può essere public O allow_self_set, ma solitamente non entrambi. I canali pubblici fungono da fallback predefinito, mentre i canali auto-assegnabili richiedono un opt-in esplicito.

2. Get Channel (richiesta PUT)

Quando il plugin chiama getChannel(), invia una richiesta PUT per recuperare il canale attualmente assegnato al dispositivo.

Formato della richiesta

// PUT /api/channel_self
// Headers:
{
  "Content-Type": "application/json"
}

// Body:
interface GetChannelRequest {
  device_id: string
  app_id: string
  platform: "ios" | "android" | "electron"
  plugin_version: string
  version_build: string
  version_code: string
  version_name: string
  is_emulator: boolean
  is_prod: boolean
  defaultChannel?: string
  channel?: string  // For newer plugin versions, contains local channel override
}

Formato della risposta

{
  "status": "ok",
  "channel": "production",
  "allowSet": true,
  "message": "",
  "error": ""
}

3. Imposta canale (richiesta POST)

Quando il plugin chiama setChannel(), invia una richiesta POST per assegnare il dispositivo a un canale specifico.

Formato della richiesta

// POST /api/channel_self
interface SetChannelRequest {
  device_id: string
  app_id: string
  channel: string
  platform: "ios" | "android" | "electron"
  plugin_version: string
  version_build: string
  version_code: string
  version_name: string
  is_emulator: boolean
  is_prod: boolean
}

Formato della risposta

{
  "status": "ok",
  "message": "Device assigned to channel successfully",
  "error": ""
}

Casi di errore

Quando un dispositivo tenta di assegnarsi a un canale pubblico (uno con public: true), il tuo endpoint dovrebbe restituire un errore:

{
  "status": "error",
  "error": "public_channel_self_set_not_allowed",
  "message": "This channel is public and does not allow device self-assignment. Unset the channel and the device will automatically use the public channel."
}

Quando un dispositivo tenta di assegnarsi a un canale che non permette l'auto-assegnazione:

{
  "status": "error",
  "error": "channel_self_set_not_allowed",
  "message": "This channel does not allow devices to self associate"
}

4. Unset Channel (richiesta DELETE)

Quando il plugin chiama unsetChannel(), invia una richiesta DELETE per rimuovere l'assegnazione del canale del dispositivo.

Formato della richiesta

// DELETE /api/channel_self
interface UnsetChannelRequest {
  device_id: string
  app_id: string
  platform: "ios" | "android" | "electron"
  plugin_version: string
  version_build: string
  version_code: string
  version_name: string
}

Esempio di implementazione

Ecco un esempio in JavaScript di come implementare l'endpoint del canale:

interface ChannelRequest {
  device_id: string
  app_id: string
  channel?: string
  platform: "ios" | "android" | "electron"
  plugin_version: string
  version_build: string
  version_code: string
  version_name: string
}

interface ChannelResponse {
  status: "ok" | "error"
  channel?: string
  allowSet?: boolean
  message?: string
  error?: string
}

export const handler = async (event) => {
  const method = event.httpMethod || event.method
  const body = JSON.parse(event.body || '{}') as ChannelRequest

  const { device_id, app_id, channel, platform } = body

  try {
    switch (method) {
      case 'GET':
        return await getDeviceChannel(device_id, app_id)

      case 'POST':
        return await setDeviceChannel(device_id, app_id, channel!, platform)

      case 'DELETE':
        return await unsetDeviceChannel(device_id, app_id)

      default:
        return {
          status: "error",
          error: "Method not allowed"
        }
    }
  } catch (error) {
    return {
      status: "error",
      error: error.message
    }
  }
}

async function getDeviceChannel(deviceId: string, appId: string): Promise<ChannelResponse> {
  // Query your database for device channel assignment
  const assignment = await database.getDeviceChannel(deviceId, appId)

  if (assignment) {
    return {
      status: "ok",
      channel: assignment.channel,
      allowSet: assignment.allowSelfAssign
    }
  }

  // Return default channel if no assignment found
  return {
    status: "ok",
    channel: "production", // Your default channel
    allowSet: true
  }
}

async function setDeviceChannel(
  deviceId: string,
  appId: string,
  channel: string,
  platform: string
): Promise<ChannelResponse> {
  // Validate channel exists and allows self-assignment
  const channelConfig = await database.getChannelConfig(channel, appId)

  if (!channelConfig) {
    return {
      status: "error",
      error: "Channel not found"
    }
  }

  if (!channelConfig.allowDeviceSelfSet) {
    return {
      status: "error",
      error: "Channel does not allow self-assignment"
    }
  }

  // Check platform restrictions
  if (platform === "ios" && !channelConfig.ios) {
    return {
      status: "error",
      error: "Channel not available for iOS"
    }
  }

  if (platform === "android" && !channelConfig.android) {
    return {
      status: "error",
      error: "Channel not available for Android"
    }
  }

  if (platform === "electron" && !channelConfig.electron) {
    return {
      status: "error",
      error: "Channel not available for Electron"
    }
  }

  // Save the assignment
  await database.setDeviceChannel(deviceId, appId, channel)

  return {
    status: "ok",
    message: "Device assigned to channel successfully"
  }
}

async function unsetDeviceChannel(deviceId: string, appId: string): Promise<ChannelResponse> {
  // Remove device channel assignment
  await database.removeDeviceChannel(deviceId, appId)

  return {
    status: "ok",
    message: "Device channel assignment removed"
  }
}

Configurazione dei Channel

Il tuo sistema di channel dovrebbe supportare queste opzioni di configurazione:

interface ChannelConfig {
  name: string
  appId: string

  // Platform targeting
  ios: boolean              // Allow updates to iOS devices
  android: boolean          // Allow updates to Android devices
  electron: boolean         // Allow updates to Electron apps

  // Device type restrictions
  allow_emulator: boolean   // Allow updates on emulator/simulator devices
  allow_device: boolean     // Allow updates on real/physical devices

  // Build type restrictions
  allow_dev: boolean        // Allow updates on development builds (is_prod=false)
  allow_prod: boolean       // Allow updates on production builds (is_prod=true)

  // Channel assignment
  public: boolean           // Default channel - devices fall back to this when no override
  allowDeviceSelfSet: boolean  // Allow devices to self-assign via setChannel()

  // Update policies
  disableAutoUpdate: "major" | "minor" | "version_number" | "none"
  disableAutoUpdateUnderNative: boolean
}

Logica di filtraggio dei device

Quando elenchi i channel compatibili (richiesta GET), dovresti filtrare i channel in base a queste condizioni:

1. Controllo piattaforma: Il channel deve consentire la piattaforma del device (ios, android, o electron)
2. Controllo tipo di device:
   • Se is_emulator=true: Il canale deve avere allow_emulator=true
   • Se is_emulator=false: Il canale deve avere allow_device=true
3. Controllo tipo di build:
   • Se is_prod=true: Il canale deve avere allow_prod=true
   • Se is_prod=false: Il canale deve avere allow_dev=true
4. Controllo visibilità: Il canale deve essere public=true O allow_device_self_set=true

// Example filtering logic
function getCompatibleChannels(
  platform: 'ios' | 'android' | 'electron',
  isEmulator: boolean,
  isProd: boolean,
  channels: ChannelConfig[]
): ChannelConfig[] {
  return channels.filter(channel => {
    // Platform check
    if (!channel[platform]) return false

    // Device type check
    if (isEmulator && !channel.allow_emulator) return false
    if (!isEmulator && !channel.allow_device) return false

    // Build type check
    if (isProd && !channel.allow_prod) return false
    if (!isProd && !channel.allow_dev) return false

    // Must be accessible (public or self-assignable)
    if (!channel.public && !channel.allowDeviceSelfSet) return false

    return true
  })
}

Esempio di schema del database

Dovrai memorizzare le configurazioni dei canali e gli assegnamenti dei dispositivi:

-- Channels table
CREATE TABLE channels (
  id SERIAL PRIMARY KEY,
  name VARCHAR(255) NOT NULL,
  app_id VARCHAR(255) NOT NULL,

  -- Platform targeting
  ios BOOLEAN DEFAULT true,
  android BOOLEAN DEFAULT true,
  electron BOOLEAN DEFAULT true,

  -- Device type restrictions
  allow_emulator BOOLEAN DEFAULT true,   -- Allow emulator/simulator devices
  allow_device BOOLEAN DEFAULT true,     -- Allow real/physical devices

  -- Build type restrictions
  allow_dev BOOLEAN DEFAULT true,        -- Allow development builds
  allow_prod BOOLEAN DEFAULT true,       -- Allow production builds

  -- Channel assignment
  public BOOLEAN DEFAULT false,          -- Default channel (fallback)
  allow_device_self_set BOOLEAN DEFAULT false,  -- Allow self-assignment

  -- Update policies
  disable_auto_update VARCHAR(50) DEFAULT 'none',
  disable_auto_update_under_native BOOLEAN DEFAULT false,

  created_at TIMESTAMP DEFAULT NOW(),
  UNIQUE(name, app_id)
);

-- Device channel assignments table
CREATE TABLE device_channels (
  id SERIAL PRIMARY KEY,
  device_id VARCHAR(255) NOT NULL,
  app_id VARCHAR(255) NOT NULL,
  channel_name VARCHAR(255) NOT NULL,
  assigned_at TIMESTAMP DEFAULT NOW(),
  UNIQUE(device_id, app_id)
);

Gestione degli errori

Gestisci i comuni scenari di errore:

// Channel not found
{
  "status": "error",
  "error": "Channel 'beta' not found"
}

// Self-assignment not allowed
{
  "status": "error",
  "error": "Channel does not allow device self-assignment"
}

// Platform not supported
{
  "status": "error",
  "error": "Channel not available for this platform"
}

// Invalid request
{
  "status": "error",
  "error": "Missing required field: device_id"
}

Best practice

1. Sicurezza: Valida ogni assegnazione di canale rispetto alle tue regole di business
2. Logging: Logga tutte le operazioni sui canali per audit e debugging
3. Prestazioni: Cache delle configurazioni dei canali per ridurre le query al database
4. Validazione: Verifica l'autenticità di device_id e app_id
5. Limitazione del numero di richieste: Implementa il rate limiting per prevenire abusi

Integrazione con gli Updates

Le assegnazioni dei canali lavorano insieme ai tuoi Endpoint update di API. Quando un dispositivo richiede un aggiornamento, controlla l'assegnazione del canale per determinare quale versione inviare:

async function getUpdateForDevice(deviceId: string, appId: string) {
  // Get device's channel assignment
  const channelAssignment = await getDeviceChannel(deviceId, appId)
  const channel = channelAssignment.channel || 'production'

  // Get the version assigned to this channel
  const channelVersion = await getChannelVersion(channel, appId)

  return {
    version: channelVersion.version,
    url: channelVersion.url,
    checksum: channelVersion.checksum
  }
}

Questo crea un sistema di gestione dei canali self-hosted completo, che ti offre il controllo totale sulla distribuzione degli aggiornamenti ai tuoi utenti.

Continua da Channel API Endpoint

Se stai usando Endpoint channel di API per pianificare il routing dei canali e il rollout graduale, connettilo a Usando @capgo/capacitor-updater per la funzionalità nativa in Usando @capgo/capacitor-updater, Canali per i dettagli di implementazione nei Channels, Canali per i dettagli di implementazione nei Channels, Canali per i dettagli di implementazione dei Channels, e Soluzione Beta Testing per il workflow del prodotto nella Beta Testing Solution.