Merge pull request #22 from Linkurious/develop

linkurious-infra · web-flow · commit 42fbc4460f94 · 2024-11-20T10:30:06.000+01:00
Release 1.0.4 [ci:run]
diff --git a/.bumpversion.cfg b/.bumpversion.cfg
@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 1.0.3
+current_version = 1.0.4
 commit = False
 tag = False
 serialize = 
diff --git a/.version b/.version
@@ -1 +1 @@
-1.0.3
+1.0.4
diff --git a/manifest.json b/manifest.json
@@ -1,6 +1,6 @@
 {
   "name": "third-party-data",
-  "version": "1.0.3",
+  "version": "1.0.4",
   "pluginApiVersion": "1.0.0",
   "publicRoute": "dist/frontend",
   "singlePageAppIndex": "index.html",
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@linkurious/lke-plugin-third-party-data",
-  "version": "1.0.3",
+  "version": "1.0.4",
   "description": "LKE Plugin - Third Party Data",
   "homepage": "https://github.com/Linkurious/lke-plugin-third-party-data#readme",
   "bugs": {
@@ -11,31 +11,26 @@
     "url": "https://github.com/Linkurious/lke-plugin-third-party-data"
   },
   "engines": {
-    "node": "18.18.2"
+    "node": "20.18.0"
   },
   "author": {
     "name": "David Rapin",
     "email": "david@linkurio.us"
   },
   "config": {},
   "scripts": {
+    "start": "npm start -w=packages/frontend",
     "npm-package-name": "echo ${npm_package_name}-${npm_package_version}.tgz | sed -e 's/@//' -e 's/\\//-/'",
     "plugin-name": "echo ${npm_package_name} | sed -e 's/^@.*\\///' -e s/^lke-plugin-//",
     "artifact-name": "echo lke-plugin-$(npm run --silent plugin-name).lke",
-    "clean": "rm -rf ./dist *.tgz *.lke",
+    "clean": "rm -rf ./tmp ./dist *.tgz *.lke ./reports",
     "clean:modules": "rm -rf ./package-lock.json ./node_modules",
     "lint": "npm run lint -ws",
     "lint:fix": "npm run lint:fix -ws",
     "lint:ci": "eslint -f checkstyle -o reports/checkstyle.xml .",
     "build": "npm run build -ws",
+    "test": "npm test -w=packages/backend",
     "postbuild": "mkdir -p tmp/github_release && npm pack && mv $(npm run --silent npm-package-name) $(npm run --silent artifact-name) && ln -sf $(pwd)/$(npm run --silent artifact-name) $(pwd)/tmp/github_release/lke-plugin-$(npm run --silent plugin-name)-v$(cat .version).lke",
-    "//deploy:login": "curl -X POST $npm_config_deploy_url/api/auth/login --cookie-jar 'lke.cookie' -H 'Content-type: application/json' -d '{ \"usernameOrEmail\": \"'$npm_config_deploy_user'\", \"password\": \"'$npm_config_deploy_pass'\" }'",
-    "//deploy:logout": "curl -X GET $npm_config_deploy_url/api/auth/logout --cookie 'lke.cookie'  -H 'Content-type: application/json' && rm lke.cookie",
-    "//predeploy:restart-plugins": "npm run deploy:login",
-    "//deploy:restart-plugins": "curl -X POST $npm_config_deploy_url/api/admin/plugins/restart-all --cookie 'lke.cookie'",
-    "//postdeploy:restart-plugins": "npm run deploy:logout",
-    "//deploy": "cp $(npm run --silent artifact-name) $npm_config_deploy_plugin_folder",
-    "//postdeploy": "npm run deploy:restart-plugins",
     "build-deploy": "npm run build && npm run deploy",
     "manual-upload": "gh release create \"v$(cat .version)\" $(npm run --silent artifact-name)",
     "bump:patch": "bump2version patch && npm version --no-git-tag-version patch",
@@ -50,7 +45,7 @@
   ],
   "bundledDependencies": true,
   "dependencies": {
-    "@linkurious/rest-client": "4.0.19",
+    "@linkurious/rest-client": "4.1.6",
     "express": "4.17.3",
     "superagent": "8.1.2"
   },
diff --git a/packages/backend/package.json b/packages/backend/package.json
@@ -4,6 +4,7 @@
   "scripts": {
     "start": "node ../../dist/backend/src/dev/server.js",
     "build": "tsc -b tsconfig.json",
+    "test": "node --test ../../dist/backend/src/test/*.js",
     "lint": "eslint ./src ../shared --ext .ts",
     "lint:fix": "eslint ./src ../shared --ext .ts --fix"
   },
diff --git a/packages/backend/src/models/detailsOptions.ts b/packages/backend/src/models/detailsOptions.ts
@@ -6,7 +6,7 @@ export class DetailsOptions {
   public readonly integrationId: string;
   public readonly searchResultId: string;
 
-  private constructor(params: {integrationId: string; searchResultId: string}) {
+  constructor(params: {integrationId: string; searchResultId: string}) {
     this.integrationId = params.integrationId;
     this.searchResultId = params.searchResultId;
   }
diff --git a/packages/backend/src/services/vendor/driver/annuaireEntreprisesDriver.ts b/packages/backend/src/services/vendor/driver/annuaireEntreprisesDriver.ts
@@ -30,7 +30,7 @@ export class AnnuaireEntreprisesDriver extends BaseSearchDriver<
     url.searchParams.set('page', '1');
     url.searchParams.set('per_page', `${maxResults}`);
 
-    const r = await this.client.get(url.toString()).set('accept', 'json');
+    const r = await this.client.get(url.toString()).set('accept', 'application/json');
     if (r.status !== 200) {
       throw new Error(`Failed to get search results: ${(r.body as ResponseBody).erreur}`);
     }
diff --git a/packages/backend/src/services/vendor/driver/companyHouseUkDriver.ts b/packages/backend/src/services/vendor/driver/companyHouseUkDriver.ts
@@ -1,3 +1,5 @@
+import {Response} from 'superagent';
+
 import {VendorResult} from '../../../../../shared/api/response';
 import {BaseDetailsSearchDriver, flattenJson} from '../baseSearchDriver';
 import {VendorIntegration} from '../../../../../shared/integration/vendorIntegration';
@@ -37,14 +39,16 @@ export class CompanyHouseUkDriver extends BaseDetailsSearchDriver<
     const r = await this.client
       .get(url.toString())
       .auth(integration.getAdminSettings('apiKey'), '', {type: 'basic'})
-      .set('accept', 'json');
+      .set('accept', 'application/json');
     if (r.status === 401) {
       throw new Error(`Invalid API key`);
     }
     if (r.status !== 200) {
       throw new Error(`Failed to get search results: ${JSON.stringify(r.body)}`);
     }
     return (r.body as SearchResponseBody).items.map((company) => {
+      delete company.kind;
+      delete company.snippet;
       delete company.address_snippet;
       delete company.matches;
       return {
@@ -64,10 +68,18 @@ export class CompanyHouseUkDriver extends BaseDetailsSearchDriver<
     const url = new URL(
       `https://api.company-information.service.gov.uk/company/${detailsOptions.searchResultId}`
     );
-    const r = await this.client
-      .get(url.toString())
-      .auth(integration.getAdminSettings('apiKey'), '', {type: 'basic'})
-      .set('accept', 'json');
+    let r: Response;
+    try {
+      r = await this.client
+        .get(url.toString())
+        .auth(integration.getAdminSettings('apiKey'), '', {type: 'basic'})
+        .set('accept', 'application/json');
+    } catch (e) {
+      if (process.env.DEBUG) {
+        console.log('HTTP error: ' + JSON.stringify(e));
+      }
+      throw e;
+    }
     if (r.status === 401) {
       throw new Error(`Invalid API key`);
     }
diff --git a/packages/backend/src/services/vendor/driver/dnbPeopleLookupDriver.ts b/packages/backend/src/services/vendor/driver/dnbPeopleLookupDriver.ts
@@ -44,7 +44,7 @@ export class DnbPeopleLookupDriver extends BaseSearchDriver<
     const r = await this.client
       .get(url.toString())
       .auth(token, {type: 'bearer'})
-      .set('accept', 'json');
+      .set('accept', 'application/json');
     if (r.status !== 200) {
       throw new Error(`Failed to get search results (http ${r.status})`);
     }
diff --git a/packages/backend/src/test/annuaireDesEntreprises.spec.ts b/packages/backend/src/test/annuaireDesEntreprises.spec.ts
@@ -0,0 +1,19 @@
+import {it, describe} from 'node:test';
+import * as assert from 'node:assert';
+
+import {AnnuaireEntreprisesDriver} from '../services/vendor/driver/annuaireEntreprisesDriver';
+import {Vendor} from '../../../shared/vendor/vendor';
+import {VendorIntegration} from '../../../shared/integration/vendorIntegration';
+
+void describe('Annuaire-des-Entreprises', () => {
+  void it('should find one results when searching for "test"', async () => {
+    const d = new AnnuaireEntreprisesDriver();
+    const results = await d.search(
+      {q: 'test'},
+      {vendor: {key: 'recherche-entreprise-gouv-fr'} as Vendor} as VendorIntegration,
+      1
+    );
+    //console.log(JSON.stringify(results, null, 2));
+    assert.deepEqual(results.length === 1, true);
+  });
+});
diff --git a/packages/backend/src/test/index.ts b/packages/backend/src/test/index.ts
diff --git a/packages/backend/src/test/searcher.spec.ts b/packages/backend/src/test/searcher.spec.ts
@@ -0,0 +1,95 @@
+import {it, describe} from 'node:test';
+import * as assert from 'node:assert';
+
+import {LkNode} from '@linkurious/rest-client';
+
+import {Searcher} from '../services/vendor/searcher';
+import {Logger} from '../services/logger';
+import {Configuration} from '../services/configuration';
+import {MyPluginConfig} from '../../../shared/myPluginConfig';
+import {CompanyHouseUkSearchResponse} from '../../../shared/vendor/vendors/companyHouseUk';
+import {CompanyHouseUkDriver} from '../services/vendor/driver/companyHouseUkDriver';
+import {DetailsOptions} from '../models/detailsOptions';
+
+const myConfig: MyPluginConfig = {
+  basePath: '/',
+  debugPort: undefined,
+  integrations: [
+    {
+      id: 'ch',
+      vendorKey: 'company-house-uk',
+      adminSettings: {
+        apiKey: '05efd800-e2e7-4f46-919c-d831365a42fc'
+      },
+      inputNodeCategory: 'Company',
+      outputNodeCategory: 'Company_details',
+      outputEdgeType: 'has_details',
+      searchQueryFieldMapping: [
+        {type: 'property', inputPropertyKey: 'name', outputPropertyKey: 'q'},
+        {
+          type: 'constant',
+          valueType: 'string',
+          outputPropertyKey: 'restrictions',
+          value: 'active-companies'
+        }
+      ],
+      outputNodeFieldMapping: [
+        {type: 'property', inputPropertyKey: 'title', outputPropertyKey: 'name'}
+      ],
+      searchResponseFieldSelection: ['title', 'address_address_line_1', 'address_region'],
+      sourceKey: 'abc123'
+    }
+  ]
+};
+
+const facebookNode: LkNode = {
+  id: '123',
+  data: {
+    categories: ['Company'],
+    properties: {
+      name: 'Facebook'
+    },
+    geo: {},
+    readAt: 0,
+    isVirtual: false,
+    statistics: undefined
+  }
+};
+
+void describe('Searcher', () => {
+  const logger = new Logger();
+  const config: Configuration = new Configuration(myConfig, logger);
+
+  void it('should search for facebook with company house', async () => {
+    const s = new Searcher(logger, config, 'ch');
+    const driver = s['getSearchDriver']();
+    const searchQuery = s.integration.getSearchQuery(facebookNode);
+    const results = await driver.search(searchQuery, s.integration, 3);
+    //console.log(JSON.stringify(results, null, 2));
+    const addresses = results.map(
+      (r) => (r.properties as CompanyHouseUkSearchResponse).address_country
+    );
+    assert.deepStrictEqual(
+      addresses.some((v) => v === 'England'),
+      true
+    );
+  });
+
+  void it('should fetch details for facebook', async () => {
+    // search
+    const s = new Searcher(logger, config, 'ch');
+    const searchDriver = s['getSearchDriver']();
+    const searchQuery = s.integration.getSearchQuery(facebookNode);
+    const results = await searchDriver.search(searchQuery, s.integration, 3);
+    assert.deepStrictEqual(results.length, 3);
+
+    // get details
+    const driver = new CompanyHouseUkDriver();
+    const details = await driver.getDetails(
+      config.getIntegrationById('ch'),
+      new DetailsOptions({integrationId: 'ds', searchResultId: results[2].id})
+    );
+    assert.deepEqual(details.properties.registered_office_address_country, 'United Kingdom');
+    //console.log(JSON.stringify(details));
+  });
+});

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "third-party-data",`
`3`		`- "version": "1.0.3",`
	`3`	`+ "version": "1.0.4",`
`4`	`4`	`"pluginApiVersion": "1.0.0",`
`5`	`5`	`"publicRoute": "dist/frontend",`
`6`	`6`	`"singlePageAppIndex": "index.html",`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@ export class DetailsOptions {`
`6`	`6`	`public readonly integrationId: string;`
`7`	`7`	`public readonly searchResultId: string;`
`8`	`8`
`9`		`- private constructor(params: {integrationId: string; searchResultId: string}) {`
	`9`	`+ constructor(params: {integrationId: string; searchResultId: string}) {`
`10`	`10`	`this.integrationId = params.integrationId;`
`11`	`11`	`this.searchResultId = params.searchResultId;`
`12`	`12`	`}`
Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ export class AnnuaireEntreprisesDriver extends BaseSearchDriver<`
`30`	`30`	`url.searchParams.set('page', '1');`
`31`	`31`	url.searchParams.set('per_page', `${maxResults}`);
`32`	`32`
`33`		`- const r = await this.client.get(url.toString()).set('accept', 'json');`
	`33`	`+ const r = await this.client.get(url.toString()).set('accept', 'application/json');`
`34`	`34`	`if (r.status !== 200) {`
`35`	`35`	throw new Error(`Failed to get search results: ${(r.body as ResponseBody).erreur}`);
`36`	`36`	`}`
Original file line number	Diff line number	Diff line change
`@@ -44,7 +44,7 @@ export class DnbPeopleLookupDriver extends BaseSearchDriver<`
`44`	`44`	`const r = await this.client`
`45`	`45`	`.get(url.toString())`
`46`	`46`	`.auth(token, {type: 'bearer'})`
`47`		`- .set('accept', 'json');`
	`47`	`+ .set('accept', 'application/json');`
`48`	`48`	`if (r.status !== 200) {`
`49`	`49`	throw new Error(`Failed to get search results (http ${r.status})`);
`50`	`50`	`}`