Merge pull request #284 from apiaryio/honzajavorek/provide-name

Provide transaction name for each annotation

Author: honzajavorek

README.md

@@ -167,6 +167,7 @@ Description of an error or warning which occurred during parsing of the API desc
 
 ### Deprecated Properties
 
+- name: `Hello world! > Retrieve Message` (string) - Transaction Name, non-deterministic breadcrumb location of the relevant HTTP Transaction within the API description document.
 - origin (object) - Object of references to nodes of [API Elements][api-elements] derived from the original API description document.
     - filename: `./api-description.apib` (string)
     - apiName: `My Api` (string)

compile/compileTransactionName.js

@@ -1,9 +1,11 @@
 module.exports = function compileTransactionName(origin) {
-  const segments = [];
-  if (origin.apiName) { segments.push(origin.apiName); }
-  if (origin.resourceGroupName) { segments.push(origin.resourceGroupName); }
-  if (origin.resourceName) { segments.push(origin.resourceName); }
-  if (origin.actionName) { segments.push(origin.actionName); }
-  if (origin.exampleName) { segments.push(origin.exampleName); }
-  return segments.join(' > ');
+  return [
+    origin.apiName,
+    origin.resourceGroupName,
+    origin.resourceName,
+    origin.actionName,
+    origin.exampleName,
+  ]
+    .filter(Boolean)
+    .join(' > ');
 };

compile/index.js

@@ -112,11 +112,7 @@ function compileRequest(httpRequestElement) {
 
   annotations.forEach((annotation) => {
     /* eslint-disable no-param-reassign */
-    annotation.location = (
-      (httpRequestElement.href ? httpRequestElement.href.sourceMapValue : undefined)
-      || (httpRequestElement.parents.find('transition').href ? httpRequestElement.parents.find('transition').href.sourceMapValue : undefined)
-      || (httpRequestElement.parents.find('resource').href ? httpRequestElement.parents.find('resource').href.sourceMapValue : undefined)
-    );
+    annotation.location = null; // https://github.com/apiaryio/dredd-transactions/issues/275
     /* eslint-enable */
   });
 
@@ -152,19 +148,26 @@ function compileResponse(httpResponseElement) {
 
 function compileTransaction(mediaType, filename, httpTransactionElement, exampleNo) {
   const origin = compileOrigin(mediaType, filename, httpTransactionElement, exampleNo);
-  const { request, annotations } = compileRequest(httpTransactionElement.request);
-
-  annotations.forEach((annotation) => { annotation.origin = Object.assign({}, origin); }); // eslint-disable-line
+  const name = compileTransactionName(origin);
 
+  const { request, annotations } = compileRequest(httpTransactionElement.request);
+  annotations.forEach((annotation) => {
+    /* eslint-disable no-param-reassign */
+    annotation.name = name;
+    annotation.origin = Object.assign({}, origin);
+    /* eslint-enable */
+  });
   if (!request) { return { transaction: null, annotations }; }
 
-  const name = compileTransactionName(origin);
-  const response = compileResponse(httpTransactionElement.response);
-
-  const transaction = {
-    request, response, origin, name,
+  return {
+    transaction: {
+      request,
+      response: compileResponse(httpTransactionElement.response),
+      name,
+      origin,
+    },
+    annotations,
   };
-  return { transaction, annotations };
 }
 
 function compile(mediaType, apiElements, filename) {

test/schemas/createAnnotationSchema.js

@@ -2,7 +2,6 @@ const createLocationSchema = require('./createLocationSchema');
 const createOriginSchema = require('./createOriginSchema');
 
 const TYPES = ['error', 'warning'];
-const COMPONENTS = ['apiDescriptionParser', 'parametersValidation', 'uriTemplateExpansion'];
 
 
 module.exports = function createAnnotationSchema(options = {}) {
@@ -13,7 +12,7 @@ module.exports = function createAnnotationSchema(options = {}) {
   const messageSchema = { type: 'string' };
   if (options.message) { messageSchema.pattern = options.message; }
 
-  return {
+  const parseAnnotationSchema = {
     type: 'object',
     properties: {
       type: {
@@ -22,22 +21,40 @@ module.exports = function createAnnotationSchema(options = {}) {
       },
       component: {
         type: 'string',
-        enum: options.component ? [options.component] : COMPONENTS,
+        enum: ['apiDescriptionParser'],
       },
       message: messageSchema,
       location: createLocationSchema(),
-      origin: createOriginSchema({ filename }),
     },
     required: ['type', 'component', 'message', 'location'],
-    dependencies: {
-      origin: {
-        properties: {
-          component: {
-            enum: ['parametersValidation', 'uriTemplateExpansion'],
-          },
-        },
+    additionalProperties: false,
+  };
+  if (options.component === 'apiDescriptionParser') {
+    return parseAnnotationSchema;
+  }
+
+  const compileAnnotationSchema = {
+    type: 'object',
+    properties: {
+      type: {
+        type: 'string',
+        enum: options.type ? [options.type] : TYPES,
+      },
+      component: {
+        type: 'string',
+        enum: options.component ? [options.component] : ['parametersValidation', 'uriTemplateExpansion'],
       },
+      message: messageSchema,
+      location: { type: 'null' }, // https://github.com/apiaryio/dredd-transactions/issues/275
+      name: { type: 'string' },
+      origin: createOriginSchema({ filename }),
     },
+    required: ['type', 'component', 'message', 'location', 'name', 'origin'],
     additionalProperties: false,
   };
+  if (['parametersValidation', 'uriTemplateExpansion'].includes(options.component)) {
+    return compileAnnotationSchema;
+  }
+
+  return { anyOf: [parseAnnotationSchema, compileAnnotationSchema] };
 };