Merge pull request #15 from vodyani/feature/optimized-long-polling

Feature/optimized long polling

Author: ChoGathK

package-lock.json

@@ -65,23 +65,17 @@
   "dependencies": {
     "@nestjs/common": "^8.4.7",
     "@vodyani/class-decorator": "^8.2.3",
-    "@vodyani/core": "^8.8.1",
     "@vodyani/http-client": "^1.1.0",
     "@vodyani/utils": "^8.6.1"
   },
   "devDependencies": {
     "@commitlint/cli": "16.3.0",
     "@commitlint/config-conventional": "16.2.4",
-    "@nestjs/testing": "8.4.7",
     "@types/jest": "27.5.2",
-    "@types/lodash": "^4.14.182",
     "@types/node": "16.11.56",
-    "@types/object-hash": "2.2.1",
-    "@types/supertest": "2.0.12",
     "@vodyani/eslint-config": "^1.1.0",
     "husky": "7.0.4",
     "jest": "27.5.1",
-    "supertest": "6.2.4",
     "ts-jest": "27.1.5",
     "typescript": "4.8.2"
   }

package.json

@@ -9,18 +9,23 @@ export interface ApolloNotificationOptions extends ApolloLongPollingInfo {
   type: NamespaceType;
 }
 
-export interface ApolloClientOptions {
+export interface ApolloHttpClientOptions {
   appId: string;
   configServerUrl: string
   clusterName?: string;
   secret?: string;
 }
 
-export interface ApolloThirdPartyClientOptions {
+export interface ApolloThirdPartyHttpClientOptions {
   appId: string;
   env: string;
   portalServerUrl: string
   token: string;
   clusters?: string;
   operator: string;
 }
+
+export interface ApolloClientOptions extends ApolloHttpClientOptions {
+  retry?: number;
+  delay?: number;
+}

src/common/interface/client.ts

@@ -12,8 +12,11 @@ export class ApolloClientProvider {
   private scheduler: ApolloScheduler;
 
   constructor(options: ApolloClientOptions) {
-    this.httpClient = new ApolloHttpClient(options);
-    this.scheduler = new ApolloScheduler(this.httpClient);
+    const { appId, configServerUrl, clusterName, secret, retry, delay } = options;
+    const clientOptions = { appId, configServerUrl, clusterName, secret };
+
+    this.httpClient = new ApolloHttpClient(clientOptions);
+    this.scheduler = new ApolloScheduler(this.httpClient, retry, delay);
   }
 
   @This

src/provider/client.ts

@@ -2,14 +2,15 @@ import { Injectable } from '@nestjs/common';
 import { This } from '@vodyani/class-decorator';
 import { AxiosError } from '@vodyani/http-client';
 
-import { ApolloThirdPartyClientOptions, NamespaceType } from '../common';
+import { ApolloThirdPartyHttpClientOptions, NamespaceType } from '../common';
 import { ApolloThirdPartyHttpClient } from '../struct';
 
 @Injectable()
 export class ApolloThirdPartClientProvider {
   private readonly httpClient: ApolloThirdPartyHttpClient;
+
   constructor(
-    private readonly options: ApolloThirdPartyClientOptions,
+    options: ApolloThirdPartyHttpClientOptions,
   ) {
     this.httpClient = new ApolloThirdPartyHttpClient(options);
   }

src/provider/third-part-client.ts

@@ -2,7 +2,7 @@ import { This } from '@vodyani/class-decorator';
 import { AgentKeepAlive, HttpClient } from '@vodyani/http-client';
 
 import {
-  ApolloClientOptions,
+  ApolloHttpClientOptions,
   ApolloLongPollingInfo,
   ApolloNotificationOptions,
   NamespaceType,
@@ -16,7 +16,7 @@ export class ApolloHttpClient {
   private readonly httpAgent = new AgentKeepAlive({ keepAlive: true });
 
   constructor(
-    private readonly options: ApolloClientOptions,
+    private readonly options: ApolloHttpClientOptions,
   ) {
     this.httpClient = new HttpClient();
     this.options.clusterName = this.options.clusterName || 'default';

src/struct/client.ts

@@ -13,6 +13,8 @@ export class ApolloScheduler {
 
   constructor(
     private readonly apolloClient: ApolloHttpClient,
+    private readonly retry = 1,
+    private readonly delay = 1000,
   ) {}
 
   @This
@@ -48,10 +50,10 @@ export class ApolloScheduler {
       } catch (err) {
         errorCount++;
 
-        if (errorCount > 4) {
+        if (errorCount > this.retry) {
           throw new Error('Incorrect long polling, please check appId of secret!');
         } else {
-          await sleep(2000);
+          await sleep(this.delay);
         }
       }
     }
@@ -66,14 +68,15 @@ export class ApolloScheduler {
       const { namespace, type, id } = info;
 
       listeners.push(info);
+
       notifications.push({ namespaceName: namespace, notificationId: id, type });
     });
 
     const data = await this.apolloClient.getConfigNotifications(notifications);
 
     if (isValidArray(data)) {
       for (const listener of listeners) {
-        const { callback, namespace, type, ip } = listener;
+        const { callback, namespace, type, id, ip } = listener;
 
         const info = data.find(e => {
           const namespaceName = e.namespaceName.includes('.json')
@@ -88,7 +91,9 @@ export class ApolloScheduler {
 
           this.listener.set(namespace, { id: info.notificationId, callback, namespace, type, ip });
 
-          callback(config);
+          if (id !== 1) {
+            callback(config);
+          }
         }
       }
     }

src/struct/scheduler.ts

@@ -2,7 +2,7 @@ import { This } from '@vodyani/class-decorator';
 import { AgentKeepAlive, HttpClient } from '@vodyani/http-client';
 
 import {
-  ApolloThirdPartyClientOptions,
+  ApolloThirdPartyHttpClientOptions,
   NamespaceType,
 } from '../common';
 
@@ -14,7 +14,7 @@ export class ApolloThirdPartyHttpClient {
   private readonly httpAgent = new AgentKeepAlive({ keepAlive: true });
 
   constructor(
-    private readonly options: ApolloThirdPartyClientOptions,
+    private readonly options: ApolloThirdPartyHttpClientOptions,
   ) {
     const { appId, clusters, env, token, portalServerUrl } = options;
 

src/struct/third-part-client.ts

@@ -1,7 +1,7 @@
 import { describe, it, expect } from '@jest/globals';
 
-import { ApolloClientProvider } from '../src/provider';
-import { ApolloClientOptions } from '../src/common';
+import { ApolloClientProvider, ApolloThirdPartClientProvider } from '../src/provider';
+import { ApolloClientOptions, ApolloThirdPartyHttpClientOptions } from '../src/common';
 
 const clientOptions: ApolloClientOptions = {
   configServerUrl: 'http://106.54.227.205:8080',
@@ -78,33 +78,45 @@ describe('ApolloClient', () => {
   }, 900000);
 
   it('listenNamespace', async () => {
-    await apolloClient.listenNamespaces(
-      [
-        {
-          type: 'properties',
-          namespace: 'listenNamespace',
-          callback: (config: any) => {
-            if (config.content === '1') {
-              apolloClient.clearListener('listenNamespace');
-              expect(!!config.content).toBe(true);
-            }
+    const time = String(Date.now());
+    const clientOptions: ApolloThirdPartyHttpClientOptions = {
+      env: 'DEV',
+      operator: 'apollo',
+      appId: 'vodyani-apollo-config',
+      portalServerUrl: 'http://106.54.227.205',
+      token: 'fbf1302cd6b2417ebf4511555facbb2371a0fc40',
+    };
+    const httpClient = new ApolloThirdPartClientProvider(clientOptions);
+
+    await Promise.all([
+      apolloClient.listenNamespaces(
+        [
+          {
+            type: 'properties',
+            namespace: 'listenNamespace',
+            callback: (config: any) => {
+              if (config.content === time) {
+                apolloClient.clearListener('listenNamespace');
+                expect(!!config.content).toBe(true);
+              }
+            },
           },
-        },
-        {
-          type: 'json',
-          namespace: 'listenNamespace3',
-          callback: (config: any) => {
-            if (config.content === '3') {
-              apolloClient.clearListener('listenNamespace3');
-              expect(!!config.content).toBe(true);
-            }
+          {
+            type: 'json',
+            namespace: 'listenNamespace3',
+            callback: (config: any) => {
+              if (config.content === time) {
+                apolloClient.clearListener('listenNamespace3');
+                expect(!!config.content).toBe(true);
+              }
+            },
           },
-        },
-      ],
-    );
-
-    // 增加修改 + 发布的流程，触发名称更新
-  }, 900000);
+        ],
+      ),
+      httpClient.saveConfig('listenNamespace', 'properties', time),
+      httpClient.saveConfig('listenNamespace3', 'json', JSON.stringify({ content: time })),
+    ]);
+  });
 
   it('listenNamespace Namespace duplication', async () => {
     try {
@@ -123,6 +135,8 @@ describe('ApolloClient', () => {
     const clientOptions: ApolloClientOptions = {
       configServerUrl: 'http://106.54.227.205:8080',
       appId: 'vodyani-apollo-config',
+      retry: 1,
+      delay: 100,
     };
 
     const apolloClient = new ApolloClientProvider(clientOptions);

test/client.spec.ts

@@ -1,9 +1,9 @@
 import { describe, it, expect } from '@jest/globals';
 
 import { ApolloThirdPartClientProvider } from '../src/provider';
-import { ApolloThirdPartyClientOptions } from '../src/common';
+import { ApolloThirdPartyHttpClientOptions } from '../src/common';
 
-const clientOptions: ApolloThirdPartyClientOptions = {
+const clientOptions: ApolloThirdPartyHttpClientOptions = {
   env: 'DEV',
   operator: 'apollo',
   appId: 'vodyani-apollo-config',
@@ -15,7 +15,7 @@ describe('ApolloThirdPartyHttpClient', () => {
   const httpClient = new ApolloThirdPartClientProvider(clientOptions);
 
   it('error', async () => {
-    const clientOptions: ApolloThirdPartyClientOptions = {
+    const clientOptions: ApolloThirdPartyHttpClientOptions = {
       env: 'DEV',
       operator: 'apollo',
       appId: 'vodyani-apollo-config',