🐛 Fixing storyProgress calculation so that values are [0,1] (ampproje…

…ct#31024) * Fixing storyProgress calculation * fixing breaking test
ed-bird · Dec 10, 2020 · a30e80f · a30e80f
1 parent fd3ead0
commit a30e80f
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 2 deletions.
diff --git a/extensions/amp-story/1.0/test/test-amp-story-viewer-messaging-handler.js b/extensions/amp-story/1.0/test/test-amp-story-viewer-messaging-handler.js
@@ -108,7 +108,7 @@ describes.fakeWin('amp-story-viewer-messaging-handler', {}, (env) => {
     });
 
     it('should return the STORY_PROGRESS', async () => {
-      storeService.dispatch(Action.SET_PAGE_IDS, [1, 2, 3, 4]);
+      storeService.dispatch(Action.SET_PAGE_IDS, [1, 2, 3, 4, 5]);
       storeService.dispatch(Action.CHANGE_PAGE, {id: 3, index: 2});
       const response = await fakeViewerService.receiveMessage(
         'getDocumentState',

diff --git a/extensions/amp-story/1.0/test/test-variable-service.js b/extensions/amp-story/1.0/test/test-variable-service.js
@@ -47,4 +47,15 @@ describes.fakeWin('amp-story variable service', {}, (env) => {
     const variables = variableService.get();
     expect(variables['storyAdvancementMode']).to.equal('manualAdvance');
   });
+
+  it('should calculate storyProgress correctly on change', () => {
+    storeService.dispatch(Action.SET_PAGE_IDS, ['a', 'b', 'c', 'd', 'e']);
+    storeService.dispatch(Action.CHANGE_PAGE, {
+      id: 'd',
+      index: 3,
+    });
+
+    const variables = variableService.get();
+    expect(variables['storyProgress']).to.equal(0.75);
+  });
 });
diff --git a/extensions/amp-story/1.0/variable-service.js b/extensions/amp-story/1.0/variable-service.js
@@ -121,7 +121,7 @@ export class AmpStoryVariableService {
           .length;
         if (numberOfPages > 0) {
           this.variables_[AnalyticsVariable.STORY_PROGRESS] =
-            pageIndex / numberOfPages;
+            pageIndex / (numberOfPages - 1);
         }
       },
       true /* callToInitialize */