[MM-68986][MM-69203] Add module to collect Session Attributes from Mobile App

android/app/src/main/AndroidManifest.xml

@@ -14,6 +14,10 @@
     <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" android:maxSdkVersion="32" tools:ignore="ScopedStorage" />
     <uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" android:maxSdkVersion="32" tools:ignore="SelectedPhotoAccess" />
     <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
+
+    <!-- Required to read the current Wi-Fi SSID for session attributes -->
+    <uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
+    <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
     <uses-permission android:name="android.permission.RECORD_AUDIO" />
     <uses-permission android:name="android.permission.MODIFY_AUDIO_SETTINGS" />
     <uses-permission android:name="android.permission.POST_NOTIFICATIONS"/>

android/app/src/main/java/com/mattermost/helpers/Network.java

@@ -64,6 +64,7 @@ private static void createClientOptions() {
 
         WritableMap requestAdapterConfiguration = Arguments.createMap();
         requestAdapterConfiguration.putString("bearerAuthTokenResponseHeader", "token");
+        requestAdapterConfiguration.putBoolean("enableSessionAttributes", true);
         clientOptions.putMap("requestAdapterConfiguration", requestAdapterConfiguration);
 
         WritableMap sessionConfiguration = Arguments.createMap();

android/app/src/main/java/com/mattermost/rnbeta/MainApplication.kt

@@ -15,6 +15,8 @@ import com.facebook.react.common.ReleaseLevel
 import com.facebook.react.defaults.DefaultNewArchitectureEntryPoint
 import com.facebook.react.modules.network.OkHttpClientProvider
 import com.mattermost.networkclient.RCTOkHttpClientFactory
+import com.mattermost.networkclient.sessionattributes.SessionAttributes
+import com.mattermost.rnshare.ShareWorker
 import com.mattermost.rnshare.helpers.RealPathUtil
 import com.mattermost.turbolog.TurboLog
 import com.mattermost.turbolog.ConfigureOptions
@@ -66,6 +68,11 @@ class MainApplication : Application(), ReactApplication, INotificationsApplicati
         OkHttpClientProvider.setOkHttpClientFactory(RCTOkHttpClientFactory())
         ExpoImageOkHttpClientGlideModule.okHttpClient = RCTOkHttpClientFactory().createNewNetworkModuleClient()
 
+        // ShareWorker can run without React Native loaded, so ApiClientModuleImpl may never
+        // initialize the session attributes engine.
+        SessionAttributes.init(this)
+        ShareWorker.getSessionAttributesHeader = SessionAttributes::getOutboundHeader
+
         loadReactNative(this)
         ApplicationLifecycleDispatcher.onApplicationCreate(this)
     }

app/actions/remote/session_attributes.test.ts

@@ -0,0 +1,51 @@
+// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
+// See LICENSE.txt for license information.
+
+import NetworkManager from '@managers/network_manager';
+
+import {fetchSessionAttributesManifest} from './session_attributes';
+
+jest.mock('@managers/network_manager');
+jest.mock('@utils/log');
+
+const serverUrl = 'https://chat.example.com';
+const manifest: SAField[] = [
+    {name: 'os_platform', type: 'string', ttl_seconds: 0, grace_period_seconds: 0},
+];
+
+describe('fetchSessionAttributesManifest', () => {
+    const mockClient = {getSessionAttributesManifest: jest.fn()};
+
+    beforeEach(() => {
+        jest.clearAllMocks();
+        (NetworkManager.getClient as jest.Mock).mockReturnValue(mockClient);
+    });
+
+    it('should return the manifest from the client', async () => {
+        mockClient.getSessionAttributesManifest.mockResolvedValue(manifest);
+
+        const result = await fetchSessionAttributesManifest(serverUrl);
+
+        expect(result).toEqual({manifest});
+    });
+
+    it('should return the error when the client request fails', async () => {
+        const error = new Error('request failed');
+        mockClient.getSessionAttributesManifest.mockRejectedValue(error);
+
+        const result = await fetchSessionAttributesManifest(serverUrl);
+
+        expect(result).toEqual({error});
+    });
+
+    it('should return the error when the client cannot be resolved', async () => {
+        const error = new Error('no client');
+        (NetworkManager.getClient as jest.Mock).mockImplementation(() => {
+            throw error;
+        });
+
+        const result = await fetchSessionAttributesManifest(serverUrl);
+
+        expect(result).toEqual({error});
+    });
+});

app/actions/remote/session_attributes.ts

@@ -0,0 +1,17 @@
+// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
+// See LICENSE.txt for license information.
+
+import NetworkManager from '@managers/network_manager';
+import {getFullErrorMessage} from '@utils/errors';
+import {logDebug} from '@utils/log';
+
+export const fetchSessionAttributesManifest = async (serverUrl: string): Promise<{manifest?: SAField[]; error?: unknown}> => {
+    try {
+        const client = NetworkManager.getClient(serverUrl);
+        const manifest = await client.getSessionAttributesManifest();
+        return {manifest};
+    } catch (error) {
+        logDebug('error on fetchSessionAttributesManifest', getFullErrorMessage(error));
+        return {error};
+    }
+};

