feat(js-sdk): circuit breaker for usage reporting (attempt 2) (#7280)

Author: n1ru4l

.changeset/beige-teams-spend.md

@@ -0,0 +1,38 @@
+---
+'@graphql-hive/envelop': minor
+'@graphql-hive/apollo': minor
+'@graphql-hive/core': minor
+'@graphql-hive/yoga': minor
+---
+
+Support circuit breaking for usage reporting.
+
+Circuit breaking is a fault-tolerance pattern that prevents a system from repeatedly calling a failing service. When errors or timeouts exceed a set threshold, the circuit “opens,” blocking further requests until the service recovers.
+
+This ensures that during a network issue or outage, the service using the Hive SDK remains healthy and is not overwhelmed by failed usage reports or repeated retries.
+
+```ts
+import { createClient } from "@graphql-hive/core"
+
+const client = createClient({
+  agent: {
+    circuitBreaker: {
+      /**
+       * Count of requests before starting evaluating.
+       * Default: 5
+       */
+      volumeThreshold: 5,
+      /**
+       * Percentage of requests failing before the circuit breaker kicks in.
+       * Default: 50
+       */
+      errorThresholdPercentage: 1,
+      /**
+       * After what time the circuit breaker is attempting to retry sending requests in milliseconds
+       * Default: 30_000
+       */
+      resetTimeout: 10_000,
+    },
+  }
+})
+```

packages/libraries/core/package.json

@@ -39,15 +39,18 @@
   "typings": "dist/typings/index.d.ts",
   "scripts": {
     "build": "node ../../../scripts/generate-version.mjs && bob build",
-    "check:build": "bob check"
+    "check:build": "bob check",
+    "typecheck": "tsc --noEmit"
   },
   "peerDependencies": {
     "graphql": "^0.13.0 || ^14.0.0 || ^15.0.0 || ^16.0.0"
   },
   "dependencies": {
+    "@graphql-hive/signal": "^2.0.0",
     "@graphql-tools/utils": "^10.0.0",
     "@whatwg-node/fetch": "^0.10.6",
     "async-retry": "^1.3.3",
+    "events": "^3.3.0",
     "js-md5": "0.8.3",
     "lodash.sortby": "^4.7.0",
     "tiny-lru": "^8.0.2"

packages/libraries/core/playground/agent-circuit-breaker.ts

@@ -0,0 +1,53 @@
+/**
+ *
+ * Just a small playground to play around with different scenarios arounf the agent.
+ * You can run it like this: `bun run --watch packages/libraries/core/playground/agent-circuit-breaker.ts`
+ */
+
+import { createAgent } from '../src/client/agent.js';
+
+let data: Array<{}> = [];
+
+const agent = createAgent<{}>(
+  {
+    debug: true,
+    endpoint: 'http://127.0.0.1',
+    token: 'noop',
+    async fetch(_url, _opts) {
+      throw new Error('FAIL FAIL');
+      // console.log('SENDING!');
+      // return new Response('ok', {
+      //   status: 200,
+      // });
+    },
+    circuitBreaker: {
+      errorThresholdPercentage: 1,
+      resetTimeout: 10_000,
+      volumeThreshold: 0,
+    },
+    maxSize: 1,
+    maxRetries: 1,
+  },
+  {
+    body() {
+      data = [];
+      return String(data);
+    },
+    data: {
+      clear() {
+        data = [];
+      },
+      size() {
+        return data.length;
+      },
+      set(d) {
+        data.push(d);
+      },
+    },
+  },
+);
+
+setInterval(() => {
+  agent.capture({});
+  console.log('BURR BURT');
+}, 1_000);

packages/libraries/core/src/circuit-breaker/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed 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 CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

packages/libraries/core/src/circuit-breaker/README.md

@@ -0,0 +1,4 @@
+# Readme
+
+This is https://github.com/nodeshift/opossum, but we use `events` from `npm`, and with esm exports
+to make it work on any platform :)

packages/libraries/core/src/circuit-breaker/cache.js

@@ -0,0 +1,65 @@
+/**
+ * Simple in-memory cache implementation
+ * @class MemoryCache
+ * @property {Map} cache Cache map
+ */
+class MemoryCache {
+  constructor(maxEntries) {
+    this.cache = new Map();
+    this.maxEntries = maxEntries ?? 2 ** 24 - 1; // Max size for Map is 2^24.
+  }
+
+  /**
+   * Get cache value by key
+   * @param {string} key Cache key
+   * @return {any} Response from cache
+   */
+  get(key) {
+    const cached = this.cache.get(key);
+    if (cached) {
+      if (cached.expiresAt > Date.now() || cached.expiresAt === 0) {
+        return cached.value;
+      }
+      this.cache.delete(key);
+    }
+    return undefined;
+  }
+
+  /**
+   * Set cache key with value and ttl
+   * @param {string} key Cache key
+   * @param {any} value Value to cache
+   * @param {number} ttl Time to live in milliseconds
+   * @return {void}
+   */
+  set(key, value, ttl) {
+    // Evict first entry when at capacity - only when it's a new key.
+    if (this.cache.size === this.maxEntries && this.get(key) === undefined) {
+      this.cache.delete(this.cache.keys().next().value);
+    }
+
+    this.cache.set(key, {
+      expiresAt: ttl,
+      value,
+    });
+  }
+
+  /**
+   * Delete cache key
+   * @param {string} key Cache key
+   * @return {void}
+   */
+  delete(key) {
+    this.cache.delete(key);
+  }
+
+  /**
+   * Clear cache
+   * @returns {void}
+   */
+  flush() {
+    this.cache.clear();
+  }
+}
+
+export default MemoryCache;