vwo-fme-node-sdk

[1.2.0] - 2024-05-22

Changed

• Segmentation module

  • Modify how context and settings are being used inside modular segmentor code
  • Cache location / User-Agent data per getFlag API
  • Single endpoint for location and User-Agent at gateway-service so that at max one call will be required to fetch data from gateway service

• Context refactoring

  • Context is now flattened out

    {
      id: 'user-id',           // MANDATORY
      ip: '1.2.3.4',           // OPTIONAL - required for user targeting
      ua: '...',               // OPTIONAL - required for user targeting
      other_attributes: '...', // OPTIONAL - required for user targeting
      // For pre-segmentation in campaigns
      customVariables: {
        // ...
      }
    }
    

• Storage optimizations

  • Optimized how data is being stored and retrieved

  • Example on how to pass storage

  class StorageConnector extends vwo.StorageConnector {
    constructor() {
      super();
    }
  
    async get(key) {
      // return promise based data for feature-key
      // return await this.map[key];
    }
  
    async set(key, data) {
      // Set data for feature-key
      // this.map[key] = data;
    }
  }
  
  vwo.init({
    sdkKey: '...',
    accountId: '123456',
    storage: StorageConnector,
  });
  

• Using interfaces, types, and model-driven code

  • Since we are using TypeScript which helps in the definition types and catching errors while developing.

• Overall Code refactoring

  • Simplified the flow of getFlag API

• Log messages

  • Separate Repo to have all the logs in one place.
  • Log messages were updated

  logger:  {
    level: vwo.LogLevelEnum.DEBUG,    // DEBUG, INFO, ERROR, TRACE< WARN
    prefix: 'CUSTOM LOG PREFIX',      // VWO-SDK default
    transport: {                      // Custom Logger
      debug: msg => console.log(msg),
      info: msg => console.log(msg),
      warn: msg => console.log(msg),
      error: msg => console.log(msg),
      trace: msg => console.log(msg)
    }
  }
  
  vwo.init({
    sdkKey: '...',
    accountId: '123456',
    logger: logger
  });
  

Added

• Code inline documentation

  • Entire Code was documented as per JavaScript Documentation convention.

• Unit and E2E Testing

  • Set up Test framework using Jest
  • Wrote unit and E2E tests to ensure nothing breaks while pushing new code
  • Ensure criticla components are working properly on every build
  • Integrate with Codecov to show coverage percentage in README
  • Post status of tests running on different node versions to Wingify slack channel

• onReady hook

  vwo.init({
    sdkKey: '...',
    accountId: '123456'
  });
  
  vwo.onReady().then(async (vwoClient) => {
    const feature = await vwoClient.getFlag('feature-key', context);
    console.log('getFlag is: ', feature.isEnabled());
  }).catch(err => {
    console.log('Error: ', err);
  });
  

• Error handling

  • Gracefully handle any kind of error - TypeError, NetworkError, etc.

• Polling support

  • Provide a way to fetch settings periodically and update the instance to use the latest settings

  const vwoClient = await vwo.init({
    sdkKey: '...',
    accountId: '123456',
    pollInterval: 5000 // in milliseconds
  });