Add odata headers

.gitignore

@@ -1,7 +1,6 @@
 # IDE
-.idea
+.idea/
 .DS_Store
-.vscode
 # Logs
 logs
 *.log

.vscode/launch.json

@@ -7,14 +7,28 @@
         {
             "type": "node",
             "request": "launch",
-            "name": "test",
-            "skipFiles": [
-                "<node_internals>/**"
-            ],
+            "name": "npm test",
             "program": "${workspaceFolder}/node_modules/.bin/jasmine",
             "cwd": "${workspaceFolder}",
-            "outFiles": [
-                "${workspaceFolder}/**/*.js"
+            "console": "integratedTerminal",
+            "env": {
+                "NODE_ENV": "development",
+                "DEBUG": "themost-framework:*"
+            }
+        },
+        {
+            "name": "npm run standalone",
+            "program": "${workspaceFolder}/bin/standalone.js",
+            "request": "launch",
+            "type": "node",
+            "console": "integratedTerminal",
+            "env": {
+                "NODE_ENV": "development",
+                "DEBUG": "themost-framework:*"
+            },
+            "runtimeArgs": [
+                "--require",
+                "@babel/register"
             ]
         }
     ]

bin/standalone.js

@@ -0,0 +1,70 @@
+/**
+ * MOST Web Framework 2.0 Codename Blueshift
+ * Copyright (c) 2017, THEMOST LP All rights reserved
+ *
+ * Use of this source code is governed by an BSD-3-Clause license that can be
+ * found in the LICENSE file at https://themost.io/license
+ */
+ import http from 'http';
+ import debug from 'debug';
+ import express from 'express';
+ import path from 'path';
+ import {ExpressDataApplication, serviceRouter} from '../modules/@themost/express/src';
+import { ODataModelBuilder } from '@themost/data';
+
+ // normalize a port into a number, string, or false.
+ function normalizePort(val) {
+    let port = parseInt(val, 10);
+    if (isNaN(port)) {
+        // named pipe
+        return val;
+    }
+    if (port >= 0) {
+        // port number
+        return port;
+    }
+    return false;
+}
+// get port from environment
+let port = normalizePort(process.env.PORT) || 3000;
+// get bind address.
+let host = process.env.HOST || 'localhost';
+
+ const app = express();
+
+ // create a new instance of data application
+ const dataApplication = new ExpressDataApplication(path.resolve(__dirname, '../modules/@themost/express/src/test/config'));
+
+ dataApplication.getService(ODataModelBuilder).defaultNamespace = 'Test1';
+ dataApplication.getService(ODataModelBuilder).hasContextLink(() => {
+    return `http://${host}:${port}/api/$metadata`;
+ });
+ // hold data application
+ app.set('ExpressDataApplication', dataApplication);
+ // use data middleware (register req.context)
+ app.use(dataApplication.middleware(app));
+ // set testRouter
+ // noinspection JSCheckFunctionSignatures
+ app.use('/api/', serviceRouter);
+
+
+ // enable namespace
+ debug.enable('themost-framework:*');
+ const log = debug('themost-framework:test');
+
+
+// noinspection JSUnresolvedFunction
+let server = http.createServer(app);
+// listen on provided port, on all network interfaces.
+server.on('error', err => {
+    log(err);
+    });
+server.on('close', () => {
+    log('Stopping the test api server from accepting new connections.');
+});
+server.on('listening', () => {
+    let addr = server.address();
+    // eslint-disable-next-line no-console
+    log(`Test api server starts listening on http://${addr.address}:${addr.port}`);
+});
+server.listen(port, host);

modules/@themost/express/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@themost/express",
-  "version": "1.5.15",
+  "version": "1.6.0",
   "description": "MOST Data ORM Express Middleware",
   "main": "dist/themost_express.cjs.js",
   "module": "dist/themost_express.esm.js",
