@saltcorn/mobile-app 1.5.0-beta.8 → 1.5.0-rc.1

package/src/helpers/common.js

@@ -4,25 +4,32 @@ import { apiCall } from "./api";
 import { Camera, CameraResultType } from "@capacitor/camera";
 import { ScreenOrientation } from "@capacitor/screen-orientation";
 import { SendIntent } from "send-intent";
+import { addPushSyncHandler } from "./offline_mode";
 
 const orientationChangeListeners = new Set();
 
-export function clearAlerts() {
+/**
+ * Make the toast area shown at the bottom empty
+ */
+export function clearToasts() {
   const iframe = document.getElementById("content-iframe");
   const alertsArea =
     iframe.contentWindow.document.getElementById("toasts-area");
   alertsArea.innerHTML = "";
 }
 
-export function showAlerts(alerts, toast = true) {
+/**
+ * Show toasts in the toast area at the bottom
+ * @param toasts
+ * @returns
+ */
+export function showToasts(toasts) {
   if (typeof saltcorn === "undefined") {
     console.log("Not yet initalized.");
-    console.log(alerts);
+    console.log(toasts);
   } else {
     const iframe = document.getElementById("content-iframe");
-    let area = iframe.contentWindow.document.getElementById(
-      toast ? "toasts-area" : "top-alert"
-    );
+    let area = iframe.contentWindow.document.getElementById("toasts-area");
     if (!area) {
       const areaHtml = `<div class="container">
   <div 
@@ -36,18 +43,14 @@ export function showAlerts(alerts, toast = true) {
       iframe.contentWindow.document
         .getElementById("page-inner-content")
         .insertAdjacentHTML("beforeend", areaHtml);
-      area = iframe.contentWindow.document.getElementById(
-        toast ? "toasts-area" : "top-alert"
-      );
+      area = iframe.contentWindow.document.getElementById("toasts-area");
     }
     const successIds = [];
     area.innerHTML = "";
-    for (const { type, msg, title } of alerts) {
-      if (toast) {
-        const rndid = `tab${Math.floor(Math.random() * 16777215).toString(16)}`;
-        area.innerHTML += saltcorn.markup.toast(type, msg, rndid, title);
-        if (type === "success") successIds.push(rndid);
-      } else area.innerHTML += saltcorn.markup.alert(type, msg);
+    for (const { type, msg, title } of toasts) {
+      const rndid = `tab${Math.floor(Math.random() * 16777215).toString(16)}`;
+      area.innerHTML += saltcorn.markup.toast(type, msg, rndid, title);
+      if (type === "success") successIds.push(rndid);
     }
     if (successIds.length > 0) {
       setTimeout(() => {
@@ -61,6 +64,34 @@ export function showAlerts(alerts, toast = true) {
   return true;
 }
 
+/**
+ * Make the alert area at the top empty
+ */
+export function clearAlerts() {
+  const iframe = document.getElementById("content-iframe");
+  const area = iframe.contentWindow.document.getElementById("alerts-area");
+  if (area) area.innerHTML = "";
+  const topAlert = iframe.contentWindow.document.getElementById("top-alert");
+  if (topAlert) topAlert.innerHTML = "";
+}
+
+/**
+ * Show alerts in the alert area at the top
+ * @param alerts
+ */
+export function showAlerts(alerts) {
+  if (typeof saltcorn === "undefined") {
+    console.log("Not yet initalized.");
+    console.log(alerts);
+  } else {
+    for (const { type, msg, title } of alerts) {
+      const iframe = document.getElementById("content-iframe");
+      const area = iframe.contentWindow.document.getElementById("top-alert");
+      area.innerHTML += saltcorn.markup.alert(type, msg);
+    }
+  }
+}
+
 export function showLoadSpinner() {
   const iframe = document.getElementById("content-iframe");
   if (iframe) iframe.contentWindow.showLoadSpinner();
@@ -71,17 +102,9 @@ export function removeLoadSpinner() {
   if (iframe) iframe.contentWindow.removeLoadSpinner();
 }
 
-export function clearTopAlerts() {
-  const iframe = document.getElementById("content-iframe");
-  const area = iframe.contentWindow.document.getElementById("alerts-area");
-  if (area) area.innerHTML = "";
-  const topAlert = iframe.contentWindow.document.getElementById("top-alert");
-  if (topAlert) topAlert.innerHTML = "";
-}
-
 export function errorAlert(error) {
   console.error(error);
-  showAlerts([
+  showToasts([
     {
       type: "error",
       msg: error.message ? error.message : "An error occured.",
@@ -109,7 +132,7 @@ export async function loadFileAsText(fileId) {
     });
   } catch (error) {
     if (
-      !showAlerts([
+      !showToasts([
         {
           type: "error",
           msg: error.message ? error.message : "An error occured.",
@@ -138,7 +161,7 @@ export async function loadEncodedFile(fileId) {
       reader.readAsDataURL(response.data);
     });
   } catch (error) {
-    showAlerts([
+    showToasts([
       {
         type: "error",
         msg: error.message ? error.message : "An error occured.",
@@ -156,7 +179,7 @@ export async function takePhoto() {
     });
     return image.path;
   } catch (error) {
-    showAlerts([
+    showToasts([
       {
         type: "error",
         msg: error.message ? error.message : "An error occured.",
@@ -189,3 +212,78 @@ export async function checkSendIntentReceived() {
     return null;
   }
 }
+
+/**
+ * init the push system, if available
+ */
+export async function tryInitPush(config) {
+  try {
+    const { initPushNotifications, addPusNotifyHandler } = await import(
+      "../helpers/notifications.js"
+    );
+    try {
+      await initPushNotifications();
+      if (saltcorn.data.utils.isPushEnabled(config.user)) addPusNotifyHandler();
+      if (config.pushSync) addPushSyncHandler();
+    } catch (error) {
+      console.error("Error initializing push notifications:", error);
+    }
+  } catch (error) {
+    console.log("Push notifications module not available:", error);
+  }
+}
+
+/**
+ * init background sync, if available
+ */
+export async function tryInitBackgroundSync(config) {
+  try {
+    const { startPeriodicBackgroundSync } = await import(
+      "../helpers/background_sync.js"
+    );
+    try {
+      if (config.syncInterval && config.syncInterval > 0)
+        await startPeriodicBackgroundSync(config.syncInterval);
+    } catch (error) {
+      console.error("Error initializing background sync:", error);
+    }
+  } catch (error) {
+    console.log("Background sync module not available:", error);
+  }
+}
+
+/**
+ * end the push system, if available
+ */
+export async function tryUnregisterPush() {
+  try {
+    const { unregisterPushNotifications } = await import(
+      "../helpers/notifications.js"
+    );
+    try {
+      await unregisterPushNotifications();
+    } catch (error) {
+      console.error("Error unregistering push notifications:", error);
+    }
+  } catch (error) {
+    console.log("Push notifications module not available:", error);
+  }
+}
+
+/**
+ * stop background sync, if available
+ */
+export async function tryStopBackgroundSync() {
+  try {
+    const { stopPeriodicBackgroundSync } = await import(
+      "../helpers/background_sync.js"
+    );
+    try {
+      await stopPeriodicBackgroundSync();
+    } catch (error) {
+      console.error("Error stopping periodic background sync:", error);
+    }
+  } catch (error) {
+    console.error("Push notifications module not available:", error);
+  }
+}

package/src/helpers/navigation.js

@@ -3,7 +3,7 @@ import i18next from "i18next";
 
 import { router } from "../routing/index";
 import { startOfflineMode } from "./offline_mode";
-import { showAlerts } from "./common";
+import { showToasts } from "./common";
 
 export let routingHistory = [];
 
@@ -186,7 +186,7 @@ export async function handleRoute(route, query, files, data) {
           await replaceIframeInnerContent(page.content);
         else await replaceIframe(page.content, page.isFile);
       } else {
-        showAlerts([
+        showToasts([
           {
             type: "warning",
             msg: i18next.t("%s finished without a result", {
@@ -199,7 +199,7 @@ export async function handleRoute(route, query, files, data) {
     }
   } catch (error) {
     if (routeAdded) popRoute();
-    showAlerts([
+    showToasts([
       {
         type: "error",
         msg: `${i18next.t("In %s", {
@@ -253,7 +253,7 @@ export async function gotoEntryView() {
     addRoute({ route: mobileConfig.entry_point, query: undefined });
     await replaceIframeInnerContent(page.content);
   } catch (error) {
-    showAlerts([
+    showToasts([
       {
         type: "error",
         msg: error.message ? error.message : "An error occured.",

package/src/helpers/offline_mode.js

@@ -2,8 +2,10 @@
 
 import { apiCall } from "./api";
 import {
-  showAlerts,
+  showToasts,
+  clearToasts,
   clearAlerts,
+  showAlerts,
   errorAlert,
   showLoadSpinner,
   removeLoadSpinner,
@@ -318,6 +320,43 @@ const handleUniqueConflicts = async (uniqueConflicts, translatedIds) => {
   }
 };
 
+/**
+ * If there was a field level data conflict, the server version is applied
+ * When it also was translated, change the untranslated row and translate it later the normal way
+ * @param {*} dataConflicts
+ * @param {*} translatedIds
+ * @param {*} alerts
+ */
+const handleUpdateConflicts = async (dataConflicts, translatedIds, alerts) => {
+  let hasConflicts = false;
+  for (const [tblName, updates] of Object.entries(dataConflicts)) {
+    const table = saltcorn.data.models.Table.findOne({ name: tblName });
+    const pkName = table.pk_name || "id";
+    const translations = translatedIds[tblName] || {};
+    for (const update of updates) {
+      // search a translation where the current row is the target
+      // and if found, make sure the untranslated row is updated
+      for (const [from, to] of Object.entries(translations)) {
+        if (to === update[pkName]) {
+          update[pkName] = from;
+        }
+      }
+
+      const { [pkName]: _sc_pkValue, ...rest } = update;
+      await table.updateRow(rest, _sc_pkValue);
+      hasConflicts = true;
+    }
+  }
+  if (hasConflicts) {
+    alerts.push({
+      type: "info",
+      msg:
+        "Some of your changes could not be applied because the data has changed on the server. " +
+        "Your local data has been updated accordingly.",
+    });
+  }
+};
+
 const updateSyncInfos = async (
   offlineChanges,
   allTranslations,
@@ -357,7 +396,7 @@ const updateSyncInfos = async (
   }
 };
 
-const syncOfflineData = async (synchedTables, syncTimestamp) => {
+const syncOfflineData = async (synchedTables, syncTimestamp, alerts) => {
   const offlineChanges = await loadOfflineChanges(synchedTables);
   if (Object.keys(offlineChanges).length === 0) return null;
   const uploadResp = await apiCall({
@@ -365,7 +404,8 @@ const syncOfflineData = async (synchedTables, syncTimestamp) => {
     path: "/sync/offline_changes",
     body: {
       changes: offlineChanges,
-      syncTimestamp,
+      oldSyncTimestamp: await getLocalSyncTimestamp(),
+      newSyncTimestamp: syncTimestamp,
     },
   });
   const { syncDir } = uploadResp.data;
@@ -377,10 +417,12 @@ const syncOfflineData = async (synchedTables, syncTimestamp) => {
       path: `/sync/upload_finished?dir_name=${encodeURIComponent(syncDir)}`,
     });
     pollCount++;
-    const { finished, translatedIds, uniqueConflicts, error } = pollResp.data;
+    const { finished, translatedIds, uniqueConflicts, dataConflicts, error } =
+      pollResp.data;
     if (finished) {
       if (error) throw new Error(error.message);
       else {
+        await handleUpdateConflicts(dataConflicts, translatedIds, alerts);
         await handleUniqueConflicts(uniqueConflicts, translatedIds);
         await handleTranslatedIds(uniqueConflicts, translatedIds);
         await updateSyncInfos(offlineChanges, translatedIds, syncTimestamp);
@@ -425,7 +467,7 @@ const checkCleanSync = async (uploadStarted, uploadStartTime, userName) => {
   return false;
 };
 
-const getSyncTimestamp = async () => {
+const getServerTime = async () => {
   const resp = await apiCall({
     method: "GET",
     path: `/sync/sync_timestamp`,
@@ -433,6 +475,16 @@ const getSyncTimestamp = async () => {
   return resp.data.syncTimestamp;
 };
 
+const setLocalSyncTimestamp = async (syncTimestamp) => {
+  const state = saltcorn.data.state.getState();
+  await state.setConfig("mobile_sync_timestamp", syncTimestamp);
+};
+
+const getLocalSyncTimestamp = async () => {
+  const state = saltcorn.data.state.getState();
+  return await state.getConfig("mobile_sync_timestamp");
+};
+
 const setSpinnerText = () => {
   const iframeWindow = $("#content-iframe")[0].contentWindow;
   if (iframeWindow) {
@@ -445,57 +497,83 @@ const setSpinnerText = () => {
   }
 };
 
-export async function sync() {
-  setSpinnerText();
-  const state = saltcorn.data.state.getState();
-  const { user } = state.mobileConfig;
-  const { offlineUser, hasOfflineData, uploadStarted, uploadStartTime } =
-    (await getLastOfflineSession()) || {};
-  if (offlineUser && hasOfflineData && offlineUser !== user.email) {
-    throw new Error(
-      `The sync is not available, '${offlineUser}' has not yet uploaded offline data.`
-    );
-  } else {
-    let syncDir = null;
-    let cleanSync = await checkCleanSync(
-      uploadStarted,
-      uploadStartTime,
-      user.email
-    );
-    const syncTimestamp = await getSyncTimestamp();
-    await setUploadStarted(true, syncTimestamp);
-    let lock = null;
-    try {
-      if (window.navigator?.wakeLock?.request)
-        lock = await window.navigator.wakeLock.request();
-    } catch (error) {
-      console.log("wakeLock not available");
-      console.log(error);
-    }
-    let transactionOpen = false;
-    try {
-      await saltcorn.data.db.query("PRAGMA foreign_keys = OFF;");
-      await saltcorn.data.db.query("BEGIN");
-      transactionOpen = true;
-      if (cleanSync) await clearLocalData(true);
-      const { synchedTables, syncInfos } = await prepare();
-      await syncRemoteDeletes(syncInfos, syncTimestamp);
-      syncDir = await syncOfflineData(synchedTables, syncTimestamp);
-      await syncRemoteData(syncInfos, syncTimestamp);
-      await endOfflineMode(true);
-      await setUploadStarted(false);
-      await saltcorn.data.db.query("COMMIT");
-      transactionOpen = false;
-      await saltcorn.data.db.query("PRAGMA foreign_keys = ON;");
-    } catch (error) {
-      if (transactionOpen) await saltcorn.data.db.query("ROLLBACK");
-      await saltcorn.data.db.query("PRAGMA foreign_keys = ON;");
-      console.log(error);
-      throw error;
-    } finally {
-      if (syncDir) await cleanSyncDir(syncDir);
-      if (lock) await lock.release();
+let syncInProgress = false;
+
+export function isSyncInProgress() {
+  return syncInProgress;
+}
+
+/**
+ *
+ * @param {boolean} withWakelock try request a wakelock and show a spinner during sync (propably not in background mode)
+ * @param {boolean} switchOnline end the offline mode and go online again after sync
+ * @param {string[]} alerts output alerts collected during sync
+ */
+export async function sync(
+  withWakelock = true,
+  switchOnline = true,
+  alerts = []
+) {
+  if (syncInProgress)
+    throw new Error("A synchronization is already in progress.");
+  syncInProgress = true;
+  try {
+    if (withWakelock) setSpinnerText();
+    const state = saltcorn.data.state.getState();
+    const { user } = state.mobileConfig;
+    const { offlineUser, hasOfflineData, uploadStarted, uploadStartTime } =
+      (await getLastOfflineSession()) || {};
+    if (offlineUser && hasOfflineData && offlineUser !== user.email) {
+      throw new Error(
+        `The sync is not available, '${offlineUser}' has not yet uploaded offline data.`
+      );
+    } else {
+      let syncDir = null;
+      let cleanSync = await checkCleanSync(
+        uploadStarted,
+        uploadStartTime,
+        user.email
+      );
+      const syncTimestamp = await getServerTime();
+      await setUploadStarted(true, syncTimestamp);
+      let lock = null;
+      if (withWakelock) {
+        try {
+          if (window.navigator?.wakeLock?.request)
+            lock = await window.navigator.wakeLock.request();
+        } catch (error) {
+          console.log("wakeLock not available");
+          console.log(error);
+        }
+      }
+      let transactionOpen = false;
+      try {
+        await saltcorn.data.db.query("PRAGMA foreign_keys = OFF;");
+        await saltcorn.data.db.query("BEGIN");
+        transactionOpen = true;
+        if (cleanSync) await clearLocalData(true);
+        const { synchedTables, syncInfos } = await prepare();
+        await syncRemoteDeletes(syncInfos, syncTimestamp);
+        syncDir = await syncOfflineData(synchedTables, syncTimestamp, alerts);
+        await syncRemoteData(syncInfos, syncTimestamp);
+        await setLocalSyncTimestamp(syncTimestamp);
+        if (switchOnline) await endOfflineMode(true);
+        await setUploadStarted(false);
+        await saltcorn.data.db.query("COMMIT");
+        transactionOpen = false;
+        await saltcorn.data.db.query("PRAGMA foreign_keys = ON;");
+      } catch (error) {
+        if (transactionOpen) await saltcorn.data.db.query("ROLLBACK");
+        await saltcorn.data.db.query("PRAGMA foreign_keys = ON;");
+        console.log(error);
+        throw error;
+      } finally {
+        if (syncDir) await cleanSyncDir(syncDir);
+        if (lock) await lock.release();
+      }
     }
+  } finally {
+    syncInProgress = false;
   }
 }
 
@@ -576,21 +654,50 @@ export async function clearLocalData(inTransaction) {
   }
 }
 
-export function networkChangeCallback(status) {
+export async function networkChangeCallback(status) {
   console.log("Network status changed", status);
   const mobileConfig = saltcorn.data.state.getState().mobileConfig;
   if (status.connectionType !== "none" && mobileConfig.isOfflineMode) {
     const iframeWindow = $("#content-iframe")[0].contentWindow;
-    if (iframeWindow) {
-      clearAlerts();
-      iframeWindow.notifyAlert(
-        `An internet connection is available, to end the offline mode click ${saltcorn.markup.a(
-          {
-            href: "javascript:execLink('/sync/sync_settings')",
-          },
-          "here"
-        )}`
-      );
+    if (mobileConfig.syncOnReconnect) {
+      if (isSyncInProgress()) {
+        console.log("Sync already in progress, skipping automatic sync");
+        return;
+      }
+      console.log("Network restored, starting automatic sync");
+      const toasts = [];
+      try {
+        await sync(false, true, toasts);
+        if (iframeWindow) {
+          clearAlerts();
+          showAlerts([
+            {
+              type: "info",
+              msg: "You are online again.",
+            },
+          ]);
+        }
+        toasts.push({
+          type: "info",
+          msg: "Synchronized your offline data.",
+        });
+      } catch (error) {
+        console.log("Error during push sync:", error);
+      }
+      if (toasts.length > 0) showToasts(toasts);
+    } else {
+      const iframeWindow = $("#content-iframe")[0].contentWindow;
+      if (iframeWindow) {
+        clearToasts();
+        iframeWindow.notifyAlert(
+          `An internet connection is available, to end the offline mode click ${saltcorn.markup.a(
+            {
+              href: "javascript:execLink('/sync/sync_settings')",
+            },
+            "here"
+          )}`
+        );
+      }
     }
   }
   mobileConfig.networkState = status.connectionType;
@@ -602,7 +709,7 @@ export async function hasOfflineRows() {
     const table = saltcorn.data.models.Table.findOne({ name: tblName });
     const pkName = table.pk_name;
     const { rows } = await saltcorn.data.db.query(
-      `select count(info_tbl.ref) 
+      `select count(info_tbl.ref) as total
            from "${saltcorn.data.db.sqlsanitize(
              tblName
            )}_sync_info" as info_tbl 
@@ -610,7 +717,7 @@ export async function hasOfflineRows() {
            on info_tbl.ref = data_tbl."${saltcorn.data.db.sqlsanitize(pkName)}"
            where info_tbl.modified_local = true`
     );
-    if (rows?.length > 0 && parseInt(rows[0].count) > 0) return true;
+    if (rows?.length > 0 && parseInt(rows[0].total) > 0) return true;
   }
   return false;
 }
@@ -630,7 +737,7 @@ export async function deleteOfflineData(noFeedback) {
     await clearLocalData(false);
     await setHasOfflineData(false);
     if (!noFeedback)
-      showAlerts([
+      showToasts([
         {
           type: "info",
           msg: "Deleted your offline data.",
@@ -643,3 +750,17 @@ export async function deleteOfflineData(noFeedback) {
     if (!noFeedback) removeLoadSpinner();
   }
 }
+
+export function addPushSyncHandler() {
+  const state = saltcorn.data.state.getState();
+  state.mobile_push_handler["push_sync"] = async (notification) => {
+    console.log("Push sync received:", notification);
+    const alerts = [];
+    try {
+      await sync(false, false, alerts);
+      if (alerts.length > 0) showToasts(alerts);
+    } catch (error) {
+      console.log("Error during push sync:", error);
+    }
+  };
+}

package/src/index.js

@@ -2,13 +2,32 @@ import { init } from "./init";
 import * as api from "./helpers/api";
 import * as auth from "./helpers/auth";
 import * as common from "./helpers/common";
-import * as notifications from "./helpers/notifications";
 import * as fileSystem from "./helpers/file_system";
 import * as navigation from "./helpers/navigation";
 import * as offlineMode from "./helpers/offline_mode";
 import * as dbSchema from "./helpers/db_schema";
 import { router } from "./routing/index";
 
+// included when push notifications or push sync is enabled
+let notifications = undefined;
+try {
+  notifications = require("./helpers/notifications");
+  console.log("Notifications module available");  
+} catch (err) {
+  console.log("Notifications module not available");
+}
+
+// included when periodic background sync is enabled
+let backgroundSync = undefined;
+try {
+  backgroundSync = require("./helpers/background_sync");
+  console.log("Background sync module available");  
+}
+catch (err) {
+  console.log("Background sync module not available");
+}
+
+// include code placed in a mobile-app directory inside plugins
 const plugins = {};
 const context = require.context("./plugins-code", true, /index\.js$/);
 context.keys().forEach((key) => {
@@ -22,10 +41,11 @@ export const mobileApp = {
   api,
   auth,
   common,
-  notifications,
   fileSystem,
   navigation: { ...navigation, router },
   offlineMode,
   dbSchema,
+  ...(notifications ? { notifications } : {}),
+  ...(backgroundSync ? { backgroundSync } : {}),
   plugins,
 };