@sprucelabs/jest-sheets-reporter 1.3.37 → 1.3.38

package/build/__tests__/behavioral/SheetsReporter.test.js

@@ -17,7 +17,7 @@ const SheetsReporterUtility_1 = require("../../SheetsReporterUtility");
 require('dotenv').config();
 class SheetsReporterTest extends AbstractSheetsReporterTest_1.default {
     static async beforeAll() {
-        this.worksheetId = await this.sheetsAdapter.generateRandomWorksheet(this.sheetId);
+        this.worksheetId = await this.sheetsAdapter.createRandomWorksheet(this.sheetId);
     }
     static async beforeEach() {
         await super.beforeEach();
@@ -51,14 +51,14 @@ class SheetsReporterTest extends AbstractSheetsReporterTest_1.default {
         test_1.assert.isEqual(value, 1);
     }
     static async canUpdateAllTestsAfterCompletion() {
-        await this.reporter.onTestResult({}, { testResults: this.testResults });
+        this.reporter.onTestResult({}, { testResults: this.testResults });
         const value = await this.sheetsAdapter.fetchCellValue(this.sheetId, this.worksheetId, 'B1');
         test_1.assert.isEqual(value, 1);
         const value2 = await this.sheetsAdapter.fetchCellValue(this.sheetId, this.worksheetId, 'B2');
         test_1.assert.isEqual(value2, 0);
     }
     static async canSetWorksheetIdInCell(cell) {
-        const worksheetId = await this.sheetsAdapter.generateRandomWorksheet(this.sheetId);
+        const worksheetId = await this.sheetsAdapter.createRandomWorksheet(this.sheetId);
         this.testMap.canBootCliInDifferentWorksheet = `${worksheetId}:${cell}`;
         await this.reporter.reportTestAsPassed('canBootCliInDifferentWorksheet');
         const value = await this.sheetsAdapter.fetchCellValue(this.sheetId, worksheetId, cell);
@@ -105,7 +105,7 @@ __decorate([
     (0, test_1.test)()
 ], SheetsReporterTest, "canUpdateAllTestsAfterCompletion", null);
 __decorate([
-    test_1.test.only('can update in another worksheet 1', 'B1'),
-    test_1.test.only('can update in another worksheet 2', 'B2')
+    (0, test_1.test)('can update in another worksheet 1', 'B1'),
+    (0, test_1.test)('can update in another worksheet 2', 'B2')
 ], SheetsReporterTest, "canSetWorksheetIdInCell", null);
 exports.default = SheetsReporterTest;

package/build/__tests__/implementation/SheetsAdapter.test.d.ts

@@ -7,4 +7,5 @@ export default class SheetsAdapterTest extends AbstractSheetsReporterTest {
     protected static beforeAll(): Promise<void>;
     protected static afterAll(): Promise<void>;
     protected static canUpdateCell(expected: string | number | boolean): Promise<void>;
+    protected static updatingCellManyTimesAtOnceDoesNotHitRateLimit(): Promise<void>;
 }

package/build/__tests__/implementation/SheetsAdapter.test.js

@@ -27,7 +27,7 @@ class SheetsAdapterTest extends AbstractSheetsReporterTest_1.default {
         });
     }
     static async beforeAll() {
-        this.worksheetId = await this.sheetsAdapter.generateRandomWorksheet(this.sheetId);
+        this.worksheetId = await this.sheetsAdapter.createRandomWorksheet(this.sheetId);
     }
     static async afterAll() {
         await super.afterAll();
@@ -46,6 +46,16 @@ class SheetsAdapterTest extends AbstractSheetsReporterTest_1.default {
         const actualValue = await this.sheetsAdapter.fetchCellValue(sheetId, worksheetId, 'A1');
         test_1.assert.isEqual(actualValue, expected);
     }
+    static async updatingCellManyTimesAtOnceDoesNotHitRateLimit() {
+        await Promise.all(new Array(75).fill(0).map(async (_, idx) => {
+            await this.adapter.updateCell({
+                sheetId: this.sheetId,
+                worksheetId: this.worksheetId,
+                cell: 'A1',
+                value: idx,
+            });
+        }));
+    }
 }
 SheetsAdapterTest.sheetId = '1MFb9AkB8sm7rurYew8hgzrXTz3JDxOFhl4kN9sNQVxw';
 __decorate([
@@ -53,4 +63,7 @@ __decorate([
     (0, test_1.test)('can set a boolean value', true),
     (0, test_1.test)('can set string value', 'it worked!')
 ], SheetsAdapterTest, "canUpdateCell", null);
+__decorate([
+    (0, test_1.test)()
+], SheetsAdapterTest, "updatingCellManyTimesAtOnceDoesNotHitRateLimit", null);
 exports.default = SheetsAdapterTest;

package/build/adapters/GoogleAdapter.d.ts

@@ -11,6 +11,7 @@ export default class SheetsReporterGoogleAdapter implements IGoogleSheetsAdapter
         cell: string;
         value: string | number | boolean;
     }): Promise<void>;
+    private retriedUpdateCell;
     protected fetchSheetAndCell(sheetId: string, worksheetId: number, cellLookup: string): Promise<{
         cell: import("google-spreadsheet").GoogleSpreadsheetCell;
         sheet: import("google-spreadsheet").GoogleSpreadsheetWorksheet;

package/build/adapters/GoogleAdapter.js

@@ -1,6 +1,10 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 const google_spreadsheet_1 = require("google-spreadsheet");
+const retry_1 = __importDefault(require("retry"));
 class SheetsReporterGoogleAdapter {
     constructor(options) {
         this.spreadsheetInstancesById = {};
@@ -20,10 +24,31 @@ class SheetsReporterGoogleAdapter {
         this.privateKey = privateKey;
     }
     async updateCell(options) {
+        await new Promise((resolve, reject) => {
+            void this.retriedUpdateCell(options, resolve, reject);
+        });
+    }
+    async retriedUpdateCell(options, resolve, reject) {
         const { sheetId, worksheetId, value, cell: cellLookup } = options;
-        const { cell, sheet } = await this.fetchSheetAndCell(sheetId, worksheetId, cellLookup);
-        cell.value = value;
-        await sheet.saveUpdatedCells();
+        const operation = retry_1.default.operation({
+            factor: 2,
+            retries: 10,
+            randomize: true,
+        });
+        operation.attempt(async () => {
+            try {
+                const { cell, sheet } = await this.fetchSheetAndCell(sheetId, worksheetId, cellLookup);
+                cell.value = value;
+                await sheet.saveUpdatedCells();
+                resolve();
+            }
+            catch (err) {
+                if (operation.retry(err)) {
+                    return;
+                }
+                reject(operation.mainError());
+            }
+        });
     }
     async fetchSheetAndCell(sheetId, worksheetId, cellLookup) {
         const spreadsheet = await this.fetchSpreadsheet(sheetId);

package/build/adapters/MockAdapter.d.ts

@@ -9,6 +9,6 @@ export default class SheetsReporterMockAdapter extends SheetsReporterTestAdapter
         value: string | number | boolean;
     }): Promise<void>;
     fetchCellValue(sheetId: string, worksheetId: number, cell: string): Promise<string | number | boolean>;
-    generateRandomWorksheet(): Promise<number>;
+    createRandomWorksheet(): Promise<number>;
     deleteWorksheet(): Promise<void>;
 }

package/build/adapters/MockAdapter.js

@@ -16,7 +16,7 @@ class SheetsReporterMockAdapter extends TestAdapter_1.default {
         const key = `${sheetId}${worksheetId}${cell}`;
         return SheetsReporterMockAdapter.cellCache[key];
     }
-    async generateRandomWorksheet() {
+    async createRandomWorksheet() {
         return -1;
     }
     async deleteWorksheet() { }

package/build/adapters/TestAdapter.d.ts

@@ -1,8 +1,8 @@
 import SheetsReporterGoogleAdapter from './GoogleAdapter';
 export default class SheetsReporterTestAdapter extends SheetsReporterGoogleAdapter {
-    private randomCount;
+    private static randomCount;
     fetchCellValue(sheetId: string, worksheetId: number, cell: string): Promise<string | number | boolean>;
-    generateRandomWorksheet(sheetId: string): Promise<number>;
+    createRandomWorksheet(sheetId: string): Promise<number>;
     deleteWorksheet(sheetId: string, worksheetId: number): Promise<void>;
     protected fetchSpreadsheet(sheetId: string): Promise<import("google-spreadsheet").GoogleSpreadsheet>;
 }

package/build/adapters/TestAdapter.js

@@ -5,19 +5,15 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const GoogleAdapter_1 = __importDefault(require("./GoogleAdapter"));
 class SheetsReporterTestAdapter extends GoogleAdapter_1.default {
-    constructor() {
-        super(...arguments);
-        this.randomCount = 0;
-    }
     async fetchCellValue(sheetId, worksheetId, cell) {
         const results = await this.fetchSheetAndCell(sheetId, worksheetId, cell);
         return results.cell.value;
     }
-    async generateRandomWorksheet(sheetId) {
-        const name = `TEST.${Date.now()}-${this.randomCount}`;
+    async createRandomWorksheet(sheetId) {
+        const name = `TEST.${Date.now()}-${SheetsReporterTestAdapter.randomCount}`;
         const sheet = await this.fetchSpreadsheet(sheetId);
         const worksheet = await sheet.addWorksheet({ title: name });
-        this.randomCount++;
+        SheetsReporterTestAdapter.randomCount++;
         return parseInt(worksheet.sheetId, 10);
     }
     async deleteWorksheet(sheetId, worksheetId) {
@@ -30,3 +26,4 @@ class SheetsReporterTestAdapter extends GoogleAdapter_1.default {
     }
 }
 exports.default = SheetsReporterTestAdapter;
+SheetsReporterTestAdapter.randomCount = 0;

package/package.json

@@ -13,7 +13,7 @@
       "@sprucelabs/resolve-path-aliases"
     ]
   },
-  "version": "1.3.37",
+  "version": "1.3.38",
   "main": "./build/SheetsReporter.js",
   "types": "./build/SheetsReporter.d.ts",
   "description": "Have your Jest tests update a Google Spreadsheet™®©. 📡",
@@ -57,7 +57,8 @@
   },
   "dependencies": {
     "dotenv": "^16.0.0",
-    "google-spreadsheet": "^3.2.0"
+    "google-spreadsheet": "^3.2.0",
+    "retry": "^0.13.1"
   },
   "devDependencies": {
     "@sprucelabs/resolve-path-aliases": "^1.0.244",