@@ -35,8 +35,9 @@
   },
   "dependencies": {
     "express": "^4.16.3",
-    "lodash": "^4.17.11",
+    "lodash": "^4.17.21",
     "multer": "^1.4.2",
+    "on-headers": "^1.0.2",
     "pluralize": "^7.0.0",
     "q": "^1.5.1",
     "rxjs": "^6.5.4",

modules/@themost/express/src/middleware.d.ts

@@ -62,3 +62,5 @@ export declare function postEntitySetAction(options?: EntitySetOptions): Request
 export declare function getEntityFunction(options?: EntityOptions): RequestHandler;
 
 export declare function postEntityAction(options?: EntityOptions): RequestHandler;
+
+export declare function setHeaders(): RequestHandler;

modules/@themost/express/src/middleware.js

@@ -13,6 +13,7 @@ import {LangUtils, HttpNotFoundError, HttpBadRequestError, HttpMethodNotAllowedE
 import { ResponseFormatter, StreamFormatter } from "./formatter";
 import {multerInstance} from "./multer";
 import fs from 'fs';
+import onHeaders from 'on-headers';
 
 const parseBoolean = LangUtils.parseBoolean;
 const DefaultTopOption = 25;
@@ -1621,8 +1622,18 @@ function getEntitySetIndex() {
         const builder = req.context.getApplication().getStrategy(ODataModelBuilder);
         // get edm document
         return builder.getEdm().then(result => {
+            let contextLink
+            if (typeof builder.getContextLink === 'function') {
+                contextLink = builder.getContextLink(req.context);
+                if (contextLink) {
+                    return res.json({
+                        "@odata.context": contextLink,
+                        "value": result.entityContainer.entitySet
+                    });
+                }
+            }
             return res.json({
-                value: result.entityContainer.entitySet
+                "value": result.entityContainer.entitySet
             });
         }).catch(err => {
             return next(err);
@@ -1653,6 +1664,20 @@ function getMetadataDocument() {
     };
 }
 
+function setHeaders() {
+    return function(_req, res, next) {
+        onHeaders(res, 
+            /**
+             * @this {ServerResponse}
+             */
+            function onSetHeaders() {
+            this.set('OData-Version', '4.0');
+        });
+        return next();
+    }
+}
+
+export {setHeaders};
 export {getEntitySetIndex};
 export {getMetadataDocument};
 export {bindEntitySet};

modules/@themost/express/src/service.js

@@ -15,6 +15,7 @@ import {bindEntitySet} from "./middleware";
 import {getEntitySet} from "./middleware";
 import {postEntitySet} from "./middleware";
 import {deleteEntitySet} from "./middleware";
+import { setHeaders } from './middleware';
 import {getEntity} from "./middleware";
 import {postEntity} from "./middleware";
 import {deleteEntity} from "./middleware";
@@ -45,7 +46,7 @@ function readStream(stream) {
         });
     });
 }
-
+serviceRouter.use(setHeaders());
 /* GET /  */
 serviceRouter.get('/', getEntitySetIndex());
 

modules/@themost/express/src/service.spec.js

@@ -7,6 +7,7 @@ import passport from 'passport';
 import {serviceRouter} from './service';
 import {dateReviver} from './helpers';
 import { ApplicationService } from '@themost/common';
+import { ODataModelBuilder } from '@themost/data';
 
 class ServiceRouterExtension extends ApplicationService {
     constructor(app) {
@@ -88,6 +89,45 @@ describe('serviceRouter', () => {
         //
     });
 
+    it('should GET /api/', async () => {
+        // change user
+        spyOn(passportStrategy, 'getUser').and.returnValue({
+            name: 'alexis.rees@example.com'
+        });
+        let response = await request(app)
+            .get('/api/')
+            .set('Content-Type', 'application/json')
+            .set('Accept', 'application/json');
+        expect(response.status).toBe(200);
+        expect(response.body).toBeTruthy();
+        expect(response.headers['odata-version']).toBe('4.0');
+
+        const dataApplication = app.get('ExpressDataApplication');
+        dataApplication.getService(ODataModelBuilder).hasContextLink(() => {
+            return `http://server.example.com/api/$metadata`;
+         });
+         response = await request(app)
+            .get('/api/')
+            .set('Content-Type', 'application/json')
+            .set('Accept', 'application/json');
+        expect(response.status).toBe(200);
+        expect(Object.prototype.hasOwnProperty.call(response.body, '@odata.context')).toBeTrue();
+        expect(response.body['@odata.context']).toBe('http://server.example.com/api/$metadata');
+
+    });
+
+    it('should GET /api/$metadata', async () => {
+        // change user
+        spyOn(passportStrategy, 'getUser').and.returnValue({
+            name: 'alexis.rees@example.com'
+        });
+        let response = await request(app)
+            .get('/api/$metadata');
+        expect(response.status).toBe(200);
+        expect(response.body).toBeTruthy();
+        expect(response.headers['odata-version']).toBe('4.0');
+    });
+
     it('should GET /api/users/', async () => {
         // change user
         spyOn(passportStrategy, 'getUser').and.returnValue({
@@ -99,6 +139,7 @@ describe('serviceRouter', () => {
             .set('Accept', 'application/json');
         expect(response.status).toBe(200);
         expect(response.body).toBeTruthy();
+        expect(response.headers['odata-version']).toBe('4.0');
     });
 
     it('should use an entity set function', async () => {

modules/@themost/express/src/test/config/models/Product.json

@@ -55,7 +55,7 @@
             "name": "releaseDate",
             "title": "Release Date",
             "description": "The release date of a product or product model. This can be used to distinguish the exact variant of a product.",
-            "type": "Date"
+            "type": "DateTime"
         }
     ],
     "constraints": [