Merge pull request #1140 from OneSignal/feat/getTags

[Feat] Add getTags to public API

MIGRATION_GUIDE.md

@@ -168,6 +168,7 @@ All user functions are synchronous.
 | `addTags`       | Adds multiple tags for the current user.       | `tags: { [key: string]: string }`    |
 | `removeTag`     | Removes a tag for the current user.            | `key: string`                        |
 | `removeTags`    | Removes multiple tags for the current user.    | `keys: string[]`                     |
+| `getTags`       | Gets the current user's tags.                  |                                      |
 
 ### Notifications Namespace
 

__test__/support/helpers/core.ts

@@ -14,6 +14,7 @@ import {
 } from '../constants';
 import CoreModule from '../../../src/core/CoreModule';
 import { CoreModuleDirector } from '../../../src/core/CoreModuleDirector';
+import { UserPropertiesModel } from '../../../src/core/models/UserPropertiesModel';
 
 export function generateNewSubscription(modelId = '0000000000') {
   return new OSModel<SupportedSubscription>(
@@ -42,6 +43,12 @@ export function getDummyIdentityOSModel(
   return new OSModel<SupportedIdentity>(ModelName.Identity, {}, modelId);
 }
 
+export function getDummyPropertyOSModel(
+  modelId = DUMMY_MODEL_ID,
+): OSModel<UserPropertiesModel> {
+  return new OSModel<UserPropertiesModel>(ModelName.Properties, {}, modelId);
+}
+
 export function getDummyPushSubscriptionOSModel(): OSModel<SupportedSubscription> {
   return new OSModel<SupportedSubscription>(
     ModelName.PushSubscriptions,

__test__/unit/user/user.test.ts

@@ -0,0 +1,57 @@
+import { TestEnvironment } from '../../support/environment/TestEnvironment';
+import User from '../../../src/onesignal/User';
+import { ModelName } from '../../../src/core/models/SupportedModels';
+import { getDummyPropertyOSModel } from '../../support/helpers/core';
+
+// suppress all internal logging
+jest.mock('../../../src/shared/libraries/Log');
+
+describe('User tests', () => {
+  test('getTags called without a properties model should return undefined tags', async () => {
+    await TestEnvironment.initialize();
+
+    const user = User.createOrGetInstance();
+    const tags = user.getTags();
+
+    expect(tags).toBe(undefined);
+  });
+
+  test('getTags called with undefined tags in properties model should return undefined tags', async () => {
+    await TestEnvironment.initialize();
+
+    OneSignal.coreDirector.add(ModelName.Properties, getDummyPropertyOSModel());
+
+    const user = User.createOrGetInstance();
+    const tags = user.getTags();
+
+    expect(tags).toBe(undefined);
+  });
+
+  test('getTags called with empty tags in properties model should return empty tags', async () => {
+    await TestEnvironment.initialize();
+
+    const propertyModel = getDummyPropertyOSModel();
+    propertyModel.set('tags', {});
+    OneSignal.coreDirector.add(ModelName.Properties, propertyModel);
+
+    const user = User.createOrGetInstance();
+    const tags = user.getTags();
+
+    expect(tags).toStrictEqual({});
+  });
+
+  test('getTags called with tags in properties model should return tags', async () => {
+    await TestEnvironment.initialize();
+
+    const tagsSample = { key1: 'value1' };
+
+    const propertyModel = getDummyPropertyOSModel();
+    propertyModel.set('tags', tagsSample);
+    OneSignal.coreDirector.add(ModelName.Properties, propertyModel);
+
+    const user = User.createOrGetInstance();
+    const tags = user.getTags();
+
+    expect(tags).toBe(tagsSample);
+  });
+});

api.json

@@ -450,6 +450,12 @@
           }
         ],
         "returnType": "void"
+      },
+      {
+        "name": "getTags",
+        "isAsync": false,
+        "args": [],
+        "returnType": "{ [key: string]: string }"
       }
     ],
     "namespaces": ["PushSubscription"]

src/onesignal/User.ts

@@ -335,4 +335,10 @@ export default class User {
       propertiesModel?.set('tags', tagsCopy);
     }
   }
+
+  public getTags(): { [key: string]: string } {
+    logMethodCall('getTags');
+
+    return OneSignal.coreDirector.getPropertiesModel()?.data?.tags;
+  }
 }

src/onesignal/UserNamespace.ts

@@ -70,4 +70,8 @@ export default class UserNamespace {
   public removeTags(keys: string[]): void {
     this._currentUser?.removeTags(keys);
   }
+
+  public getTags(): { [key: string]: string } {
+    return this._currentUser?.getTags() || {};
+  }
 }