fixed url parameters function

Author: doripjonov

endpoints/recognition_endpoints.js

@@ -71,7 +71,7 @@ const recognition_endpoints = {
     async add_request(image_path, url, api_key){
         var bodyFormData = new FormData();
         bodyFormData.append('file', fs.createReadStream(image_path), { knownLength: fs.statSync(image_path).size }); 
-
+        
         const response = await axios.post( url, bodyFormData, {
             headers: {
                 ...bodyFormData.getHeaders(),
@@ -96,16 +96,20 @@ const recognition_endpoints = {
         return new Promise( async (resolve, reject) => {
             await axios.get(image_url, { responseType: 'stream' })
             .then( async (response) => {
-                bodyFormData.append('file', response.data, 'exadel.png'); 
-        
-                const res = await axios.post( url, bodyFormData, {
-                    headers: {
-                        ...bodyFormData.getHeaders(),
-                        "x-api-key": api_key
-                    },
-                })
-        
-                return resolve(res)
+                let image_extention = response.headers['content-type'].split("/")[1]
+                bodyFormData.append('file', response.data, `example.${image_extention}`);   
+                try {
+                    const res = await axios.post( url, bodyFormData, {
+                        headers: {
+                            ...bodyFormData.getHeaders(),
+                            "x-api-key": api_key
+                        },
+                    })
+
+                    resolve(res)
+                } catch (error) {
+                    reject(error)
+                }
             })
             .catch(error => {
                 return reject(error)

index.js

@@ -15,4 +15,17 @@
  */
 import { CompreFace } from './core/compre_face.js';
 
-export { CompreFace }
+let server = "http://localhost";
+let port = 8000;
+let image_url = "https://www.youtube.com/watch?v=Bs65qyxglHg";
+let key = "00000000-0000-0000-0000-000000000002";
+let image_id = '0ef8edcf-42fa-42ff-b6f0-6c15bd27782d';
+let options = { limit: 0, det_prob_threshold: 0, prediction_count: 1 }
+
+let core = new CompreFace(server, port, options);
+let recognition_service = core.initFaceRecognitionService(key);
+let faceCollection = recognition_service.getFaceCollection();
+
+faceCollection.add(image_url, "Vimeo")
+    .then(response => console.log(response))
+    .catch(error => console.log(error))

services/recognition_service.js

@@ -39,21 +39,25 @@ class RecognitionService {
      * @param {Object} options 
      * @returns {String}
      */
-    add_options_to_url(url, localOptions, needLimitOption, needDetOption, needPredictionOption){
+    add_options_to_url(url, localOptions, required_parameters){
+        // merge options passed by localy and globally NOTE: global options will override local on if same value passed from both of them
         let uniqueOptions = {...localOptions, ...this.options};
         let isThereAnyOptions = Object.keys(uniqueOptions);
 
-        // check whether user passed options by main class
+        // check whether any parameters passed
         if(isThereAnyOptions.length > 0){
-            if(!isNaN(uniqueOptions['limit']) && needLimitOption){
+            // check whether limit parameter passed and it is required for particular endpoint (ex: it is not requrid for add())
+            if(uniqueOptions['limit'] >= 0 && required_parameters['limit']){
                 url = `${url}?limit=${uniqueOptions['limit']}`
             }
 
-            if(!isNaN(uniqueOptions['det_prob_threshold']) && needDetOption){
+            // check whether det_prob_threshold parameter passed and is it required for particular endpoint
+            if(uniqueOptions['det_prob_threshold'] >= 0 && required_parameters['det_prob_threshold']){
                 url = `${url}&det_prob_threshold=${uniqueOptions['det_prob_threshold']}`
             }
 
-            if(!isNaN(uniqueOptions['prediction_count']) && needPredictionOption){
+            // check whether prediction_count passed and is it required for particular endpoint
+            if(uniqueOptions['prediction_count'] >= 0 && required_parameters['prediction_count']){
                 url = `${url}&prediction_count=${uniqueOptions['prediction_count']}`
             }
         }
@@ -94,12 +98,15 @@ class RecognitionService {
              * @returns {Promise} 
              */
             add(image_path, subject, options){
+                // add extra parameter(s) name with true value if it is referenced in API documentation for particular endpoint
+                // add_options_to_url() adds this parameter to url if user passes some value as option otherwise function ignores this parameter
+                let required_url_parameters = { det_prob_threshold: true };
                 let urlRegEX = /^(?:http(s)?:\/\/)?[\w.-]+(?:\.[\w\.-]+)+[\w\-\._~:/?#[\]@!\$&'\(\)\*\+,;=.]+$/;
                 let isUrl = urlRegEX.test(image_path);
 
                 // add parameters to basic url
                 url = `${url}?subject=${subject}`
-                url = that.add_options_to_url(url, options, false, true, false);
+                url = that.add_options_to_url(url, options, required_url_parameters);
 
                 return new Promise((resolve, reject) => {
                     if(isUrl){
@@ -129,9 +136,12 @@ class RecognitionService {
              * @returns {Promise}
              */
             recognize(image_path, options){
+                // add extra parameter(s) name with true value if it is referenced in API documentation for particular endpoint
+                // add_options_to_url() adds this parameter to url if user passes some value as option otherwise function ignores this parameter
+                let required_url_parameters = {limit: true, det_prob_threshold: true, prediction_count: true };
                 // add parameters to basic url
                 url = `${url}/recognize`;
-                url = that.add_options_to_url(url, options, true, true, true);
+                url = that.add_options_to_url(url, options, required_url_parameters);
 
                 return new Promise((resolve, reject) => {
                     recognition_endpoints.recognize_face_request(image_path, url, key)
@@ -152,9 +162,12 @@ class RecognitionService {
              * @returns {Promise}
              */
             verify(image_path, image_id, options){
+                // add extra parameter(s) name with true value if it is referenced in API documentation for particular endpoint
+                // add_options_to_url() adds this parameter to url if user passes some value as option otherwise function ignores this parameter
+                let required_url_parameters = { det_prob_threshold: true, prediction_count: true };
                 // add parameters to basic url
                 url = `${url}/${image_id}/verify`;
-                url = that.add_options_to_url(url, options, true, true, false);
+                url = that.add_options_to_url(url, options, required_url_parameters);
 
                 return new Promise((resolve, reject) => {
                     recognition_endpoints.verify_face_request(image_path, url, key)