Merge pull request #70 from SGO34/upgrade-gsg-Steve

Edited README with new Apollo server instructions and link to documentation

Author: vincentdesmares

.github/workflows/nodejs.yml

@@ -8,7 +8,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [12.18.1]
+        node-version: [16.14.0]
 
     steps:
       - uses: actions/checkout@v1

.nvmrc

@@ -1 +1 @@
-10.15.0
+16.14.0

CHANGELOG.md

@@ -2,25 +2,25 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
-## [7.5.0](https://github.com/teamstarter/graphql-sequelize-generator/compare/v7.4.1...v7.5.0) (2021-10-19)
-
+### [7.5.1](https://github.com/teamstarter/graphql-sequelize-generator/compare/v7.5.0...v7.5.1) (2022-01-20)
 
 ### Features
 
-* **count:** Allow the count to have extra args. Use the ones from list if not specified. ([5ad2d81](https://github.com/teamstarter/graphql-sequelize-generator/commit/5ad2d81))
-* **count-extra-arguments:** added the abbility to add an extra argum ([f128137](https://github.com/teamstarter/graphql-sequelize-generator/commit/f128137))
-* **count-extra-arguments:** added the abbility to add an extra argument to the count query ([5c24eba](https://github.com/teamstarter/graphql-sequelize-generator/commit/5c24eba))
+- **webhooks:** Make it easier to use graphql-web-hooks with GSG.
+
+## [7.5.0](https://github.com/teamstarter/graphql-sequelize-generator/compare/v7.4.1...v7.5.0) (2021-10-19)
 
+### Features
 
+- **count:** Allow the count to have extra args. Use the ones from list if not specified. ([5ad2d81](https://github.com/teamstarter/graphql-sequelize-generator/commit/5ad2d81))
+- **count-extra-arguments:** added the abbility to add an extra argum ([f128137](https://github.com/teamstarter/graphql-sequelize-generator/commit/f128137))
+- **count-extra-arguments:** added the abbility to add an extra argument to the count query ([5c24eba](https://github.com/teamstarter/graphql-sequelize-generator/commit/5c24eba))
 
 ### [7.4.1](https://github.com/teamstarter/graphql-sequelize-generator/compare/v7.4.0...v7.4.1) (2021-09-21)
 
-
 ### Bug Fixes
 
-* **parent-obejct-attributes:** Fix an issue with HasOne relations that failed to be fetched. ([ce28b57](https://github.com/teamstarter/graphql-sequelize-generator/commit/ce28b57))
-
-
+- **parent-obejct-attributes:** Fix an issue with HasOne relations that failed to be fetched. ([ce28b57](https://github.com/teamstarter/graphql-sequelize-generator/commit/ce28b57))
 
 ## [7.4.0](https://github.com/teamstarter/graphql-sequelize-generator/compare/v7.3.5...v7.4.0) (2021-08-10)
 

README.md

@@ -5,9 +5,10 @@ easily generate a GraphQL API from your sequelize models.
 
 It's a very good fit for POCs and MVPs, while also scaling pretty well thanks to [dataloader-sequelize](https://github.com/mickhansen/dataloader-sequelize).
 
-## Manual
+---
 
-Get started with **[the online documentation](https://teamstarter.github.io/gsg-documentation/)**
+## Documentation
+The complete documentation car be found [here](https://teamstarter.github.io/gsg-documentation/)
 
 ## What can I do with GSG?
 
@@ -23,44 +24,92 @@ The tools provided by this library will allow you to:
 - Add custom fields/resolvers on auto-generated types.
 - Easy integration with [dataloader-sequelize](https://github.com/mickhansen/dataloader-sequelize)
 
+---
+
 ## Getting started
 
-Add the lib and the peer dependencies:
+---
+
+### Setting up the dependencies and the library
+
+Add the lib and the peer dependencies of GraphQL-Sequelize-Generator:
 
 ```
-$ yarn add graphql-sequelize-generator graphql sequelize graphql-sequelize
+yarn add graphql-sequelize-generator graphql sequelize graphql-sequelize @apollo/server dataloader-sequelize graphql-relay ws
 ```
 
-⚠️ Caution: GSG requires at least Node v9.11.2 or greater as it is using async/await.
+⚠️ Caution: GSG requires Node v9.11.2 or greater as it is using async/await.
+
+---
+
+### Initializing the project with Sequelize-CLI and adding data to the database
 
-Then you will be ready to add a GraphQL API to your express server with only a few lines of code:
+If you need to initialize the project, please follow this Sequelize documentation page : [Sequelize-Cli and Migrations](https://sequelize.org/docs/v6/other-topics/migrations/)
+
+---
+
+# Setting up your server
+
+Create a file where you will set up your server and paste the following code. We used index.js (at the root of our example project):
 
 ```javascript
-import express from 'express'
-const {
-  generateModelTypes,
-  generateGraphqlExpressMiddleware
-} = require('graphql-sequelize-generator')
-import models from './models'
-
-const types = generateModelTypes(models)
-
-graphqlSchemaDeclaration.user = {
-  model: models.user,
-  actions: ['list', 'create']
-}
-
-const server = generateApolloServer({
-  graphqlSchemaDeclaration,
-  types,
-  models
-})
-
-const app = express()
-server.applyMiddleware({
-  app,
-  path: '/graphql'
-})
+// index.js
+const { expressMiddleware } = require("@apollo/server/express4");
+const express = require("express");
+const http = require("http");
+const cors = require("cors");
+const json = require("body-parser");
+const { createContext, EXPECTED_OPTIONS_KEY } = require("dataloader-sequelize");
+const setupServer = require("./schema");
+const models = require("./models"); //Assuming "models" is your import of the Sequelize models folder, initialized by Sequelize-Cli
+
+const createServer = async (options = {}, globalPreCallback = () => null) => {
+  const app = express();
+  options = {
+    spdy: { plain: true },
+    ...options,
+  };
+  const httpServer = http.createServer(options, app);
+  const { server } = setupServer(globalPreCallback, httpServer);
+  await server.start();
+  //server.applyMiddleware({ app, path: '/graphql' })
+  app.use(
+    "/graphql",
+    cors(),
+    json(),
+    expressMiddleware(server, {
+      context: async ({ req, connection }) => {
+        const contextDataloader = createContext(models.sequelize);
+
+        // Connection is provided when a webSocket is connected.
+        if (connection) {
+          // check connection for metadata
+          return {
+            ...connection.context,
+            [EXPECTED_OPTIONS_KEY]: contextDataloader,
+          };
+        }
+      },
+    })
+  );
+
+  await new Promise((resolve) => {
+    httpServer.listen(process.env.PORT || 8080, () => {
+      resolve();
+    });
+
+    console.log(
+      `🚀 Server ready at http://localhost:${process.env.PORT || 8080}/graphql`
+    );
+  });
+  return httpServer;
+};
+
+const closeServer = async (server) => {
+  await Promise.all([new Promise((resolve) => server.close(() => resolve()))]);
+};
+
+createServer();
 ```
 
 ## Getting started with boilerplates
@@ -69,3 +118,4 @@ You can easily start a project with graphql-sequelize-generator using these boil
 
 - In JavaScript : [GSG Boilerplate](https://github.com/teamstarter/gsg-boilerplate)
 - In TypeScript : [GSG Typescript Boilerplate](https://github.com/teamstarter/gsg-boilerplate-typescript)
+

lib/associations/field.js

@@ -7,7 +7,7 @@ function generateAssociationField(relation, types, graphqlSchemaDeclaration, mod
     var newBaseType = graphqlSchemaDeclaration &&
         // @ts-ignore
         !types[relation.target.name].associationsInjected
-        ? __1.injectAssociations(types[relation.target.name], graphqlSchemaDeclaration, types, models, globalPreCallback)
+        ? (0, __1.injectAssociations)(types[relation.target.name], graphqlSchemaDeclaration, types, models, globalPreCallback)
         : types[relation.target.name];
     var type = relation.associationType === 'BelongsToMany' ||
         relation.associationType === 'HasMany'
@@ -23,7 +23,7 @@ function generateAssociationField(relation, types, graphqlSchemaDeclaration, mod
                 // An arg with the key order will automatically be converted to a order on the target
                 name: 'order',
                 type: graphql_1.GraphQLString
-            }
+            },
         ]
     };
     if (relation.associationType === 'HasMany') {

lib/associations/fields.js

@@ -16,7 +16,7 @@ var field_1 = __importDefault(require("./field"));
 function generateAssociationsFields(associations, types) {
     var fields = {};
     for (var associationName in associations) {
-        fields[associationName] = field_1["default"](associations[associationName], types);
+        fields[associationName] = (0, field_1["default"])(associations[associationName], types);
     }
     return fields;
 }

lib/associations/inject.js

@@ -18,7 +18,7 @@ var debug_1 = __importDefault(require("debug"));
 var graphql_sequelize_1 = require("graphql-sequelize");
 var createResolver_1 = __importDefault(require("../createResolver"));
 var field_1 = __importDefault(require("./field"));
-var debug = debug_1["default"]('gsg');
+var debug = (0, debug_1["default"])('gsg');
 function injectAssociations(modelGraphQLType, graphqlSchemaDeclaration, outputTypes, models, globalPreCallback, proxyModelName) {
     if (proxyModelName === void 0) { proxyModelName = null; }
     var modelName = proxyModelName || modelGraphQLType.name;
@@ -34,18 +34,18 @@ function injectAssociations(modelGraphQLType, graphqlSchemaDeclaration, outputTy
     var associationsFields = {};
     for (var associationName in associations) {
         if (!graphqlSchemaDeclaration[associations[associationName].target.name]) {
-            debug("Cannot generate the association for model [" + associations[associationName].target.name + "] as it wasn't declared in the schema declaration. Skipping it.");
+            debug("Cannot generate the association for model [".concat(associations[associationName].target.name, "] as it wasn't declared in the schema declaration. Skipping it."));
             continue;
         }
-        associationsFields[associationName] = field_1["default"](associations[associationName], outputTypes, graphqlSchemaDeclaration, models, globalPreCallback, createResolver_1["default"](graphqlSchemaDeclaration[associations[associationName].target.name], models, globalPreCallback, associations[associationName]));
+        associationsFields[associationName] = (0, field_1["default"])(associations[associationName], outputTypes, graphqlSchemaDeclaration, models, globalPreCallback, (0, createResolver_1["default"])(graphqlSchemaDeclaration[associations[associationName].target.name], models, globalPreCallback, associations[associationName]));
     }
     // We have to mutate the original field, as type names must be unique
     // We cannot return a new type as the type may have already been used
     // In previous models.
     var baseFields = {};
     var modelDefinition = graphqlSchemaDeclaration[modelName];
     if (typeof modelDefinition !== 'undefined') {
-        baseFields = graphql_sequelize_1.attributeFields(modelDefinition.model, {
+        baseFields = (0, graphql_sequelize_1.attributeFields)(modelDefinition.model, {
             allowNull: false,
             exclude: modelDefinition.excludeFields,
             commentToDescription: true

lib/createResolver.js

@@ -25,7 +25,7 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
     function verb(n) { return function (v) { return step([n, v]); }; }
     function step(op) {
         if (f) throw new TypeError("Generator is already executing.");
-        while (_) try {
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
             if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
             if (y = 0, t) op = [op[0] & 2, t.value];
             switch (op[0]) {
@@ -90,7 +90,7 @@ function allowOrderOnAssociations(findOptions, model) {
         if (parts.length === 2) {
             var associationName = parts[0];
             if (typeof model.associations[associationName] === 'undefined') {
-                throw new Error("Association " + associationName + " unknown on model " + model.name + " order");
+                throw new Error("Association ".concat(associationName, " unknown on model ").concat(model.name, " order"));
             }
             if (typeof findOptions.include === 'undefined') {
                 findOptions.include = [];
@@ -191,7 +191,7 @@ function createResolver(graphqlTypeDeclaration, models, globalPreCallback, relat
     var listAfter = graphqlTypeDeclaration.list && graphqlTypeDeclaration.list.after
         ? graphqlTypeDeclaration.list.after
         : undefined;
-    return graphql_sequelize_1.resolver(relation || graphqlTypeDeclaration.model, {
+    return (0, graphql_sequelize_1.resolver)(relation || graphqlTypeDeclaration.model, {
         contextToOptions: graphqlTypeDeclaration.list
             ? graphqlTypeDeclaration.list.contextToOptions
             : undefined,
@@ -263,11 +263,11 @@ function createResolver(graphqlTypeDeclaration, models, globalPreCallback, relat
                         return [2 /*return*/, graphqlTypeDeclaration.list &&
                                 graphqlTypeDeclaration.list.removeUnusedAttributes === false
                                 ? result
-                                : removeUnusedAttributes_1["default"](result, info, graphqlTypeDeclaration.model, models)];
+                                : (0, removeUnusedAttributes_1["default"])(result, info, graphqlTypeDeclaration.model, models)];
                     case 10: return [2 /*return*/, graphqlTypeDeclaration.list &&
                             graphqlTypeDeclaration.list.removeUnusedAttributes === false
                             ? processedFindOptions
-                            : removeUnusedAttributes_1["default"](processedFindOptions, info, graphqlTypeDeclaration.model, models)];
+                            : (0, removeUnusedAttributes_1["default"])(processedFindOptions, info, graphqlTypeDeclaration.model, models)];
                 }
             });
         }); },

lib/generateApolloServer.js

@@ -15,11 +15,13 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 exports.__esModule = true;
 var graphql_1 = require("graphql");
-var apollo_server_express_1 = require("apollo-server-express");
+var server_1 = require("@apollo/server");
+var disabled_1 = require("@apollo/server/plugin/disabled");
+var ws_1 = require("graphql-ws/lib/use/ws");
 var schema_1 = __importDefault(require("./schema"));
 function generateApolloServer(_a) {
-    var graphqlSchemaDeclaration = _a.graphqlSchemaDeclaration, customMutations = _a.customMutations, types = _a.types, models = _a.models, _b = _a.apolloServerOptions, apolloServerOptions = _b === void 0 ? {} : _b, _c = _a.pubSubInstance, pubSubInstance = _c === void 0 ? null : _c, _d = _a.callWebhook, callWebhook = _d === void 0 ? function () { return null; } : _d, _e = _a.globalPreCallback, globalPreCallback = _e === void 0 ? function () { return null; } : _e;
-    var graphqlSchema = new graphql_1.GraphQLSchema(schema_1["default"]({
+    var graphqlSchemaDeclaration = _a.graphqlSchemaDeclaration, customMutations = _a.customMutations, types = _a.types, models = _a.models, _b = _a.apolloServerOptions, apolloServerOptions = _b === void 0 ? {} : _b, _c = _a.pubSubInstance, pubSubInstance = _c === void 0 ? null : _c, _d = _a.callWebhook, callWebhook = _d === void 0 ? function () { return null; } : _d, _e = _a.wsServer, wsServer = _e === void 0 ? null : _e, _f = _a.globalPreCallback, globalPreCallback = _f === void 0 ? function () { return null; } : _f;
+    var graphqlSchema = new graphql_1.GraphQLSchema((0, schema_1["default"])({
         graphqlSchemaDeclaration: graphqlSchemaDeclaration,
         customMutations: customMutations,
         types: types,
@@ -28,6 +30,11 @@ function generateApolloServer(_a) {
         pubSubInstance: pubSubInstance,
         callWebhook: callWebhook
     }));
-    return new apollo_server_express_1.ApolloServer(__assign({ schema: graphqlSchema, cacheControl: false }, apolloServerOptions));
+    // Hand in the schema we just created and have the
+    // WebSocketServer start listening.
+    if (wsServer) {
+        (0, ws_1.useServer)({ schema: graphqlSchema }, wsServer);
+    }
+    return new server_1.ApolloServer(__assign({ schema: graphqlSchema, plugins: [(0, disabled_1.ApolloServerPluginCacheControlDisabled)()] }, apolloServerOptions));
 }
 exports["default"] = generateApolloServer;

lib/generateTypes/graphQLType.js

@@ -29,11 +29,11 @@ function generateGraphQLType(model, types, isInput) {
     if (isInput === void 0) { isInput = false; }
     var GraphQLClass = isInput ? GraphQLInputObjectType : GraphQLObjectType;
     var type = new GraphQLClass({
-        name: isInput ? model.name + "Input" : model.name,
+        name: isInput ? "".concat(model.name, "Input") : model.name,
         fields: function () { return (__assign(__assign({}, attributeFields(model, {
             allowNull: !!isInput,
             commentToDescription: true
-        })), (isInput ? fields_1["default"](model.associations, types) : {}))); }
+        })), (isInput ? (0, fields_1["default"])(model.associations, types) : {}))); }
     });
     return type;
 }