launchdarkly-js-sdk-common 4.3.2 → 5.0.0-alpha.2

package/src/UserFilter.js

@@ -1,75 +0,0 @@
-const utils = require('./utils');
-
-/**
- * The UserFilter object transforms user objects into objects suitable to be sent as JSON to
- * the server, hiding any private user attributes.
- *
- * @param {Object} the LaunchDarkly client configuration object
- **/
-function UserFilter(config) {
-  const filter = {};
-  const allAttributesPrivate = config.allAttributesPrivate;
-  const privateAttributeNames = config.privateAttributeNames || [];
-  const ignoreAttrs = { key: true, custom: true, anonymous: true };
-  const allowedTopLevelAttrs = {
-    key: true,
-    secondary: true,
-    ip: true,
-    country: true,
-    email: true,
-    firstName: true,
-    lastName: true,
-    avatar: true,
-    name: true,
-    anonymous: true,
-    custom: true,
-  };
-
-  filter.filterUser = function(user) {
-    if (!user) {
-      return null;
-    }
-    const userPrivateAttrs = user.privateAttributeNames || [];
-
-    const isPrivateAttr = function(name) {
-      return (
-        !ignoreAttrs[name] &&
-        (allAttributesPrivate || userPrivateAttrs.indexOf(name) !== -1 || privateAttributeNames.indexOf(name) !== -1)
-      );
-    };
-    const filterAttrs = function(props, isAttributeAllowed) {
-      return Object.keys(props).reduce(
-        (acc, name) => {
-          const ret = acc;
-          if (isAttributeAllowed(name)) {
-            if (isPrivateAttr(name)) {
-              // add to hidden list
-              ret[1][name] = true;
-            } else {
-              ret[0][name] = props[name];
-            }
-          }
-          return ret;
-        },
-        [{}, {}]
-      );
-    };
-    const result = filterAttrs(user, key => allowedTopLevelAttrs[key]);
-    const filteredProps = result[0];
-    let removedAttrs = result[1];
-    if (user.custom) {
-      const customResult = filterAttrs(user.custom, () => true);
-      filteredProps.custom = customResult[0];
-      removedAttrs = utils.extend({}, removedAttrs, customResult[1]);
-    }
-    const removedAttrNames = Object.keys(removedAttrs);
-    if (removedAttrNames.length) {
-      removedAttrNames.sort();
-      filteredProps.privateAttrs = removedAttrNames;
-    }
-    return filteredProps;
-  };
-  return filter;
-}
-
-module.exports = UserFilter;

package/src/UserValidator.js

@@ -1,56 +0,0 @@
-const { v1: uuidv1 } = require('uuid');
-
-const errors = require('./errors');
-const messages = require('./messages');
-const utils = require('./utils');
-
-// Transforms the user object if necessary to make sure it has a valid key.
-// 1. If a key is present, but is not a string, change it to a string.
-// 2. If no key is present, and "anonymous" is true, use a UUID as a key. This is cached in local
-// storage if possible.
-// 3. If there is no key (or no user object), return an error.
-
-const ldUserIdKey = 'ld:$anonUserId';
-
-function UserValidator(persistentStorage) {
-  function getCachedUserId() {
-    return persistentStorage.get(ldUserIdKey);
-  }
-
-  function setCachedUserId(id) {
-    return persistentStorage.set(ldUserIdKey, id);
-  }
-
-  const ret = {};
-
-  // Validates the user, returning a Promise that resolves to the validated user, or rejects if there is an error.
-  ret.validateUser = user => {
-    if (!user) {
-      return Promise.reject(new errors.LDInvalidUserError(messages.userNotSpecified()));
-    }
-
-    const userOut = utils.clone(user);
-    if (userOut.key !== null && userOut.key !== undefined) {
-      userOut.key = userOut.key.toString();
-      return Promise.resolve(userOut);
-    }
-    if (userOut.anonymous) {
-      return getCachedUserId().then(cachedId => {
-        if (cachedId) {
-          userOut.key = cachedId;
-          return userOut;
-        } else {
-          const id = uuidv1();
-          userOut.key = id;
-          return setCachedUserId(id).then(() => userOut);
-        }
-      });
-    } else {
-      return Promise.reject(new errors.LDInvalidUserError(messages.invalidUser()));
-    }
-  };
-
-  return ret;
-}
-
-module.exports = UserValidator;

package/src/__tests__/UserFilter-test.js

