@adobe/helix-onedrive-support 10.0.13 → 10.1.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [10.1.0](https://github.com/adobe/helix-onedrive-support/compare/v10.0.14...v10.1.0) (2023-06-05)
+
+
+### Features
+
+* add rate limit in log and StatusCodeError ([#394](https://github.com/adobe/helix-onedrive-support/issues/394)) ([d9289fd](https://github.com/adobe/helix-onedrive-support/commit/d9289fd12fd290ad6482f3604ab9a3b1b9f1200d))
+
+## [10.0.14](https://github.com/adobe/helix-onedrive-support/compare/v10.0.13...v10.0.14) (2023-06-03)
+
+
+### Bug Fixes
+
+* **deps:** update dependency @adobe/helix-shared-tokencache to v1.2.5 ([#393](https://github.com/adobe/helix-onedrive-support/issues/393)) ([a40b956](https://github.com/adobe/helix-onedrive-support/commit/a40b956a4bb01f10ea85d84bb387a7644f54173d))
+
 ## [10.0.13](https://github.com/adobe/helix-onedrive-support/compare/v10.0.12...v10.0.13) (2023-05-28)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/helix-onedrive-support",
-  "version": "10.0.13",
+  "version": "10.1.0",
   "description": "Helix OneDrive Support",
   "main": "src/index.js",
   "exports": {
@@ -28,7 +28,7 @@
   "homepage": "https://github.com/adobe/helix-onedrive-support#readme",
   "dependencies": {
     "@adobe/fetch": "4.0.13",
-    "@adobe/helix-shared-tokencache": "1.2.4",
+    "@adobe/helix-shared-tokencache": "1.2.5",
     "@azure/msal-node": "1.17.2",
     "jose": "4.14.4"
   },
@@ -36,12 +36,12 @@
     "@adobe/eslint-config-helix": "2.0.2",
     "@semantic-release/changelog": "6.0.3",
     "@semantic-release/git": "10.0.1",
-    "@aws-sdk/client-s3": "3.341.0",
+    "@aws-sdk/client-s3": "3.345.0",
     "ajv": "8.12.0",
-    "c8": "7.13.0",
+    "c8": "7.14.0",
     "codecov": "3.8.3",
-    "dotenv": "16.0.3",
-    "eslint": "8.41.0",
+    "dotenv": "16.1.3",
+    "eslint": "8.42.0",
     "eslint-plugin-header": "3.1.1",
     "eslint-plugin-import": "2.27.5",
     "husky": "8.0.3",
@@ -54,7 +54,7 @@
     "mocha-multi-reporters": "1.5.1",
     "nock": "13.3.1",
     "npm": "9.6.7",
-    "semantic-release": "21.0.2"
+    "semantic-release": "21.0.3"
   },
   "lint-staged": {
     "*.js": "eslint"

package/src/OneDrive.js

@@ -16,6 +16,7 @@ import { Workbook } from './excel/Workbook.js';
 import { StatusCodeError } from './StatusCodeError.js';
 import { editDistance, sanitizeName, splitByExtension } from './utils.js';
 import { SharePointSite } from './SharePointSite.js';
+import { RateLimit } from './RateLimit.js';
 
 /**
  * the maximum subscription time in milliseconds
@@ -128,12 +129,18 @@ export class OneDrive {
     try {
       const { fetch } = this.fetchContext;
       const resp = await fetch(url, opts);
+      const rateLimit = RateLimit.fromHeaders(resp.headers);
+
+      if (rateLimit) {
+        this.log.warn({ sharepointRateLimit: { tenant: this.auth.tenant, ...rateLimit.toJSON() } });
+      }
+
       if (!resp.ok) {
         const text = await resp.text();
         let err;
         try {
           // try to parse json
-          err = StatusCodeError.fromErrorResponse(JSON.parse(text), resp.status);
+          err = StatusCodeError.fromErrorResponse(JSON.parse(text), resp.status, rateLimit);
         } catch {
           err = new StatusCodeError(text, resp.status);
         }

package/src/RateLimit.js

@@ -0,0 +1,77 @@
+/*
+ * Copyright 2023 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+
+/**
+ * Rate limit class
+ */
+export class RateLimit {
+  static fromHeaders(headers) {
+    const names = [
+      ['RateLimit-Limit', 'limit'],
+      ['RateLimit-Remaining', 'remaining'],
+      ['RateLimit-Reset', 'reset'],
+      ['Retry-After', 'retryAfter'],
+    ];
+
+    const result = {};
+    let notEmpty = false;
+
+    names.forEach(([hdr, prop]) => {
+      const valueS = headers.get(hdr);
+      if (valueS) {
+        const value = Number.parseInt(valueS, 10);
+        if (!Number.isNaN(value)) {
+          result[prop] = value;
+          notEmpty = true;
+        }
+      }
+    });
+    return notEmpty ? new RateLimit(result) : null;
+  }
+
+  constructor({
+    limit, remaining, reset, retryAfter,
+  }) {
+    this._limit = limit;
+    this._remaining = remaining;
+    this._reset = reset;
+    this._retryAfter = retryAfter;
+  }
+
+  get limit() {
+    return this._limit;
+  }
+
+  get remaining() {
+    return this._remaining;
+  }
+
+  get reset() {
+    return this._reset;
+  }
+
+  get retryAfter() {
+    return this._retryAfter;
+  }
+
+  toJSON() {
+    const o = {
+      limit: this.limit,
+      remaining: this.remaining,
+      reset: this.reset,
+    };
+    if (this.retryAfter) {
+      o.retryAfter = this.retryAfter;
+    }
+    return o;
+  }
+}

package/src/StatusCodeError.js

@@ -39,15 +39,16 @@ export class StatusCodeError extends Error {
    * Converts a Graph API error response to a status code error.
    * @param {object} errorBody The parsed error response body
    * @param {number} statusCode The status code of the error response
+   * @param {RateLimit} rateLimit rate limit or null
    * @param {object} details The underlying error
    * @returns {StatusCodeError} status code error
    */
-  static fromErrorResponse(errorBody, statusCode) {
+  static fromErrorResponse(errorBody, statusCode, rateLimit) {
     if (errorBody.error && errorBody.error.message) {
       // eslint-disable-next-line no-param-reassign
       errorBody = errorBody.error;
     }
-    return new StatusCodeError(errorBody.message, statusCode, errorBody);
+    return new StatusCodeError(errorBody.message, statusCode, errorBody, rateLimit);
   }
 
   /**
@@ -56,10 +57,12 @@ export class StatusCodeError extends Error {
    * @param {string} msg Error message
    * @param {number} statusCode Status code of the error response
    * @param {object} details underlying error
+   * @param {RateLimit} rateLimit rate limit or null
    */
-  constructor(msg, statusCode, details) {
+  constructor(msg, statusCode, details, rateLimit) {
     super(msg?.value ?? msg);
     this.statusCode = statusCode;
     this.details = details;
+    this.rateLimit = rateLimit;
   }
 }

package/src/excel/NamedItemContainer.js

@@ -50,7 +50,7 @@ export class NamedItemContainer {
       });
     } catch (e) {
       if ((e.details && e.details.code === 'ItemAlreadyExists') && e.statusCode !== 409) {
-        throw new StatusCodeError(e.message, 409, e.code, e);
+        throw new StatusCodeError(e.message, 409);
       }
       throw e;
     }
@@ -64,7 +64,7 @@ export class NamedItemContainer {
       });
     } catch (e) {
       if ((e.details && e.details.code === 'ItemNotFound') && e.statusCode !== 404) {
-        throw new StatusCodeError(e.message, 404, e.code, e);
+        throw new StatusCodeError(e.message, 404);
       }
       throw e;
     }