@alfalab/bridge-to-native 1.2.1 → 1.3.2

package/client/services-and-utils/native-navigation-and-title-service.d.ts

@@ -50,6 +50,7 @@ export declare class NativeNavigationAndTitleService {
      * экзепляра B2N следующей страницы текущего WA
      */
     private prepareExternalLinkBeforeOpen;
+    private static shouldInitializeFromNextPageId;
     /**
      * Читает сохраннённый в sessionStorage `nativeHistoryStack`,
      * снова сохраняет его в sessionStorage, уменьшая список на одну запись,

package/client/services-and-utils/native-navigation-and-title-service.js

@@ -135,9 +135,12 @@ class NativeNavigationAndTitleService {
      */
     initializeNativeHistoryStack() {
         const { nextPageId, title } = this.nativeParamsService;
-        if (nextPageId) {
+        if (nextPageId &&
+            NativeNavigationAndTitleService.shouldInitializeFromNextPageId(nextPageId)) {
             // Сценарий 2 – `nextPageId` ставит метод `this.navigateServerSide`,
             // т.е. это инициализация сразу после перехода server-side навигацией.
+            // Если в sessionStorage уже есть стек, используем `nextPageId` только для прямого
+            // перехода "вперёд", когда он на 1 больше сохранённой глубины истории.
             this.nativeHistoryStack = new Array(nextPageId).fill(0 /* NativeHistoryStackSpecialValues.ServerSideNavigationStub */);
             this.nativeHistoryStack[this.nativeHistoryStack.length - 1] = title;
         }
@@ -168,11 +171,38 @@ class NativeNavigationAndTitleService {
      */
     prepareExternalLinkBeforeOpen(url) {
         const currentPageId = this.nativeHistoryStack.length;
-        const divider = new URL(url).searchParams.toString() ? '&' : '?';
-        const modifiedUrl = new URL(`${url}${divider}${this.nativeParamsService.originalWebviewParams}`);
+        const modifiedUrl = new URL(url);
+        const { originalWebviewParams, appVersion } = this.nativeParamsService;
+        if (originalWebviewParams) {
+            const originalWebviewSearchParams = new URLSearchParams(originalWebviewParams);
+            originalWebviewSearchParams.forEach((value, key) => {
+                modifiedUrl.searchParams.set(key, value);
+            });
+        }
+        // Явно добавляем query-параметр `device_app_version` используемый NA на iOS, чтобы он был и в Android окружении.
+        // Таким образом гарантируется, что версию приложения будет видеть следующее WA
+        // (заголовок `app-version` может отсутствовать при server-side переходах).
+        modifiedUrl.searchParams.set(query_and_headers_keys_1.QUERY_NATIVE_IOS_APPVERSION, appVersion);
         modifiedUrl.searchParams.set(query_and_headers_keys_1.QUERY_B2N_NEXT_PAGEID, (currentPageId + 1).toString());
         return modifiedUrl;
     }
+    static shouldInitializeFromNextPageId(nextPageId) {
+        if (!NativeNavigationAndTitleService.hasSavedHistoryStack()) {
+            return true;
+        }
+        try {
+            const serializedNativeHistoryStack = sessionStorage.getItem(query_and_headers_keys_1.SS_KEY_BRIDGE_TO_NATIVE_HISTORY_STACK);
+            if (!serializedNativeHistoryStack) {
+                return true;
+            }
+            return (nextPageId ===
+                JSON.parse(serializedNativeHistoryStack).length +
+                    1);
+        }
+        catch (_a) {
+            return true;
+        }
+    }
     /**
      * Читает сохраннённый в sessionStorage `nativeHistoryStack`,
      * снова сохраняет его в sessionStorage, уменьшая список на одну запись,

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@alfalab/bridge-to-native",
-    "version": "1.2.1",
+    "version": "1.3.2",
     "license": "MIT",
     "description": "Утилита для удобной работы веб приложения внутри нативного приложения и коммуникации с ним.",
     "engines": {
@@ -32,14 +32,13 @@
         "build:clean": "shx rm -rf .publish",
         "build:copy-package-json": "shx cp package.json .publish/package.json",
         "build:ts": "tsc --build",
-        "changelog": "bash bin/fill-changelog-file-and-notify-github.sh",
         "format": "arui-presets-lint format",
         "format:check": "arui-presets-lint format:check",
         "lint": "yarn lint:scripts && yarn format:check",
         "lint:fix": "yarn lint:scripts --fix && yarn format",
         "lint:scripts": "arui-presets-lint scripts",
         "pub": "npm publish .publish --userconfig \"../.npmrc\" --tag \"$TAG\"",
-        "release": "yarn build && npm version \"$VERSION\" --no-git-tag-version && yarn build:copy-package-json && yarn pub",
+        "release": "yarn build && yarn build:copy-package-json && yarn pub",
         "test": "arui-scripts test --silent --collect-coverage"
     },
     "devDependencies": {

package/query-and-headers-keys.js

@@ -34,7 +34,7 @@ exports.QUERY_B2N_TITLE = 'b2n-title';
 // (т.к. `title` часто может использоваться самим веб-приложением).
 // Игнорируется, если указан 'b2n-title'.
 exports.QUERY_B2N_TITLE_DEPRECATED = 'title';
-// NA на iOS приложение передаёт в этом параметре схему,
+// NA на iOS передаёт в этом параметре схему,
 // под которым оно зарегистрировано в OS.
 // Известные проблемы:
 // * В старых версиях отсутствует, клиентский код использует хардкод (см. `src/client/constants.ts`);
@@ -42,7 +42,9 @@ exports.QUERY_B2N_TITLE_DEPRECATED = 'title';
 //  и схемой, которая приходит в этом параметре.
 //  Нужно просить iOS разработчика собрать сборку нормально.
 exports.QUERY_NATIVE_IOS_APPID = 'applicationId';
-// NA на iOS приложение передаёт в этом параметре свою версию.
+// Исторически NA на iOS передаёт в этом параметре свою версию.
+// B2N сознательно переиспользует этот query и для server-side переходов в Android,
+// чтобы не вводить отдельный служебный параметр только для переноса версии между WA.
 exports.QUERY_NATIVE_IOS_APPVERSION = 'device_app_version';
 // NA на обеих платформах в этом параметре передаёт активную тему (светлая/тёмная).
 exports.QUERY_NATIVE_THEME = 'theme';

package/server/prepare-native-app-details-for-client.d.ts

@@ -1,3 +1,4 @@
+import { type NativeParams } from '../types';
 import { type UniversalRequest } from './types';
 /**
  * Парсит запрос, доставая из него данные о нативном приложении,
@@ -10,4 +11,4 @@ import { type UniversalRequest } from './types';
  *  Нужно передать функцию, которая средствами используемого веб-сервера добавит заголовок в ответ.
  *  b2native с её помощью добавит `Set-Cookie` заголовок с некоторыми данными для своего клиентского кода.
  */
-export declare function prepareNativeAppDetailsForClient(request: UniversalRequest, setResponseHeader: (headerKey: string, headerValue: string) => void): any;
+export declare function prepareNativeAppDetailsForClient(request: UniversalRequest, setResponseHeader: (headerKey: string, headerValue: string) => void): Partial<NativeParams>;

package/server/prepare-native-app-details-for-client.js

@@ -25,25 +25,21 @@ function prepareNativeAppDetailsForClient(request, setResponseHeader) {
     // 1) Данных NA в запросе с большой вероятностью не будет;
     // 2) клиентская сторона сохранит всё, что нужно в SessionStorage
     const cookieHeader = (0, utils_1.getHeaderValue)(request, query_and_headers_keys_1.HEADER_KEY_COOKIE);
+    const nativeParamsFromCookie = (0, utils_1.readNativeParamsFromCookie)(cookieHeader);
     const hasReloadFlag = cookieHeader?.includes(`${query_and_headers_keys_1.COOKIE_KEY_BRIDGE_TO_NATIVE_RELOAD}=true`);
     if (hasReloadFlag) {
         setResponseHeader('Set-Cookie', `${query_and_headers_keys_1.COOKIE_KEY_BRIDGE_TO_NATIVE_RELOAD}=false; Max-Age=0; Path=/`);
-        const cookieData = (0, utils_1.getBridgeToNativeDataCookie)(cookieHeader);
-        if (cookieData) {
-            try {
-                return JSON.parse(decodeURIComponent(cookieData));
-            }
-            catch {
-                return parseRequest(request);
-            }
+        if (nativeParamsFromCookie) {
+            return nativeParamsFromCookie;
         }
+        return buildNativeParams(request);
     }
-    const nativeParams = parseRequest(request);
+    const nativeParams = buildNativeParams(request, nativeParamsFromCookie);
     const serializedNativeParams = encodeURIComponent(JSON.stringify(nativeParams));
     setResponseHeader('Set-Cookie', `${query_and_headers_keys_1.COOKIE_KEY_BRIDGE_TO_NATIVE_DATA}=${serializedNativeParams}; Path=/`);
     return nativeParams;
 }
-function parseRequest(request) {
+function buildNativeParams(request, nativeParamsFromCookie) {
     // Прихраним «сервисные» query-параметры от нативного приложения,
     // чтобы подмешать их к URL при переходе в другое веб-приложение
     // в рамках одной вебвью-сессии.
@@ -70,6 +66,9 @@ function parseRequest(request) {
         const [, appIdSubsting] = iosAppIdQuery.match(regexp_patterns_1.iosAppIdPattern); // кастинг ок — в условии блока регулярка проверена
         nativeParams.iosAppId = appIdSubsting;
     }
+    // Версия приложения может приехать прямо в текущем request (в query-параметре `device_app_version`
+    // или заголовке `app-version`), а при server-side переходах / возврате назад может уже не приехать.
+    // В таких сценариях берём `appVersion` фолбэком из куки `bridgeToNativeData`.
     if (iosAppVersionQuery && regexp_patterns_1.versionPattern.test(iosAppVersionQuery)) {
         nativeParams.appVersion = iosAppVersionQuery;
     }
@@ -77,6 +76,11 @@ function parseRequest(request) {
         const [, versionSubstring] = appVersionFromHeaders.match(regexp_patterns_1.versionPattern); // кастинг ок — в условии блока регулярка проверена
         nativeParams.appVersion = versionSubstring;
     }
+    else if (nativeParamsFromCookie?.appVersion &&
+        regexp_patterns_1.versionPattern.test(nativeParamsFromCookie.appVersion)) {
+        const [, versionSubstring] = nativeParamsFromCookie.appVersion.match(regexp_patterns_1.versionPattern);
+        nativeParams.appVersion = versionSubstring;
+    }
     else {
         nativeParams.appVersion = '0.0.0';
     }

package/server/utils.d.ts

@@ -1,3 +1,4 @@
+import { type NativeParams } from '../types';
 import { type UniversalRequest } from './types';
 /**
  * На основе объекта запроса любого типа возвращает
@@ -31,6 +32,10 @@ export declare function parseHeaderTimestamp(headerValue: string | number | null
 /**
  * Возвращает значение для нужной куки
  *
- * @param cookieName Имя куки
+ * @param cookieHeader Имя куки
  */
-export declare const getBridgeToNativeDataCookie: (cookieName: string | null) => string | undefined;
+export declare const getBridgeToNativeDataCookie: (cookieHeader: string | null) => string | undefined;
+/**
+ * Возвращает десериализованные данные из `bridgeToNativeData` cookie.
+ */
+export declare function readNativeParamsFromCookie(cookieHeader: string | null): Partial<NativeParams> | null;

package/server/utils.js

@@ -5,6 +5,7 @@ exports.getHeaderValue = getHeaderValue;
 exports.getQueryValues = getQueryValues;
 exports.hasBridgeToNativeDataCookie = hasBridgeToNativeDataCookie;
 exports.parseHeaderTimestamp = parseHeaderTimestamp;
+exports.readNativeParamsFromCookie = readNativeParamsFromCookie;
 const query_and_headers_keys_1 = require("../query-and-headers-keys");
 const regexp_patterns_1 = require("./regexp-patterns");
 /**
@@ -57,13 +58,13 @@ function parseHeaderTimestamp(headerValue) {
 /**
  * Возвращает значение для нужной куки
  *
- * @param cookieName Имя куки
+ * @param cookieHeader Имя куки
  */
-const getBridgeToNativeDataCookie = (cookieName) => {
-    if (!cookieName) {
+const getBridgeToNativeDataCookie = (cookieHeader) => {
+    if (!cookieHeader) {
         return undefined;
     }
-    const cookies = cookieName.split(';');
+    const cookies = cookieHeader.split(';');
     for (const cookie of cookies) {
         const [key, value] = cookie.trim().split('=');
         if (key === query_and_headers_keys_1.COOKIE_KEY_BRIDGE_TO_NATIVE_DATA) {
@@ -73,3 +74,18 @@ const getBridgeToNativeDataCookie = (cookieName) => {
     return undefined;
 };
 exports.getBridgeToNativeDataCookie = getBridgeToNativeDataCookie;
+/**
+ * Возвращает десериализованные данные из `bridgeToNativeData` cookie.
+ */
+function readNativeParamsFromCookie(cookieHeader) {
+    const cookieData = (0, exports.getBridgeToNativeDataCookie)(cookieHeader);
+    if (!cookieData) {
+        return null;
+    }
+    try {
+        return JSON.parse(decodeURIComponent(cookieData));
+    }
+    catch {
+        return null;
+    }
+}