Skip to content

ADFA-5192 refactor(install): retire the dead companion install leg #436

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
luisguzman-adfa merged 1 commit into from
Aug 19, 2026
Merged

ADFA-5192 refactor(install): retire the dead companion install leg #436

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
206 changes: 5 additions & 201 deletions controller/app/src/main/java/org/iiab/controller/install/presentation/InstallService.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,6 @@

import java.io.BufferedReader;
import java.io.File;
import java.io.FileReader;
import java.io.FileWriter;
import java.io.InputStreamReader;
import java.util.Locale;

Expand Down Expand Up @@ -90,16 +88,12 @@ public final class InstallService extends Service {

// Start extras (snapshotted at start; the pipeline never reads the live UI).
public static final String EXTRA_TIER = "tier"; // InstallationPlanner.Tier.name()
public static final String EXTRA_COMPANION = "companion"; // boolean
public static final String EXTRA_ARCH = "arch"; // termux arch, e.g. arm64-v8a
public static final String EXTRA_KIWIX_LANG = "kiwixLang"; // nullable override
public static final String EXTRA_KIWIX_VARIANT = "kiwixVariant"; // nullable override
public static final String EXTRA_REINSTALL = "reinstall"; // boolean: wipe existing rootfs first
public static final String EXTRA_MODULES = "modules"; // String[]: module yamlBaseKeys to install

// Which pipeline to run (ADFA-4476). Absent/"install" -> normal install; "reset" -> scratch reset.
public static final String EXTRA_MODE = "mode";
public static final String EXTRA_SKIP_MAPS = "skipMaps"; // content flow: maps ship in the base image
public static final String MODE_INSTALL = "install";
public static final String MODE_RESET = "reset";

Expand Down Expand Up @@ -129,7 +123,6 @@ public final class InstallService extends Service {
* non-destructive guard. Exactly the failure the cleanup claims to prevent.
*/
private volatile TarExtractor extractor;
private volatile org.iiab.controller.content.RestContentClient restContentClient; // ADFA-4840 (was socket.io, ADFA-4832); volatile: ADFA-5119 review

private volatile boolean cancelled = false;
private volatile boolean finished = false;
Expand Down Expand Up @@ -181,12 +174,8 @@ public final class InstallService extends Service {

// Snapshot of the start parameters.
private InstallationPlanner.Tier tier;
private boolean companionData;
private String arch;
private String overrideKiwixLang;
private String overrideKiwixVariant;
private boolean reinstall;
private boolean skipMaps;
private boolean resetMode;

// ADFA-4476 slice 3: per-module install queue state (module mode only).
Expand Down Expand Up @@ -315,13 +304,9 @@ public int onStartCommand(Intent intent, int flags, int startId) {
// Snapshot start parameters (rootfs install).
String tierName = intent.getStringExtra(EXTRA_TIER);
tier = parseTier(tierName);
companionData = intent.getBooleanExtra(EXTRA_COMPANION, false);
arch = intent.getStringExtra(EXTRA_ARCH);
if (arch == null) arch = "arm64-v8a";
overrideKiwixLang = intent.getStringExtra(EXTRA_KIWIX_LANG);
overrideKiwixVariant = intent.getStringExtra(EXTRA_KIWIX_VARIANT);
reinstall = intent.getBooleanExtra(EXTRA_REINSTALL, false);
skipMaps = intent.getBooleanExtra(EXTRA_SKIP_MAPS, false);
resetMode = MODE_RESET.equals(intent.getStringExtra(EXTRA_MODE));

startForeground(NOTIFICATION_ID, buildNotification(getString(R.string.install_busy_provisioning)));
Expand Down Expand Up @@ -361,12 +346,11 @@ private void persistInstalledTier() {
private void runPipeline() {
try {
// Non-destructive guard (ADFA-4725): an already-installed system is NEVER
// re-extracted unless an explicit reinstall was requested. "Get more" then only
// runs the additive companion-data steps (Kiwix zims + Maps) inside the existing
// rootfs, so the OS blocks and any customized content are left untouched.
// re-extracted unless an explicit reinstall was requested, so the OS blocks and any
// customized content are left untouched. Content ("Get more") is added by the wizard
// through its own live channel, not here (ADFA-5192 retired the legacy companion leg).
if (!reinstall && debianRootfs.exists() && debianRootfs.isDirectory()) {
if (companionData) startCompanionData();
else finishSuccess();
finishSuccess();
return;
}
// ADFA-5119 (review): a fresh install — nothing on disk — is already building the system
Expand Down Expand Up @@ -652,13 +636,7 @@ public void onComplete(String destDir) {
}
}

// DNS is written at the single chokepoint (PRootEngine.executeInContainer),
// so the companion-data proot steps below get a working resolv.conf for free.
if (companionData) {
startCompanionData();
} else {
finishSuccess();
}
finishSuccess();
}

@Override
Expand All @@ -673,179 +651,6 @@ public void onError(String error) {
});
}

/**
* ADFA-5119 (review): widen {@code work} back before this runs.
*
* <p>By the time companion data starts, the rootfs is extracted and usable — so from here a
* cancellation is content being abandoned, not a system. Left at ROOTFS_BUILD, the notification's
* Cancel during a ZIM download or the maps runrole would have deleted a working rootfs and
* cleared setup_complete. Reachable only from the legacy {@code companion=true} start; the K2Go
* wizard banks content as wishlists and passes false.
*/
private void startCompanionData() {
work = org.iiab.controller.install.domain.AbandonedInstall.Work.CONTENT;
editLocalVarsForMaps(debianRootfs, tier);
SharedPreferences prefs = getSharedPreferences(getString(R.string.pref_file_internal), Context.MODE_PRIVATE);
String targetLang = (overrideKiwixLang != null) ? overrideKiwixLang : prefs.getString("selected_lang_minimal", org.iiab.controller.applang.data.ContentLanguage.systemDefault());

InstallationPlanner.calculateProjectedSize(this, tier, true, targetLang, overrideKiwixVariant,
new InstallationPlanner.PlanResultListener() {
@Override
public void onCalculated(InstallationPlanner.StorageProjection projection) {
if (cancelled) return;
if (projection.resolvedFilename != null) downloadAndIndexKiwix(projection.resolvedFilename);
else runMapsAnsible();
}

@Override
public void onError(String error) {
runMapsAnsible();
}
});
}

private void downloadAndIndexKiwix(String zimFilename) {
// ADFA-4832: on an already-running system, adding a ZIM via a second proot
// (iiab-make-kiwix-lib) collides with the live server and breaks Kiwix. Route the add
// through the in-server dashboard channel — the running server downloads + indexes
// in-process, no new proot. The app-side proot path below stays for the fresh-install
// case (server down), which safely owns the rootfs exclusively.
if (org.iiab.controller.ServerStateRepository.get().current().alive) {
addZimViaLiveChannel(zimFilename);
return;
}

postProvisioning(getString(R.string.install_status_preparing_kiwix));

String zimUrl = "https://download.kiwix.org/zim/wikipedia/" + zimFilename;
File libraryDir = new File(debianRootfs, "library/zims/content");
if (!libraryDir.exists()) libraryDir.mkdirs();

if (aria2Manager == null) aria2Manager = new Aria2Manager();
aria2Manager.startDownload(this, zimUrl, new Aria2Manager.DownloadListener() {
@Override
public void onProgress(int percentage, String speed, String eta) {
if (cancelled) return;
String text = getString(R.string.install_status_zim_download, percentage, speed);
postProvisioning(text);
updateNotification(text);
}

@Override
public void onComplete(String downloadPath) {
if (cancelled) return;
postProvisioning(getString(R.string.install_status_indexing_zim));
File downloadedZim = new File(downloadPath, zimFilename);
if (downloadedZim.exists()) downloadedZim.renameTo(new File(libraryDir, zimFilename));

if (prootEngine == null) prootEngine = new PRootEngine();
prootEngine.executeInContainer(InstallService.this, debianRootfs.getAbsolutePath(), "iiab-make-kiwix-lib",
new PRootEngine.OutputListener() {
@Override public void onOutputLine(String line) { log("[Kiwix] " + line); }
@Override public void onProcessExit(int exitCode) { runMapsAnsible(); }
@Override public void onError(String error) { runMapsAnsible(); }
});
}

@Override
public void onError(String error) {
runMapsAnsible();
}
});
}

/**
* ADFA-4840: add a ZIM on the LIVE system through the in-server durable REST job engine, so the
* running server does the download + index in-process (no second proot). Short POST + ~1s polls
* instead of a long-lived socket; the job is durable server-side, so it survives UI/config churn
* and even a dashboard restart. This service is foreground, so polling continues in the background.
* On success we finish here rather than running the maps proot — maps on a live system needs the
* same migration (follow-up), and spawning that proot would re-introduce the collision.
*/
private void addZimViaLiveChannel(String zimFilename) {
postProvisioning(getString(R.string.install_status_preparing_kiwix));
restContentClient = new org.iiab.controller.content.RestContentClient();
restContentClient.addZim(zimFilename, new org.iiab.controller.content.RestContentClient.Listener() {
@Override public void onProgress(int percent, String speed) {
if (cancelled) return;
// ADFA-4830: install_status_zim_download no longer bakes the unit — the rate carries
// its own localized "/s". The live channel gives a raw rate, so append it here.
String rate = speed + getString(R.string.k2go_rate_per_second);
String text = getString(R.string.install_status_zim_download, percent, rate);
postProvisioning(text);
updateNotification(text);
}
@Override public void onIndexing() {
if (cancelled) return;
postProvisioning(getString(R.string.install_status_indexing_zim));
}
@Override public void onLog(String line) { log("[Kiwix-live] " + line); }
@Override public void onDone() {
if (cancelled) return;
finishSuccess();
}
@Override public void onError(String message) {
if (cancelled) return;
log("[Kiwix-live] add failed: " + message);
// Safe degrade: never spawn a colliding proot on the live system — surface the failure.
fail(getString(R.string.install_error_download, message));
}
});
}

private void runMapsAnsible() {
if (cancelled) return;

if (skipMaps || tier == InstallationPlanner.Tier.BASIC) {
// Maps ship in the software block (base image) and BASIC already has them; the
// content flow disables the maps reinstall. Skip straight to success.
postProvisioning(getString(R.string.install_status_maps_provisioned));
new Handler(Looper.getMainLooper()).postDelayed(this::finishSuccess, 1500);
return;
}

postProvisioning(getString(R.string.install_status_maps_configuring));
if (prootEngine == null) prootEngine = new PRootEngine();
String installCmd = "cd /opt/iiab/iiab && ./runrole --reinstall maps";
prootEngine.executeInContainer(this, debianRootfs.getAbsolutePath(), installCmd, new PRootEngine.OutputListener() {
@Override public void onOutputLine(String line) { log("[Ansible] " + line); }
@Override public void onProcessExit(int exitCode) { finishSuccess(); }
@Override public void onError(String error) { finishSuccess(); }
});
}

private void editLocalVarsForMaps(File debianRootfs, InstallationPlanner.Tier tier) {
File yamlFile = new File(debianRootfs, "etc/iiab/local_vars.yml");
if (!yamlFile.exists()) return;
try {
StringBuilder content = new StringBuilder();
BufferedReader reader = new BufferedReader(new FileReader(yamlFile));
String line;
while ((line = reader.readLine()) != null) content.append(line).append("\n");
reader.close();

String text = content.toString();
text = text.replaceAll("(?m)^maps_install:\\s*.*", "maps_install: True");
text = text.replaceAll("(?m)^maps_enabled:\\s*.*", "maps_enabled: True");

if (tier == InstallationPlanner.Tier.STANDARD) {
text = text.replaceAll("(?m)^maps_vector_(quality|zoom):\\s*.*", "maps_vector_zoom: 11");
text = text.replaceAll("(?m)^maps_satellite_zoom:\\s*.*", "maps_satellite_zoom: 9");
text = text.replaceAll("(?m)^maps_terrain_zoom:\\s*.*", "maps_terrain_zoom: 7");
} else if (tier == InstallationPlanner.Tier.FULL) {
text = text.replaceAll("(?m)^maps_vector_(quality|zoom):\\s*.*", "maps_vector_zoom: 11");
text = text.replaceAll("(?m)^maps_satellite_zoom:\\s*.*", "maps_satellite_zoom: 9");
text = text.replaceAll("(?m)^maps_terrain_zoom:\\s*.*", "maps_terrain_zoom: 8");
}
// BASIC keeps the base-image defaults.

FileWriter writer = new FileWriter(yamlFile);
writer.write(text);
writer.close();
} catch (Exception ignored) {
}
}

// ------------------------------------------------------------ reset pipeline

/**
Expand Down Expand Up @@ -1480,7 +1285,6 @@ private void doCancel() {
finished = true;
try {
if (aria2Manager != null) aria2Manager.stopDownload();
if (restContentClient != null) restContentClient.cancel(); // ADFA-4840
// ADFA-5119 (review): stop tar BEFORE the cleanup deletes the tree it is writing into.
// Without this the rm -rf below raced a live extraction and the surviving directory was
// adopted by the next install's non-destructive guard — a "successful" boot over a wreck.
Expand Down
2 changes: 0 additions & 2 deletions controller/app/src/main/java/org/iiab/controller/redesign/SetupLibraryActivity.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -320,13 +320,11 @@
Intent i = new Intent(this, InstallService.class);
i.setAction(InstallService.ACTION_START);
i.putExtra(InstallService.EXTRA_TIER, getSelectedTier().name());
i.putExtra(InstallService.EXTRA_COMPANION, false);
i.putExtra(InstallService.EXTRA_ARCH, SystemStateEvaluator.termuxArch(this));
// ADFA-5023: reinstall wipes the existing rootfs first. Stopping a LIVE server before the wipe is
// done by the SERVICE (InstallService.runPipeline) — NOT here — so this navigation stays instant:
// one tap goes straight to the boot gate instead of the wizard sitting there during stopEnvironment.
i.putExtra(InstallService.EXTRA_REINSTALL, reinstallMode);
i.putExtra(InstallService.EXTRA_SKIP_MAPS, true);
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) startForegroundService(i);
else startService(i);
// ADFA-5023: plain startActivity so a FRESH LibraryActivity is created and reads EXTRA_INSTALLING
Expand Down Expand Up @@ -607,7 +605,7 @@
* on purpose (not deleted): ADFA-4842 (reactivate proot modules via module management) may want
* to generalize a "install these proot modules now" path from here — 4842 decides whether to
* reuse/generalize or delete. Deleting now could remove something module management wants. */
public void openMapsPreparing(String[] levels) {

Check warning on line 608 in controller/app/src/main/java/org/iiab/controller/redesign/SetupLibraryActivity.java

View workflow job for this annotation

GitHub Actions / Build & Distribute 

[dep-ann*** deprecated item is not annotated with @deprecated

Check warning on line 608 in controller/app/src/main/java/org/iiab/controller/redesign/SetupLibraryActivity.java

View workflow job for this annotation

GitHub Actions / Lint & Compile Check 

[dep-ann] deprecated item is not annotated with @deprecated
getSupportFragmentManager().beginTransaction()
.replace(R.id.k2go_setup_host, MapsPreparingFragment.newInstance(levels))
.addToBackStack("maps_preparing")
Expand Down Expand Up @@ -673,7 +671,7 @@
* the per-layer selection). InstallService writes the full maps_* local_vars and runs runrole
* with the shared success/failure verdict, revert-on-fail and observable progress. {@code levels}
* is aligned to the Choose groups [base, satellite, terrain, search]; null = off. */
public void startMapsInstall(String[] levels) {

Check warning on line 674 in controller/app/src/main/java/org/iiab/controller/redesign/SetupLibraryActivity.java

View workflow job for this annotation

GitHub Actions / Build & Distribute 

[dep-ann*** deprecated item is not annotated with @deprecated

Check warning on line 674 in controller/app/src/main/java/org/iiab/controller/redesign/SetupLibraryActivity.java

View workflow job for this annotation

GitHub Actions / Lint & Compile Check 

[dep-ann] deprecated item is not annotated with @deprecated
String base = levels != null && levels.length > 0 && levels[0] != null ? levels[0] : "11";
String sat = levels != null && levels.length > 1 && levels[1] != null ? levels[1] : "none";
String ter = levels != null && levels.length > 2 && levels[2] != null ? levels[2] : "0-none";
Expand All @@ -695,7 +693,7 @@
* backToGetMoreHubZim, along with the ZIM live door that was the only thing calling it.)
* ADFA-4848: "Run in background" from Preparing -> drop the whole Maps flow off the back
* stack and return to the Get More hub; the build keeps running. */
public void backToGetMoreHub() {

Check warning on line 696 in controller/app/src/main/java/org/iiab/controller/redesign/SetupLibraryActivity.java

View workflow job for this annotation

GitHub Actions / Build & Distribute 

[dep-ann*** deprecated item is not annotated with @deprecated

Check warning on line 696 in controller/app/src/main/java/org/iiab/controller/redesign/SetupLibraryActivity.java

View workflow job for this annotation

GitHub Actions / Lint & Compile Check 

[dep-ann] deprecated item is not annotated with @deprecated
getSupportFragmentManager().popBackStack("getmore_maps",
androidx.fragment.app.FragmentManager.POP_BACK_STACK_INCLUSIVE);
}
Expand Down