Merge pull request #166 from neo4j/updates-for-ogm-installation-page

Updates for ogm installation page

Author: rsill-neo4j

modules/ROOT/pages/ogm/installation.adoc

@@ -1,10 +1,10 @@
 [[ogm-installation]]
-:description: This page describes how to install the OGM in Neo4j GraphQL and includes examples of how to use it.
+:description: This page describes how to install the OGM in Neo4j GraphQL and how to use it.
 = Installation
 :page-aliases: ogm/examples/index.adoc
 
-The OGM can be installed into a new or existing Node.js project in a similar way to the installation of the Neo4j GraphQL Library.
-As such, it requires some dependencies to be included:
+You can install the OGM into a new or existing Node.js project in a similar way to how you install the Neo4j GraphQL Library.
+It has the following dependencies:
 
 * `@neo4j/graphql-ogm`: the OGM package.
 * `graphql`: the package used by the Neo4j GraphQL Library to generate a schema and execute queries and mutations.
@@ -15,54 +15,49 @@ As such, it requires some dependencies to be included:
 npm install @neo4j/graphql-ogm graphql neo4j-driver
 ----
 
-To use the OGM, you must always import it:
-
-[source, javascript, indent=0]
-----
-const { OGM } = require("@neo4j/graphql-ogm");
-----
 
 == Usage examples
 
-Here are some examples of how you might take advantage of the OGM.
+Here are some examples of how you can use the OGM.
 
 [[ogm-examples-custom-resolvers]]
 === Custom Resolvers
 
-A common case for using the OGM will be within custom resolvers inside a Neo4j GraphQL instance (very meta!), due to the fact that it has access to some fields which the Neo4j GraphQL Library may not. A common use case might be to have a `password` field marked with directive `@private`, and a custom resolver for creating users with passwords.
+The OGM has access to some fields which the Neo4j GraphQL Library doesn't.
+It is common practice to use the OGM to create custom resolvers when dealing with such fields.
+For example, you can have a `password` field marked with the `@private` directive and a custom resolver for creating users with passwords.
 
-To get started with this example, create your example application directory, create a new project and also the file which will contain your application code:
+Execute the following to create an example application directory and create a new project:
 
 [source, bash, indent=0]
 ----
 mkdir ogm-custom-resolvers-example
 cd ogm-custom-resolvers-example
-npm init --yes
+npm init es6 --yes
 touch index.js
 ----
 
-Then you need to install your dependencies:
+Install the dependencies:
 
 [source, bash, indent=0]
 ----
-npm install @neo4j/graphql-ogm graphql neo4j-driver apollo-server
+npm install @neo4j/graphql-ogm graphql neo4j-driver @apollo/server
 ----
 
-Assuming a running Neo4j database at "bolt://localhost:7687" with username "neo4j" and password "password", in your empty `index.js` file, add the following code:
+Assuming a running Neo4j database at "neo4j://localhost:7687" with username "username" and password "password", in your empty `index.js` file, add the following code:
 
 [source, javascript, indent=0]
 ----
 import { ApolloServer } from "@apollo/server";
 import { startStandaloneServer } from "@apollo/server/standalone";
-import { Neo4jGraphQLAuthJWTPlugin } from "@neo4j/graphql-plugin-auth";
 import { Neo4jGraphQL } from "@neo4j/graphql";
 import { OGM } from "@neo4j/graphql-ogm";
 import neo4j from "neo4j-driver";
 
-import { createJWT, comparePassword } from "./utils"; // example util function, more information below
+import { createJWT, comparePassword } from "./utils.js"; // example util function, more information below
 
 const driver = neo4j.driver(
-    "bolt://localhost:7687",
+    "neo4j://localhost:7687",
     neo4j.auth.basic("username", "password")
 );
 
@@ -106,55 +101,73 @@ const resolvers = {
 
             return createJWT({ sub: users[0].id });
         },
+
         signIn: async (_source, { username, password }) => {
             const [user] = await User.find({
                 where: {
                     username,
                 },
             });
-
+        
             if (!user) {
                 throw new Error(`User with username ${username} not found!`);
             }
 
             const correctPassword = await comparePassword(password, user.password);
 
             if (!correctPassword) {
-                throw new Error(`Incorrect password for user with username ${username}!`);
+                throw new Error(
+                    `Incorrect password for user with username ${username}!`
+                );
             }
 
             return createJWT({ sub: user.id });
         },
     },
 };
 
+
 const neoSchema = new Neo4jGraphQL({
     typeDefs,
     driver,
     resolvers,
-    plugins: {
-        auth: new Neo4jGraphQLAuthJWTPlugin({
-            secret: "secret"
-        })
-    }
+    features: {
+        authorization: {
+            key: "secret",
+        },
+    },
 });
 
