Merge pull request #14 from Speckle-Next/matteo/gql

Matteo/gql

.editorconfig

@@ -7,3 +7,4 @@ charset = utf-8
 end_of_line = lf
 insert_final_newline = true
 trim_trailing_whitespace = true
+spaces_around_brackets = both

.eslintrc.json

@@ -7,13 +7,46 @@
     "parserOptions": {
         "ecmaVersion": 11
     },
-    "ignorePatterns": [ "modules/*/tests/*", "node_modules/*", "frontend/*"],
+    "ignorePatterns": [
+        "modules/*/tests/*",
+        "node_modules/*",
+        "frontend/*"
+    ],
     "rules": {
-      "arrow-spacing": [ 2, { "before": true, "after": true } ],
-      "array-bracket-spacing": [ 2, "always" ],
-      "block-spacing": [ 2, "always" ],
-      "camelcase": [ 1, { "properties": "always" } ],
-      "space-in-parens": [ 2, "always" ],
-      "keyword-spacing": 2
+        "arrow-spacing": [
+            2,
+            {
+                "before": true,
+                "after": true
+            }
+        ],
+        "array-bracket-spacing": [
+            2,
+            "always"
+        ],
+        "block-spacing": [
+            2,
+            "always"
+        ],
+        "camelcase": [
+            1,
+            {
+                "properties": "always"
+            }
+        ],
+        "space-in-parens": [
+            2,
+            "always"
+        ],
+        "keyword-spacing": 2,
+        "semi": "off",
+        "indent": [
+            "error",
+            2
+        ],
+        "padded-blocks": [
+            "error",
+            "never"
+        ]
     }
-}
+}

modules/core/graph/resolvers/branches.js

