otoddyota 1.0.5

Over-The-Air (OTA) Code Push client by OTODDY for Flutter applications with automatic engine patch detection.

OtoddyOTA

A drop-in Over-The-Air (OTA) Code Push client for Flutter applications, engineered by OTODDY.

Deliver instant Dart bug fixes, UI updates, and feature enhancements to your users over the air without waiting for App Store reviews or reinstalling APKs.

---

🏢 About OTODDY

OTODDY is a product-focused technology company building software products, digital platforms, and developer technologies that solve real-world problems. We create scalable, reliable, and user-centric technology across mobility, healthcare, business software, and emerging digital domains.

• Website: https://otoddy.com
• GitHub: https://github.com/Otoddy-On-Demand-Driver/otoddy_ota_inhouse

---

🚀 Key Features

• ⚡ Zero-Friction Updates: Push Dart code updates directly to running devices in seconds.
• 🛡️ Engine Snapshot Guard: Verifies the Dart engine snapshot hash before loading, preventing crashes.
• 🔒 Atomic Downloads: Safe, stream-piped downloads with atomic replacement.
• 🌐 Dynamic Architecture Detection: Automatically resolves arm64-v8a vs. x86_64 dynamically via Dart Abi.current().
• ⛔ Remote Killswitch: Instant emergency rollback if a patch contains critical issues.

---

📦 Installation

Add otoddyota to your Flutter app:

flutter pub add otoddyota

Or add it directly to your pubspec.yaml:

dependencies:
  flutter:
    sdk: flutter
  otoddyota: ^1.0.1

---

💻 Usage

Initialize OtoddyOTA inside your main() before calling runApp:

import 'package:flutter/material.dart';
import 'package:otoddyota/otoddyota.dart';

void main() {
  WidgetsFlutterBinding.ensureInitialized();

  // Initialize OtoddyOTA early
  OtoddyOTA.init(
    serverUrls: [
      'https://codepush.yourdomain.com', // Your live production server
      'http://10.0.2.2:8080',            // Local Android emulator fallback
      'http://localhost:8080',           // USB device / localhost
    ],
    appId: 'com.yourcompany.yourapp',
    releaseVersion: '1.0.0', // Must match installed base release
    onPatchReady: (patchNumber) {
      debugPrint('==> New OtoddyOTA patch #$patchNumber ready!');
      // Prompt user or automatically restart app to load the new patch:
      OtoddyOTA.restartApp();
    },
  );

  runApp(const MyApp());
}

---

⚙️ Android Setup

Zero Native Configuration!

otoddyota is a zero-config Flutter plugin. It embeds an internal Android InitProvider (OtoddyInitProvider) that automatically registers the patch loader with the Flutter engine before the engine boots. No custom code in MainActivity.kt or AndroidManifest.xml is required!

1. Ensure Internet Permission

In android/app/src/main/AndroidManifest.xml:

<manifest xmlns:android="http://schemas.android.com/apk/res/android">
    <uses-permission android:name="android.permission.INTERNET"/>

### 2. Configure Hooked Engine Repository
In your root `android/build.gradle.kts` (or `build.gradle`):
```kotlin
val localEngineMaven = System.getenv("LOCAL_ENGINE_MAVEN")
if (localEngineMaven != null) {
    allprojects {
        repositories {
            maven { url = java.io.File(localEngineMaven).toURI() }
        }
    }
}

---

🌐 Backend Protocol Specification (Self-Hosting Your Server)

otoddyota is completely server-agnostic. Any backend server (Node.js, Go, Python, Dart, etc.) can be used with this package by implementing the following wire protocol:

1. Patch Check Endpoint

• Method: POST
• Path: /api/v1/patches/check
• Request Body (JSON):

  {
    "app_id": "com.example.app",
    "release_version": "1.0.0",
    "platform": "android",
    "arch": "arm64",
    "channel": "stable",
    "client_id": "device",
    "current_patch_number": 0
  }
  

• Response when update is available (HTTP 200):

  {
    "patch_available": true,
    "patch": {
      "number": 1,
      "hash": "<sha256-hash-of-snapshot>",
      "download_url": "https://yourdomain.com/patches/download/patch_1.so"
    },
    "rolled_back_patch_numbers": null
  }
  

• Response when app is up-to-date (HTTP 200):

  {
    "patch_available": false,
    "rolled_back_patch_numbers": null
  }
  

• Emergency Rollback: If a patch number is included in rolled_back_patch_numbers, the client instantly deletes that patch from local storage and falls back to the APK baseline.

2. Patch Download Endpoint

• Method: GET
• Path: The download_url returned from the check endpoint.
• Response: Streams the compiled libapp.so binary file (Content-Type: application/octet-stream).

---

📜 License

Distributed under the MIT License. See LICENSE for more information.

Built with ❤️ by OTODDY.