-Promise.all([neoSchema.getSchema(), ogm.init()]).then(([schema]) => {
+async function main() {
+    await ogm.init();
+
     const server = new ApolloServer({
-        schema,
+        schema: await neoSchema.getSchema(),
     });
 
-    startStandaloneServer(server, {
-        context: async ({ req }) => ({ req }),
-    }).then(({ url }) =>  {
-        console.log(`🚀 Server ready at ${url}`);
+    const { url } = await startStandaloneServer(server, {
+        listen: { port: 4000 },
+        context: async ({ req }) => ({
+            token: req.headers.authorization,
+        }),
     });
-});
+
+    console.log(`🚀 Server ready at ${url}`);
+}
+
+main();
 ----
 
-It's important to note the JWT secret being passed into the `Neo4jGraphQL` constructor in this example.
+Create the file `utils.js` in the same directory.
+Install additional dependencies:
+
+[source, bash, indent=0]
+----
+npm install bcrypt jsonwebtoken
+----
+
+Add the following code to `utils.js`:
 
-Additionally, an example implementation for the util functions `createJWT` and `comparePassword` is provided in this code snippet:
 [source, javascript, indent=0]
 ----
 import bcrypt from "bcrypt";
@@ -167,7 +180,7 @@ export function createJWT(data) {
                 return reject(err);
             }
 
-            return resolve(token as string);
+            return resolve(token);
         });
     });
 }
@@ -187,11 +200,11 @@ export function comparePassword(plainText, hash) {
 
 [NOTE]
 ====
-This code for the util functions `createJWT` and `comparePassword` is an example. 
-You will likely need to adjust it to suit your use case.
+The code for the util functions `createJWT` and `comparePassword` is an example. 
+Adjust it to suit your use case.
 ====
 
-Back in the command line, run the following command to start your server:
+Back on the command line, run the following command to start your server:
 
 [source, bash, indent=0]
 ----
@@ -205,31 +218,32 @@ You should see the following output:
 🚀 Server ready at http://localhost:4000/
 ----
 
-You can execute the `signUp` Mutation against this GraphQL API to sign up, but when you go to query the user through the same API, the password field will not be available.
+You can execute the `signUp` mutation against the GraphQL API to sign up, but if you try querying the user through the same API, the password field will not be available.
 
 [[ogm-examples-rest-api]]
 === REST API
 
-This example demonstrates how you might use the OGM without exposing a Neo4j GraphQL API endpoint. The example starts an https://expressjs.com/[Express] server and uses the OGM to interact with the Neo4j GraphQL Library, exposed over a REST endpoint.
+This example demonstrates how you can use the OGM without exposing a Neo4j GraphQL API endpoint.
+It starts an https://expressjs.com/[Express] server and uses the OGM to interact with the Neo4j GraphQL Library, exposed via a REST endpoint.
 
-First, create your example application directory, create a new project and also the file which will contain yur application code:
+Execute the following to create an example application directory and a new project:
 
 [source, bash, indent=0]
 ----
 mkdir ogm-rest-example
 cd ogm-rest-example
-npm init --yes
+npm init es6 --yes
 touch index.js
 ----
 
-Then you need to install your dependencies:
+Install the dependencies:
 
 [source, bash, indent=0]
 ----
 npm install @neo4j/graphql-ogm graphql neo4j-driver express
 ----
 
-Assuming a running Neo4j database at "bolt://localhost:7687" with username "neo4j" and password "password", in your empty `index.js` file, add the following code:
+Assuming a running Neo4j database at "neo4j://localhost:7687" with username "username" and password "password", in your empty `index.js` file, add the following code:
 
 [source, javascript, indent=0]
 ----
@@ -238,8 +252,8 @@ import { OGM } from "@neo4j/graphql-ogm";
 import neo4j from "neo4j-driver";
 
 const driver = neo4j.driver(
-    "bolt://localhost:7687",
-    neo4j.auth.basic("username", "password")
+  "bolt://localhost:7687",
+  neo4j.auth.basic("username", "password")
 );
 
 const typeDefs = `
@@ -249,34 +263,39 @@ const typeDefs = `
     }
 `;
 
-const ogm = new OGM({ typeDefs, driver });
+const ogm = new OGM({
+  typeDefs,
+  driver,
+  features: { filters: { String: { MATCHES: true } } },
+});
+
 const User = ogm.model("User");
 
 const app = express();
 
 app.get("/users", async (req, res) => {
-    const { search, offset, limit, sort } = req.query;
+  const { search, offset, limit, sort } = req.query;
 
-    const regex = search ? `(?i).*${search}.*` : null;
+  const regex = search ? `(?i).*${search}.*` : null;
 
-    const users = await User.find({
-        where: { name_REGEX: regex },
-        options: {
-            offset,
-            limit,
-            sort
-        }
-    });
+  const users = await User.find({
+    where: { name_MATCHES: regex },
+    options: {
+      offset,
+      limit,
+      sort,
+    },
+  });
 
-    return res.json(users).end();
+  return res.json(users).end();
 });
 
 const port = 4000;
 
 ogm.init().then(() => {
-    app.listen(port, () => {
-        console.log("Example app listening at http://localhost:${port}")
-    });
+  app.listen(port, () => {
+    console.log(`Example app listening at http://localhost:${port}/users`);
+  });
 });
 ----
 
@@ -287,11 +306,11 @@ In your application directory, you can run this application:
 node index.js
 ----
 
-Which should output:
+You should see the following output:
 
 [source, bash, indent=0]
 ----
-Example app listening at http://localhost:4000
+Example app listening at http://localhost:4000/users
 ----
 
-The REST API should now be ready to accept requests at the URL logged.
+The REST API should now be available at `http://localhost:4000`, with a single working route `/users`.