Added support to data version and execution metadata

package.json

@@ -66,7 +66,7 @@
   "homepage": "https://github.com/yarinvak/polaris#readme",
   "dependencies": {
     "@bitjourney/uuid-v4": "^1.0.1",
-    "@enigmatis/polaris-logs": "^2.5.3",
+    "@enigmatis/polaris-logs": "^2.5.4",
     "@enigmatis/utills": "^1.3.3",
     "@types/graphql": "^14.2.0",
     "@types/graphql-fields": "^1.3.0",

src/common/execution-result-validator.ts

@@ -0,0 +1,13 @@
+import * as joi from 'joi';
+
+const executionResultSchema = joi.object().keys({
+    result: joi.any(),
+    executionMetadata: joi.any(),
+});
+
+export function isExecutionResultResponse(candidate: object): boolean {
+    if (!candidate) {
+        return false;
+    }
+    return !joi.validate(candidate, executionResultSchema, { stripUnknown: true }).error;
+}

src/inversion-of-control/container-manager.ts

@@ -2,6 +2,7 @@ import { PolarisLogger } from '@enigmatis/polaris-logs';
 import { Container, decorate, injectable } from 'inversify';
 import 'reflect-metadata';
 import { PolarisGraphQLLogger } from '../logging/polaris-graphql-logger';
+import { ExecutionResultMiddleware } from '../middlewares/execution-result-middleware';
 import { IrrelevantEntitiesMiddleware } from '../middlewares/irrelevant-entities-middleware';
 import { PolarisMiddleware } from '../middlewares/polaris-middleware';
 import { DefaultRealitiesHolder } from '../realities-holder/default-realities-holder';
@@ -13,6 +14,7 @@ decorate(injectable(), PolarisLogger);
 export const polarisContainer = new Container();
 polarisContainer.bind(POLARIS_TYPES.GraphQLServer).to(PolarisGraphQLServer);
 polarisContainer.bind(POLARIS_TYPES.GraphQLLogger).to(PolarisGraphQLLogger);
+polarisContainer.bind(POLARIS_TYPES.Middleware).to(ExecutionResultMiddleware);
 polarisContainer.bind(POLARIS_TYPES.Middleware).to(PolarisMiddleware);
 polarisContainer.bind(POLARIS_TYPES.Middleware).to(IrrelevantEntitiesMiddleware);
 polarisContainer.bind(POLARIS_TYPES.RealitiesHolderValidator).to(RealitiesHolderValidator);

src/middlewares/execution-result-middleware.ts

@@ -0,0 +1,19 @@
+import { injectable } from 'inversify';
+import { isExecutionResultResponse } from '../common/execution-result-validator';
+import { Middleware, RequestMiddlewareParams, ResponseMiddlewareParams } from './middleware';
+
+@injectable()
+export class ExecutionResultMiddleware implements Middleware {
+    preResolve({ args }: RequestMiddlewareParams) {
+        return;
+    }
+
+    postResolve(params: ResponseMiddlewareParams): any {
+        if (isExecutionResultResponse(params.result)) {
+            params.context.executionMetadata = params.result.executionMetadata;
+            return params.result.result;
+        }
+
+        return params.result;
+    }
+}

src/server/data-version-extension.ts

@@ -0,0 +1,18 @@
+import { GraphQLExtension, GraphQLResponse } from 'graphql-extensions';
+import { PolarisContext } from './polaris-context';
+
+export class DataVersionExtension extends GraphQLExtension {
+    willSendResponse(responseContext: {
+        graphqlResponse: GraphQLResponse;
+        context: PolarisContext;
+    }) {
+        const { context, graphqlResponse } = responseContext;
+        if (context.body.operationName !== 'IntrospectionQuery') {
+            graphqlResponse.extensions = {
+                ...graphqlResponse.extensions,
+                dataVersion: context.executionMetadata && context.executionMetadata.dataVersion,
+            };
+        }
+        return responseContext;
+    }
+}

src/server/graphql-server.ts

@@ -1,4 +1,4 @@
-import { SoftDeleteConfiguration } from '@enigmatis/utills';
+import { ExecutionMetadata, SoftDeleteConfiguration } from '@enigmatis/utills';
 import { ApolloServer, Config, PubSub } from 'apollo-server-koa';
 import { GraphQLError, GraphQLFormattedError, GraphQLSchema } from 'graphql';
 import { applyMiddleware } from 'graphql-middleware';
@@ -16,6 +16,7 @@ import { Middleware } from '../middlewares/middleware';
 import { createMiddleware } from '../middlewares/polaris-middleware-creator';
 import { PolarisProperties } from '../properties/polaris-properties';
 import { RealitiesHolderValidator } from '../realities-holder/realities-holder-validator';
+import { DataVersionExtension } from './data-version-extension';
 import { IrrelevantEntitiesExtension } from './irrelevant-entities-extension';
 import { PolarisContext } from './polaris-context';
 
@@ -62,6 +63,7 @@ export class PolarisGraphQLServer implements GraphQLServer {
             extensions: [
                 () => new IrrelevantEntitiesExtension(),
                 () => new ResponseHeadersExtension(),
+                () => new DataVersionExtension(),
             ],
             ...userApolloConfig,
         };
@@ -83,9 +85,7 @@ export class PolarisGraphQLServer implements GraphQLServer {
                     `🚀 Server ready at http://localhost:${port}${this.server.graphqlPath}`,
                 );
                 this.polarisLogger.info(
-                    `🚀 Subscriptions ready at ws://localhost:${port}${
-                        this.server.subscriptionsPath
-                    }`,
+                    `🚀 Subscriptions ready at ws://localhost:${port}${this.server.subscriptionsPath}`,
                 );
                 resolve();
             });
