Merge pull request #40 from AtB-AS/master

.graphqlconfig.yml

@@ -0,0 +1,5 @@
+include: 'src/**/*.ts'
+extensions:
+  endpoints:
+    Entur:
+      url: https://api.entur.io/journey-planner/v2/graphql

Readme.md

@@ -37,3 +37,17 @@ API endpoints live in `api/`.
 
 The current implementation uses [@entur/sdk](https://github.com/entur/sdk) as an
 abstraction on top of Entur's GraphQL endpoints.
+
+## GraphQL Code Generation
+
+For endpoints that uses GraphQL directly we generate types and code using
+`graphql-code-gen`. If the queries, scheme, operations or fragments change,
+generate the code using scripts:
+
+```
+npm run gql-gen
+```
+
+This will make a TypeScript representation of the `.graphql` file in the same
+location but with `.graphql-gen.ts` extension. You can use these directly as
+queries.

codegen.yml

@@ -0,0 +1,33 @@
+overwrite: true
+schema: 'https://api.entur.io/journey-planner/v2/graphql'
+documents: ./src/**/*.graphql
+generates:
+  src/graphql/types.ts:
+    config:
+      maybeValue: T
+      skipTypename: true
+      exportFragmentSpreadSubTypes: true
+      preResolveTypes: true
+    plugins:
+      - typescript
+  src/:
+    preset: near-operation-file
+    presetConfig:
+      extension: .graphql-gen.ts
+      baseTypesPath: graphql/types.ts
+    config:
+      withHooks: false
+      withComponent: false
+      withHOC: false
+      withResultType: false
+      skipTypename: true
+      # This causes some types to be wrong (e.g. in departure query dates are any type)
+      # but it makes using the types waay easier. Necessary evil in my mind.
+      preResolveTypes: true
+      exportFragmentSpreadSubTypes: true
+      # Looks like almost all types in the GraphQL server is optional but actually are set. The Maybe combinator
+      # is a pain to work with when traversing the types.
+      maybeValue: T
+    plugins:
+      - 'typescript-operations'
+      - 'typescript-react-apollo'

package.json

@@ -8,55 +8,67 @@
     "start": "node dist/index.js",
     "start:dev": "ts-node --files ./src/index.ts",
     "start:watch": "nodemon",
-    "test": "jest"
+    "test": "jest",
+    "gql-gen": "graphql-codegen --config codegen.yml"
   },
   "keywords": [],
   "author": "",
   "license": "EUPL-1.2",
   "devDependencies": {
+    "@graphql-codegen/cli": "1.17.4",
+    "@graphql-codegen/near-operation-file-preset": "^1.17.4",
+    "@graphql-codegen/typescript": "1.17.4",
+    "@graphql-codegen/typescript-operations": "^1.17.4",
+    "@graphql-codegen/typescript-react-apollo": "^1.17.4",
     "@types/hapi__inert": "^5.2.0",
     "@types/hapi__vision": "^5.5.1",
-    "@types/jest": "^24.9.1",
+    "@types/jest": "^26.0.5",
     "@types/lodash.sortby": "^4.7.6",
     "@types/logfmt": "^1.2.1",
     "@types/lz-string": "^1.3.34",
-    "@types/node": "^13.13.9",
+    "@types/node": "^14.0.24",
     "@types/node-fetch": "^2.5.7",
-    "@types/uuid": "^7.0.4",
-    "jest": "^25.5.4",
+    "@types/uuid": "^8.0.0",
+    "copyfiles": "^2.3.0",
+    "jest": "^26.1.0",
     "nodemon": "^2.0.4",
-    "prettier": "^1.19.1",
-    "ts-jest": "^25.5.1",
-    "ts-node": "^8.10.1",
-    "typescript": "^3.9.3"
+    "prettier": "^2.0.5",
+    "ts-jest": "^26.1.3",
+    "ts-node": "^8.10.2",
+    "typescript": "^3.9.7"
   },
   "dependencies": {
     "@badrap/result": "^0.2.6",
-    "@entur/sdk": "^1.5.2",
-    "@google-cloud/pubsub": "^1.7.3",
-    "@google-cloud/trace-agent": "^4.2.5",
+    "@entur/sdk": "^1.7.2",
+    "@google-cloud/pubsub": "^2.3.0",
+    "@google-cloud/trace-agent": "^5.1.0",
     "@hapi/boom": "^9.1.0",
-    "@hapi/hapi": "^19.1.1",
+    "@hapi/hapi": "^19.2.0",
     "@hapi/inert": "^6.0.1",
     "@hapi/vision": "^6.0.0",
-    "@opencensus/core": "0.0.20",
-    "@opencensus/exporter-stackdriver": "0.0.20",
+    "@opencensus/core": "0.0.22",
+    "@opencensus/exporter-stackdriver": "0.0.22",
     "@types/continuation-local-storage": "^3.2.2",
-    "@types/hapi__hapi": "^19.0.3",
-    "agentkeepalive": "^4.1.2",
-    "date-fns": "^2.14.0",
-    "google-auth-library": "^5.10.1",
+    "@types/hapi__hapi": "^19.0.4",
+    "agentkeepalive": "^4.1.3",
+    "apollo-cache-inmemory": "^1.6.6",
+    "apollo-client": "^2.6.10",
+    "apollo-link-http": "^1.5.17",
+    "date-fns": "^2.15.0",
+    "google-auth-library": "^6.0.5",
+    "graphql": "^15.3.0",
+    "graphql-tag": "^2.10.4",
     "hapi-api-version": "^2.3.1",
     "hapi-pulse": "^3.0.0",
-    "hapi-swagger": "^12.1.3",
+    "hapi-swagger": "^13.0.2",
     "haversine-distance": "^1.2.1",
     "lodash.sortby": "^4.7.0",
     "logfmt": "^1.3.2",
     "lz-string": "^1.4.4",
     "node-fetch": "^2.6.0",
-    "p-limit": "^2.3.0",
+    "p-limit": "^3.0.2",
     "p-throttle": "^3.1.0",
-    "uuid": "^7.0.3"
+    "uuid": "^8.2.0"
   },
   "nodemonConfig": {
     "ignore": [

src/api/__test__/stops.test.ts

@@ -23,6 +23,12 @@ const svc: jest.Mocked<IStopsService> = {
     Result.ok(Promise.resolve([]))
   ),
   getDepartures: jest.fn((...args: any): any => Result.ok(Promise.resolve([]))),
+  getDeparturesPaging: jest.fn((...args: any): any =>
+    Result.ok(Promise.resolve([]))
+  ),
+  getDepartureRealtime: jest.fn((...args: any): any =>
+    Result.ok(Promise.resolve([]))
+  ),
   getNearestPlaces: jest.fn((...args: any): any =>
     Result.ok(Promise.resolve([]))
   ),

src/api/stops/index.ts

@@ -12,7 +12,9 @@ import {
   getDeparturesBetweenStopPlacesRequest,
   getStopPlacesByNameRequest,
   getNearestDeparturesRequest,
-  getDeparturesRequest
+  getDeparturesRequest,
+  getDepartureRealtime,
+  getDeparturesPagingRequest
 } from './schema';
 import {
   StopPlaceQuery,
@@ -24,7 +26,9 @@ import {
   StopPlaceByNameQuery,
   NearestDeparturesQuery,
   FeatureLocation,
-  DeparturesFromLocationQuery
+  DeparturesFromLocationQuery,
+  DepartureRealtimeQuery,
+  DeparturesFromLocationPagingQuery
 } from '../../service/types';
 
 export default (server: Hapi.Server) => (service: IStopsService) => {
@@ -190,4 +194,33 @@ export default (server: Hapi.Server) => (service: IStopsService) => {
       return (await service.getDepartures(locaton, query)).unwrap();
     }
   });
+  server.route({
+    method: 'POST',
+    path: '/bff/v1/departures-from-location-paging',
+    options: {
+      tags: ['api', 'stops', 'departures'],
+      validate: getDeparturesPagingRequest,
+      description: 'Get departures from feature location'
+    },
+    handler: async (request, h) => {
+      const locaton = (request.payload as unknown) as FeatureLocation;
+      const query = (request.query as unknown) as DeparturesFromLocationPagingQuery;
+
+      return (await service.getDeparturesPaging(locaton, query)).unwrap();
+    }
+  });
+  server.route({
+    method: 'GET',
+    path: '/bff/v1/departures-realtime',
+    options: {
+      tags: ['api', 'stops', 'departures', 'realtime'],
+      validate: getDepartureRealtime,
+      description:
+        'Get updated realtime information of all lines and quays passed as data'
+    },
+    handler: async (request, h) => {
+      const query = (request.query as unknown) as DepartureRealtimeQuery;
+      return (await service.getDepartureRealtime(query)).unwrap();
+    }
+  });
 };

src/api/stops/schema.ts

@@ -26,6 +26,7 @@ export const getStopPlaceDeparturesRequest = {
     includeNonBoarding: Joi.bool()
   })
 };
