Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions .github/workflows/tests-evault-core.yml
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
name: Tests [evault-core]

on:
push:
branches: [main]
paths:
- 'infrastructure/evault-core/**'
pull_request:
branches: [main]
paths:
- 'infrastructure/w3id/**'

jobs:
test:
runs-on: ubuntu-latest

steps:
- name: Checkout code
uses: actions/checkout@v3

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Update the checkout action to the latest version

The current version of actions/checkout being used (v3) is outdated. The latest version (v4) includes improvements and bug fixes.

- uses: actions/checkout@v3+ uses: actions/checkout@v4
📝 Committable suggestion

‼️IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
uses: actions/checkout@v3
uses: actions/checkout@v4
🧰 Tools
🪛 actionlint (1.7.4)

19-19: the runner of "actions/checkout@v3" action is too old to run on GitHub Actions. update the action's version to fix this issue

(action)


- name: Set up Node.js 22
uses: actions/setup-node@v4
with:
node-version: 22

- name: Install pnpm
run: npm install -g pnpm

- name: Install dependencies
run: pnpm install

- name: Run tests
run: pnpm -F=evault-core test

22 changes: 22 additions & 0 deletions infrastructure/evault-core/docker-compose.yml
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
version: '3.8'

services:
neo4j:
image: neo4j:5.15
container_name: neo4j
ports:
- "7474:7474"
- "7687:7687"
environment:
- NEO4J_AUTH=neo4j/testpass
volumes:
- neo4j_data:/data
networks:
- graphnet

volumes:
neo4j_data:

networks:
graphnet:
driver: bridge
40 changes: 30 additions & 10 deletions infrastructure/evault-core/package.json
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,32 @@
{
"name": "evault-core",
"version": "1.0.0",
"description": "",
"main": "index.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"keywords": [],
"author": "",
"license": "ISC"
"name": "evault-core",
"version": "0.1.0",
"description": "",
"main": "index.js",
"scripts": {
"test": "vitest --config vitest.config.ts"
},
"keywords": [],
"author": "",
"license": "ISC",
"devDependencies": {
"@types/json-schema": "^7.0.15",
"@types/node": "^22.13.10",
"dotenv": "^16.5.0",
"testcontainers": "^10.24.2",
"tsx": "^4.19.3",
"typescript": "^5.8.3",
"uuid": "^11.1.0",
"vitest": "^3.0.9"
},
"dependencies": {
"@testcontainers/neo4j": "^10.24.2",
"graphql": "^16.10.0",
"graphql-type-json": "^0.3.2",
"graphql-voyager": "^2.1.0",
"graphql-yoga": "^5.13.4",
"json-schema": "^0.4.0",
"neo4j-driver": "^5.28.1",
"w3id": "workspace:*"
}
}
270 changes: 270 additions & 0 deletions infrastructure/evault-core/src/db/db.service.spec.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,270 @@
import neo4j, { Driver } from "neo4j-driver";
import { DbService } from "./db.service"; // adjust if needed
import { it, describe, beforeAll, afterAll, expect } from "vitest";
import { Neo4jContainer, StartedNeo4jContainer } from "@testcontainers/neo4j";

type Envelope = {
id: string;
ontology: string;
value: any;
valueType: string;
};

describe("DbService (integration)", () => {
let container: StartedNeo4jContainer;
let service: DbService;
let driver: Driver;

beforeAll(async () => {
container = await new Neo4jContainer("neo4j:5.15").start();

const username = container.getUsername();
const password = container.getPassword();
const boltPort = container.getMappedPort(7687);
const uri = `bolt://localhost:${boltPort}`;

driver = neo4j.driver(uri, neo4j.auth.basic(username, password));
service = new DbService(driver);
});

afterAll(async () => {
await service.close();
await driver.close();
await container.stop();
});

it("should store and retrieve a meta-envelope with various data types", async () => {
const input = {
ontology: "TestTypes",
payload: {
string: "hello world",
number: 42,
boolean: true,
date: new Date("2025-04-10T00:00:00Z"),
array: [1, 2, 3],
object: { nested: { value: "deep" } },
},
acl: ["@test-user"],
};

const result = await service.storeMetaEnvelope(input, input.acl);
const id = result.metaEnvelope.id;

const fetched = await service.findMetaEnvelopeById(id);
expect(fetched).toBeDefined();
expect(fetched.id).toBeDefined();
expect(fetched.ontology).toBe("TestTypes");
expect(fetched.acl).toEqual(["@test-user"]);
expect(fetched.envelopes).toHaveLength(6);

// Verify parsed field matches original payload
expect(fetched.parsed).toEqual(input.payload);

// Verify each data type is properly stored and retrieved
const envelopes = fetched.envelopes.reduce(
(acc: Record<string, Envelope>, e: Envelope) => {
acc[e.ontology] = e;
return acc;
},
{},
);

expect(envelopes.string.value).toBe("hello world");
expect(envelopes.string.valueType).toBe("string");

expect(envelopes.number.value).toBe(42);
expect(envelopes.number.valueType).toBe("number");

expect(envelopes.boolean.value).toBe(true);
expect(envelopes.boolean.valueType).toBe("boolean");

expect(envelopes.date.value).toBeInstanceOf(Date);
expect(envelopes.date.value.toISOString()).toBe(
"2025-04-10T00:00:00.000Z",
);
expect(envelopes.date.valueType).toBe("date");

expect(envelopes.array.value).toEqual([1, 2, 3]);
expect(envelopes.array.valueType).toBe("array");

expect(envelopes.object.value).toEqual({ nested: { value: "deep" } });
expect(envelopes.object.valueType).toBe("object");
});

it("should find meta-envelopes containing the search term in any envelope value", async () => {
const input = {
ontology: "SocialMediaPost",
payload: {
text: "This is a searchable tweet",
image: "https://example.com/image.jpg",
likes: ["user1", "user2"],
},
acl: ["@search-test-user"],
};

const metaEnv = await service.storeMetaEnvelope(input, input.acl);

const found = await service.findMetaEnvelopesBySearchTerm(
"SocialMediaPost",
"searchable",
);

expect(Array.isArray(found)).toBe(true);
const match = found.find((m) => m.id === metaEnv.metaEnvelope.id);
expect(match).toBeDefined();
if (!match) throw new Error();
expect(match.envelopes.length).toBeGreaterThan(0);
expect(
match.envelopes.some((e) => e.value.includes("searchable")),
).toBe(true);
});

it("should return empty array if no values contain the search term", async () => {
const found = await service.findMetaEnvelopesBySearchTerm(
"SocialMediaPost",
"notfoundterm",
);
expect(Array.isArray(found)).toBe(true);
expect(found.length).toBe(0);
});

it("should find meta-envelopes by ontology", async () => {
const results =
await service.findMetaEnvelopesByOntology("SocialMediaPost");
expect(Array.isArray(results)).toBe(true);
expect(results.length).toBeGreaterThan(0);
});

it("should delete a meta-envelope and its envelopes", async () => {
const meta = {
ontology: "TempPost",
payload: {
value: "to be deleted",
},
acl: ["@delete-user"],
};

const stored = await service.storeMetaEnvelope(meta, meta.acl);
await service.deleteMetaEnvelope(stored.metaEnvelope.id);

const deleted = await service.findMetaEnvelopeById(
stored.metaEnvelope.id,
);
expect(deleted).toBeNull();
});

it("should update envelope value with proper type handling", async () => {
const meta = {
ontology: "UpdateTest",
payload: {
value: "original",
},
acl: ["@updater"],
};

const stored = await service.storeMetaEnvelope(meta, meta.acl);

const result = await service.findMetaEnvelopeById(
stored.metaEnvelope.id,
);
const targetEnvelope = result.envelopes.find(
(e: Envelope) => e.ontology === "value",
);

// Update with a different type
const newValue = new Date("2025-04-10T00:00:00Z");
await service.updateEnvelopeValue(targetEnvelope.id, newValue);

const updated = await service.findMetaEnvelopeById(
stored.metaEnvelope.id,
);
const updatedValue = updated.envelopes.find(
(e: Envelope) => e.id === targetEnvelope.id,
);
expect(updatedValue.value).toBeInstanceOf(Date);
expect(updatedValue.value.toISOString()).toBe(
"2025-04-10T00:00:00.000Z",
);
expect(updatedValue.valueType).toBe("date");
});

it("should find meta-envelopes containing the search term in any value type", async () => {
const input = {
ontology: "SearchTest",
payload: {
string: "This is a searchable string",
array: ["searchable", "array", "element"],
object: { text: "searchable object" },
number: 42,
date: new Date("2025-04-10T00:00:00Z"),
},
acl: ["@search-test-user"],
};

const metaEnv = await service.storeMetaEnvelope(input, input.acl);

// Test search in string
const foundInString = await service.findMetaEnvelopesBySearchTerm(
"SearchTest",
"searchable string",
);
expect(foundInString.length).toBeGreaterThan(0);
expect(foundInString[0].id).toBe(metaEnv.metaEnvelope.id);

// Test search in array
const foundInArray = await service.findMetaEnvelopesBySearchTerm(
"SearchTest",
"searchable",
);
expect(foundInArray.length).toBeGreaterThan(0);
expect(foundInArray[0].id).toBe(metaEnv.metaEnvelope.id);

// Test search in object
const foundInObject = await service.findMetaEnvelopesBySearchTerm(
"SearchTest",
"searchable object",
);
expect(foundInObject.length).toBeGreaterThan(0);
expect(foundInObject[0].id).toBe(metaEnv.metaEnvelope.id);
});

it("should find meta-envelopes containing the search term with parsed payload", async () => {
const input = {
ontology: "SearchTestHeyyy",
payload: {
string: "This is a searchable string",
array: ["searchable", "array", "element"],
object: { text: "searchable object" },
number: 42,
date: new Date("2025-04-10T00:00:00Z"),
},
acl: ["@search-test-user"],
};

const metaEnv = await service.storeMetaEnvelope(input, input.acl);

// Test search in string
const foundInString = await service.findMetaEnvelopesBySearchTerm(
"SearchTestHeyyy",
"searchable string",
);
expect(foundInString.length).toBeGreaterThan(0);
expect(foundInString[0].id).toBe(metaEnv.metaEnvelope.id);

// Test search in array
const foundInArray = await service.findMetaEnvelopesBySearchTerm(
"SearchTestHeyyy",
"searchable",
);
expect(foundInArray.length).toBeGreaterThan(0);
expect(foundInArray[0].id).toBe(metaEnv.metaEnvelope.id);

// Test search in object
const foundInObject = await service.findMetaEnvelopesBySearchTerm(
"SearchTestHeyyy",
"searchable object",
);
expect(foundInObject.length).toBeGreaterThan(0);
expect(foundInObject[0].id).toBe(metaEnv.metaEnvelope.id);
});
});
Comment on lines +191 to +270

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Eliminate redundant tests.

This test is almost identical to the search test at lines 94-120, and the test at lines 231-269 is nearly identical to the test at lines 191-230. Consider consolidating these tests to reduce duplication.

Consider consolidating the duplicate tests by:

  1. Using a parameterized test approach
  2. Creating helper functions for common test patterns
  3. Or at minimum, adding comments explaining why these separate but similar tests are necessary

For example:

functiontestSearchFunctionality(ontology: string,description: string){it(`should ${description} for ontology ${ontology}`,async()=>{// Common test logic});}testSearchFunctionality("SearchTest","find meta-envelopes containing the search term in any value type");testSearchFunctionality("SearchTestHeyyy","find meta-envelopes containing the search term with parsed payload");

Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions .github/workflows/tests-evault-core.yml
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
name: Tests [evault-core]

on:
push:
branches: [main]
paths:
- 'infrastructure/evault-core/**'
pull_request:
branches: [main]
paths:
- 'infrastructure/w3id/**'

jobs:
test:
runs-on: ubuntu-latest

steps:
- name: Checkout code
uses: actions/checkout@v3

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Update the checkout action to the latest version

The current version of actions/checkout being used (v3) is outdated. The latest version (v4) includes improvements and bug fixes.

- uses: actions/checkout@v3+ uses: actions/checkout@v4
📝 Committable suggestion

‼️IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
uses: actions/checkout@v3
uses: actions/checkout@v4
🧰 Tools
🪛 actionlint (1.7.4)

19-19: the runner of "actions/checkout@v3" action is too old to run on GitHub Actions. update the action's version to fix this issue

(action)


- name: Set up Node.js 22
uses: actions/setup-node@v4
with:
node-version: 22

- name: Install pnpm
run: npm install -g pnpm

- name: Install dependencies
run: pnpm install

- name: Run tests
run: pnpm -F=evault-core test

22 changes: 22 additions & 0 deletions infrastructure/evault-core/docker-compose.yml
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
version: '3.8'

services:
neo4j:
image: neo4j:5.15
container_name: neo4j
ports:
- "7474:7474"
- "7687:7687"
environment:
- NEO4J_AUTH=neo4j/testpass
volumes:
- neo4j_data:/data
networks:
- graphnet

volumes:
neo4j_data:

networks:
graphnet:
driver: bridge
40 changes: 30 additions & 10 deletions infrastructure/evault-core/package.json
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,32 @@
{
"name": "evault-core",
"version": "1.0.0",
"description": "",
"main": "index.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"keywords": [],
"author": "",
"license": "ISC"
"name": "evault-core",
"version": "0.1.0",
"description": "",
"main": "index.js",
"scripts": {
"test": "vitest --config vitest.config.ts"
},
"keywords": [],
"author": "",
"license": "ISC",
"devDependencies": {
"@types/json-schema": "^7.0.15",
"@types/node": "^22.13.10",
"dotenv": "^16.5.0",
"testcontainers": "^10.24.2",
"tsx": "^4.19.3",
"typescript": "^5.8.3",
"uuid": "^11.1.0",
"vitest": "^3.0.9"
},
"dependencies": {
"@testcontainers/neo4j": "^10.24.2",
"graphql": "^16.10.0",
"graphql-type-json": "^0.3.2",
"graphql-voyager": "^2.1.0",
"graphql-yoga": "^5.13.4",
"json-schema": "^0.4.0",
"neo4j-driver": "^5.28.1",
"w3id": "workspace:*"
}
}
270 changes: 270 additions & 0 deletions infrastructure/evault-core/src/db/db.service.spec.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,270 @@
import neo4j, { Driver } from "neo4j-driver";
import { DbService } from "./db.service"; // adjust if needed
import { it, describe, beforeAll, afterAll, expect } from "vitest";
import { Neo4jContainer, StartedNeo4jContainer } from "@testcontainers/neo4j";

type Envelope = {
id: string;
ontology: string;
value: any;
valueType: string;
};

describe("DbService (integration)", () => {
let container: StartedNeo4jContainer;
let service: DbService;
let driver: Driver;

beforeAll(async () => {
container = await new Neo4jContainer("neo4j:5.15").start();

const username = container.getUsername();
const password = container.getPassword();
const boltPort = container.getMappedPort(7687);
const uri = `bolt://localhost:${boltPort}`;

driver = neo4j.driver(uri, neo4j.auth.basic(username, password));
service = new DbService(driver);
});

afterAll(async () => {
await service.close();
await driver.close();
await container.stop();
});

it("should store and retrieve a meta-envelope with various data types", async () => {
const input = {
ontology: "TestTypes",
payload: {
string: "hello world",
number: 42,
boolean: true,
date: new Date("2025-04-10T00:00:00Z"),
array: [1, 2, 3],
object: { nested: { value: "deep" } },
},
acl: ["@test-user"],
};

const result = await service.storeMetaEnvelope(input, input.acl);
const id = result.metaEnvelope.id;

const fetched = await service.findMetaEnvelopeById(id);
expect(fetched).toBeDefined();
expect(fetched.id).toBeDefined();
expect(fetched.ontology).toBe("TestTypes");
expect(fetched.acl).toEqual(["@test-user"]);
expect(fetched.envelopes).toHaveLength(6);

// Verify parsed field matches original payload
expect(fetched.parsed).toEqual(input.payload);

// Verify each data type is properly stored and retrieved
const envelopes = fetched.envelopes.reduce(
(acc: Record<string, Envelope>, e: Envelope) => {
acc[e.ontology] = e;
return acc;
},
{},
);

expect(envelopes.string.value).toBe("hello world");
expect(envelopes.string.valueType).toBe("string");

expect(envelopes.number.value).toBe(42);
expect(envelopes.number.valueType).toBe("number");

expect(envelopes.boolean.value).toBe(true);
expect(envelopes.boolean.valueType).toBe("boolean");

expect(envelopes.date.value).toBeInstanceOf(Date);
expect(envelopes.date.value.toISOString()).toBe(
"2025-04-10T00:00:00.000Z",
);
expect(envelopes.date.valueType).toBe("date");

expect(envelopes.array.value).toEqual([1, 2, 3]);
expect(envelopes.array.valueType).toBe("array");

expect(envelopes.object.value).toEqual({ nested: { value: "deep" } });
expect(envelopes.object.valueType).toBe("object");
});

it("should find meta-envelopes containing the search term in any envelope value", async () => {
const input = {
ontology: "SocialMediaPost",
payload: {
text: "This is a searchable tweet",
image: "https://example.com/image.jpg",
likes: ["user1", "user2"],
},
acl: ["@search-test-user"],
};

const metaEnv = await service.storeMetaEnvelope(input, input.acl);

const found = await service.findMetaEnvelopesBySearchTerm(
"SocialMediaPost",
"searchable",
);

expect(Array.isArray(found)).toBe(true);
const match = found.find((m) => m.id === metaEnv.metaEnvelope.id);
expect(match).toBeDefined();
if (!match) throw new Error();
expect(match.envelopes.length).toBeGreaterThan(0);
expect(
match.envelopes.some((e) => e.value.includes("searchable")),
).toBe(true);
});

it("should return empty array if no values contain the search term", async () => {
const found = await service.findMetaEnvelopesBySearchTerm(
"SocialMediaPost",
"notfoundterm",
);
expect(Array.isArray(found)).toBe(true);
expect(found.length).toBe(0);
});

it("should find meta-envelopes by ontology", async () => {
const results =
await service.findMetaEnvelopesByOntology("SocialMediaPost");
expect(Array.isArray(results)).toBe(true);
expect(results.length).toBeGreaterThan(0);
});

it("should delete a meta-envelope and its envelopes", async () => {
const meta = {
ontology: "TempPost",
payload: {
value: "to be deleted",
},
acl: ["@delete-user"],
};

const stored = await service.storeMetaEnvelope(meta, meta.acl);
await service.deleteMetaEnvelope(stored.metaEnvelope.id);

const deleted = await service.findMetaEnvelopeById(
stored.metaEnvelope.id,
);
expect(deleted).toBeNull();
});

it("should update envelope value with proper type handling", async () => {
const meta = {
ontology: "UpdateTest",
payload: {
value: "original",
},
acl: ["@updater"],
};

const stored = await service.storeMetaEnvelope(meta, meta.acl);

const result = await service.findMetaEnvelopeById(
stored.metaEnvelope.id,
);
const targetEnvelope = result.envelopes.find(
(e: Envelope) => e.ontology === "value",
);

// Update with a different type
const newValue = new Date("2025-04-10T00:00:00Z");
await service.updateEnvelopeValue(targetEnvelope.id, newValue);

const updated = await service.findMetaEnvelopeById(
stored.metaEnvelope.id,
);
const updatedValue = updated.envelopes.find(
(e: Envelope) => e.id === targetEnvelope.id,
);
expect(updatedValue.value).toBeInstanceOf(Date);
expect(updatedValue.value.toISOString()).toBe(
"2025-04-10T00:00:00.000Z",
);
expect(updatedValue.valueType).toBe("date");
});

it("should find meta-envelopes containing the search term in any value type", async () => {
const input = {
ontology: "SearchTest",
payload: {
string: "This is a searchable string",
array: ["searchable", "array", "element"],
object: { text: "searchable object" },
number: 42,
date: new Date("2025-04-10T00:00:00Z"),
},
acl: ["@search-test-user"],
};

const metaEnv = await service.storeMetaEnvelope(input, input.acl);

// Test search in string
const foundInString = await service.findMetaEnvelopesBySearchTerm(
"SearchTest",
"searchable string",
);
expect(foundInString.length).toBeGreaterThan(0);
expect(foundInString[0].id).toBe(metaEnv.metaEnvelope.id);

// Test search in array
const foundInArray = await service.findMetaEnvelopesBySearchTerm(
"SearchTest",
"searchable",
);
expect(foundInArray.length).toBeGreaterThan(0);
expect(foundInArray[0].id).toBe(metaEnv.metaEnvelope.id);

// Test search in object
const foundInObject = await service.findMetaEnvelopesBySearchTerm(
"SearchTest",
"searchable object",
);
expect(foundInObject.length).toBeGreaterThan(0);
expect(foundInObject[0].id).toBe(metaEnv.metaEnvelope.id);
});

it("should find meta-envelopes containing the search term with parsed payload", async () => {
const input = {
ontology: "SearchTestHeyyy",
payload: {
string: "This is a searchable string",
array: ["searchable", "array", "element"],
object: { text: "searchable object" },
number: 42,
date: new Date("2025-04-10T00:00:00Z"),
},
acl: ["@search-test-user"],
};

const metaEnv = await service.storeMetaEnvelope(input, input.acl);

// Test search in string
const foundInString = await service.findMetaEnvelopesBySearchTerm(
"SearchTestHeyyy",
"searchable string",
);
expect(foundInString.length).toBeGreaterThan(0);
expect(foundInString[0].id).toBe(metaEnv.metaEnvelope.id);

// Test search in array
const foundInArray = await service.findMetaEnvelopesBySearchTerm(
"SearchTestHeyyy",
"searchable",
);
expect(foundInArray.length).toBeGreaterThan(0);
expect(foundInArray[0].id).toBe(metaEnv.metaEnvelope.id);

// Test search in object
const foundInObject = await service.findMetaEnvelopesBySearchTerm(
"SearchTestHeyyy",
"searchable object",
);
expect(foundInObject.length).toBeGreaterThan(0);
expect(foundInObject[0].id).toBe(metaEnv.metaEnvelope.id);
});
});
Comment on lines +191 to +270

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Eliminate redundant tests.

This test is almost identical to the search test at lines 94-120, and the test at lines 231-269 is nearly identical to the test at lines 191-230. Consider consolidating these tests to reduce duplication.

Consider consolidating the duplicate tests by:

  1. Using a parameterized test approach
  2. Creating helper functions for common test patterns
  3. Or at minimum, adding comments explaining why these separate but similar tests are necessary

For example:

functiontestSearchFunctionality(ontology: string,description: string){it(`should ${description} for ontology ${ontology}`,async()=>{// Common test logic});}testSearchFunctionality("SearchTest","find meta-envelopes containing the search term in any value type");testSearchFunctionality("SearchTestHeyyy","find meta-envelopes containing the search term with parsed payload");

Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions .github/workflows/tests-evault-core.yml
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
name: Tests [evault-core]

on:
push:
branches: [main]
paths:
- 'infrastructure/evault-core/**'
pull_request:
branches: [main]
paths:
- 'infrastructure/w3id/**'

jobs:
test:
runs-on: ubuntu-latest

steps:
- name: Checkout code
uses: actions/checkout@v3

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Update the checkout action to the latest version

The current version of actions/checkout being used (v3) is outdated. The latest version (v4) includes improvements and bug fixes.

- uses: actions/checkout@v3+ uses: actions/checkout@v4
📝 Committable suggestion

‼️IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
uses: actions/checkout@v3
uses: actions/checkout@v4
🧰 Tools
🪛 actionlint (1.7.4)

19-19: the runner of "actions/checkout@v3" action is too old to run on GitHub Actions. update the action's version to fix this issue

(action)


- name: Set up Node.js 22
uses: actions/setup-node@v4
with:
node-version: 22

- name: Install pnpm
run: npm install -g pnpm

- name: Install dependencies
run: pnpm install

- name: Run tests
run: pnpm -F=evault-core test

22 changes: 22 additions & 0 deletions infrastructure/evault-core/docker-compose.yml
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
version: '3.8'

services:
neo4j:
image: neo4j:5.15
container_name: neo4j
ports:
- "7474:7474"
- "7687:7687"
environment:
- NEO4J_AUTH=neo4j/testpass
volumes:
- neo4j_data:/data
networks:
- graphnet

volumes:
neo4j_data:

networks:
graphnet:
driver: bridge
40 changes: 30 additions & 10 deletions infrastructure/evault-core/package.json
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,32 @@
{
"name": "evault-core",
"version": "1.0.0",
"description": "",
"main": "index.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"keywords": [],
"author": "",
"license": "ISC"
"name": "evault-core",
"version": "0.1.0",
"description": "",
"main": "index.js",
"scripts": {
"test": "vitest --config vitest.config.ts"
},
"keywords": [],
"author": "",
"license": "ISC",
"devDependencies": {
"@types/json-schema": "^7.0.15",
"@types/node": "^22.13.10",
"dotenv": "^16.5.0",
"testcontainers": "^10.24.2",
"tsx": "^4.19.3",
"typescript": "^5.8.3",
"uuid": "^11.1.0",
"vitest": "^3.0.9"
},
"dependencies": {
"@testcontainers/neo4j": "^10.24.2",
"graphql": "^16.10.0",
"graphql-type-json": "^0.3.2",
"graphql-voyager": "^2.1.0",
"graphql-yoga": "^5.13.4",
"json-schema": "^0.4.0",
"neo4j-driver": "^5.28.1",
"w3id": "workspace:*"
}
}
270 changes: 270 additions & 0 deletions infrastructure/evault-core/src/db/db.service.spec.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,270 @@
import neo4j, { Driver } from "neo4j-driver";
import { DbService } from "./db.service"; // adjust if needed
import { it, describe, beforeAll, afterAll, expect } from "vitest";
import { Neo4jContainer, StartedNeo4jContainer } from "@testcontainers/neo4j";

type Envelope = {
id: string;
ontology: string;
value: any;
valueType: string;
};

describe("DbService (integration)", () => {
let container: StartedNeo4jContainer;
let service: DbService;
let driver: Driver;

beforeAll(async () => {
container = await new Neo4jContainer("neo4j:5.15").start();

const username = container.getUsername();
const password = container.getPassword();
const boltPort = container.getMappedPort(7687);
const uri = `bolt://localhost:${boltPort}`;

driver = neo4j.driver(uri, neo4j.auth.basic(username, password));
service = new DbService(driver);
});

afterAll(async () => {
await service.close();
await driver.close();
await container.stop();
});

it("should store and retrieve a meta-envelope with various data types", async () => {
const input = {
ontology: "TestTypes",
payload: {
string: "hello world",
number: 42,
boolean: true,
date: new Date("2025-04-10T00:00:00Z"),
array: [1, 2, 3],
object: { nested: { value: "deep" } },
},
acl: ["@test-user"],
};

const result = await service.storeMetaEnvelope(input, input.acl);
const id = result.metaEnvelope.id;

const fetched = await service.findMetaEnvelopeById(id);
expect(fetched).toBeDefined();
expect(fetched.id).toBeDefined();
expect(fetched.ontology).toBe("TestTypes");
expect(fetched.acl).toEqual(["@test-user"]);
expect(fetched.envelopes).toHaveLength(6);

// Verify parsed field matches original payload
expect(fetched.parsed).toEqual(input.payload);

// Verify each data type is properly stored and retrieved
const envelopes = fetched.envelopes.reduce(
(acc: Record<string, Envelope>, e: Envelope) => {
acc[e.ontology] = e;
return acc;
},
{},
);

expect(envelopes.string.value).toBe("hello world");
expect(envelopes.string.valueType).toBe("string");

expect(envelopes.number.value).toBe(42);
expect(envelopes.number.valueType).toBe("number");

expect(envelopes.boolean.value).toBe(true);
expect(envelopes.boolean.valueType).toBe("boolean");

expect(envelopes.date.value).toBeInstanceOf(Date);
expect(envelopes.date.value.toISOString()).toBe(
"2025-04-10T00:00:00.000Z",
);
expect(envelopes.date.valueType).toBe("date");

expect(envelopes.array.value).toEqual([1, 2, 3]);
expect(envelopes.array.valueType).toBe("array");

expect(envelopes.object.value).toEqual({ nested: { value: "deep" } });
expect(envelopes.object.valueType).toBe("object");
});

it("should find meta-envelopes containing the search term in any envelope value", async () => {
const input = {
ontology: "SocialMediaPost",
payload: {
text: "This is a searchable tweet",
image: "https://example.com/image.jpg",
likes: ["user1", "user2"],
},
acl: ["@search-test-user"],
};

const metaEnv = await service.storeMetaEnvelope(input, input.acl);

const found = await service.findMetaEnvelopesBySearchTerm(
"SocialMediaPost",
"searchable",
);

expect(Array.isArray(found)).toBe(true);
const match = found.find((m) => m.id === metaEnv.metaEnvelope.id);
expect(match).toBeDefined();
if (!match) throw new Error();
expect(match.envelopes.length).toBeGreaterThan(0);
expect(
match.envelopes.some((e) => e.value.includes("searchable")),
).toBe(true);
});

it("should return empty array if no values contain the search term", async () => {
const found = await service.findMetaEnvelopesBySearchTerm(
"SocialMediaPost",
"notfoundterm",
);
expect(Array.isArray(found)).toBe(true);
expect(found.length).toBe(0);
});

it("should find meta-envelopes by ontology", async () => {
const results =
await service.findMetaEnvelopesByOntology("SocialMediaPost");
expect(Array.isArray(results)).toBe(true);
expect(results.length).toBeGreaterThan(0);
});

it("should delete a meta-envelope and its envelopes", async () => {
const meta = {
ontology: "TempPost",
payload: {
value: "to be deleted",
},
acl: ["@delete-user"],
};

const stored = await service.storeMetaEnvelope(meta, meta.acl);
await service.deleteMetaEnvelope(stored.metaEnvelope.id);

const deleted = await service.findMetaEnvelopeById(
stored.metaEnvelope.id,
);
expect(deleted).toBeNull();
});

it("should update envelope value with proper type handling", async () => {
const meta = {
ontology: "UpdateTest",
payload: {
value: "original",
},
acl: ["@updater"],
};

const stored = await service.storeMetaEnvelope(meta, meta.acl);

const result = await service.findMetaEnvelopeById(
stored.metaEnvelope.id,
);
const targetEnvelope = result.envelopes.find(
(e: Envelope) => e.ontology === "value",
);

// Update with a different type
const newValue = new Date("2025-04-10T00:00:00Z");
await service.updateEnvelopeValue(targetEnvelope.id, newValue);

const updated = await service.findMetaEnvelopeById(
stored.metaEnvelope.id,
);
const updatedValue = updated.envelopes.find(
(e: Envelope) => e.id === targetEnvelope.id,
);
expect(updatedValue.value).toBeInstanceOf(Date);
expect(updatedValue.value.toISOString()).toBe(
"2025-04-10T00:00:00.000Z",
);
expect(updatedValue.valueType).toBe("date");
});

it("should find meta-envelopes containing the search term in any value type", async () => {
const input = {
ontology: "SearchTest",
payload: {
string: "This is a searchable string",
array: ["searchable", "array", "element"],
object: { text: "searchable object" },
number: 42,
date: new Date("2025-04-10T00:00:00Z"),
},
acl: ["@search-test-user"],
};

const metaEnv = await service.storeMetaEnvelope(input, input.acl);

// Test search in string
const foundInString = await service.findMetaEnvelopesBySearchTerm(
"SearchTest",
"searchable string",
);
expect(foundInString.length).toBeGreaterThan(0);
expect(foundInString[0].id).toBe(metaEnv.metaEnvelope.id);

// Test search in array
const foundInArray = await service.findMetaEnvelopesBySearchTerm(
"SearchTest",
"searchable",
);
expect(foundInArray.length).toBeGreaterThan(0);
expect(foundInArray[0].id).toBe(metaEnv.metaEnvelope.id);

// Test search in object
const foundInObject = await service.findMetaEnvelopesBySearchTerm(
"SearchTest",
"searchable object",
);
expect(foundInObject.length).toBeGreaterThan(0);
expect(foundInObject[0].id).toBe(metaEnv.metaEnvelope.id);
});

it("should find meta-envelopes containing the search term with parsed payload", async () => {
const input = {
ontology: "SearchTestHeyyy",
payload: {
string: "This is a searchable string",
array: ["searchable", "array", "element"],
object: { text: "searchable object" },
number: 42,
date: new Date("2025-04-10T00:00:00Z"),
},
acl: ["@search-test-user"],
};

const metaEnv = await service.storeMetaEnvelope(input, input.acl);

// Test search in string
const foundInString = await service.findMetaEnvelopesBySearchTerm(
"SearchTestHeyyy",
"searchable string",
);
expect(foundInString.length).toBeGreaterThan(0);
expect(foundInString[0].id).toBe(metaEnv.metaEnvelope.id);

// Test search in array
const foundInArray = await service.findMetaEnvelopesBySearchTerm(
"SearchTestHeyyy",
"searchable",
);
expect(foundInArray.length).toBeGreaterThan(0);
expect(foundInArray[0].id).toBe(metaEnv.metaEnvelope.id);

// Test search in object
const foundInObject = await service.findMetaEnvelopesBySearchTerm(
"SearchTestHeyyy",
"searchable object",
);
expect(foundInObject.length).toBeGreaterThan(0);
expect(foundInObject[0].id).toBe(metaEnv.metaEnvelope.id);
});
});
Comment on lines +191 to +270

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Eliminate redundant tests.

This test is almost identical to the search test at lines 94-120, and the test at lines 231-269 is nearly identical to the test at lines 191-230. Consider consolidating these tests to reduce duplication.

Consider consolidating the duplicate tests by:

  1. Using a parameterized test approach
  2. Creating helper functions for common test patterns
  3. Or at minimum, adding comments explaining why these separate but similar tests are necessary

For example:

functiontestSearchFunctionality(ontology: string,description: string){it(`should ${description} for ontology ${ontology}`,async()=>{// Common test logic});}testSearchFunctionality("SearchTest","find meta-envelopes containing the search term in any value type");testSearchFunctionality("SearchTestHeyyy","find meta-envelopes containing the search term with parsed payload");

Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions .github/workflows/tests-evault-core.yml
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
name: Tests [evault-core]

on:
push:
branches: [main]
paths:
- 'infrastructure/evault-core/**'
pull_request:
branches: [main]
paths:
- 'infrastructure/w3id/**'

jobs:
test:
runs-on: ubuntu-latest

steps:
- name: Checkout code
uses: actions/checkout@v3

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Update the checkout action to the latest version

The current version of actions/checkout being used (v3) is outdated. The latest version (v4) includes improvements and bug fixes.

- uses: actions/checkout@v3+ uses: actions/checkout@v4
📝 Committable suggestion

‼️IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
uses: actions/checkout@v3
uses: actions/checkout@v4
🧰 Tools
🪛 actionlint (1.7.4)

19-19: the runner of "actions/checkout@v3" action is too old to run on GitHub Actions. update the action's version to fix this issue

(action)


- name: Set up Node.js 22
uses: actions/setup-node@v4
with:
node-version: 22

- name: Install pnpm
run: npm install -g pnpm

- name: Install dependencies
run: pnpm install

- name: Run tests
run: pnpm -F=evault-core test

22 changes: 22 additions & 0 deletions infrastructure/evault-core/docker-compose.yml
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
version: '3.8'

services:
neo4j:
image: neo4j:5.15
container_name: neo4j
ports:
- "7474:7474"
- "7687:7687"
environment:
- NEO4J_AUTH=neo4j/testpass
volumes:
- neo4j_data:/data
networks:
- graphnet

volumes:
neo4j_data:

networks:
graphnet:
driver: bridge
40 changes: 30 additions & 10 deletions infrastructure/evault-core/package.json
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,32 @@
{
"name": "evault-core",
"version": "1.0.0",
"description": "",
"main": "index.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"keywords": [],
"author": "",
"license": "ISC"
"name": "evault-core",
"version": "0.1.0",
"description": "",
"main": "index.js",
"scripts": {
"test": "vitest --config vitest.config.ts"
},
"keywords": [],
"author": "",
"license": "ISC",
"devDependencies": {
"@types/json-schema": "^7.0.15",
"@types/node": "^22.13.10",
"dotenv": "^16.5.0",
"testcontainers": "^10.24.2",
"tsx": "^4.19.3",
"typescript": "^5.8.3",
"uuid": "^11.1.0",
"vitest": "^3.0.9"
},
"dependencies": {
"@testcontainers/neo4j": "^10.24.2",
"graphql": "^16.10.0",
"graphql-type-json": "^0.3.2",
"graphql-voyager": "^2.1.0",
"graphql-yoga": "^5.13.4",
"json-schema": "^0.4.0",
"neo4j-driver": "^5.28.1",
"w3id": "workspace:*"
}
}
270 changes: 270 additions & 0 deletions infrastructure/evault-core/src/db/db.service.spec.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,270 @@
import neo4j, { Driver } from "neo4j-driver";
import { DbService } from "./db.service"; // adjust if needed
import { it, describe, beforeAll, afterAll, expect } from "vitest";
import { Neo4jContainer, StartedNeo4jContainer } from "@testcontainers/neo4j";

type Envelope = {
id: string;
ontology: string;
value: any;
valueType: string;
};

describe("DbService (integration)", () => {
let container: StartedNeo4jContainer;
let service: DbService;
let driver: Driver;

beforeAll(async () => {
container = await new Neo4jContainer("neo4j:5.15").start();

const username = container.getUsername();
const password = container.getPassword();
const boltPort = container.getMappedPort(7687);
const uri = `bolt://localhost:${boltPort}`;

driver = neo4j.driver(uri, neo4j.auth.basic(username, password));
service = new DbService(driver);
});

afterAll(async () => {
await service.close();
await driver.close();
await container.stop();
});

it("should store and retrieve a meta-envelope with various data types", async () => {
const input = {
ontology: "TestTypes",
payload: {
string: "hello world",
number: 42,
boolean: true,
date: new Date("2025-04-10T00:00:00Z"),
array: [1, 2, 3],
object: { nested: { value: "deep" } },
},
acl: ["@test-user"],
};

const result = await service.storeMetaEnvelope(input, input.acl);
const id = result.metaEnvelope.id;

const fetched = await service.findMetaEnvelopeById(id);
expect(fetched).toBeDefined();
expect(fetched.id).toBeDefined();
expect(fetched.ontology).toBe("TestTypes");
expect(fetched.acl).toEqual(["@test-user"]);
expect(fetched.envelopes).toHaveLength(6);

// Verify parsed field matches original payload
expect(fetched.parsed).toEqual(input.payload);

// Verify each data type is properly stored and retrieved
const envelopes = fetched.envelopes.reduce(
(acc: Record<string, Envelope>, e: Envelope) => {
acc[e.ontology] = e;
return acc;
},
{},
);

expect(envelopes.string.value).toBe("hello world");
expect(envelopes.string.valueType).toBe("string");

expect(envelopes.number.value).toBe(42);
expect(envelopes.number.valueType).toBe("number");

expect(envelopes.boolean.value).toBe(true);
expect(envelopes.boolean.valueType).toBe("boolean");

expect(envelopes.date.value).toBeInstanceOf(Date);
expect(envelopes.date.value.toISOString()).toBe(
"2025-04-10T00:00:00.000Z",
);
expect(envelopes.date.valueType).toBe("date");

expect(envelopes.array.value).toEqual([1, 2, 3]);
expect(envelopes.array.valueType).toBe("array");

expect(envelopes.object.value).toEqual({ nested: { value: "deep" } });
expect(envelopes.object.valueType).toBe("object");
});

it("should find meta-envelopes containing the search term in any envelope value", async () => {
const input = {
ontology: "SocialMediaPost",
payload: {
text: "This is a searchable tweet",
image: "https://example.com/image.jpg",
likes: ["user1", "user2"],
},
acl: ["@search-test-user"],
};

const metaEnv = await service.storeMetaEnvelope(input, input.acl);

const found = await service.findMetaEnvelopesBySearchTerm(
"SocialMediaPost",
"searchable",
);

expect(Array.isArray(found)).toBe(true);
const match = found.find((m) => m.id === metaEnv.metaEnvelope.id);
expect(match).toBeDefined();
if (!match) throw new Error();
expect(match.envelopes.length).toBeGreaterThan(0);
expect(
match.envelopes.some((e) => e.value.includes("searchable")),
).toBe(true);
});

it("should return empty array if no values contain the search term", async () => {
const found = await service.findMetaEnvelopesBySearchTerm(
"SocialMediaPost",
"notfoundterm",
);
expect(Array.isArray(found)).toBe(true);
expect(found.length).toBe(0);
});

it("should find meta-envelopes by ontology", async () => {
const results =
await service.findMetaEnvelopesByOntology("SocialMediaPost");
expect(Array.isArray(results)).toBe(true);
expect(results.length).toBeGreaterThan(0);
});

it("should delete a meta-envelope and its envelopes", async () => {
const meta = {
ontology: "TempPost",
payload: {
value: "to be deleted",
},
acl: ["@delete-user"],
};

const stored = await service.storeMetaEnvelope(meta, meta.acl);
await service.deleteMetaEnvelope(stored.metaEnvelope.id);

const deleted = await service.findMetaEnvelopeById(
stored.metaEnvelope.id,
);
expect(deleted).toBeNull();
});

it("should update envelope value with proper type handling", async () => {
const meta = {
ontology: "UpdateTest",
payload: {
value: "original",
},
acl: ["@updater"],
};

const stored = await service.storeMetaEnvelope(meta, meta.acl);

const result = await service.findMetaEnvelopeById(
stored.metaEnvelope.id,
);
const targetEnvelope = result.envelopes.find(
(e: Envelope) => e.ontology === "value",
);

// Update with a different type
const newValue = new Date("2025-04-10T00:00:00Z");
await service.updateEnvelopeValue(targetEnvelope.id, newValue);

const updated = await service.findMetaEnvelopeById(
stored.metaEnvelope.id,
);
const updatedValue = updated.envelopes.find(
(e: Envelope) => e.id === targetEnvelope.id,
);
expect(updatedValue.value).toBeInstanceOf(Date);
expect(updatedValue.value.toISOString()).toBe(
"2025-04-10T00:00:00.000Z",
);
expect(updatedValue.valueType).toBe("date");
});

it("should find meta-envelopes containing the search term in any value type", async () => {
const input = {
ontology: "SearchTest",
payload: {
string: "This is a searchable string",
array: ["searchable", "array", "element"],
object: { text: "searchable object" },
number: 42,
date: new Date("2025-04-10T00:00:00Z"),
},
acl: ["@search-test-user"],
};

const metaEnv = await service.storeMetaEnvelope(input, input.acl);

// Test search in string
const foundInString = await service.findMetaEnvelopesBySearchTerm(
"SearchTest",
"searchable string",
);
expect(foundInString.length).toBeGreaterThan(0);
expect(foundInString[0].id).toBe(metaEnv.metaEnvelope.id);

// Test search in array
const foundInArray = await service.findMetaEnvelopesBySearchTerm(
"SearchTest",
"searchable",
);
expect(foundInArray.length).toBeGreaterThan(0);
expect(foundInArray[0].id).toBe(metaEnv.metaEnvelope.id);

// Test search in object
const foundInObject = await service.findMetaEnvelopesBySearchTerm(
"SearchTest",
"searchable object",
);
expect(foundInObject.length).toBeGreaterThan(0);
expect(foundInObject[0].id).toBe(metaEnv.metaEnvelope.id);
});

it("should find meta-envelopes containing the search term with parsed payload", async () => {
const input = {
ontology: "SearchTestHeyyy",
payload: {
string: "This is a searchable string",
array: ["searchable", "array", "element"],
object: { text: "searchable object" },
number: 42,
date: new Date("2025-04-10T00:00:00Z"),
},
acl: ["@search-test-user"],
};

const metaEnv = await service.storeMetaEnvelope(input, input.acl);

// Test search in string
const foundInString = await service.findMetaEnvelopesBySearchTerm(
"SearchTestHeyyy",
"searchable string",
);
expect(foundInString.length).toBeGreaterThan(0);
expect(foundInString[0].id).toBe(metaEnv.metaEnvelope.id);

// Test search in array
const foundInArray = await service.findMetaEnvelopesBySearchTerm(
"SearchTestHeyyy",
"searchable",
);
expect(foundInArray.length).toBeGreaterThan(0);
expect(foundInArray[0].id).toBe(metaEnv.metaEnvelope.id);

// Test search in object
const foundInObject = await service.findMetaEnvelopesBySearchTerm(
"SearchTestHeyyy",
"searchable object",
);
expect(foundInObject.length).toBeGreaterThan(0);
expect(foundInObject[0].id).toBe(metaEnv.metaEnvelope.id);
});
});
Comment on lines +191 to +270

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Eliminate redundant tests.

This test is almost identical to the search test at lines 94-120, and the test at lines 231-269 is nearly identical to the test at lines 191-230. Consider consolidating these tests to reduce duplication.

Consider consolidating the duplicate tests by:

  1. Using a parameterized test approach
  2. Creating helper functions for common test patterns
  3. Or at minimum, adding comments explaining why these separate but similar tests are necessary

For example:

functiontestSearchFunctionality(ontology: string,description: string){it(`should ${description} for ontology ${ontology}`,async()=>{// Common test logic});}testSearchFunctionality("SearchTest","find meta-envelopes containing the search term in any value type");testSearchFunctionality("SearchTestHeyyy","find meta-envelopes containing the search term with parsed payload");

Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions .github/workflows/tests-evault-core.yml
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
name: Tests [evault-core]

on:
push:
branches: [main]
paths:
- 'infrastructure/evault-core/**'
pull_request:
branches: [main]
paths:
- 'infrastructure/w3id/**'

jobs:
test:
runs-on: ubuntu-latest

steps:
- name: Checkout code
uses: actions/checkout@v3

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Update the checkout action to the latest version

The current version of actions/checkout being used (v3) is outdated. The latest version (v4) includes improvements and bug fixes.

- uses: actions/checkout@v3+ uses: actions/checkout@v4
📝 Committable suggestion

‼️IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
uses: actions/checkout@v3
uses: actions/checkout@v4
🧰 Tools
🪛 actionlint (1.7.4)

19-19: the runner of "actions/checkout@v3" action is too old to run on GitHub Actions. update the action's version to fix this issue

(action)


- name: Set up Node.js 22
uses: actions/setup-node@v4
with:
node-version: 22

- name: Install pnpm
run: npm install -g pnpm

- name: Install dependencies
run: pnpm install

- name: Run tests
run: pnpm -F=evault-core test

22 changes: 22 additions & 0 deletions infrastructure/evault-core/docker-compose.yml
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
version: '3.8'

services:
neo4j:
image: neo4j:5.15
container_name: neo4j
ports:
- "7474:7474"
- "7687:7687"
environment:
- NEO4J_AUTH=neo4j/testpass
volumes:
- neo4j_data:/data
networks:
- graphnet

volumes:
neo4j_data:

networks:
graphnet:
driver: bridge
40 changes: 30 additions & 10 deletions infrastructure/evault-core/package.json
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,32 @@
{
"name": "evault-core",
"version": "1.0.0",
"description": "",
"main": "index.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"keywords": [],
"author": "",
"license": "ISC"
"name": "evault-core",
"version": "0.1.0",
"description": "",
"main": "index.js",
"scripts": {
"test": "vitest --config vitest.config.ts"
},
"keywords": [],
"author": "",
"license": "ISC",
"devDependencies": {
"@types/json-schema": "^7.0.15",
"@types/node": "^22.13.10",
"dotenv": "^16.5.0",
"testcontainers": "^10.24.2",
"tsx": "^4.19.3",
"typescript": "^5.8.3",
"uuid": "^11.1.0",
"vitest": "^3.0.9"
},
"dependencies": {
"@testcontainers/neo4j": "^10.24.2",
"graphql": "^16.10.0",
"graphql-type-json": "^0.3.2",
"graphql-voyager": "^2.1.0",
"graphql-yoga": "^5.13.4",
"json-schema": "^0.4.0",
"neo4j-driver": "^5.28.1",
"w3id": "workspace:*"
}
}
270 changes: 270 additions & 0 deletions infrastructure/evault-core/src/db/db.service.spec.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,270 @@
import neo4j, { Driver } from "neo4j-driver";
import { DbService } from "./db.service"; // adjust if needed
import { it, describe, beforeAll, afterAll, expect } from "vitest";
import { Neo4jContainer, StartedNeo4jContainer } from "@testcontainers/neo4j";

type Envelope = {
id: string;
ontology: string;
value: any;
valueType: string;
};

describe("DbService (integration)", () => {
let container: StartedNeo4jContainer;
let service: DbService;
let driver: Driver;

beforeAll(async () => {
container = await new Neo4jContainer("neo4j:5.15").start();

const username = container.getUsername();
const password = container.getPassword();
const boltPort = container.getMappedPort(7687);
const uri = `bolt://localhost:${boltPort}`;

driver = neo4j.driver(uri, neo4j.auth.basic(username, password));
service = new DbService(driver);
});

afterAll(async () => {
await service.close();
await driver.close();
await container.stop();
});

it("should store and retrieve a meta-envelope with various data types", async () => {
const input = {
ontology: "TestTypes",
payload: {
string: "hello world",
number: 42,
boolean: true,
date: new Date("2025-04-10T00:00:00Z"),
array: [1, 2, 3],
object: { nested: { value: "deep" } },
},
acl: ["@test-user"],
};

const result = await service.storeMetaEnvelope(input, input.acl);
const id = result.metaEnvelope.id;

const fetched = await service.findMetaEnvelopeById(id);
expect(fetched).toBeDefined();
expect(fetched.id).toBeDefined();
expect(fetched.ontology).toBe("TestTypes");
expect(fetched.acl).toEqual(["@test-user"]);
expect(fetched.envelopes).toHaveLength(6);

// Verify parsed field matches original payload
expect(fetched.parsed).toEqual(input.payload);

// Verify each data type is properly stored and retrieved
const envelopes = fetched.envelopes.reduce(
(acc: Record<string, Envelope>, e: Envelope) => {
acc[e.ontology] = e;
return acc;
},
{},
);

expect(envelopes.string.value).toBe("hello world");
expect(envelopes.string.valueType).toBe("string");

expect(envelopes.number.value).toBe(42);
expect(envelopes.number.valueType).toBe("number");

expect(envelopes.boolean.value).toBe(true);
expect(envelopes.boolean.valueType).toBe("boolean");

expect(envelopes.date.value).toBeInstanceOf(Date);
expect(envelopes.date.value.toISOString()).toBe(
"2025-04-10T00:00:00.000Z",
);
expect(envelopes.date.valueType).toBe("date");

expect(envelopes.array.value).toEqual([1, 2, 3]);
expect(envelopes.array.valueType).toBe("array");

expect(envelopes.object.value).toEqual({ nested: { value: "deep" } });
expect(envelopes.object.valueType).toBe("object");
});

it("should find meta-envelopes containing the search term in any envelope value", async () => {
const input = {
ontology: "SocialMediaPost",
payload: {
text: "This is a searchable tweet",
image: "https://example.com/image.jpg",
likes: ["user1", "user2"],
},
acl: ["@search-test-user"],
};

const metaEnv = await service.storeMetaEnvelope(input, input.acl);

const found = await service.findMetaEnvelopesBySearchTerm(
"SocialMediaPost",
"searchable",
);

expect(Array.isArray(found)).toBe(true);
const match = found.find((m) => m.id === metaEnv.metaEnvelope.id);
expect(match).toBeDefined();
if (!match) throw new Error();
expect(match.envelopes.length).toBeGreaterThan(0);
expect(
match.envelopes.some((e) => e.value.includes("searchable")),
).toBe(true);
});

it("should return empty array if no values contain the search term", async () => {
const found = await service.findMetaEnvelopesBySearchTerm(
"SocialMediaPost",
"notfoundterm",
);
expect(Array.isArray(found)).toBe(true);
expect(found.length).toBe(0);
});

it("should find meta-envelopes by ontology", async () => {
const results =
await service.findMetaEnvelopesByOntology("SocialMediaPost");
expect(Array.isArray(results)).toBe(true);
expect(results.length).toBeGreaterThan(0);
});

it("should delete a meta-envelope and its envelopes", async () => {
const meta = {
ontology: "TempPost",
payload: {
value: "to be deleted",
},
acl: ["@delete-user"],
};

const stored = await service.storeMetaEnvelope(meta, meta.acl);
await service.deleteMetaEnvelope(stored.metaEnvelope.id);

const deleted = await service.findMetaEnvelopeById(
stored.metaEnvelope.id,
);
expect(deleted).toBeNull();
});

it("should update envelope value with proper type handling", async () => {
const meta = {
ontology: "UpdateTest",
payload: {
value: "original",
},
acl: ["@updater"],
};

const stored = await service.storeMetaEnvelope(meta, meta.acl);

const result = await service.findMetaEnvelopeById(
stored.metaEnvelope.id,
);
const targetEnvelope = result.envelopes.find(
(e: Envelope) => e.ontology === "value",
);

// Update with a different type
const newValue = new Date("2025-04-10T00:00:00Z");
await service.updateEnvelopeValue(targetEnvelope.id, newValue);

const updated = await service.findMetaEnvelopeById(
stored.metaEnvelope.id,
);
const updatedValue = updated.envelopes.find(
(e: Envelope) => e.id === targetEnvelope.id,
);
expect(updatedValue.value).toBeInstanceOf(Date);
expect(updatedValue.value.toISOString()).toBe(
"2025-04-10T00:00:00.000Z",
);
expect(updatedValue.valueType).toBe("date");
});

it("should find meta-envelopes containing the search term in any value type", async () => {
const input = {
ontology: "SearchTest",
payload: {
string: "This is a searchable string",
array: ["searchable", "array", "element"],
object: { text: "searchable object" },
number: 42,
date: new Date("2025-04-10T00:00:00Z"),
},
acl: ["@search-test-user"],
};

const metaEnv = await service.storeMetaEnvelope(input, input.acl);

// Test search in string
const foundInString = await service.findMetaEnvelopesBySearchTerm(
"SearchTest",
"searchable string",
);
expect(foundInString.length).toBeGreaterThan(0);
expect(foundInString[0].id).toBe(metaEnv.metaEnvelope.id);

// Test search in array
const foundInArray = await service.findMetaEnvelopesBySearchTerm(
"SearchTest",
"searchable",
);
expect(foundInArray.length).toBeGreaterThan(0);
expect(foundInArray[0].id).toBe(metaEnv.metaEnvelope.id);

// Test search in object
const foundInObject = await service.findMetaEnvelopesBySearchTerm(
"SearchTest",
"searchable object",
);
expect(foundInObject.length).toBeGreaterThan(0);
expect(foundInObject[0].id).toBe(metaEnv.metaEnvelope.id);
});

it("should find meta-envelopes containing the search term with parsed payload", async () => {
const input = {
ontology: "SearchTestHeyyy",
payload: {
string: "This is a searchable string",
array: ["searchable", "array", "element"],
object: { text: "searchable object" },
number: 42,
date: new Date("2025-04-10T00:00:00Z"),
},
acl: ["@search-test-user"],
};

const metaEnv = await service.storeMetaEnvelope(input, input.acl);

// Test search in string
const foundInString = await service.findMetaEnvelopesBySearchTerm(
"SearchTestHeyyy",
"searchable string",
);
expect(foundInString.length).toBeGreaterThan(0);
expect(foundInString[0].id).toBe(metaEnv.metaEnvelope.id);

// Test search in array
const foundInArray = await service.findMetaEnvelopesBySearchTerm(
"SearchTestHeyyy",
"searchable",
);
expect(foundInArray.length).toBeGreaterThan(0);
expect(foundInArray[0].id).toBe(metaEnv.metaEnvelope.id);

// Test search in object
const foundInObject = await service.findMetaEnvelopesBySearchTerm(
"SearchTestHeyyy",
"searchable object",
);
expect(foundInObject.length).toBeGreaterThan(0);
expect(foundInObject[0].id).toBe(metaEnv.metaEnvelope.id);
});
});
Comment on lines +191 to +270

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Eliminate redundant tests.

This test is almost identical to the search test at lines 94-120, and the test at lines 231-269 is nearly identical to the test at lines 191-230. Consider consolidating these tests to reduce duplication.

Consider consolidating the duplicate tests by:

  1. Using a parameterized test approach
  2. Creating helper functions for common test patterns
  3. Or at minimum, adding comments explaining why these separate but similar tests are necessary

For example:

functiontestSearchFunctionality(ontology: string,description: string){it(`should ${description} for ontology ${ontology}`,async()=>{// Common test logic});}testSearchFunctionality("SearchTest","find meta-envelopes containing the search term in any value type");testSearchFunctionality("SearchTestHeyyy","find meta-envelopes containing the search term with parsed payload");

Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions .github/workflows/tests-evault-core.yml
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
name: Tests [evault-core]

on:
push:
branches: [main]
paths:
- 'infrastructure/evault-core/**'
pull_request:
branches: [main]
paths:
- 'infrastructure/w3id/**'

jobs:
test:
runs-on: ubuntu-latest

steps:
- name: Checkout code
uses: actions/checkout@v3

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Update the checkout action to the latest version

The current version of actions/checkout being used (v3) is outdated. The latest version (v4) includes improvements and bug fixes.

- uses: actions/checkout@v3+ uses: actions/checkout@v4
📝 Committable suggestion

‼️IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
uses: actions/checkout@v3
uses: actions/checkout@v4
🧰 Tools
🪛 actionlint (1.7.4)

19-19: the runner of "actions/checkout@v3" action is too old to run on GitHub Actions. update the action's version to fix this issue

(action)


- name: Set up Node.js 22
uses: actions/setup-node@v4
with:
node-version: 22

- name: Install pnpm
run: npm install -g pnpm

- name: Install dependencies
run: pnpm install

- name: Run tests
run: pnpm -F=evault-core test

22 changes: 22 additions & 0 deletions infrastructure/evault-core/docker-compose.yml
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
version: '3.8'

services:
neo4j:
image: neo4j:5.15
container_name: neo4j
ports:
- "7474:7474"
- "7687:7687"
environment:
- NEO4J_AUTH=neo4j/testpass
volumes:
- neo4j_data:/data
networks:
- graphnet

volumes:
neo4j_data:

networks:
graphnet:
driver: bridge
40 changes: 30 additions & 10 deletions infrastructure/evault-core/package.json
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,32 @@
{
"name": "evault-core",
"version": "1.0.0",
"description": "",
"main": "index.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"keywords": [],
"author": "",
"license": "ISC"
"name": "evault-core",
"version": "0.1.0",
"description": "",
"main": "index.js",
"scripts": {
"test": "vitest --config vitest.config.ts"
},
"keywords": [],
"author": "",
"license": "ISC",
"devDependencies": {
"@types/json-schema": "^7.0.15",
"@types/node": "^22.13.10",
"dotenv": "^16.5.0",
"testcontainers": "^10.24.2",
"tsx": "^4.19.3",
"typescript": "^5.8.3",
"uuid": "^11.1.0",
"vitest": "^3.0.9"
},
"dependencies": {
"@testcontainers/neo4j": "^10.24.2",
"graphql": "^16.10.0",
"graphql-type-json": "^0.3.2",
"graphql-voyager": "^2.1.0",
"graphql-yoga": "^5.13.4",
"json-schema": "^0.4.0",
"neo4j-driver": "^5.28.1",
"w3id": "workspace:*"
}
}
270 changes: 270 additions & 0 deletions infrastructure/evault-core/src/db/db.service.spec.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,270 @@
import neo4j, { Driver } from "neo4j-driver";
import { DbService } from "./db.service"; // adjust if needed
import { it, describe, beforeAll, afterAll, expect } from "vitest";
import { Neo4jContainer, StartedNeo4jContainer } from "@testcontainers/neo4j";

type Envelope = {
id: string;
ontology: string;
value: any;
valueType: string;
};

describe("DbService (integration)", () => {
let container: StartedNeo4jContainer;
let service: DbService;
let driver: Driver;

beforeAll(async () => {
container = await new Neo4jContainer("neo4j:5.15").start();

const username = container.getUsername();
const password = container.getPassword();
const boltPort = container.getMappedPort(7687);
const uri = `bolt://localhost:${boltPort}`;

driver = neo4j.driver(uri, neo4j.auth.basic(username, password));
service = new DbService(driver);
});

afterAll(async () => {
await service.close();
await driver.close();
await container.stop();
});

it("should store and retrieve a meta-envelope with various data types", async () => {
const input = {
ontology: "TestTypes",
payload: {
string: "hello world",
number: 42,
boolean: true,
date: new Date("2025-04-10T00:00:00Z"),
array: [1, 2, 3],
object: { nested: { value: "deep" } },
},
acl: ["@test-user"],
};

const result = await service.storeMetaEnvelope(input, input.acl);
const id = result.metaEnvelope.id;

const fetched = await service.findMetaEnvelopeById(id);
expect(fetched).toBeDefined();
expect(fetched.id).toBeDefined();
expect(fetched.ontology).toBe("TestTypes");
expect(fetched.acl).toEqual(["@test-user"]);
expect(fetched.envelopes).toHaveLength(6);

// Verify parsed field matches original payload
expect(fetched.parsed).toEqual(input.payload);

// Verify each data type is properly stored and retrieved
const envelopes = fetched.envelopes.reduce(
(acc: Record<string, Envelope>, e: Envelope) => {
acc[e.ontology] = e;
return acc;
},
{},
);

expect(envelopes.string.value).toBe("hello world");
expect(envelopes.string.valueType).toBe("string");

expect(envelopes.number.value).toBe(42);
expect(envelopes.number.valueType).toBe("number");

expect(envelopes.boolean.value).toBe(true);
expect(envelopes.boolean.valueType).toBe("boolean");

expect(envelopes.date.value).toBeInstanceOf(Date);
expect(envelopes.date.value.toISOString()).toBe(
"2025-04-10T00:00:00.000Z",
);
expect(envelopes.date.valueType).toBe("date");

expect(envelopes.array.value).toEqual([1, 2, 3]);
expect(envelopes.array.valueType).toBe("array");

expect(envelopes.object.value).toEqual({ nested: { value: "deep" } });
expect(envelopes.object.valueType).toBe("object");
});

it("should find meta-envelopes containing the search term in any envelope value", async () => {
const input = {
ontology: "SocialMediaPost",
payload: {
text: "This is a searchable tweet",
image: "https://example.com/image.jpg",
likes: ["user1", "user2"],
},
acl: ["@search-test-user"],
};

const metaEnv = await service.storeMetaEnvelope(input, input.acl);

const found = await service.findMetaEnvelopesBySearchTerm(
"SocialMediaPost",
"searchable",
);

expect(Array.isArray(found)).toBe(true);
const match = found.find((m) => m.id === metaEnv.metaEnvelope.id);
expect(match).toBeDefined();
if (!match) throw new Error();
expect(match.envelopes.length).toBeGreaterThan(0);
expect(
match.envelopes.some((e) => e.value.includes("searchable")),
).toBe(true);
});

it("should return empty array if no values contain the search term", async () => {
const found = await service.findMetaEnvelopesBySearchTerm(
"SocialMediaPost",
"notfoundterm",
);
expect(Array.isArray(found)).toBe(true);
expect(found.length).toBe(0);
});

it("should find meta-envelopes by ontology", async () => {
const results =
await service.findMetaEnvelopesByOntology("SocialMediaPost");
expect(Array.isArray(results)).toBe(true);
expect(results.length).toBeGreaterThan(0);
});

it("should delete a meta-envelope and its envelopes", async () => {
const meta = {
ontology: "TempPost",
payload: {
value: "to be deleted",
},
acl: ["@delete-user"],
};

const stored = await service.storeMetaEnvelope(meta, meta.acl);
await service.deleteMetaEnvelope(stored.metaEnvelope.id);

const deleted = await service.findMetaEnvelopeById(
stored.metaEnvelope.id,
);
expect(deleted).toBeNull();
});

it("should update envelope value with proper type handling", async () => {
const meta = {
ontology: "UpdateTest",
payload: {
value: "original",
},
acl: ["@updater"],
};

const stored = await service.storeMetaEnvelope(meta, meta.acl);

const result = await service.findMetaEnvelopeById(
stored.metaEnvelope.id,
);
const targetEnvelope = result.envelopes.find(
(e: Envelope) => e.ontology === "value",
);

// Update with a different type
const newValue = new Date("2025-04-10T00:00:00Z");
await service.updateEnvelopeValue(targetEnvelope.id, newValue);

const updated = await service.findMetaEnvelopeById(
stored.metaEnvelope.id,
);
const updatedValue = updated.envelopes.find(
(e: Envelope) => e.id === targetEnvelope.id,
);
expect(updatedValue.value).toBeInstanceOf(Date);
expect(updatedValue.value.toISOString()).toBe(
"2025-04-10T00:00:00.000Z",
);
expect(updatedValue.valueType).toBe("date");
});

it("should find meta-envelopes containing the search term in any value type", async () => {
const input = {
ontology: "SearchTest",
payload: {
string: "This is a searchable string",
array: ["searchable", "array", "element"],
object: { text: "searchable object" },
number: 42,
date: new Date("2025-04-10T00:00:00Z"),
},
acl: ["@search-test-user"],
};

const metaEnv = await service.storeMetaEnvelope(input, input.acl);

// Test search in string
const foundInString = await service.findMetaEnvelopesBySearchTerm(
"SearchTest",
"searchable string",
);
expect(foundInString.length).toBeGreaterThan(0);
expect(foundInString[0].id).toBe(metaEnv.metaEnvelope.id);

// Test search in array
const foundInArray = await service.findMetaEnvelopesBySearchTerm(
"SearchTest",
"searchable",
);
expect(foundInArray.length).toBeGreaterThan(0);
expect(foundInArray[0].id).toBe(metaEnv.metaEnvelope.id);

// Test search in object
const foundInObject = await service.findMetaEnvelopesBySearchTerm(
"SearchTest",
"searchable object",
);
expect(foundInObject.length).toBeGreaterThan(0);
expect(foundInObject[0].id).toBe(metaEnv.metaEnvelope.id);
});

it("should find meta-envelopes containing the search term with parsed payload", async () => {
const input = {
ontology: "SearchTestHeyyy",
payload: {
string: "This is a searchable string",
array: ["searchable", "array", "element"],
object: { text: "searchable object" },
number: 42,
date: new Date("2025-04-10T00:00:00Z"),
},
acl: ["@search-test-user"],
};

const metaEnv = await service.storeMetaEnvelope(input, input.acl);

// Test search in string
const foundInString = await service.findMetaEnvelopesBySearchTerm(
"SearchTestHeyyy",
"searchable string",
);
expect(foundInString.length).toBeGreaterThan(0);
expect(foundInString[0].id).toBe(metaEnv.metaEnvelope.id);

// Test search in array
const foundInArray = await service.findMetaEnvelopesBySearchTerm(
"SearchTestHeyyy",
"searchable",
);
expect(foundInArray.length).toBeGreaterThan(0);
expect(foundInArray[0].id).toBe(metaEnv.metaEnvelope.id);

// Test search in object
const foundInObject = await service.findMetaEnvelopesBySearchTerm(
"SearchTestHeyyy",
"searchable object",
);
expect(foundInObject.length).toBeGreaterThan(0);
expect(foundInObject[0].id).toBe(metaEnv.metaEnvelope.id);
});
});
Comment on lines +191 to +270

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Eliminate redundant tests.

This test is almost identical to the search test at lines 94-120, and the test at lines 231-269 is nearly identical to the test at lines 191-230. Consider consolidating these tests to reduce duplication.

Consider consolidating the duplicate tests by:

  1. Using a parameterized test approach
  2. Creating helper functions for common test patterns
  3. Or at minimum, adding comments explaining why these separate but similar tests are necessary

For example:

functiontestSearchFunctionality(ontology: string,description: string){it(`should ${description} for ontology ${ontology}`,async()=>{// Common test logic});}testSearchFunctionality("SearchTest","find meta-envelopes containing the search term in any value type");testSearchFunctionality("SearchTestHeyyy","find meta-envelopes containing the search term with parsed payload");

Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions .github/workflows/tests-evault-core.yml
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
name: Tests [evault-core]

on:
push:
branches: [main]
paths:
- 'infrastructure/evault-core/**'
pull_request:
branches: [main]
paths:
- 'infrastructure/w3id/**'

jobs:
test:
runs-on: ubuntu-latest

steps:
- name: Checkout code
uses: actions/checkout@v3

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Update the checkout action to the latest version

The current version of actions/checkout being used (v3) is outdated. The latest version (v4) includes improvements and bug fixes.

- uses: actions/checkout@v3+ uses: actions/checkout@v4
📝 Committable suggestion

‼️IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
uses: actions/checkout@v3
uses: actions/checkout@v4
🧰 Tools
🪛 actionlint (1.7.4)

19-19: the runner of "actions/checkout@v3" action is too old to run on GitHub Actions. update the action's version to fix this issue

(action)


- name: Set up Node.js 22
uses: actions/setup-node@v4
with:
node-version: 22

- name: Install pnpm
run: npm install -g pnpm

- name: Install dependencies
run: pnpm install

- name: Run tests
run: pnpm -F=evault-core test

22 changes: 22 additions & 0 deletions infrastructure/evault-core/docker-compose.yml
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
version: '3.8'

services:
neo4j:
image: neo4j:5.15
container_name: neo4j
ports:
- "7474:7474"
- "7687:7687"
environment:
- NEO4J_AUTH=neo4j/testpass
volumes:
- neo4j_data:/data
networks:
- graphnet

volumes:
neo4j_data:

networks:
graphnet:
driver: bridge
40 changes: 30 additions & 10 deletions infrastructure/evault-core/package.json
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,32 @@
{
"name": "evault-core",
"version": "1.0.0",
"description": "",
"main": "index.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"keywords": [],
"author": "",
"license": "ISC"
"name": "evault-core",
"version": "0.1.0",
"description": "",
"main": "index.js",
"scripts": {
"test": "vitest --config vitest.config.ts"
},
"keywords": [],
"author": "",
"license": "ISC",
"devDependencies": {
"@types/json-schema": "^7.0.15",
"@types/node": "^22.13.10",
"dotenv": "^16.5.0",
"testcontainers": "^10.24.2",
"tsx": "^4.19.3",
"typescript": "^5.8.3",
"uuid": "^11.1.0",
"vitest": "^3.0.9"
},
"dependencies": {
"@testcontainers/neo4j": "^10.24.2",
"graphql": "^16.10.0",
"graphql-type-json": "^0.3.2",
"graphql-voyager": "^2.1.0",
"graphql-yoga": "^5.13.4",
"json-schema": "^0.4.0",
"neo4j-driver": "^5.28.1",
"w3id": "workspace:*"
}
}
270 changes: 270 additions & 0 deletions infrastructure/evault-core/src/db/db.service.spec.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,270 @@
import neo4j, { Driver } from "neo4j-driver";
import { DbService } from "./db.service"; // adjust if needed
import { it, describe, beforeAll, afterAll, expect } from "vitest";
import { Neo4jContainer, StartedNeo4jContainer } from "@testcontainers/neo4j";

type Envelope = {
id: string;
ontology: string;
value: any;
valueType: string;
};

describe("DbService (integration)", () => {
let container: StartedNeo4jContainer;
let service: DbService;
let driver: Driver;

beforeAll(async () => {
container = await new Neo4jContainer("neo4j:5.15").start();

const username = container.getUsername();
const password = container.getPassword();
const boltPort = container.getMappedPort(7687);
const uri = `bolt://localhost:${boltPort}`;

driver = neo4j.driver(uri, neo4j.auth.basic(username, password));
service = new DbService(driver);
});

afterAll(async () => {
await service.close();
await driver.close();
await container.stop();
});

it("should store and retrieve a meta-envelope with various data types", async () => {
const input = {
ontology: "TestTypes",
payload: {
string: "hello world",
number: 42,
boolean: true,
date: new Date("2025-04-10T00:00:00Z"),
array: [1, 2, 3],
object: { nested: { value: "deep" } },
},
acl: ["@test-user"],
};

const result = await service.storeMetaEnvelope(input, input.acl);
const id = result.metaEnvelope.id;

const fetched = await service.findMetaEnvelopeById(id);
expect(fetched).toBeDefined();
expect(fetched.id).toBeDefined();
expect(fetched.ontology).toBe("TestTypes");
expect(fetched.acl).toEqual(["@test-user"]);
expect(fetched.envelopes).toHaveLength(6);

// Verify parsed field matches original payload
expect(fetched.parsed).toEqual(input.payload);

// Verify each data type is properly stored and retrieved
const envelopes = fetched.envelopes.reduce(
(acc: Record<string, Envelope>, e: Envelope) => {
acc[e.ontology] = e;
return acc;
},
{},
);

expect(envelopes.string.value).toBe("hello world");
expect(envelopes.string.valueType).toBe("string");

expect(envelopes.number.value).toBe(42);
expect(envelopes.number.valueType).toBe("number");

expect(envelopes.boolean.value).toBe(true);
expect(envelopes.boolean.valueType).toBe("boolean");

expect(envelopes.date.value).toBeInstanceOf(Date);
expect(envelopes.date.value.toISOString()).toBe(
"2025-04-10T00:00:00.000Z",
);
expect(envelopes.date.valueType).toBe("date");

expect(envelopes.array.value).toEqual([1, 2, 3]);
expect(envelopes.array.valueType).toBe("array");

expect(envelopes.object.value).toEqual({ nested: { value: "deep" } });
expect(envelopes.object.valueType).toBe("object");
});

it("should find meta-envelopes containing the search term in any envelope value", async () => {
const input = {
ontology: "SocialMediaPost",
payload: {
text: "This is a searchable tweet",
image: "https://example.com/image.jpg",
likes: ["user1", "user2"],
},
acl: ["@search-test-user"],
};

const metaEnv = await service.storeMetaEnvelope(input, input.acl);

const found = await service.findMetaEnvelopesBySearchTerm(
"SocialMediaPost",
"searchable",
);

expect(Array.isArray(found)).toBe(true);
const match = found.find((m) => m.id === metaEnv.metaEnvelope.id);
expect(match).toBeDefined();
if (!match) throw new Error();
expect(match.envelopes.length).toBeGreaterThan(0);
expect(
match.envelopes.some((e) => e.value.includes("searchable")),
).toBe(true);
});

it("should return empty array if no values contain the search term", async () => {
const found = await service.findMetaEnvelopesBySearchTerm(
"SocialMediaPost",
"notfoundterm",
);
expect(Array.isArray(found)).toBe(true);
expect(found.length).toBe(0);
});

it("should find meta-envelopes by ontology", async () => {
const results =
await service.findMetaEnvelopesByOntology("SocialMediaPost");
expect(Array.isArray(results)).toBe(true);
expect(results.length).toBeGreaterThan(0);
});

it("should delete a meta-envelope and its envelopes", async () => {
const meta = {
ontology: "TempPost",
payload: {
value: "to be deleted",
},
acl: ["@delete-user"],
};

const stored = await service.storeMetaEnvelope(meta, meta.acl);
await service.deleteMetaEnvelope(stored.metaEnvelope.id);

const deleted = await service.findMetaEnvelopeById(
stored.metaEnvelope.id,
);
expect(deleted).toBeNull();
});

it("should update envelope value with proper type handling", async () => {
const meta = {
ontology: "UpdateTest",
payload: {
value: "original",
},
acl: ["@updater"],
};

const stored = await service.storeMetaEnvelope(meta, meta.acl);

const result = await service.findMetaEnvelopeById(
stored.metaEnvelope.id,
);
const targetEnvelope = result.envelopes.find(
(e: Envelope) => e.ontology === "value",
);

// Update with a different type
const newValue = new Date("2025-04-10T00:00:00Z");
await service.updateEnvelopeValue(targetEnvelope.id, newValue);

const updated = await service.findMetaEnvelopeById(
stored.metaEnvelope.id,
);
const updatedValue = updated.envelopes.find(
(e: Envelope) => e.id === targetEnvelope.id,
);
expect(updatedValue.value).toBeInstanceOf(Date);
expect(updatedValue.value.toISOString()).toBe(
"2025-04-10T00:00:00.000Z",
);
expect(updatedValue.valueType).toBe("date");
});

it("should find meta-envelopes containing the search term in any value type", async () => {
const input = {
ontology: "SearchTest",
payload: {
string: "This is a searchable string",
array: ["searchable", "array", "element"],
object: { text: "searchable object" },
number: 42,
date: new Date("2025-04-10T00:00:00Z"),
},
acl: ["@search-test-user"],
};

const metaEnv = await service.storeMetaEnvelope(input, input.acl);

// Test search in string
const foundInString = await service.findMetaEnvelopesBySearchTerm(
"SearchTest",
"searchable string",
);
expect(foundInString.length).toBeGreaterThan(0);
expect(foundInString[0].id).toBe(metaEnv.metaEnvelope.id);

// Test search in array
const foundInArray = await service.findMetaEnvelopesBySearchTerm(
"SearchTest",
"searchable",
);
expect(foundInArray.length).toBeGreaterThan(0);
expect(foundInArray[0].id).toBe(metaEnv.metaEnvelope.id);

// Test search in object
const foundInObject = await service.findMetaEnvelopesBySearchTerm(
"SearchTest",
"searchable object",
);
expect(foundInObject.length).toBeGreaterThan(0);
expect(foundInObject[0].id).toBe(metaEnv.metaEnvelope.id);
});

it("should find meta-envelopes containing the search term with parsed payload", async () => {
const input = {
ontology: "SearchTestHeyyy",
payload: {
string: "This is a searchable string",
array: ["searchable", "array", "element"],
object: { text: "searchable object" },
number: 42,
date: new Date("2025-04-10T00:00:00Z"),
},
acl: ["@search-test-user"],
};

const metaEnv = await service.storeMetaEnvelope(input, input.acl);

// Test search in string
const foundInString = await service.findMetaEnvelopesBySearchTerm(
"SearchTestHeyyy",
"searchable string",
);
expect(foundInString.length).toBeGreaterThan(0);
expect(foundInString[0].id).toBe(metaEnv.metaEnvelope.id);

// Test search in array
const foundInArray = await service.findMetaEnvelopesBySearchTerm(
"SearchTestHeyyy",
"searchable",
);
expect(foundInArray.length).toBeGreaterThan(0);
expect(foundInArray[0].id).toBe(metaEnv.metaEnvelope.id);

// Test search in object
const foundInObject = await service.findMetaEnvelopesBySearchTerm(
"SearchTestHeyyy",
"searchable object",
);
expect(foundInObject.length).toBeGreaterThan(0);
expect(foundInObject[0].id).toBe(metaEnv.metaEnvelope.id);
});
});
Comment on lines +191 to +270

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Eliminate redundant tests.

This test is almost identical to the search test at lines 94-120, and the test at lines 231-269 is nearly identical to the test at lines 191-230. Consider consolidating these tests to reduce duplication.

Consider consolidating the duplicate tests by:

  1. Using a parameterized test approach
  2. Creating helper functions for common test patterns
  3. Or at minimum, adding comments explaining why these separate but similar tests are necessary

For example:

functiontestSearchFunctionality(ontology: string,description: string){it(`should ${description} for ontology ${ontology}`,async()=>{// Common test logic});}testSearchFunctionality("SearchTest","find meta-envelopes containing the search term in any value type");testSearchFunctionality("SearchTestHeyyy","find meta-envelopes containing the search term with parsed payload");

Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions .github/workflows/tests-evault-core.yml
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
name: Tests [evault-core]

on:
push:
branches: [main]
paths:
- 'infrastructure/evault-core/**'
pull_request:
branches: [main]
paths:
- 'infrastructure/w3id/**'

jobs:
test:
runs-on: ubuntu-latest

steps:
- name: Checkout code
uses: actions/checkout@v3

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Update the checkout action to the latest version

The current version of actions/checkout being used (v3) is outdated. The latest version (v4) includes improvements and bug fixes.

- uses: actions/checkout@v3+ uses: actions/checkout@v4
📝 Committable suggestion

‼️IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
uses: actions/checkout@v3
uses: actions/checkout@v4
🧰 Tools
🪛 actionlint (1.7.4)

19-19: the runner of "actions/checkout@v3" action is too old to run on GitHub Actions. update the action's version to fix this issue

(action)


- name: Set up Node.js 22
uses: actions/setup-node@v4
with:
node-version: 22

- name: Install pnpm
run: npm install -g pnpm

- name: Install dependencies
run: pnpm install

- name: Run tests
run: pnpm -F=evault-core test

22 changes: 22 additions & 0 deletions infrastructure/evault-core/docker-compose.yml
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
version: '3.8'

services:
neo4j:
image: neo4j:5.15
container_name: neo4j
ports:
- "7474:7474"
- "7687:7687"
environment:
- NEO4J_AUTH=neo4j/testpass
volumes:
- neo4j_data:/data
networks:
- graphnet

volumes:
neo4j_data:

networks:
graphnet:
driver: bridge
40 changes: 30 additions & 10 deletions infrastructure/evault-core/package.json
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,32 @@
{
"name": "evault-core",
"version": "1.0.0",
"description": "",
"main": "index.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"keywords": [],
"author": "",
"license": "ISC"
"name": "evault-core",
"version": "0.1.0",
"description": "",
"main": "index.js",
"scripts": {
"test": "vitest --config vitest.config.ts"
},
"keywords": [],
"author": "",
"license": "ISC",
"devDependencies": {
"@types/json-schema": "^7.0.15",
"@types/node": "^22.13.10",
"dotenv": "^16.5.0",
"testcontainers": "^10.24.2",
"tsx": "^4.19.3",
"typescript": "^5.8.3",
"uuid": "^11.1.0",
"vitest": "^3.0.9"
},
"dependencies": {
"@testcontainers/neo4j": "^10.24.2",
"graphql": "^16.10.0",
"graphql-type-json": "^0.3.2",
"graphql-voyager": "^2.1.0",
"graphql-yoga": "^5.13.4",
"json-schema": "^0.4.0",
"neo4j-driver": "^5.28.1",
"w3id": "workspace:*"
}
}
270 changes: 270 additions & 0 deletions infrastructure/evault-core/src/db/db.service.spec.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,270 @@
import neo4j, { Driver } from "neo4j-driver";
import { DbService } from "./db.service"; // adjust if needed
import { it, describe, beforeAll, afterAll, expect } from "vitest";
import { Neo4jContainer, StartedNeo4jContainer } from "@testcontainers/neo4j";

type Envelope = {
id: string;
ontology: string;
value: any;
valueType: string;
};

describe("DbService (integration)", () => {
let container: StartedNeo4jContainer;
let service: DbService;
let driver: Driver;

beforeAll(async () => {
container = await new Neo4jContainer("neo4j:5.15").start();

const username = container.getUsername();
const password = container.getPassword();
const boltPort = container.getMappedPort(7687);
const uri = `bolt://localhost:${boltPort}`;

driver = neo4j.driver(uri, neo4j.auth.basic(username, password));
service = new DbService(driver);
});

afterAll(async () => {
await service.close();
await driver.close();
await container.stop();
});

it("should store and retrieve a meta-envelope with various data types", async () => {
const input = {
ontology: "TestTypes",
payload: {
string: "hello world",
number: 42,
boolean: true,
date: new Date("2025-04-10T00:00:00Z"),
array: [1, 2, 3],
object: { nested: { value: "deep" } },
},
acl: ["@test-user"],
};

const result = await service.storeMetaEnvelope(input, input.acl);
const id = result.metaEnvelope.id;

const fetched = await service.findMetaEnvelopeById(id);
expect(fetched).toBeDefined();
expect(fetched.id).toBeDefined();
expect(fetched.ontology).toBe("TestTypes");
expect(fetched.acl).toEqual(["@test-user"]);
expect(fetched.envelopes).toHaveLength(6);

// Verify parsed field matches original payload
expect(fetched.parsed).toEqual(input.payload);

// Verify each data type is properly stored and retrieved
const envelopes = fetched.envelopes.reduce(
(acc: Record<string, Envelope>, e: Envelope) => {
acc[e.ontology] = e;
return acc;
},
{},
);

expect(envelopes.string.value).toBe("hello world");
expect(envelopes.string.valueType).toBe("string");

expect(envelopes.number.value).toBe(42);
expect(envelopes.number.valueType).toBe("number");

expect(envelopes.boolean.value).toBe(true);
expect(envelopes.boolean.valueType).toBe("boolean");

expect(envelopes.date.value).toBeInstanceOf(Date);
expect(envelopes.date.value.toISOString()).toBe(
"2025-04-10T00:00:00.000Z",
);
expect(envelopes.date.valueType).toBe("date");

expect(envelopes.array.value).toEqual([1, 2, 3]);
expect(envelopes.array.valueType).toBe("array");

expect(envelopes.object.value).toEqual({ nested: { value: "deep" } });
expect(envelopes.object.valueType).toBe("object");
});

it("should find meta-envelopes containing the search term in any envelope value", async () => {
const input = {
ontology: "SocialMediaPost",
payload: {
text: "This is a searchable tweet",
image: "https://example.com/image.jpg",
likes: ["user1", "user2"],
},
acl: ["@search-test-user"],
};

const metaEnv = await service.storeMetaEnvelope(input, input.acl);

const found = await service.findMetaEnvelopesBySearchTerm(
"SocialMediaPost",
"searchable",
);

expect(Array.isArray(found)).toBe(true);
const match = found.find((m) => m.id === metaEnv.metaEnvelope.id);
expect(match).toBeDefined();
if (!match) throw new Error();
expect(match.envelopes.length).toBeGreaterThan(0);
expect(
match.envelopes.some((e) => e.value.includes("searchable")),
).toBe(true);
});

it("should return empty array if no values contain the search term", async () => {
const found = await service.findMetaEnvelopesBySearchTerm(
"SocialMediaPost",
"notfoundterm",
);
expect(Array.isArray(found)).toBe(true);
expect(found.length).toBe(0);
});

it("should find meta-envelopes by ontology", async () => {
const results =
await service.findMetaEnvelopesByOntology("SocialMediaPost");
expect(Array.isArray(results)).toBe(true);
expect(results.length).toBeGreaterThan(0);
});

it("should delete a meta-envelope and its envelopes", async () => {
const meta = {
ontology: "TempPost",
payload: {
value: "to be deleted",
},
acl: ["@delete-user"],
};

const stored = await service.storeMetaEnvelope(meta, meta.acl);
await service.deleteMetaEnvelope(stored.metaEnvelope.id);

const deleted = await service.findMetaEnvelopeById(
stored.metaEnvelope.id,
);
expect(deleted).toBeNull();
});

it("should update envelope value with proper type handling", async () => {
const meta = {
ontology: "UpdateTest",
payload: {
value: "original",
},
acl: ["@updater"],
};

const stored = await service.storeMetaEnvelope(meta, meta.acl);

const result = await service.findMetaEnvelopeById(
stored.metaEnvelope.id,
);
const targetEnvelope = result.envelopes.find(
(e: Envelope) => e.ontology === "value",
);

// Update with a different type
const newValue = new Date("2025-04-10T00:00:00Z");
await service.updateEnvelopeValue(targetEnvelope.id, newValue);

const updated = await service.findMetaEnvelopeById(
stored.metaEnvelope.id,
);
const updatedValue = updated.envelopes.find(
(e: Envelope) => e.id === targetEnvelope.id,
);
expect(updatedValue.value).toBeInstanceOf(Date);
expect(updatedValue.value.toISOString()).toBe(
"2025-04-10T00:00:00.000Z",
);
expect(updatedValue.valueType).toBe("date");
});

it("should find meta-envelopes containing the search term in any value type", async () => {
const input = {
ontology: "SearchTest",
payload: {
string: "This is a searchable string",
array: ["searchable", "array", "element"],
object: { text: "searchable object" },
number: 42,
date: new Date("2025-04-10T00:00:00Z"),
},
acl: ["@search-test-user"],
};

const metaEnv = await service.storeMetaEnvelope(input, input.acl);

// Test search in string
const foundInString = await service.findMetaEnvelopesBySearchTerm(
"SearchTest",
"searchable string",
);
expect(foundInString.length).toBeGreaterThan(0);
expect(foundInString[0].id).toBe(metaEnv.metaEnvelope.id);

// Test search in array
const foundInArray = await service.findMetaEnvelopesBySearchTerm(
"SearchTest",
"searchable",
);
expect(foundInArray.length).toBeGreaterThan(0);
expect(foundInArray[0].id).toBe(metaEnv.metaEnvelope.id);

// Test search in object
const foundInObject = await service.findMetaEnvelopesBySearchTerm(
"SearchTest",
"searchable object",
);
expect(foundInObject.length).toBeGreaterThan(0);
expect(foundInObject[0].id).toBe(metaEnv.metaEnvelope.id);
});

it("should find meta-envelopes containing the search term with parsed payload", async () => {
const input = {
ontology: "SearchTestHeyyy",
payload: {
string: "This is a searchable string",
array: ["searchable", "array", "element"],
object: { text: "searchable object" },
number: 42,
date: new Date("2025-04-10T00:00:00Z"),
},
acl: ["@search-test-user"],
};

const metaEnv = await service.storeMetaEnvelope(input, input.acl);

// Test search in string
const foundInString = await service.findMetaEnvelopesBySearchTerm(
"SearchTestHeyyy",
"searchable string",
);
expect(foundInString.length).toBeGreaterThan(0);
expect(foundInString[0].id).toBe(metaEnv.metaEnvelope.id);

// Test search in array
const foundInArray = await service.findMetaEnvelopesBySearchTerm(
"SearchTestHeyyy",
"searchable",
);
expect(foundInArray.length).toBeGreaterThan(0);
expect(foundInArray[0].id).toBe(metaEnv.metaEnvelope.id);

// Test search in object
const foundInObject = await service.findMetaEnvelopesBySearchTerm(
"SearchTestHeyyy",
"searchable object",
);
expect(foundInObject.length).toBeGreaterThan(0);
expect(foundInObject[0].id).toBe(metaEnv.metaEnvelope.id);
});
});
Comment on lines +191 to +270

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Eliminate redundant tests.

This test is almost identical to the search test at lines 94-120, and the test at lines 231-269 is nearly identical to the test at lines 191-230. Consider consolidating these tests to reduce duplication.

Consider consolidating the duplicate tests by:

  1. Using a parameterized test approach
  2. Creating helper functions for common test patterns
  3. Or at minimum, adding comments explaining why these separate but similar tests are necessary

For example:

functiontestSearchFunctionality(ontology: string,description: string){it(`should ${description} for ontology ${ontology}`,async()=>{// Common test logic});}testSearchFunctionality("SearchTest","find meta-envelopes containing the search term in any value type");testSearchFunctionality("SearchTestHeyyy","find meta-envelopes containing the search term with parsed payload");

Loading