@@ -148,6 +148,7 @@ export class PolarisGraphQLServer implements GraphQLServer {
             headers,
             body: ctx.request.body,
             softDeleteConfiguration: this.softDeleteConfiguration,
+            executionMetadata: { debugDate: new Date() },
             irrelevantEntities: new IrrelevantEntitiesContainer(),
             ...this.getCustomContext(ctx),
         };

src/server/irrelevant-entities-extension.ts

@@ -10,6 +10,7 @@ export class IrrelevantEntitiesExtension extends GraphQLExtension {
 
         if (context.headers.dataVersion) {
             graphqlResponse.extensions = {
+                ...graphqlResponse.extensions,
                 irrelevantEntities: context.irrelevantEntities.irrelevantContainer,
             };
         }

test/integration-tests/test-server/client.ts

@@ -1,9 +1,7 @@
 import { GraphQLClient } from 'graphql-request';
 import * as polarisPropertiesPath from './config/properties.json';
 
-export const url = `http://localhost:${polarisPropertiesPath.port}${
-    polarisPropertiesPath.endpoint
-}`;
+export const url = `http://localhost:${polarisPropertiesPath.port}${polarisPropertiesPath.endpoint}`;
 
 export const graphQLRequest = async (data: string, headers: any, variables: any = undefined) => {
     const graphQLClient = new GraphQLClient(url, { headers });

test/integration-tests/test-server/schema/resolvers/book-resolvers-functions.ts

@@ -1,11 +1,10 @@
-import { PolarisRequestHeaders } from '@enigmatis/utills';
 import { UserInputError } from 'apollo-server-koa';
 import { PolarisContext } from '../../../../../src/server/polaris-context';
 import { Author } from '../definitions/author';
 import { Book } from '../definitions/book';
 import { BOOK_UPDATED } from './subscription-event-names';
 
-import { getModelCreator, QueryWithIrrelevant } from '@enigmatis/mongo-driver';
+import { getModelCreator, getModelExecutor, QueryWithIrrelevant } from '@enigmatis/mongo-driver';
 import { authorSchema } from '../../dal/author-model';
 import { bookSchema } from '../../dal/book-model';
 
@@ -109,13 +108,17 @@ export const bookByIdResolver = async (
     if (!Number.isInteger(realityId as any)) {
         throw new UserInputError('please provide reality-id header');
     } else {
-        return getModelCreator<Book>('book', bookSchema)(context)
-            .findOne({ testId: bookId })
-            .populate({
-                path: 'author',
-                model: getModelCreator<Author>('author', authorSchema)(context),
-            })
-            .lean();
+        return getModelExecutor<Book>('book', bookSchema).execute(
+            m =>
+                m
+                    .findOne({ testId: bookId })
+                    .populate({
+                        path: 'author',
+                        model: getModelCreator<Author>('author', authorSchema)(context),
+                    })
+                    .lean(),
+            context,
+        );
     }
 };
 

test/integration-tests/tests/irrelevant-entities.test.ts

@@ -10,7 +10,7 @@ export const titles = ['first', 'second', 'third', 'fourth', 'fifth'];
 const prepareDb = async (headers: PolarisRequestHeaders) => {
     const books = [];
     for (let i = 0; i < titles.length; i++) {
-        books.push({ title: titles[i], testId: i, dataVersion: i + 1 });
+        books.push({ title: titles[i], testId: i });
     }
     await getModelCreator<Book>('book', bookSchema)({ headers }).create(books);
 };
@@ -80,7 +80,7 @@ describe('irrelevant entities tests', () => {
         }`;
         const { extensions }: any = await graphqlRawRequest(queryBook, { 'reality-id': 1 });
 
-        expect(extensions).not.toBeDefined();
+        expect(extensions.irrelevantEntities).not.toBeDefined();
     });
 
     test('deleted entity is in irrelevant entities', async () => {

test/integration-tests/tests/response-headers.test.ts

@@ -8,7 +8,7 @@ import { TestServer } from '../test-server/server';
 const titles = ['first', 'second', 'third', 'fourth', 'fifth'];
 
 const prepareDb = async (headers: PolarisRequestHeaders) => {
-    const context: PolarisBaseContext = { headers };
+    const context: PolarisBaseContext = { headers, executionMetadata: { dataVersion: 0 } };
 
     const books = [];
     for (let i = 0; i < titles.length; i++) {

test/integration-tests/tests/soft-delete.test.ts

@@ -30,7 +30,11 @@ const defaultAuthor = {
 const bookId = '0';
 
 const prepareDb = async (softDeleteConfiguration?: SoftDeleteConfiguration) => {
-    const context: PolarisBaseContext = { headers, softDeleteConfiguration };
+    const context: PolarisBaseContext = {
+        headers,
+        softDeleteConfiguration,
+        executionMetadata: { dataVersion: 0 },
+    };
     const author = await getModelCreator<Author>('author', authorSchema)(context).create(
         defaultAuthor,
     );

test/middlewares/filter-executor.test.ts

@@ -39,6 +39,7 @@ describe('filter resolver tests', () => {
                 headers: { dataVersion: 3, realityId: 0 },
                 body: {},
                 irrelevantEntities: new IrrelevantEntitiesContainer(),
+                executionMetadata: { dataVersion: 0 },
             };
             const middlewareParams: ResponseMiddlewareParams = {
                 root,
@@ -60,6 +61,7 @@ describe('filter resolver tests', () => {
                 headers: { realityId: 1 },
                 body: {},
                 irrelevantEntities: new IrrelevantEntitiesContainer(),
+                executionMetadata: { dataVersion: 0 },
             };
             const middlewareParams: ResponseMiddlewareParams = {
                 root,
@@ -81,6 +83,7 @@ describe('filter resolver tests', () => {
                 headers: { realityId: 1 },
                 body: {},
                 irrelevantEntities: new IrrelevantEntitiesContainer(),
+                executionMetadata: { dataVersion: 0 },
             };
             const middlewareParams: ResponseMiddlewareParams = {
                 root,
@@ -102,6 +105,7 @@ describe('filter resolver tests', () => {
                 headers: { realityId: 1 },
                 body: {},
                 irrelevantEntities: new IrrelevantEntitiesContainer(),
+                executionMetadata: { dataVersion: 0 },
             };
             const middlewareParams: ResponseMiddlewareParams = {
                 root,
@@ -125,6 +129,7 @@ describe('filter resolver tests', () => {
                 headers: { realityId: 1 },
                 body: {},
                 irrelevantEntities: new IrrelevantEntitiesContainer(),
+                executionMetadata: { dataVersion: 0 },
             };
             const middlewareParams: ResponseMiddlewareParams = {
                 root,
@@ -144,6 +149,7 @@ describe('filter resolver tests', () => {
                 headers: { realityId: 1 },
                 body: {},
                 irrelevantEntities: new IrrelevantEntitiesContainer(),
+                executionMetadata: { dataVersion: 0 },
             };
             const middlewareParams: ResponseMiddlewareParams = {
                 root,

test/middlewares/irrelevant-entities-middleware.test.ts

@@ -31,6 +31,7 @@ describe('split relevantEntities and irrelevant', () => {
                 headers: { dataVersion: 3 },
                 body: {},
                 irrelevantEntities: new IrrelevantEntitiesContainer(),
+                executionMetadata: { dataVersion: 0 },
             };
             const middlewareParams: ResponseMiddlewareParams = {
                 root,
@@ -51,6 +52,7 @@ describe('split relevantEntities and irrelevant', () => {
                 headers: { dataVersion: 3 },
                 body: {},
                 irrelevantEntities: new IrrelevantEntitiesContainer(),
+                executionMetadata: { dataVersion: 0 },
             };
             const middlewareParams: ResponseMiddlewareParams = {
                 root,
@@ -70,6 +72,7 @@ describe('split relevantEntities and irrelevant', () => {
                 headers: { dataVersion: 0 },
                 body: {},
                 irrelevantEntities: new IrrelevantEntitiesContainer(),
+                executionMetadata: { dataVersion: 0 },
             };
             const middlewareParams: ResponseMiddlewareParams = {
                 root,
@@ -94,6 +97,7 @@ describe('not modifying result if not needed', () => {
                 headers: {},
                 body: {},
                 irrelevantEntities: new IrrelevantEntitiesContainer(),
+                executionMetadata: { dataVersion: 0 },
             };
             const middlewareParams: ResponseMiddlewareParams = {
                 root,
@@ -112,6 +116,7 @@ describe('not modifying result if not needed', () => {
                 headers: {},
                 body: {},
                 irrelevantEntities: new IrrelevantEntitiesContainer(),
+                executionMetadata: { dataVersion: 0 },
             };
             const middlewareParams: ResponseMiddlewareParams = {
                 root,
@@ -133,6 +138,7 @@ describe('not modifying result if not needed', () => {
                 headers: {},
                 body: {},
                 irrelevantEntities: new IrrelevantEntitiesContainer(),
+                executionMetadata: { dataVersion: 0 },
             };
             const middlewareParams: ResponseMiddlewareParams = {
                 root,
@@ -151,6 +157,7 @@ describe('not modifying result if not needed', () => {
                 headers: {},
                 body: {},
                 irrelevantEntities: new IrrelevantEntitiesContainer(),
+                executionMetadata: { dataVersion: 0 },
             };
             const middlewareParams: ResponseMiddlewareParams = {
                 root,

test/middlewares/middleware-activation-condition/filter-data-version.test.ts

@@ -14,6 +14,7 @@ describe('data version tests', () => {
             headers: {},
             body: {},
             irrelevantEntities: new IrrelevantEntitiesContainer(),
+            executionMetadata: { dataVersion: 0 },
         };
         const middlewareParams: ResponseMiddlewareParams = {
             root: undefined,
@@ -30,6 +31,7 @@ describe('data version tests', () => {
                 headers: { dataVersion: 1 },
                 body: {},
                 irrelevantEntities: new IrrelevantEntitiesContainer(),
+                executionMetadata: { dataVersion: 0 },
             };
             const middlewareParams: ResponseMiddlewareParams = {
                 root: undefined,
@@ -45,6 +47,7 @@ describe('data version tests', () => {
                 headers: { dataVersion: 1 },
                 body: {},
                 irrelevantEntities: new IrrelevantEntitiesContainer(),
+                executionMetadata: { dataVersion: 0 },
             };
             const middlewareParams: ResponseMiddlewareParams = {
                 root: undefined,
@@ -60,6 +63,7 @@ describe('data version tests', () => {
                 headers: { dataVersion: 2 },
                 body: {},
                 irrelevantEntities: new IrrelevantEntitiesContainer(),
+                executionMetadata: { dataVersion: 0 },
             };
             const middlewareParams: ResponseMiddlewareParams = {
                 root: undefined,
@@ -75,6 +79,7 @@ describe('data version tests', () => {
                 headers: { dataVersion: 2 },
                 body: {},
                 irrelevantEntities: new IrrelevantEntitiesContainer(),
+                executionMetadata: { dataVersion: 0 },
             };
             const middlewareParams: ResponseMiddlewareParams = {
                 root: undefined,