@@ -30,6 +30,8 @@ module.exports = {
   Stream: {
 
     async branches( parent, args, context, info ) {
+      if ( args.limit && args.limit > 100 )
+        throw new UserInputError( 'Cannot return more than 100 items, please use pagination.' )
       let { items, cursor, totalCount } = await getBranchesByStreamId( { streamId: parent.id, limit: args.limit, cursor: args.cursor } )
 
       return { totalCount, cursor, items }

modules/core/graph/resolvers/commits.js

@@ -32,6 +32,8 @@ module.exports = {
   Stream: {
 
     async commits( parent, args, context, info ) {
+      if ( args.limit && args.limit > 100 )
+        throw new UserInputError( 'Cannot return more than 100 items, please use pagination.' )
       let { commits: items, cursor } = await getCommitsByStreamId( { streamId: parent.id, limit: args.limit, cursor: args.cursor } )
       let totalCount = await getCommitsTotalCountByStreamId( { streamId: parent.id } )
 
@@ -47,9 +49,10 @@ module.exports = {
   User: {
 
     async commits( parent, args, context, info ) {
-
       let publicOnly = context.userId !== parent.id
       let totalCount = await getCommitsTotalCountByUserId( { userId: parent.id } )
+      if ( args.limit && args.limit > 100 )
+        throw new UserInputError( 'Cannot return more than 100 items, please use pagination.' )
       let { commits: items, cursor } = await getCommitsByUserId( { userId: parent.id, limit: args.limit, cursor: args.cursor, publicOnly } )
 
       return { items, cursor, totalCount }
@@ -58,6 +61,8 @@ module.exports = {
   },
   Branch: {
     async commits( parent, args, context, info ) {
+      if ( args.limit && args.limit > 100 )
+        throw new UserInputError( 'Cannot return more than 100 items, please use pagination.' )
       let { commits, cursor } = await getCommitsByBranchId( { branchId: parent.id, limit: args.limit, cursor: args.cursor } )
       let totalCount = await getCommitsTotalCountByBranchId( { branchId: parent.id } )
 

modules/core/graph/resolvers/streams.js

@@ -22,6 +22,17 @@ module.exports = {
 
       let stream = await getStream( { streamId: args.id } )
       return stream
+    },
+    async streams( parent, args, context, info ) {
+      await validateScopes( context.scopes, 'streams:read' )
+
+      if ( args.limit && args.limit > 100 )
+        throw new UserInputError( 'Cannot return more than 100 items, please use pagination.' )
+
+      let totalCount = await getUserStreamsCount( {userId: context.userId, publicOnly: false, searchQuery: args.query} )
+
+      let {cursor, streams} = await getUserStreams( {userId: context.userId, limit: args.limit, cursor: args.cursor, publicOnly: false, searchQuery: args.query} )
+      return {totalCount, cursor: cursor, items: streams}
     }
   },
   Stream: {
@@ -35,7 +46,9 @@ module.exports = {
   User: {
 
     async streams( parent, args, context, info ) {
-      // Return only the user's public streams if parent.id !== context.userId
+      if ( args.limit && args.limit > 100 )
+        throw new UserInputError( 'Cannot return more than 100 items, please use pagination.' )
+        // Return only the user's public streams if parent.id !== context.userId
       let publicOnly = parent.id !== context.userId
       let totalCount = await getUserStreamsCount( { userId: parent.id, publicOnly } )
 

modules/core/graph/resolvers/user.js → modules/core/graph/resolvers/users.js

@@ -1,7 +1,7 @@
 'use strict'
 const appRoot = require( 'app-root-path' )
 const { ApolloError, AuthenticationError, UserInputError } = require( 'apollo-server-express' )
-const { createUser, getUser, getUserByEmail, getUserRole, updateUser, deleteUser, validatePasssword } = require( '../../services/users' )
+const { createUser, getUser, getUserByEmail, getUserRole, updateUser, deleteUser, searchUsers, validatePasssword } = require( '../../services/users' )
 const { createPersonalAccessToken, createAppToken, revokeToken, revokeTokenById, validateToken, getUserTokens } = require( '../../services/tokens' )
 const { validateServerRole, validateScopes, authorizeResolver } = require( `${appRoot}/modules/shared` )
 const setupCheck = require( `${appRoot}/setupcheck` )
@@ -10,12 +10,11 @@ const zxcvbn = require( 'zxcvbn' )
 module.exports = {
   Query: {
 
-    async _( ) {
+    async _() {
       return `Ph'nglui mglw'nafh Cthulhu R'lyeh wgah'nagl fhtagn.`
     },
 
     async user( parent, args, context, info ) {
-
       await validateServerRole( context, 'server:user' )
 
       if ( !args.id )
@@ -30,6 +29,22 @@ module.exports = {
       return await getUser( args.id || context.userId )
     },
 
+    async userSearch( parent, args, context, info ) {
+      await validateServerRole( context, 'server:user' )
+      await validateScopes( context.scopes, 'profile:read' )
+      await validateScopes( context.scopes, 'users:read' )
+
+      if ( args.query.length < 3 ) 
+        throw new UserInputError( 'Search query must be at least 3 carachters.' )
+
+
+      if ( args.limit  && args.limit > 100 ) 
+        throw new UserInputError( 'Cannot return more than 100 items, please use pagination.' )
+
+      let {cursor, users} = await searchUsers( args.query, args.limit, args.cursor )
+      return {cursor: cursor, items: users}
+    },
+
     async userPwdStrength( parent, args, context, info ) {
       let res = zxcvbn( args.pwd )
       return { score: res.score, feedback: res.feedback }
@@ -64,11 +79,13 @@ module.exports = {
 
   },
 
+
+
   Mutation: {
     async userEdit( parent, args, context, info ) {
       await validateServerRole( context, 'server:user' )
       await updateUser( context.userId, args.user )
       return true
     }
   }
-}
+}

modules/core/graph/schemas/branchesAndCommits.graphql

@@ -1,20 +1,20 @@
 extend type Stream {
-  commits( limit: Int! = 20, cursor: String ): CommitCollection
+  commits( limit: Int! = 25, cursor: String ): CommitCollection
   commit( id: String! ): Commit
-  branches( limit: Int! = 100, cursor: String ): BranchCollection
+  branches( limit: Int! = 25, cursor: String ): BranchCollection
   branch( name: String! ): Branch
 }
 
 extend type User {
-  commits( limit: Int! = 20, cursor: String ): CommitCollectionUser
+  commits( limit: Int! = 25, cursor: String ): CommitCollectionUser
 }
 
 type Branch {
   id: String!
   name: String!
   author: User!
   description: String!
-  commits( limit: Int! = 20, cursor: String ): CommitCollection
+  commits( limit: Int! = 25, cursor: String ): CommitCollection
 }
 
 type Commit {

modules/core/graph/schemas/streams.graphql

@@ -1,5 +1,9 @@
 extend type Query {
   stream( id: String! ): Stream
+  """
+  All the streams of the current user, pass in the `query` parameter to seach by name, description or ID.
+  """
+  streams( query: String!, limit: Int! = 25, cursor: String ): StreamCollection
 }
 
 type Stream {
@@ -16,7 +20,7 @@ extend type User {
   """
   All the streams that a user has access to.
   """
-  streams( limit: Int! = 20, cursor: String ): StreamCollectionUser
+  streams( limit: Int! = 25, cursor: String ): StreamCollection
 }
 
 type StreamCollaborator {
@@ -25,12 +29,13 @@ type StreamCollaborator {
   role: String!
 }
 
-type StreamCollectionUser {
+type StreamCollection {
   totalCount: Int!
   cursor: String
   items: [ Stream ]
 }
 
+
 extend type Mutation {
   """
   Creates a new stream.

modules/core/graph/schemas/user.graphql

@@ -3,6 +3,7 @@ extend type Query {
   Gets the profile of a user. If no id argument is provided, will return the current authenticated user's profile (as extracted from the authorization header).
   """
   user( id: String ): User
+  userSearch( query: String!, limit: Int! = 25, cursor: String ): UserSearchResultCollection
   userPwdStrength( pwd: String! ): JSONObject
 }
 
@@ -22,6 +23,21 @@ type User {
   role: String
 }
 
+type UserSearchResultCollection {
+  cursor: String
+  items: [ UserSearchResult ]
+}
+
+type UserSearchResult {
+  id: String!
+  username: String
+  name: String
+  bio: String
+  company: String
+  avatar: String
+  verified: Boolean
+}
+
 extend type Mutation {
   """
   Edits a user's profile.

modules/core/migrations/002-2020-05-18-scopes.js

@@ -6,50 +6,50 @@ exports.up = async knex => {
   debug( 'Setting up core module scopes.' )
 
   let coreModuleScopes = [ {
-      name: 'server:setup',
-      description: 'Edit server information.'
-    },
-    {
-      name: 'tokens:read',
-      description: `Access your api tokens.`
-    },
-    {
-      name: 'tokens:write',
-      description: `Create and delete api tokens on your behalf.`
-    },
-    {
-      name: 'apps:authorize',
-      description: 'Grant third party applications access rights on your behalf to the api.'
-    },
-    {
-      name: 'apps:create',
-      description: 'Register a third party application.'
-    },
-    {
-      name: 'streams:read',
-      description: 'Read your streams & and any associated information (branches, tags, comments, objects, etc.)'
-    },
-    {
-      name: 'streams:write',
-      description: 'Create streams on your behalf and read your streams & any associated information (any associated information (branches, tags, comments, objects, etc.)'
-    },
-    {
-      name: 'profile:read',
-      description: `Read your profile information`
-    },
-    {
-      name: 'profile:email',
-      description: `Access your email.`
-    },
+    name: 'server:setup',
+    description: 'Edit server information.'
+  },
+  {
+    name: 'tokens:read',
+    description: `Access your api tokens.`
+  },
+  {
+    name: 'tokens:write',
+    description: `Create and delete api tokens on your behalf.`
+  },
+  {
+    name: 'apps:authorize',
+    description: 'Grant third party applications access rights on your behalf to the api.'
+  },
+  {
+    name: 'apps:create',
+    description: 'Register a third party application.'
+  },
+  {
+    name: 'streams:read',
+    description: 'Read your streams & and any associated information (branches, tags, comments, objects, etc.)'
+  },
+  {
+    name: 'streams:write',
+    description: 'Create streams on your behalf and read your streams & any associated information (any associated information (branches, tags, comments, objects, etc.)'
+  },
+  {
+    name: 'profile:read',
+    description: `Read your profile information`
+  },
+  {
+    name: 'profile:email',
+    description: `Access your email.`
+  },
 
-    {
-      name: 'users:read',
-      description: `Read other users' profile on your behalf.`
-    },
-    {
-      name: 'users:email',
-      description: 'Access the emails of other users.'
-    }
+  {
+    name: 'users:read',
+    description: `Read other users' profile on your behalf.`
+  },
+  {
+    name: 'users:email',
+    description: 'Access the emails of other users.'
+  }
   ]
 
   await knex( 'scopes' ).insert( coreModuleScopes )

modules/core/services/branches.js

@@ -10,7 +10,6 @@ const BranchCommits = ( ) => knex( 'branch_commits' )
 module.exports = {
 
   async createBranch( { name, description, streamId, authorId } ) {
-
     let branch = {}
     branch.id = crs( { length: 10 } )
     branch.streamId = streamId
@@ -32,7 +31,7 @@ module.exports = {
   },
 
   async getBranchesByStreamId( { streamId, limit, cursor } ) {
-    limit = limit || 100
+    limit = limit || 25
     let query = Branches( ).select( '*' ).where( { streamId: streamId } )
 
     if ( cursor )