Add Vector Store Redis

Author: pedrozadotdev

README.md

@@ -1,6 +1,6 @@
 # n8n-nodes-gnr-stack
 
-This is a set of n8n community nodes. It may be used in GNR Stack.
+This is a set of n8n community nodes. It may be used in GNR(Grist/N8n/Redis) Stack.
 
 ## HTTP Forward Auth Trigger/Response Node
 It can be used as a HTTP forward auth middleware with reverse proxies like Traefik and Caddy.
@@ -27,15 +27,15 @@ _List the operations supported by your node._
 
 ## Credentials
 
-Use [Redis](https://docs.n8n.io/integrations/builtin/credentials/redis/) as session data storage.
+Use [Redis](https://docs.n8n.io/integrations/builtin/credentials/redis/) as data storage.
 
 ## Compatibility
 
 N8N 1.76.1 and above.
 
 ## Usage
 
-TODO
+Se examples folder
 
 ## Resources
 

examples/Caddyfile

@@ -1,34 +1,32 @@
-:80 {
+:8080 {
 
-	rewrite /n8n /n8n/
-
-	handle_path /n8n/* {
+	handle_path /n8n/webhook/* {
 		uri strip_prefix /n8n
-		# Fix custom node icons when using N8N_PATH
-		uri replace icons/CUSTOM/home/node/.n8n/custom/ icons/CUSTOM/
     reverse_proxy n8n:5678 {
 			header_up X-Real-IP {remote_host}
 	  }
 	}
 
-	handle /protected {
+	handle /auth/login {
 		forward_auth n8n:5678 {
 			uri /webhook/{$WEBHOOK_ID}/check
 			copy_headers X-Forwarded-User
 		}
 	}
 
-	handle /login {
-		uri replace login webhook/{$WEBHOOK_ID}/login
+	handle /_auth/login {
+		uri replace /_auth/login webhook/{$WEBHOOK_ID}/login
 		reverse_proxy n8n:5678 {
 			header_up X-Real-IP {remote_host}
 		}
 	}
 
-	handle /logout {
-		uri replace logout webhook/{$WEBHOOK_ID}/logout
+	handle /_auth/logout {
+		uri replace /_auth/logout webhook/{$WEBHOOK_ID}/logout
 		reverse_proxy n8n:5678
 	}
 
-  reverse_proxy whoami:80
+  reverse_proxy grist:8484 {
+		header_up -X-Real-IP
+	}
 }

examples/docker-compose.yml

@@ -4,14 +4,11 @@ services:
     restart: always
     environment:
       - NODE_ENV=production
-      - N8N_PATH=/n8n/
-      - WEBHOOK_URL=http://localhost:8080/n8n/
-      - N8N_PROXY_HOPS=1
     volumes:
       - ./data/n8n:/home/node/.n8n
       - ../dist:/home/node/.n8n/custom
     ports:
-      - 5678:5678
+      - 8081:5678
     depends_on:
       build:
         condition: service_completed_successfully
@@ -24,22 +21,52 @@ services:
     command: ["run", "build-docker"]
 
   redis:
-    image: redis:7-alpine
+    image: redis/redis-stack:latest
     restart: always
-    command: redis-server --save 20 1 --loglevel warning
+    healthcheck:
+      test: [ "CMD", "redis-cli", "--raw", "incr", "ping" ]
+      interval: 5s
+      timeout: 5s
+      retries: 5
     volumes:
       - ./data/redis:/data
+    ports:
+      - 8082:8001
 
-  whoami:
-    image: traefik/whoami
+  grist:
+    image: gristlabs/grist-oss
     restart: always
-
+    volumes:
+      - ./data/grist:/persist
+    environment:
+      - GRIST_SESSION_SECRET=invent-a-secret-here
+      - [email protected]
+      - GRIST_SANDBOX_FLAVOR=gvisor
+      - APP_HOME_URL=http://localhost:8080
+      - GRIST_SINGLE_ORG=example-com
+      - COOKIE_MAX_AGE=604800000
+      - GRIST_HIDE_UI_ELEMENTS=helpCenter,billing,templates,createSite,multiSite,multiAccounts,sendToDrive,tutorials,supportGrist
+      - GRIST_PAGE_TITLE_SUFFIX=" - Example.com"
+      - GRIST_WIDGET_LIST_URL="https://github.com/gristlabs/grist-widget/releases/download/latest/manifest.json"
+      - ALLOWED_WEBHOOK_DOMAINS=n8n:5678
+      - GRIST_FORWARD_AUTH_HEADER=X-Forwarded-User
+      - GRIST_FORWARD_AUTH_LOGOUT_PATH=/_auth/logout
+      # - GRIST_DOCS_MINIO_ACCESS_KEY=grist
+      # - GRIST_DOCS_MINIO_SECRET_KEY=grist
+      # - GRIST_DOCS_MINIO_ENDPOINT=s3
+      # - GRIST_DOCS_MINIO_PORT=8333
+      # - GRIST_DOCS_MINIO_USE_SSL=0
+      # - GRIST_DOCS_MINIO_BUCKET=grist
+      - REDIS_URL=redis://redis:6379
+    depends_on:
+      redis:
+        condition: service_healthy
   caddy:
     image: caddy:alpine
     restart: always
     environment:
       - WEBHOOK_ID=aa1e42ef-7492-4235-9f22-e3c007358d15
     ports:
-      - 8080:80
+      - 8080:8080
     volumes:
       - ./Caddyfile:/etc/caddy/Caddyfile

jest.config.js

@@ -2,13 +2,17 @@
 module.exports = {
 	preset: 'ts-jest/presets/default-esm',
 	collectCoverage: true,
-	coverageDirectory: "coverage",
-	coverageProvider: "v8",
+	coverageDirectory: 'coverage',
+	coverageProvider: 'v8',
 	collectCoverageFrom: ['nodes/**/*.ts'],
+	coveragePathIgnorePatterns: [
+		'<rootDir>/nodes/common/types.ts',
+		'<rootDir>/nodes/VectorStoreRedis/VectorStoreRedis.node.ts',
+	],
 	testPathIgnorePatterns: ['/node_modules/'],
-  transform: {},
-  moduleNameMapper: {
-    '^(\\.{1,2}/.*)\\.js$': '$1'
-  },
-  testEnvironment: 'node'
+	transform: {},
+	moduleNameMapper: {
+		'^(\\.{1,2}/.*)\\.js$': '$1',
+	},
+	testEnvironment: 'node',
 };

nodes/HttpForwardAuth/HttpForwardAuth.node.ts

@@ -8,17 +8,17 @@ import type {
 	INodeType,
 } from 'n8n-workflow';
 
-import { FORWARDED_USER_HEADER, TRIGGER_NAME } from './constants';
+import { FORWARDED_USER_HEADER, TRIGGER_NAME } from '../common/constants';
 import { responseDescription } from './descriptions';
-import { getRedisClient } from './transport';
-import type { RedisCredential } from './types';
+import { getRedisClient } from '../common/transport';
+import type { RedisCredential } from '../common/types';
 import {
 	createSession,
 	generateSessionToken,
 	rateLimitReset,
 	redisConnectionTest,
 	setSessionTokenCookie,
-} from './utils';
+} from '../common/utils';
 
 type TriggerParamsType = {
 	authURL: string;

nodes/HttpForwardAuth/HttpForwardAuthTrigger.node.ts

@@ -6,19 +6,19 @@ import type {
 	IDataObject,
 } from 'n8n-workflow';
 
-import { FORWARDED_USER_HEADER, REMOTE_IP_HEADER, SESSION_KEY } from './constants';
-import { cookieParse } from './cookieParser';
+import { FORWARDED_USER_HEADER, REMOTE_IP_HEADER, SESSION_KEY } from '../common/constants';
+import { cookieParse } from '../common/cookieParser';
 import { triggerDescription } from './descriptions';
 import { logoutPageHTMLTemplate } from './templates';
-import { getRedisClient } from './transport';
-import type { RedisCredential } from './types';
+import { getRedisClient } from '../common/transport';
+import type { RedisCredential } from '../common/types';
 import {
 	deleteSessionTokenCookie,
 	rateLimitConsume,
 	redisConnectionTest,
 	setSessionTokenCookie,
 	validateSessionToken,
-} from './utils';
+} from '../common/utils';
 
 export class HttpForwardAuthTrigger implements INodeType {
 	description = triggerDescription;
@@ -28,8 +28,7 @@ export class HttpForwardAuthTrigger implements INodeType {
 	};
 
 	async webhook(this: IWebhookFunctions): Promise<IWebhookResponseData> {
-		const req = this.getRequestObject();
-		const res = this.getResponseObject();
+		const [req, res] = [this.getRequestObject(), this.getResponseObject()];
 		const addResHeader = (key: string, value: string) => res.setHeader(key, value);
 
 		const credentials = (await this.getCredentials('redis')) as RedisCredential;
@@ -41,7 +40,7 @@ export class HttpForwardAuthTrigger implements INodeType {
 		const logoutRedirectURL = this.getNodeParameter('logoutRedirectURL', '') as string;
 		const enableHTTP = this.getNodeParameter('enableHTTP', false) as boolean;
 		const rateLimit = this.getNodeParameter('rateLimit', false) as boolean;
-		const remoteIp = rateLimit ? req.headers[REMOTE_IP_HEADER] as string : undefined;
+		const remoteIp = rateLimit ? (req.headers[REMOTE_IP_HEADER] as string) : undefined;
 		const rateLimitErrorMessage = this.getNodeParameter('rateLimitErrorMessage', '') as string;
 		const loginTemplate = this.getNodeParameter('loginTemplate', '') as string;
 

nodes/HttpForwardAuth/descriptions.ts

@@ -2,7 +2,7 @@
 import type { INodeTypeDescription } from 'n8n-workflow';
 import { NodeConnectionType } from 'n8n-workflow';
 
-import { TRIGGER_NAME } from './constants';
+import { TRIGGER_NAME } from '../common/constants';
 import { loginPageHTMLTemplate } from './templates';
 
 export const responseDescription: INodeTypeDescription = {

nodes/HttpForwardAuth/templates.ts

@@ -151,33 +151,3 @@ export const logoutPageHTMLTemplate = `<!DOCTYPE html>
 	<form name="logout" method="post" action="#LOGOUT_URL#"></form>
 	</body>
 </html>`;
-
-export const redisRLScript = `
--- Returns 1 if allowed, 0 if not
-local key                   = KEYS[1]
-local now                   = tonumber(ARGV[1])
-
-local timeoutSeconds = {1, 2, 4, 8, 16, 30, 60, 180, 300}
-
-local fields = redis.call("HGETALL", key)
-if #fields == 0 then
-    redis.call("HSET", key, "index", 1, "updated_at", now)
-    return {1}
-end
-local index = 0
-local updatedAt = 0
-for i = 1, #fields, 2 do
-	if fields[i] == "index" then
-        index = tonumber(fields[i+1])
-    elseif fields[i] == "updated_at" then
-        updatedAt = tonumber(fields[i+1])
-    end
-end
-local allowed = now - updatedAt >= timeoutSeconds[index]
-if not allowed then
-    return {0}
-end
-index = math.min(index + 1, #timeoutSeconds)
-redis.call("HSET", key, "index", index, "updated_at", now)
-return {1}
-`;

nodes/VectorStoreRedis/VectorStoreRedis.node.ts

@@ -0,0 +1,60 @@
+import { RedisVectorStore } from '@langchain/redis';
+import { createVectorStoreNode } from '@n8n/n8n-nodes-langchain/dist/nodes/vector_store/shared/createVectorStoreNode';
+import type { RedisCredential } from '../common/types';
+import { getRedisClient } from '../common/transport';
+
+export class VectorStoreRedis extends createVectorStoreNode({
+	meta: {
+		displayName: 'Redis Vector Store',
+		name: 'vectorStoreRedis',
+		description: 'Work with your data in Redis Vector Store',
+		icon: 'file:redis.svg',
+		docsUrl: 'https://github.com/pedrozadotdev/n8n-nodes-gnr-stack',
+		credentials: [
+			{
+				// eslint-disable-next-line n8n-nodes-base/node-class-description-credentials-name-unsuffixed
+				name: 'redis',
+				// @ts-ignore
+				displayName: 'Redis Credential',
+				required: true,
+				testedBy: 'redisConnectionTest',
+			},
+		],
+	},
+	sharedFields: [
+		{
+			displayName: 'Index Name',
+			name: 'indexName',
+			type: 'string',
+			default: '',
+			required: true,
+			description: 'The index name that will be use in Redis',
+		},
+	],
+	loadFields: [],
+	retrieveFields: [],
+	// @ts-ignore
+	async getVectorStoreClient(context, _filter, embeddings, itemIndex) {
+		const credentials = (await context.getCredentials('redis')) as RedisCredential;
+		const { client } = await getRedisClient(credentials);
+		const indexName = context.getNodeParameter('indexName', itemIndex) as string;
+
+		return new RedisVectorStore(embeddings, {
+			redisClient: client,
+			indexName,
+		});
+	},
+
+	async populateVectorStore(context, embeddings, documents, itemIndex) {
+		const credentials = (await context.getCredentials('redis')) as RedisCredential;
+		const { client } = await getRedisClient(credentials);
+		const indexName = context.getNodeParameter('indexName', itemIndex) as string;
+
+		const vectorStore = new RedisVectorStore(embeddings, {
+			redisClient: client,
+			indexName,
+		});
+
+		await vectorStore.addDocuments(documents);
+	},
+}) {}