@proteinjs/service 1.0.32 → 1.1.0

package/CHANGELOG.md

@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [1.1.0](https://github.com/proteinjs/service/compare/@proteinjs/service@1.0.32...@proteinjs/service@1.1.0) (2024-09-09)
+
+
+### Features
+
+* Add retry functionality to serviceFactory with configurable retries per method. Implement RetryConfig type and logic to handle retries for specified service methods. ([cc9627f](https://github.com/proteinjs/service/commit/cc9627fe12aa40920764e0fa2debc1547881b887))
+
+
+
+
+
 ## [1.0.32](https://github.com/proteinjs/service/compare/@proteinjs/service@1.0.31...@proteinjs/service@1.0.32) (2024-08-30)
 
 

package/dist/src/Service.d.ts

@@ -1,6 +1,15 @@
 import { SerializableFunction, NotFunction } from '@proteinjs/serializer';
 import { Loadable } from '@proteinjs/reflection';
 import { Debouncer } from '@proteinjs/util';
+type RemoveIndex<T> = {
+    [K in keyof T as string extends K ? never : number extends K ? never : symbol extends K ? never : K]: T[K];
+};
+type KeysWithoutIndexSignature<T> = keyof RemoveIndex<T>;
+type Diff<T, U> = T extends U ? never : T;
+type KeysWithoutService<T extends Service> = Diff<KeysWithoutIndexSignature<T>, KeysWithoutIndexSignature<Service>>;
+type RetryConfig<T extends Service> = {
+    [K in KeysWithoutService<T>]?: number;
+};
 export interface Service extends Loadable {
     serviceMetadata?: {
         auth?: {
@@ -30,5 +39,6 @@ export interface Service extends Loadable {
  * @param debouncer optionally pass in an instance of debouncer if you want to limit service client calls
  * @returns a function that creates a Service
  */
-export declare const serviceFactory: <T extends Service>(serviceInterfaceQualifiedName: string, debouncer?: Debouncer) => () => T;
+export declare const serviceFactory: <T extends Service>(serviceInterfaceQualifiedName: string, debouncer?: Debouncer, retryConfig?: RetryConfig<T> | undefined) => () => T;
+export {};
 //# sourceMappingURL=Service.d.ts.map

package/dist/src/Service.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Service.d.ts","sourceRoot":"","sources":["../../src/Service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAC1E,OAAO,EAAE,QAAQ,EAAoB,MAAM,uBAAuB,CAAC;AAEnE,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAE5C,MAAM,WAAW,OAAQ,SAAQ,QAAQ;IACvC,eAAe,CAAC,EAAE;QAChB,IAAI,CAAC,EAAE;YACL,2HAA2H;YAC3H,MAAM,CAAC,EAAE,OAAO,CAAC;YACjB,kIAAkI;YAClI,QAAQ,CAAC,EAAE,OAAO,CAAC;YACnB,8HAA8H;YAC9H,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;YACjB;;;;;eAKG;YACH,SAAS,CAAC,EAAE,CAAC,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,KAAK,OAAO,CAAC;SAC1D,CAAC;QACF,uFAAuF;QACvF,UAAU,CAAC,EAAE,OAAO,CAAC;KACtB,CAAC;IACF,CAAC,IAAI,EAAE,MAAM,GAAG,oBAAoB,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC;CACzD;AAED;;;;;;GAMG;AACH,eAAO,MAAM,cAAc,qDACM,MAAM,cACzB,SAAS,YAatB,CAAC"}
+{"version":3,"file":"Service.d.ts","sourceRoot":"","sources":["../../src/Service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAC1E,OAAO,EAAE,QAAQ,EAAoB,MAAM,uBAAuB,CAAC;AAEnE,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAE5C,KAAK,WAAW,CAAC,CAAC,IAAI;KACnB,CAAC,IAAI,MAAM,CAAC,IAAI,MAAM,SAAS,CAAC,GAAG,KAAK,GAAG,MAAM,SAAS,CAAC,GAAG,KAAK,GAAG,MAAM,SAAS,CAAC,GAAG,KAAK,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CAC3G,CAAC;AACF,KAAK,yBAAyB,CAAC,CAAC,IAAI,MAAM,WAAW,CAAC,CAAC,CAAC,CAAC;AAGzD,KAAK,IAAI,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,KAAK,GAAG,CAAC,CAAC;AAG1C,KAAK,kBAAkB,CAAC,CAAC,SAAS,OAAO,IAAI,IAAI,CAAC,yBAAyB,CAAC,CAAC,CAAC,EAAE,yBAAyB,CAAC,OAAO,CAAC,CAAC,CAAC;AAEpH,KAAK,WAAW,CAAC,CAAC,SAAS,OAAO,IAAI;KACnC,CAAC,IAAI,kBAAkB,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,MAAM;CACtC,CAAC;AAEF,MAAM,WAAW,OAAQ,SAAQ,QAAQ;IACvC,eAAe,CAAC,EAAE;QAChB,IAAI,CAAC,EAAE;YACL,2HAA2H;YAC3H,MAAM,CAAC,EAAE,OAAO,CAAC;YACjB,kIAAkI;YAClI,QAAQ,CAAC,EAAE,OAAO,CAAC;YACnB,8HAA8H;YAC9H,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;YACjB;;;;;eAKG;YACH,SAAS,CAAC,EAAE,CAAC,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,KAAK,OAAO,CAAC;SAC1D,CAAC;QACF,uFAAuF;QACvF,UAAU,CAAC,EAAE,OAAO,CAAC;KACtB,CAAC;IACF,CAAC,IAAI,EAAE,MAAM,GAAG,oBAAoB,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC;CACzD;AAED;;;;;;GAMG;AACH,eAAO,MAAM,cAAc,qDACM,MAAM,cACzB,SAAS,sDAmCtB,CAAC"}

package/dist/src/Service.js

@@ -1,4 +1,40 @@
 "use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.serviceFactory = void 0;
 var reflection_1 = require("@proteinjs/reflection");
@@ -10,15 +46,63 @@ var ServiceClient_1 = require("./ServiceClient");
  * @param debouncer optionally pass in an instance of debouncer if you want to limit service client calls
  * @returns a function that creates a Service
  */
-var serviceFactory = function (serviceInterfaceQualifiedName, debouncer) {
+var serviceFactory = function (serviceInterfaceQualifiedName, debouncer, retryConfig) {
     return function () {
         var service = {};
         var serviceInterface = reflection_1.SourceRepository.get().interface(serviceInterfaceQualifiedName);
-        for (var _i = 0, _a = serviceInterface.methods; _i < _a.length; _i++) {
-            var method = _a[_i];
+        var _loop_1 = function (method) {
             var servicePath = "/service/".concat(serviceInterface.qualifiedName, "/").concat(method.name);
             var serviceClient = new ServiceClient_1.ServiceClient(servicePath, method, debouncer);
-            service[method.name] = serviceClient.send.bind(serviceClient);
+            if (retryConfig && method.name in retryConfig) {
+                var methodName = method.name;
+                var maxRetries_1 = retryConfig[methodName];
+                service[method.name] = function () {
+                    var args = [];
+                    for (var _i = 0; _i < arguments.length; _i++) {
+                        args[_i] = arguments[_i];
+                    }
+                    return __awaiter(void 0, void 0, void 0, function () {
+                        var lastError, attempt, error_1;
+                        return __generator(this, function (_a) {
+                            switch (_a.label) {
+                                case 0:
+                                    attempt = 0;
+                                    _a.label = 1;
+                                case 1:
+                                    if (!(attempt < maxRetries_1)) return [3 /*break*/, 7];
+                                    _a.label = 2;
+                                case 2:
+                                    _a.trys.push([2, 3, , 6]);
+                                    return [2 /*return*/, serviceClient.send.bind(serviceClient).apply(void 0, args)];
+                                case 3:
+                                    error_1 = _a.sent();
+                                    lastError = error_1;
+                                    if (!(attempt < maxRetries_1 - 1)) return [3 /*break*/, 5];
+                                    return [4 /*yield*/, new Promise(function (resolve) { return setTimeout(resolve, 1000); })];
+                                case 4:
+                                    _a.sent(); // short wait before retrying
+                                    _a.label = 5;
+                                case 5: return [3 /*break*/, 6];
+                                case 6:
+                                    attempt++;
+                                    return [3 /*break*/, 1];
+                                case 7:
+                                    if (lastError) {
+                                        throw lastError;
+                                    }
+                                    return [2 /*return*/];
+                            }
+                        });
+                    });
+                };
+            }
+            else {
+                service[method.name] = serviceClient.send.bind(serviceClient);
+            }
+        };
+        for (var _i = 0, _a = serviceInterface.methods; _i < _a.length; _i++) {
+            var method = _a[_i];
+            _loop_1(method);
         }
         return service;
     };

package/dist/src/Service.js.map

@@ -1 +1 @@
-{"version":3,"file":"Service.js","sourceRoot":"","sources":["../../src/Service.ts"],"names":[],"mappings":";;;AACA,oDAAmE;AACnE,iDAAgD;AA0BhD;;;;;;GAMG;AACI,IAAM,cAAc,GAAG,UAC5B,6BAAqC,EACrC,SAAqB;IAErB,OAAO;QACL,IAAM,OAAO,GAAQ,EAAE,CAAC;QACxB,IAAM,gBAAgB,GAAG,6BAAgB,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,6BAA6B,CAAC,CAAC;QACzF,KAAqB,UAAwB,EAAxB,KAAA,gBAAgB,CAAC,OAAO,EAAxB,cAAwB,EAAxB,IAAwB,EAAE;YAA1C,IAAM,MAAM,SAAA;YACf,IAAM,WAAW,GAAG,mBAAY,gBAAgB,CAAC,aAAa,cAAI,MAAM,CAAC,IAAI,CAAE,CAAC;YAChF,IAAM,aAAa,GAAG,IAAI,6BAAa,CAAC,WAAW,EAAE,MAAM,EAAE,SAAS,CAAC,CAAC;YACxE,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;SAC/D;QAED,OAAO,OAAO,CAAC;IACjB,CAAC,CAAC;AACJ,CAAC,CAAC;AAfW,QAAA,cAAc,kBAezB"}
+{"version":3,"file":"Service.js","sourceRoot":"","sources":["../../src/Service.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AACA,oDAAmE;AACnE,iDAAgD;AAyChD;;;;;;GAMG;AACI,IAAM,cAAc,GAAG,UAC5B,6BAAqC,EACrC,SAAqB,EACrB,WAA4B;IAE5B,OAAO;QACL,IAAM,OAAO,GAAQ,EAAE,CAAC;QACxB,IAAM,gBAAgB,GAAG,6BAAgB,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,6BAA6B,CAAC,CAAC;gCAC9E,MAAM;YACf,IAAM,WAAW,GAAG,mBAAY,gBAAgB,CAAC,aAAa,cAAI,MAAM,CAAC,IAAI,CAAE,CAAC;YAChF,IAAM,aAAa,GAAG,IAAI,6BAAa,CAAC,WAAW,EAAE,MAAM,EAAE,SAAS,CAAC,CAAC;YACxE,IAAI,WAAW,IAAI,MAAM,CAAC,IAAI,IAAI,WAAW,EAAE;gBAC7C,IAAM,UAAU,GAAG,MAAM,CAAC,IAA6B,CAAC;gBACxD,IAAM,YAAU,GAAG,WAAW,CAAC,UAAU,CAAE,CAAC;gBAC5C,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG;oBAAO,cAAc;yBAAd,UAAc,EAAd,qBAAc,EAAd,IAAc;wBAAd,yBAAc;;;;;;;oCAEjC,OAAO,GAAG,CAAC;;;yCAAE,CAAA,OAAO,GAAG,YAAU,CAAA;;;;oCAEtC,sBAAO,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,eAAI,IAAI,GAAE;;;oCAEvD,SAAS,GAAG,OAAK,CAAC;yCACd,CAAA,OAAO,GAAG,YAAU,GAAG,CAAC,CAAA,EAAxB,wBAAwB;oCAC1B,qBAAM,IAAI,OAAO,CAAC,UAAC,OAAO,IAAK,OAAA,UAAU,CAAC,OAAO,EAAE,IAAI,CAAC,EAAzB,CAAyB,CAAC,EAAA;;oCAAzD,SAAyD,CAAC,CAAC,6BAA6B;;;;oCANlD,OAAO,EAAE,CAAA;;;oCAUrD,IAAI,SAAS,EAAE;wCACb,MAAM,SAAS,CAAC;qCACjB;;;;;iBACF,CAAC;aACH;iBAAM;gBACL,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;aAC/D;;QAxBH,KAAqB,UAAwB,EAAxB,KAAA,gBAAgB,CAAC,OAAO,EAAxB,cAAwB,EAAxB,IAAwB;YAAxC,IAAM,MAAM,SAAA;oBAAN,MAAM;SAyBhB;QAED,OAAO,OAAO,CAAC;IACjB,CAAC,CAAC;AACJ,CAAC,CAAC;AArCW,QAAA,cAAc,kBAqCzB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@proteinjs/service",
-  "version": "1.0.32",
+  "version": "1.1.0",
   "description": "Service api",
   "publishConfig": {
     "access": "public"
@@ -43,5 +43,5 @@
   },
   "main": "./dist/generated/index.js",
   "types": "./dist/generated/index.d.ts",
-  "gitHead": "634f90f0f01748585e2f6c8be36c4d832d1fe604"
+  "gitHead": "22d0bff91a32a3e34b35d6985a0ce5863270757d"
 }

package/src/Service.ts

@@ -3,6 +3,21 @@ import { Loadable, SourceRepository } from '@proteinjs/reflection';
 import { ServiceClient } from './ServiceClient';
 import { Debouncer } from '@proteinjs/util';
 
+type RemoveIndex<T> = {
+  [K in keyof T as string extends K ? never : number extends K ? never : symbol extends K ? never : K]: T[K];
+};
+type KeysWithoutIndexSignature<T> = keyof RemoveIndex<T>;
+
+// Get keys of T that are not in U
+type Diff<T, U> = T extends U ? never : T;
+
+// Get only the keys specific to T, excluding those from Service
+type KeysWithoutService<T extends Service> = Diff<KeysWithoutIndexSignature<T>, KeysWithoutIndexSignature<Service>>;
+
+type RetryConfig<T extends Service> = {
+  [K in KeysWithoutService<T>]?: number;
+};
+
 export interface Service extends Loadable {
   serviceMetadata?: {
     auth?: {
@@ -35,7 +50,8 @@ export interface Service extends Loadable {
  */
 export const serviceFactory = <T extends Service>(
   serviceInterfaceQualifiedName: string,
-  debouncer?: Debouncer
+  debouncer?: Debouncer,
+  retryConfig?: RetryConfig<T>
 ): (() => T) => {
   return () => {
     const service: any = {};
@@ -43,7 +59,28 @@ export const serviceFactory = <T extends Service>(
     for (const method of serviceInterface.methods) {
       const servicePath = `/service/${serviceInterface.qualifiedName}/${method.name}`;
       const serviceClient = new ServiceClient(servicePath, method, debouncer);
-      service[method.name] = serviceClient.send.bind(serviceClient);
+      if (retryConfig && method.name in retryConfig) {
+        const methodName = method.name as KeysWithoutService<T>;
+        const maxRetries = retryConfig[methodName]!;
+        service[method.name] = async (...args: any[]) => {
+          let lastError;
+          for (let attempt = 0; attempt < maxRetries; attempt++) {
+            try {
+              return serviceClient.send.bind(serviceClient)(...args);
+            } catch (error) {
+              lastError = error;
+              if (attempt < maxRetries - 1) {
+                await new Promise((resolve) => setTimeout(resolve, 1000)); // short wait before retrying
+              }
+            }
+          }
+          if (lastError) {
+            throw lastError;
+          }
+        };
+      } else {
+        service[method.name] = serviceClient.send.bind(serviceClient);
+      }
     }
 
     return service;