Log GQL requests in watcher (#517)

* Update config for server GQL * Add winston logger for GQL requests * Fix codegen templates for resolver and package * Update package versions --------- Co-authored-by: Prathamesh Musale <prathamesh.musale0@gmail.com>
cerc-io · Jun 6, 2024 · 8d052ad · 8d052ad
1 parent 836fe45
commit 8d052ad
Show file tree

Hide file tree

Showing 26 changed files with 374 additions and 96 deletions.
diff --git a/lerna.json b/lerna.json
@@ -2,7 +2,7 @@
   "packages": [
     "packages/*"
   ],
-  "version": "0.2.93",
+  "version": "0.2.94",
   "npmClient": "yarn",
   "useWorkspaces": true,
   "command": {

diff --git a/packages/cache/package.json b/packages/cache/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@cerc-io/cache",
-  "version": "0.2.93",
+  "version": "0.2.94",
   "description": "Generic object cache",
   "main": "dist/index.js",
   "scripts": {

diff --git a/packages/cli/package.json b/packages/cli/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@cerc-io/cli",
-  "version": "0.2.93",
+  "version": "0.2.94",
   "main": "dist/index.js",
   "license": "AGPL-3.0",
   "scripts": {
@@ -15,13 +15,13 @@
   },
   "dependencies": {
     "@apollo/client": "^3.7.1",
-    "@cerc-io/cache": "^0.2.93",
-    "@cerc-io/ipld-eth-client": "^0.2.93",
+    "@cerc-io/cache": "^0.2.94",
+    "@cerc-io/ipld-eth-client": "^0.2.94",
     "@cerc-io/libp2p": "^0.42.2-laconic-0.1.4",
     "@cerc-io/nitro-node": "^0.1.15",
-    "@cerc-io/peer": "^0.2.93",
-    "@cerc-io/rpc-eth-client": "^0.2.93",
-    "@cerc-io/util": "^0.2.93",
+    "@cerc-io/peer": "^0.2.94",
+    "@cerc-io/rpc-eth-client": "^0.2.94",
+    "@cerc-io/util": "^0.2.94",
     "@ethersproject/providers": "^5.4.4",
     "@graphql-tools/utils": "^9.1.1",
     "@ipld/dag-cbor": "^8.0.0",

diff --git a/packages/cli/src/server.ts b/packages/cli/src/server.ts
@@ -11,6 +11,7 @@ import assert from 'assert';
 import { ConnectionOptions } from 'typeorm';
 import express, { Application } from 'express';
 import { ApolloServer } from 'apollo-server-express';
+import winston from 'winston';
 
 import { JsonRpcProvider } from '@ethersproject/providers';
 import {
@@ -30,7 +31,8 @@ import {
   Consensus,
   readParty,
   UpstreamConfig,
-  fillBlocks
+  fillBlocks,
+  createGQLLogger
 } from '@cerc-io/util';
 import { TypeSource } from '@graphql-tools/utils';
 import type {
@@ -268,7 +270,11 @@ export class ServerCmd {
   }
 
   async exec (
-    createResolvers: (indexer: IndexerInterface, eventWatcher: EventWatcher) => Promise<any>,
+    createResolvers: (
+      indexer: IndexerInterface,
+      eventWatcher: EventWatcher,
+      gqlLogger: winston.Logger
+    ) => Promise<any>,
     typeDefs: TypeSource,
     paymentsManager?: PaymentsManager
   ): Promise<{
@@ -308,7 +314,8 @@ export class ServerCmd {
       await eventWatcher.start();
     }
 
-    const resolvers = await createResolvers(indexer, eventWatcher);
+    const gqlLogger = createGQLLogger(config.server.gql.logDir);
+    const resolvers = await createResolvers(indexer, eventWatcher, gqlLogger);
 
     // Create an Express app
     const app: Application = express();

diff --git a/packages/codegen/package.json b/packages/codegen/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@cerc-io/codegen",
-  "version": "0.2.93",
+  "version": "0.2.94",
   "description": "Code generator",
   "private": true,
   "main": "index.js",
@@ -20,7 +20,7 @@
   },
   "homepage": "https://github.com/cerc-io/watcher-ts#readme",
   "dependencies": {
-    "@cerc-io/util": "^0.2.93",
+    "@cerc-io/util": "^0.2.94",
     "@graphql-tools/load-files": "^6.5.2",
     "@npmcli/package-json": "^5.0.0",
     "@poanet/solidity-flattener": "https://github.com/vulcanize/solidity-flattener.git",

diff --git a/packages/codegen/src/assets/.gitignore b/packages/codegen/src/assets/.gitignore
@@ -4,3 +4,5 @@ out/
 
 .vscode
 .idea
+
+gql-logs/
diff --git a/packages/codegen/src/templates/config-template.handlebars b/packages/codegen/src/templates/config-template.handlebars
@@ -2,7 +2,6 @@
   host = "127.0.0.1"
   port = {{port}}
   kind = "{{watcherKind}}"
-  gqlPath = "/graphql"
 
   # Checkpointing state.
   checkpointing = true
@@ -24,25 +23,32 @@
   clearEntitiesCacheInterval = 1000
 
   {{/if}}
-  # Max block range for which to return events in eventsInRange GQL query.
-  # Use -1 for skipping check on block range.
-  maxEventsBlockRange = 1000
-
   # Flag to specify whether RPC endpoint supports block hash as block tag parameter
   rpcSupportsBlockHashParam = true
 
-  # GQL cache settings
-  [server.gqlCache]
-    enabled = true
+  # Server GQL config
+  [server.gql]
+    path = "/graphql"
+
+    # Max block range for which to return events in eventsInRange GQL query.
+    # Use -1 for skipping check on block range.
+    maxEventsBlockRange = 1000
+
+    # Log directory for GQL requests
+    logDir = "./gql-logs"
+
+    # GQL cache settings
+    [server.gql.cache]
+      enabled = true
 
-    # Max in-memory cache size (in bytes) (default 8 MB)
-    # maxCacheSize
+      # Max in-memory cache size (in bytes) (default 8 MB)
+      # maxCacheSize
 
-    # GQL cache-control max-age settings (in seconds)
-    maxAge = 15
-    {{#if (subgraphPath)}}
-    timeTravelMaxAge = 86400 # 1 day
-    {{/if}}
+      # GQL cache-control max-age settings (in seconds)
+      maxAge = 15
+      {{#if (subgraphPath)}}
+      timeTravelMaxAge = 86400 # 1 day
+      {{/if}}
 
 [metrics]
   host = "127.0.0.1"

diff --git a/packages/codegen/src/templates/indexer-template.handlebars b/packages/codegen/src/templates/indexer-template.handlebars
@@ -660,7 +660,7 @@ export class Indexer implements IndexerInterface {
   }
 
   async getEventsInRange (fromBlockNumber: number, toBlockNumber: number): Promise<Array<Event>> {
-    return this._baseIndexer.getEventsInRange(fromBlockNumber, toBlockNumber, this._serverConfig.maxEventsBlockRange);
+    return this._baseIndexer.getEventsInRange(fromBlockNumber, toBlockNumber, this._serverConfig.gql.maxEventsBlockRange);
   }
 
   async getSyncStatus (): Promise<SyncStatus | undefined> {

diff --git a/packages/codegen/src/templates/package-template.handlebars b/packages/codegen/src/templates/package-template.handlebars
@@ -41,12 +41,12 @@
   "homepage": "https://github.com/cerc-io/watcher-ts#readme",
   "dependencies": {
     "@apollo/client": "^3.3.19",
-    "@cerc-io/cli": "^0.2.93",
-    "@cerc-io/ipld-eth-client": "^0.2.93",
-    "@cerc-io/solidity-mapper": "^0.2.93",
-    "@cerc-io/util": "^0.2.93",
+    "@cerc-io/cli": "^0.2.94",
+    "@cerc-io/ipld-eth-client": "^0.2.94",
+    "@cerc-io/solidity-mapper": "^0.2.94",
+    "@cerc-io/util": "^0.2.94",
     {{#if (subgraphPath)}}
-    "@cerc-io/graph-node": "^0.2.93",
+    "@cerc-io/graph-node": "^0.2.94",
     {{/if}}
     "@ethersproject/providers": "^5.4.4",
     "debug": "^4.3.1",
@@ -75,6 +75,7 @@
     "eslint-plugin-standard": "^5.0.0",
     "husky": "^7.0.2",
     "ts-node": "^10.2.1",
-    "typescript": "^5.0.2"
+    "typescript": "^5.0.2",
+    "winston": "^3.13.0"
   }
 }
diff --git a/packages/codegen/src/templates/readme-template.handlebars b/packages/codegen/src/templates/readme-template.handlebars
@@ -63,7 +63,7 @@
 
 To enable GQL requests caching:
 
-* Update the `server.gqlCache` config with required settings.
+* Update the `server.gql.cache` config with required settings.
 
 * In the GQL [schema file](./src/schema.gql), use the `cacheControl` directive to apply cache hints at schema level.