support for caliper graded profile

backend/packages/Upgrade/src/api/controllers/ExperimentClientController.ts

@@ -17,7 +17,8 @@ import { ExperimentUser } from '../models/ExperimentUser';
 import { ExperimentUserService } from '../services/ExperimentUserService';
 import { UpdateWorkingGroupValidator } from './validators/UpdateWorkingGroupValidator';
 import { MonitoredDecisionPoint } from '../models/MonitoredDecisionPoint';
-import { ISingleMetric, IGroupMetric, SERVER_ERROR } from 'upgrade_types';
+import { ISingleMetric, IGroupMetric, SERVER_ERROR, ILogInput } from 'upgrade_types';
+import { parse, toSeconds } from 'iso8601-duration';
 import { FailedParamsValidator } from './validators/FailedParamsValidator';
 import { ExperimentError } from '../models/ExperimentError';
 import { FeatureFlag } from '../models/FeatureFlag';
@@ -31,6 +32,7 @@ import { Metric } from '../models/Metric';
 import * as express from 'express';
 import { AppRequest } from '../../types';
 import { env } from '../../env';
+import { CaliperLogEnvelope } from './validators/CaliperLogEnvelope';
 
 interface IExperimentAssignment {
   expId: string;
@@ -650,6 +652,70 @@ export class ExperimentClientController {
     });
   }
 
