Merge pull request #270 from pryv/feature/user-agent-pryv.io-with-api-version

Feature/user agent pryv.io with api version

Author: Zebedeusz

.vscode/snipsnap.code-snippets

@@ -127,7 +127,7 @@ class ExpressAppLifecycle {
 // 
 async function expressAppInit(dependencies: any, isDNSLess: boolean) {
   const pv = new ProjectVersion(); 
-  const version = await pv.version(); 
+  const version = pv.version(); 
 
   dependencies.register('airbrakeNotifier', {airbrakeNotifier: createAirbrakeNotifierIfNeeded()});
 

components/api-server/src/expressApp.js

@@ -18,7 +18,9 @@ var utils = require('components/utils'),
     SetFileReadTokenStream = require('./streams/SetFileReadTokenStream');
 
 const assert = require('assert');
-    
+
+const { ProjectVersion } = require('components/middleware/src/project_version');
+
 const {TypeRepository, isSeriesType} = require('components/business').types;
 
 
@@ -44,8 +46,13 @@ module.exports = function (
   auditSettings, updatesSettings, openSourceSettings,
 ) {
 
+  
+  // Initialise the project version as soon as we can. 
+  const pv = new ProjectVersion();
+  let version = pv.version();
+  
   // Update types and log error
-  typeRepo.tryUpdate(eventTypesUrl)
+  typeRepo.tryUpdate(eventTypesUrl, version)
     .catch((err) => logging.getLogger('typeRepo').warn(err));
 
   const logger = logging.getLogger('methods/events');

components/api-server/src/methods/events.js

@@ -35,10 +35,7 @@ let config: ConfigAccess = null;
 
 // Initialise the project version as soon as we can. 
 const pv = new ProjectVersion(); 
-(async () => {
-  version = await pv.version();
-})();
-
+version = pv.version();
 
 /**
  * 

components/api-server/src/methods/helpers/setCommonMeta.js

@@ -9,7 +9,7 @@
 // TypeRepository is the repository for all Pryv event types. It allows access
 // to coercion and validation. 
 
-import type {EventType, Content} from './types/interfaces';
+import type { EventType, Content } from './types/interfaces';
 
 const lodash = require('lodash');
 const superagent = require('superagent');
@@ -35,26 +35,25 @@ function isSeriesType(name: string): boolean {
 // A validator that can check values against a types JSON Schema. 
 // 
 class TypeValidator {
-  
+
   // Validates the given event type against its schema. 
   // 
   validate(type: EventType, content: Content): Promise<Content> {
     return type.callValidator(this, content);
   }
-  
+
   validateWithSchema(
-    content: Content, 
+    content: Content,
     schema: any
-  ): Promise<Content> 
-  {
+  ): Promise<Content> {
     return bluebird.try(() => {
-      const validator = new ZSchemaValidator(); 
-      
+      const validator = new ZSchemaValidator();
+
       return bluebird
         .fromCallback(
           (cb) => validator.validate(content, schema, cb))
         .then(() => content);
-    }); 
+    });
   }
 }
 
@@ -92,10 +91,10 @@ class TypeRepository {
   // 
   isKnown(name: string): boolean {
     if (isSeriesType(name)) {
-      const leafTypeName = name.slice(SERIES_PREFIX.length); 
+      const leafTypeName = name.slice(SERIES_PREFIX.length);
       return this.isKnown(leafTypeName);
     }
-    
+
     return defaultTypes.types.hasOwnProperty(name);
   }
 
@@ -104,18 +103,18 @@ class TypeRepository {
   // `event-types.default.json`. 
   // 
   lookupLeafType(name: string): EventType {
-    if (! this.isKnown(name)) throw new errors.TypeDoesNotExistError(
+    if (!this.isKnown(name)) throw new errors.TypeDoesNotExistError(
       `Type '${name}' does not exist in this Pryv instance.`);
 
     const typeSchema = defaultTypes.types[name];
 
     if (typeSchema.type === 'object') {
       return new ComplexType(name, typeSchema);
     }
-    
+
     return new BasicType(name, typeSchema);
   }
-  
+
   // Lookup a Pryv Event Type by name. To check if a type exists, use
   // `#isKnown`. Pryv types are either leaf types ('mass/kg', 'position/wgs84')
   // or series types ('series:LEAFTYPE'). 
@@ -124,48 +123,51 @@ class TypeRepository {
   // 
   lookup(name: string) {
     if (isSeriesType(name)) {
-      const leafTypeName = name.slice(SERIES_PREFIX.length); 
+      const leafTypeName = name.slice(SERIES_PREFIX.length);
       const leafType = this.lookupLeafType(leafTypeName);
-      
+
       return new InfluxRowType(leafType);
     }
-    
+
     // assert: Not a series type, must be a leaf type. 
     return this.lookupLeafType(name);
   }
 
   // Produces a validator instance. 
   //
   validator(): TypeValidator {
-    return new TypeValidator(); 
+    return new TypeValidator();
   }
 
   // Tries to update the stored type definitions with a file found on the 
   // internet. 
   // 
-  tryUpdate(sourceURL: string): Promise<void> {
+  tryUpdate(sourceURL: string, apiVersion: string): Promise<void> {
     function unavailableError(err) {
       throw new Error(
         'Could not update event types from ' + sourceURL +
         '\nError: ' + err.message);
     }
     function invalidError(err) {
       throw new Error(
-        'Invalid event types schema returned from ' + sourceURL + 
+        'Invalid event types schema returned from ' + sourceURL +
         '\nErrors: ' + err.errors);
     }
-    
+
+    const USER_AGENT_PREFIX: string = 'Pryv.io/';
+
     return superagent
       .get(sourceURL)
+      .set('User-Agent', USER_AGENT_PREFIX + apiVersion)
       .catch(unavailableError)
       .then((res) => {
-        const validator = new ZSchemaValidator(); 
-        const schema = res.body; 
-        
+        const validator = new ZSchemaValidator();
+        const schema = res.body;
+
         return bluebird.try(() => {
-          if (!validator.validateSchema(schema)) 
+          if (!validator.validateSchema(schema))
             return invalidError(validator.lastReport);
-            
+
           // Overwrite defaultTypes with the merged list of type schemata. 
           defaultTypes = lodash.merge(defaultTypes, schema);
         });
@@ -174,10 +176,10 @@ class TypeRepository {
 }
 
 module.exports = {
-  TypeRepository: TypeRepository, 
+  TypeRepository: TypeRepository,
   InfluxRowType: InfluxRowType,
   isSeriesType: isSeriesType,
-  errors: errors, 
+  errors: errors,
 };
 
 export type { InfluxRowType };

components/business/src/types.js

@@ -248,7 +248,7 @@ class Webhook implements MessageSink {
     _.merge(this, fieldsToUpdate);
     await makeUpdate(fields, this);
   }
-
+  
   async delete(): Promise<void> {
     if (this.repository == null) {
       throw new Error('repository not set for Webhook object.');

components/business/src/webhooks/Webhook.js

@@ -50,9 +50,9 @@ describe('Webhook', () => {
         });
 
         let apiVersion;
-        before(async () => {
+        before(() => {
           const pv = new ProjectVersion(); 
-          apiVersion = await pv.version();
+          apiVersion = pv.version();
         });
 
         after(() => {

components/business/test/acceptance/webhooks/Webhook.test.js

@@ -134,14 +134,14 @@ class Server {
    * 
    * @return express application.
    */
-  async setupExpress(): Promise<express$Application> {
+  setupExpress(): Promise<express$Application> {
     const logger = this.logger;
     const settings = this.settings;
     const logSettings = settings.get('logs').obj();
     const traceEnabled = settings.get('trace.enable').bool(); 
 
     const pv = new ProjectVersion(); 
-    const version = await pv.version(); 
+    const version = pv.version(); 
 
     var app = express(); 
 

components/hfs-server/src/server.js

@@ -14,15 +14,14 @@ const bluebird = require('bluebird');
 const child_process = require('child_process');
 
 const API_VERSION_FILENAME = '.api-version';
+const DEFAULT_VERSION = 'unset';
 
 // The method '#version' returns a version string for this project; it
-// determines it using one of two methods: 
+// determines it using the following:
 // 
-//   a) If the project contains a file called '.api-version' at its root, 
-//      the contents of the file are returned as version string. Take care 
-//      to strip newlines from the file. 
-//   b) Otherwise, we try to run 'git describe' and use the output from this
-//      command. 
+//   If the project contains a file called '.api-version' at its root, 
+//   the contents of the file are returned as version string. 
+//   Take care to strip newlines from the file. 
 // 
 // The way we find the project root is as follows: Look at the paths in 
 // 'process.mainModule' - and try to find the first one which does exist. This
@@ -37,28 +36,11 @@ const API_VERSION_FILENAME = '.api-version';
 class ProjectVersion {
   // Returns the projects version number. 
   // 
-  async version(): Promise<string> {
+  version(): string {
     const version = this.readStaticVersion(); 
     if (version != null) return version; 
 
-    // NOTE If we get here, we better be in a development environment. Otherwise
-    // we will try to run git describe and fail, throwing an error in the 
-    // process. 
-    
-    return await this.gitVersion(); 
-  }
-  
-  async gitVersion(): Promise<string> {
-    const version = await this.exec('git describe');
-    
-    return version.slice(0, -1);
-  }
-  
-  async exec(cmd: string): Promise<string> {
-    const exec = (cmd) => bluebird.fromCallback(
-      cb => child_process.exec(cmd, cb));
-
-    return exec(cmd);
+    return DEFAULT_VERSION;
   }
 
   readStaticVersion(): ?string {
@@ -71,7 +53,6 @@ class ProjectVersion {
 
       // If the version file does not exist, give up. 
       if (! fs.existsSync(versionFilePath)) continue; 
-      
       return fs.readFileSync(versionFilePath).toString();
     }            
 

components/middleware/src/project_version.js

@@ -10,7 +10,7 @@
 const path = require('path');
 
 const chai = require('chai');
-const assert = chai.assert; 
+const assert = chai.assert;
 const sinon = require('sinon');
 
 const bluebird = require('bluebird');
@@ -22,14 +22,14 @@ const { ProjectVersion } = require('../../src/project_version');
 describe('ProjectVersion#version', () => {
   let pv;
   beforeEach(() => {
-    pv = new ProjectVersion(); 
+    pv = new ProjectVersion();
   });
-  
+
   describe('when a ".api-version" file exists in the project', () => {
     const versionFilePath = path.join(__dirname, '../../../../../', '.api-version');
-    
+
     it('[HV40] reads .api-version and returns that constant', async () => {
-      assert.strictEqual(await pv.version(), '1.2.3');
+      assert.strictEqual(pv.version(), '1.2.3');
     });
   });
 });