+
 export const getDeparturesRequest = {
   payload: Joi.object({
     layer: Joi.string(),
@@ -40,6 +41,36 @@ export const getDeparturesRequest = {
     walkSpeed: Joi.number().default(1.3)
   })
 };
+
+export const getDeparturesPagingRequest = {
+  payload: Joi.object({
+    layer: Joi.string(),
+    id: Joi.string(),
+    coordinates: Joi.object({ longitude: Joi.number(), latitude: Joi.number() })
+  }).options({ allowUnknown: true }),
+
+  query: Joi.object({
+    limit: Joi.number().default(5),
+    startTime: Joi.date(),
+
+    // Paging
+    pageSize: Joi.number().default(10),
+    pageOffset: Joi.number().default(0),
+
+    // Deprecated fields
+    offset: Joi.number().default(ONE_MINUTE).description('Deprecated'),
+    walkSpeed: Joi.number().default(1.3).description('Deprecated')
+  })
+};
+
+export const getDepartureRealtime = {
+  query: Joi.object({
+    quayIds: Joi.array().items(Joi.string()).default([]),
+    startTime: Joi.date(),
+    limit: Joi.number().default(5)
+  })
+};
+
 export const getDeparturesFromQuayRequest = getStopPlaceDeparturesRequest;
 
 export const getNearestDeparturesRequest = {

src/graphql/graphql-client.ts

@@ -0,0 +1,30 @@
+import ApolloClient, { DefaultOptions } from 'apollo-client';
+import { InMemoryCache } from 'apollo-cache-inmemory';
+import { HttpLink } from 'apollo-link-http';
+import fetch from 'node-fetch';
+
+const link = new HttpLink({
+  uri: 'https://api.entur.io/journey-planner/v2/graphql',
+
+  // node-fetch uses a different signature than the browser implemented fetch
+  // But we use node-fetch's agent option in other parts of the project.
+  // The functionallity overlaps so this works as expected.
+  fetch: (fetch as unknown) as WindowOrWorkerGlobalScope['fetch']
+});
+
+const defaultOptions: DefaultOptions = {
+  watchQuery: {
+    fetchPolicy: 'cache-and-network',
+    errorPolicy: 'ignore'
+  },
+  query: {
+    fetchPolicy: 'network-only',
+    errorPolicy: 'all'
+  }
+};
+
+export default new ApolloClient({
+  link,
+  cache: new InMemoryCache(),
+  defaultOptions
+});