+
+   /**
+   * @swagger
+   * /log/caliper:
+   *    post:
+   *       description: Post Caliper format log data
+   *       consumes:
+   *         - application/json
+   *       parameters:
+   *          - in: body
+   *            name: data
+   *            required: true
+   *            description: User Document
+   *       tags:
+   *         - Client Side SDK
+   *       produces:
+   *         - application/json
+   *       responses:
+   *          '200':
+   *            description: Log data
+   *          '500':
+   *            description: null value in column "id\" of relation \"experiment_user\" violates not-null constraint
+   */
+   @Post('log/caliper')
+   public async caliperLog(
+     @Body({ validate: { validationError: { target: false, value: false } } })
+     @Req()
+     request: AppRequest,
+     envelope: CaliperLogEnvelope
+   ): Promise<Log[]> {
+     let logResponse: Log[] = [];
+     envelope.data.forEach(async log => {
+       request.logger.info({ message: 'Starting the log call for user' });
+       const userId = log.object.assignee.id
+       // getOriginalUserDoc call for alias
+       const experimentUserDoc = await this.getUserDoc(userId, request.logger);
+       if (experimentUserDoc) {
+         // append userDoc in logger
+         request.logger.child({ userDoc: experimentUserDoc });
+         request.logger.info({ message: 'Got the original user doc' });
+       }
+       const logs: ILogInput = {
+         "metrics": {
+           "attributes": log.generated.attempt.extensions.metrics.attributes || {},
+           "groupedMetrics": log.generated.attempt.extensions.metrics.groupedMetrics || [],
+         },
+         timestamp: log.eventTime
+       };
+
+       logs.metrics.attributes['duration'] = toSeconds(parse(log.generated.attempt.duration));
+       logs.metrics.attributes['scoreGiven'] = log.generated.scoreGiven;
+
+       let res = await this.experimentAssignmentService.dataLog(userId, [logs], {
+         logger: request.logger,
+         userDoc: experimentUserDoc,
+       })
+
+       logResponse.concat(res);
+
+     });
+     return logResponse;
+
+   }
+
   /**
    * @swagger
    * /bloblog:

backend/packages/Upgrade/src/api/controllers/validators/CaliperLogData.ts

@@ -0,0 +1,39 @@
+import { IsNotEmpty, IsDefined, IsString, IsJSON, IsObject } from 'class-validator';
+import { Attempt, CaliperActor, ScoreObject } from 'upgrade_types';
+
+export class CaliperLogData {
+
+  @IsDefined()
+  @IsNotEmpty()
+  @IsString()
+  public profile: string;
+
+  @IsDefined()
+  @IsNotEmpty()
+  @IsJSON()
+  public actor: CaliperActor;
+
+  @IsDefined()
+  @IsNotEmpty()
+  @IsString()
+  public action: string;
+
+  @IsDefined()
+  @IsNotEmpty()
+  @IsString()
+  public eventTime: string;
+
+  @IsDefined()
+  @IsNotEmpty()
+  @IsJSON()
+  public object: Attempt;
+
+  @IsObject()
+  public extensions: object;
+
+  @IsObject()
+  @IsNotEmpty()
+  @IsJSON()
+  public generated: ScoreObject;
+
+}

backend/packages/Upgrade/src/api/controllers/validators/CaliperLogEnvelope.ts

@@ -0,0 +1,22 @@
+import { IsNotEmpty, IsDefined, IsString } from 'class-validator';
+import { CaliperLogData } from './CaliperLogData';
+
+
+export class CaliperLogEnvelope {
+  @IsDefined()
+  @IsNotEmpty()
+  @IsString()
+  public sensor: string;
+
+  @IsDefined()
+  @IsNotEmpty()
+  @IsString()
+  public sendTime: string;
+
+  @IsDefined()
+  @IsNotEmpty()
+  @IsString()
+  public dataVersion: string;
+
+  public data: CaliperLogData[];
+}

clientlibs/js/src/UpgradeClient.ts

@@ -14,11 +14,13 @@ import getExperimentCondition from './functions/getExperimentCondition';
 import markExperimentPoint from './functions/markExperimentPoint';
 import getAllFeatureFlags from './functions/getAllfeatureFlags';
 import log from './functions/log';
+import logCaliper from './functions/logCaliper';
 import setAltUserIds from './functions/setAltUserIds';
 import addMetrics from './functions/addMetrics';
 import getFeatureFlag from './functions/getFeatureFlag';
 import init from './functions/init';
 import * as uuid from 'uuid';
+import { CaliperEnvelope } from '../../../types/src/Experiment/interfaces';
 
 export default class UpgradeClient {
   // Endpoints URLs
@@ -31,6 +33,7 @@ export default class UpgradeClient {
     failedExperimentPoint: null,
     getAllFeatureFlag: null,
     log: null,
+    logCaliper: null,
     altUserIds: null,
     addMetrics: null,
   };
@@ -59,6 +62,7 @@ export default class UpgradeClient {
       failedExperimentPoint: `${hostUrl}/api/v1/failed`,
       getAllFeatureFlag: `${hostUrl}/api/v1/featureflag`,
       log: `${hostUrl}/api/v1/log`,
+      logCaliper: `${hostUrl}/api/v1/logCaliper`,
       altUserIds: `${hostUrl}/api/v1/useraliases`,
       addMetrics: `${hostUrl}/api/v1/metric`,
     };
@@ -179,6 +183,11 @@ export default class UpgradeClient {
     return await log(this.api.log, this.userId, this.token, this.clientSessionId, value, sendAsAnalytics);
   }
 
+  async logCaliper(value: CaliperEnvelope, sendAsAnalytics = false): Promise<Interfaces.ILog[]> {
+    this.validateClient();
+    return await logCaliper(this.api.logCaliper, this.userId, this.token, this.clientSessionId, value, sendAsAnalytics);
+  }
+
   async setAltUserIds(altUserIds: string[]): Promise<Interfaces.IExperimentUserAliases> {
     this.validateClient();
     return await setAltUserIds(this.api.altUserIds, this.userId, this.token, this.clientSessionId, altUserIds);

clientlibs/js/src/functions/logCaliper.ts

@@ -0,0 +1,30 @@
+import { Types, Interfaces } from '../identifiers';
+import fetchDataService from '../common/fetchDataService';
+import { CaliperEnvelope } from '../../../../types/src/Experiment/interfaces';
+
+export default async function logCaliper(
+  url: string,
+  userId: string,
+  token: string,
+  clientSessionId: string,
+  value: CaliperEnvelope,
+  sendAsAnalytics = false
+): Promise<Interfaces.ILog[]> {
+  try {
+    const logResponse = await fetchDataService(
+      url,
+      token,
+      clientSessionId,
+      value,
+      Types.REQUEST_TYPES.POST,
+      sendAsAnalytics
+    );
+    if (logResponse.status) {
+      return logResponse.data;
+    } else {
+      throw new Error(JSON.stringify(logResponse.message));
+    }
+  } catch (error) {
+    throw new Error(error.message);
+  }
+}