app/actions/websocket/event.ts

@@ -30,7 +30,15 @@ import {handleUserRoleUpdatedEvent, handleTeamMemberRoleUpdatedEvent, handleRole
 import {handleLicenseChangedEvent, handleConfigChangedEvent} from './system';
 import * as teams from './teams';
 import {handleThreadUpdatedEvent, handleThreadReadChangedEvent, handleThreadFollowChangedEvent} from './threads';
-import {handleUserUpdatedEvent, handleUserTypingEvent, handleStatusChangedEvent, handleCustomProfileAttributesValuesUpdatedEvent, handleCustomProfileAttributesFieldUpdatedEvent, handleCustomProfileAttributesFieldDeletedEvent} from './users';
+import {
+    handleCustomProfileAttributesFieldDeletedEvent,
+    handleCustomProfileAttributesFieldUpdatedEvent,
+    handleCustomProfileAttributesValuesUpdatedEvent,
+    handleSessionAttributesPropertyFieldEvent,
+    handleStatusChangedEvent,
+    handleUserTypingEvent,
+    handleUserUpdatedEvent,
+} from './users';
 
 export async function handleWebSocketEvent(serverUrl: string, msg: WebSocketMessage) {
     switch (msg.event) {
@@ -317,6 +325,7 @@ export async function handleWebSocketEvent(serverUrl: string, msg: WebSocketMess
         case WebsocketEvents.PROPERTY_FIELD_CREATED:
         case WebsocketEvents.PROPERTY_FIELD_UPDATED:
             handlePropertyFieldCreatedOrUpdated(serverUrl, msg);
+            handleSessionAttributesPropertyFieldEvent(serverUrl, msg);
             break;
 
         case WebsocketEvents.PROPERTY_FIELD_DELETED:

app/actions/websocket/index.test.ts

@@ -14,6 +14,7 @@ import {loadConfigAndCalls} from '@calls/actions/calls';
 import {isSupportedServerCalls} from '@calls/utils';
 import DatabaseManager from '@database/manager';
 import AppsManager from '@managers/apps_manager';
+import SessionAttributesManager from '@managers/session_attributes_manager';
 import {handlePlaybookReconnect} from '@playbooks/actions/websocket/reconnect';
 import {getActiveServerUrl} from '@queries/app/servers';
 import {getLastPostInThread} from '@queries/servers/post';
@@ -52,6 +53,12 @@ jest.mock('@utils/helpers', () => ({
 }));
 
 jest.mock('@playbooks/actions/websocket/reconnect');
+jest.mock('@managers/session_attributes_manager', () => ({
+    __esModule: true,
+    default: {
+        refreshManifest: jest.fn().mockResolvedValue(undefined),
+    },
+}));
 
 describe('WebSocket Index Actions', () => {
     const serverUrl = 'baseHandler.test.com';
@@ -107,6 +114,7 @@ describe('WebSocket Index Actions', () => {
             expect(loadConfigAndCalls).toHaveBeenCalled();
             expect(deferredAppEntryActions).toHaveBeenCalled();
             expect(handlePlaybookReconnect).toHaveBeenCalledWith(serverUrl);
+            expect(SessionAttributesManager.refreshManifest).toHaveBeenCalledWith(serverUrl);
         });
 
         it('should handle error when server database not found', async () => {
@@ -163,6 +171,7 @@ describe('WebSocket Index Actions', () => {
             expect(expiredBoRPostCleanup).toHaveBeenCalled();
             expect(AppsManager.refreshAppBindings).toHaveBeenCalled();
             expect(handlePlaybookReconnect).toHaveBeenCalledWith(serverUrl);
+            expect(SessionAttributesManager.refreshManifest).toHaveBeenCalledWith(serverUrl);
         });
 
         it('should fetch posts for channel screen', async () => {

app/actions/websocket/index.ts

@@ -21,6 +21,7 @@ import {isSupportedServerCalls} from '@calls/utils';
 import {Screens} from '@constants';
 import DatabaseManager from '@database/manager';
 import AppsManager from '@managers/apps_manager';
+import SessionAttributesManager from '@managers/session_attributes_manager';
 import {handlePlaybookReconnect} from '@playbooks/actions/websocket/reconnect';
 import {getActiveServerUrl} from '@queries/app/servers';
 import {getLastPostInThread} from '@queries/servers/post';
@@ -64,6 +65,8 @@ async function doReconnect(serverUrl: string, groupLabel?: BaseRequestGroupLabel
     const {database} = operator;
 
     try {
+        await SessionAttributesManager.refreshManifest(serverUrl);
+
         const lastFullSync = await getLastFullSync(database);
         const now = Date.now();
 

app/actions/websocket/system.test.ts

@@ -6,6 +6,7 @@ import {reconcilePersistenceFlag} from '@actions/local/ephemeral_mode/wipe';
 import {storeConfig} from '@actions/local/systems';
 import {SYSTEM_IDENTIFIERS} from '@constants/database';
 import DatabaseManager from '@database/manager';
+import SessionAttributesManager from '@managers/session_attributes_manager';
 import {getConfig, getLicense} from '@queries/servers/system';
 
 import {handleLicenseChangedEvent, handleConfigChangedEvent} from './system';
@@ -16,6 +17,13 @@ jest.mock('@actions/local/channel');
 jest.mock('@actions/local/ephemeral_mode/wipe');
 jest.mock('@actions/local/systems');
 jest.mock('@database/manager');
+jest.mock('@managers/session_attributes_manager', () => ({
+    __esModule: true,
+    default: {
+        refreshManifest: jest.fn().mockResolvedValue(undefined),
+        removeServer: jest.fn(),
+    },
+}));
 jest.mock('@queries/servers/system');
 
 describe('WebSocket System Actions', () => {
@@ -156,6 +164,42 @@ describe('WebSocket System Actions', () => {
             expect(updateDmGmDisplayName).toHaveBeenCalledWith(serverUrl);
         });
 
+        it('should re-init session attributes when feature flag is enabled', async () => {
+            jest.mocked(getConfig).mockResolvedValue({
+                FeatureFlagSessionAttributes: 'false',
+            } as ClientConfig);
+
+            const msg = {
+                data: {
+                    config: {
+                        FeatureFlagSessionAttributes: 'true',
+                    },
+                },
+            } as WebSocketMessage;
+
+            await handleConfigChangedEvent(serverUrl, msg);
+
+            expect(SessionAttributesManager.refreshManifest).toHaveBeenCalledWith(serverUrl);
+        });
+
+        it('should stop sending session attributes when feature flag is disabled', async () => {
+            jest.mocked(getConfig).mockResolvedValue({
+                FeatureFlagSessionAttributes: 'true',
+            } as ClientConfig);
+
+            const msg = {
+                data: {
+                    config: {
+                        FeatureFlagSessionAttributes: 'false',
+                    },
+                },
+            } as WebSocketMessage;
+
+            await handleConfigChangedEvent(serverUrl, msg);
+
+            expect(SessionAttributesManager.removeServer).toHaveBeenCalledWith(serverUrl);
+        });
+
         it('should reconcile the persistence flag against the new config so a live MEM-cleanup change clears zero-persistence', async () => {
             const mockConfig = {
                 MobileEphemeralModeEnabled: 'true',

app/actions/websocket/system.ts

@@ -6,8 +6,10 @@ import {reconcilePersistenceFlag} from '@actions/local/ephemeral_mode/wipe';
 import {storeConfig} from '@actions/local/systems';
 import {fetchCategories} from '@actions/remote/category';
 import {applyPersistenceModeChange} from '@actions/remote/refresh';
+import {License} from '@constants';
 import {SYSTEM_IDENTIFIERS} from '@constants/database';
 import DatabaseManager from '@database/manager';
+import SessionAttributesManager from '@managers/session_attributes_manager';
 import {getConfig, getCurrentTeamId, getLicense} from '@queries/servers/system';
 import EphemeralStore from '@store/ephemeral_store';
 import {getFullErrorMessage} from '@utils/errors';
@@ -26,6 +28,16 @@ export async function handleLicenseChangedEvent(serverUrl: string, msg: WebSocke
         if (license?.LockTeammateNameDisplay && (prevLicense?.LockTeammateNameDisplay !== license.LockTeammateNameDisplay)) {
             updateDmGmDisplayName(serverUrl);
         }
+
+        const prevSessionAttributes = prevLicense?.SkuShortName === License.SKU_SHORT_NAME.EnterpriseAdvanced;
+        const newSessionAttributes = license?.SkuShortName === License.SKU_SHORT_NAME.EnterpriseAdvanced;
+        if (newSessionAttributes !== prevSessionAttributes) {
+            if (newSessionAttributes) {
+                await SessionAttributesManager.refreshManifest(serverUrl);
+            } else {
+                SessionAttributesManager.removeServer(serverUrl);
+            }
+        }
     } catch {
         // do nothing
     }
@@ -60,6 +72,16 @@ export async function handleConfigChangedEvent(serverUrl: string, msg: WebSocket
                 logError('handleConfigChangedEvent', getFullErrorMessage(modeChangeError));
             }
         }
+
+        const prevSessionAttributes = prevConfig?.FeatureFlagSessionAttributes === 'true';
+        const newSessionAttributes = config?.FeatureFlagSessionAttributes === 'true';
+        if (newSessionAttributes !== prevSessionAttributes) {
+            if (newSessionAttributes) {
+                await SessionAttributesManager.refreshManifest(serverUrl);
+            } else {
+                SessionAttributesManager.removeServer(serverUrl);
+            }
+        }
     } catch {
         // do nothing
     }

app/actions/websocket/users.test.ts

@@ -8,6 +8,7 @@ import {setCurrentUserStatus} from '@actions/local/user';
 import {fetchMe, fetchUsersByIds} from '@actions/remote/user';
 import {Events} from '@constants';
 import DatabaseManager from '@database/manager';
+import SessionAttributesManager from '@managers/session_attributes_manager';
 import WebsocketManager from '@managers/websocket_manager';
 import {queryChannelsByTypes, queryUserChannelsByTypes} from '@queries/servers/channel';
 import {deleteCustomProfileAttributesByFieldId} from '@queries/servers/custom_profile';
@@ -25,6 +26,7 @@ import {
     handleCustomProfileAttributesValuesUpdatedEvent,
     handleCustomProfileAttributesFieldUpdatedEvent,
     handleCustomProfileAttributesFieldDeletedEvent,
+    handleSessionAttributesPropertyFieldEvent,
 } from './users';
 
 import type ServerDataOperator from '@database/operator/server_data_operator';
@@ -35,6 +37,14 @@ jest.mock('@actions/remote/user');
 jest.mock('@database/manager');
 jest.mock('@helpers/api/preference');
 jest.mock('@managers/websocket_manager');
+jest.mock('@managers/session_attributes_manager', () => ({
+    __esModule: true,
+    default: {
+        refreshManifest: jest.fn().mockResolvedValue(undefined),
+        upsertManifestField: jest.fn(),
+        removeManifestField: jest.fn(),
+    },
+}));
 jest.mock('@queries/servers/channel');
 jest.mock('@queries/servers/custom_profile');
 jest.mock('@queries/servers/preference');
@@ -532,4 +542,56 @@ describe('WebSocket Users Actions', () => {
             expect(deleteCustomProfileAttributesByFieldId).toHaveBeenCalled();
         });
     });
+
+    describe('handleSessionAttributesPropertyFieldEvent', () => {
+        const buildField = (attrs: Record<string, unknown> = {}) => JSON.stringify({
+            name: 'os_version',
+            type: 'text',
+            attrs: {enabled: true, platforms: ['desktop', 'mobile'], ttl_seconds: 60, grace_period_seconds: 30, ...attrs},
+        });
+
+        const buildMessage = (property_field?: string, objectType: string | undefined = 'session') => ({
+            event: 'property_field_updated',
+            data: {object_type: objectType, property_field},
+        }) as WebSocketMessage;
+
+        it('should upsert an enabled mobile field from the websocket payload', () => {
+            handleSessionAttributesPropertyFieldEvent(serverUrl, buildMessage(buildField()));
+
+            expect(SessionAttributesManager.upsertManifestField).toHaveBeenCalledWith(serverUrl, {
+                name: 'os_version',
+                type: 'text',
+                ttl_seconds: 60,
+                grace_period_seconds: 30,
+            });
+            expect(SessionAttributesManager.removeManifestField).not.toHaveBeenCalled();
+        });
+
+        it('should remove a disabled field', () => {
+            handleSessionAttributesPropertyFieldEvent(serverUrl, buildMessage(buildField({enabled: false})));
+
+            expect(SessionAttributesManager.removeManifestField).toHaveBeenCalledWith(serverUrl, 'os_version');
+            expect(SessionAttributesManager.upsertManifestField).not.toHaveBeenCalled();
+        });
+
+        it('should remove a field not targeted at mobile', () => {
+            handleSessionAttributesPropertyFieldEvent(serverUrl, buildMessage(buildField({platforms: ['desktop']})));
+
+            expect(SessionAttributesManager.removeManifestField).toHaveBeenCalledWith(serverUrl, 'os_version');
+        });
+
+        it('should ignore non-session object types', () => {
+            handleSessionAttributesPropertyFieldEvent(serverUrl, buildMessage(buildField(), 'channel'));
+
+            expect(SessionAttributesManager.upsertManifestField).not.toHaveBeenCalled();
+            expect(SessionAttributesManager.removeManifestField).not.toHaveBeenCalled();
+        });
+
+        it('should ignore events without a property field payload', () => {
+            handleSessionAttributesPropertyFieldEvent(serverUrl, buildMessage(undefined));
+
+            expect(SessionAttributesManager.upsertManifestField).not.toHaveBeenCalled();
+            expect(SessionAttributesManager.removeManifestField).not.toHaveBeenCalled();
+        });
+    });
 });