API v4 (WIP) (#10453)

API v4

test/api/unit/libs/preening.test.js

@@ -0,0 +1,59 @@
+import { preenHistory } from '../../../../website/server/libs/preening';
+import moment from 'moment';
+import sinon from 'sinon'; // eslint-disable-line no-shadow
+import { generateHistory } from '../../../helpers/api-unit.helper.js';
+
+describe('preenHistory', () => {
+  let clock;
+
+  beforeEach(() => {
+    // Replace system clocks so we can get predictable results
+    clock = sinon.useFakeTimers({
+      now: Number(moment('2013-10-20').zone(0).startOf('day').toDate()),
+      toFake: ['Date'],
+    });
+  });
+  afterEach(() => {
+    return clock.restore();
+  });
+
+  it('does not modify history if all entries are more recent than cutoff (free users)', () => {
+    let h = generateHistory(60);
+    expect(preenHistory(_.cloneDeep(h), false, 0)).to.eql(h);
+  });
+
+  it('does not modify history if all entries are more recent than cutoff (subscribers)', () => {
+    let h = generateHistory(365);
+    expect(preenHistory(_.cloneDeep(h), true, 0)).to.eql(h);
+  });
+
+  it('does aggregate data in monthly entries before cutoff (free users)', () => {
+    let h = generateHistory(81); // Jumps to July
+    let preened = preenHistory(_.cloneDeep(h), false, 0);
+    expect(preened.length).to.eql(62); // Keeps 60 days + 2 entries per august and july
+  });
+
+  it('does aggregate data in monthly entries before cutoff (subscribers)', () => {
+    let h = generateHistory(396); // Jumps to September 2012
+    let preened = preenHistory(_.cloneDeep(h), true, 0);
+    expect(preened.length).to.eql(367); // Keeps 365 days + 2 entries per october and september
+  });
+
+  it('does aggregate data in monthly and yearly entries before cutoff (free users)', () => {
+    let h = generateHistory(731); // Jumps to October 21 2012
+    let preened = preenHistory(_.cloneDeep(h), false, 0);
+    expect(preened.length).to.eql(73); // Keeps 60 days + 11 montly entries and 2 yearly entry for 2011 and 2012
+  });
+
+  it('does aggregate data in monthly and yearly entries before cutoff (subscribers)', () => {
+    let h = generateHistory(1031); // Jumps to October 21 2012
+    let preened = preenHistory(_.cloneDeep(h), true, 0);
+    expect(preened.length).to.eql(380); // Keeps 365 days + 13 montly entries and 2 yearly entries for 2011 and 2010
+  });
+
+  it('correctly aggregates values', () => {
+    let h = generateHistory(63); // Compress last 3 days
+    let preened = preenHistory(_.cloneDeep(h), false, 0);
+    expect(preened[0].value).to.eql((61 + 62 + 63) / 3);
+  });
+});