@@ -1,93 +0,0 @@
-import UserFilter from '../UserFilter';
-
-describe('UserFilter', () => {
-  // users to serialize
-  const user = {
-    key: 'abc',
-    firstName: 'Sue',
-    custom: { bizzle: 'def', dizzle: 'ghi' },
-  };
-
-  const userSpecifyingOwnPrivateAttr = {
-    key: 'abc',
-    firstName: 'Sue',
-    custom: { bizzle: 'def', dizzle: 'ghi' },
-    privateAttributeNames: ['dizzle', 'unused'],
-  };
-
-  const userWithUnknownTopLevelAttrs = {
-    key: 'abc',
-    firstName: 'Sue',
-    species: 'human',
-    hatSize: 6,
-    custom: { bizzle: 'def', dizzle: 'ghi' },
-  };
-
-  const anonUser = {
-    key: 'abc',
-    anonymous: true,
-    custom: { bizzle: 'def', dizzle: 'ghi' },
-  };
-
-  // expected results from serializing user
-  const userWithAllAttrsHidden = {
-    key: 'abc',
-    custom: {},
-    privateAttrs: ['bizzle', 'dizzle', 'firstName'],
-  };
-
-  const userWithSomeAttrsHidden = {
-    key: 'abc',
-    custom: { dizzle: 'ghi' },
-    privateAttrs: ['bizzle', 'firstName'],
-  };
-
-  const userWithOwnSpecifiedAttrHidden = {
-    key: 'abc',
-    firstName: 'Sue',
-    custom: { bizzle: 'def' },
-    privateAttrs: ['dizzle'],
-  };
-
-  const anonUserWithAllAttrsHidden = {
-    key: 'abc',
-    anonymous: true,
-    custom: {},
-    privateAttrs: ['bizzle', 'dizzle'],
-  };
-
-  it('includes all user attributes by default', () => {
-    const uf = UserFilter({});
-    expect(uf.filterUser(user)).toEqual(user);
-  });
-
-  it('hides all except key if allAttributesPrivate is true', () => {
-    const uf = UserFilter({ allAttributesPrivate: true });
-    expect(uf.filterUser(user)).toEqual(userWithAllAttrsHidden);
-  });
-
-  it('hides some attributes if privateAttributeNames is set', () => {
-    const uf = UserFilter({ privateAttributeNames: ['firstName', 'bizzle'] });
-    expect(uf.filterUser(user)).toEqual(userWithSomeAttrsHidden);
-  });
-
-  it('hides attributes specified in per-user privateAttrs', () => {
-    const uf = UserFilter({});
-    expect(uf.filterUser(userSpecifyingOwnPrivateAttr)).toEqual(userWithOwnSpecifiedAttrHidden);
-  });
-
-  it('looks at both per-user privateAttrs and global config', () => {
-    const uf = UserFilter({ privateAttributeNames: ['firstName', 'bizzle'] });
-    expect(uf.filterUser(userSpecifyingOwnPrivateAttr)).toEqual(userWithAllAttrsHidden);
-  });
-
-  it('strips unknown top-level attributes', () => {
-    const uf = UserFilter({});
-    expect(uf.filterUser(userWithUnknownTopLevelAttrs)).toEqual(user);
-  });
-
-  it('leaves the "anonymous" attribute as is', () => {
-    const uf = UserFilter({ allAttributesPrivate: true });
-    expect(uf.filterUser(anonUser)).toEqual(anonUserWithAllAttrsHidden);
-  });
-});

package/src/__tests__/UserValidator-test.js

@@ -1,57 +0,0 @@
-import UserValidator from '../UserValidator';
-
-describe('UserValidator', () => {
-  let localStorage;
-  let logger;
-  let uv;
-
-  beforeEach(() => {
-    localStorage = {};
-    logger = {
-      warn: jest.fn(),
-    };
-    uv = UserValidator(localStorage, logger);
-  });
-
-  it('rejects null user', async () => {
-    await expect(uv.validateUser(null)).rejects.toThrow();
-  });
-
-  it('leaves user with string key unchanged', async () => {
-    const u = { key: 'someone', name: 'me' };
-    expect(await uv.validateUser(u)).toEqual(u);
-  });
-
-  it('stringifies non-string key', async () => {
-    const u0 = { key: 123, name: 'me' };
-    const u1 = { key: '123', name: 'me' };
-    expect(await uv.validateUser(u0)).toEqual(u1);
-  });
-
-  it('uses cached key for anonymous user', async () => {
-    const cachedKey = 'thing';
-    let storageKey;
-    localStorage.get = async key => {
-      storageKey = key;
-      return cachedKey;
-    };
-    const u = { anonymous: true };
-    expect(await uv.validateUser(u)).toEqual({ key: cachedKey, anonymous: true });
-    expect(storageKey).toEqual('ld:$anonUserId');
-  });
-
-  it('generates and stores key for anonymous user', async () => {
-    let storageKey;
-    let storedValue;
-    localStorage.get = async () => null;
-    localStorage.set = async (key, value) => {
-      storageKey = key;
-      storedValue = value;
-    };
-    const u0 = { anonymous: true };
-    const u1 = await uv.validateUser(u0);
-    expect(storedValue).toEqual(expect.anything());
-    expect(u1).toEqual({ key: storedValue, anonymous: true });
-    expect(storageKey).toEqual('ld:$anonUserId');
-  });
-});