Skip to content

Commit

Permalink
Deprecate options of assertIndexesAndConstraints and remove from …
Browse files Browse the repository at this point in the history 
…tests (#5632)

* Deprecate `options` of `assertIndexesAndConstraints` and remove from tests

* Fix flaky test
  • Loading branch information
@darrellwarde
darrellwarde authored Oct 8, 2024
1 parent 184ae4a commit 3c69066
Show file tree
Hide file tree
Showing 10 changed files with 70 additions and 19 deletions.
5 changes: 5 additions & 0 deletions .changeset/afraid-cows-beg.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@neo4j/graphql": patch
---

The `options` argument of `assertIndexesAndConstraints` has been deprecated and the creation of indexes and constraints will no longer be support in the next major version of the library.
3 changes: 3 additions & 0 deletions packages/graphql/src/classes/Neo4jGraphQL.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -166,6 +166,9 @@ class Neo4jGraphQL {
}: {
driver?: Driver;
sessionConfig?: Neo4jGraphQLSessionConfig;
/**
* @deprecated The ability to create indexes and constraints will be removed in version 6.0.0
*/
options?: AssertIndexesAndConstraintsOptions;
} = {}): Promise<void> {
if (!(this.executableSchema || this.subgraphSchema)) {
Expand Down
4 changes: 2 additions & 2 deletions ...phql/tests/integration/directives/cypher/filtering/cypher-filtering-list-auth.int.test.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -161,14 +161,14 @@ describe("cypher directive filtering - List Auth", () => {

expect(gqlResult.errors).toBeFalsy();
expect(gqlResult?.data).toEqual({
[Movie.plural]: [
[Movie.plural]: expect.toIncludeSameMembers([
{
custom_field: ["a", "b", "c"],
},
{
custom_field: ["bbb", "a", "bbb"],
},
],
]),
});
});

Expand Down
49 changes: 37 additions & 12 deletions packages/graphql/tests/integration/directives/fulltext/fulltext-query.int.test.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -134,11 +134,13 @@ describe("@fulltext directive", () => {
neoSchema = await testHelper.initNeo4jGraphQL({
typeDefs,
});

await testHelper.createFulltextIndex(`${personType.name}Index`, personType.name, ["name"]);

await neoSchema.getSchema();
await neoSchema.assertIndexesAndConstraints({
driver,
sessionConfig: { database: databaseName },
options: { create: true },
});

await testHelper.executeCypher(
Expand Down Expand Up @@ -1244,11 +1246,13 @@ describe("@fulltext directive", () => {
},
},
});

await testHelper.createFulltextIndex(`${personType.name}Index`, personType.name, ["name"]);

await neoSchema.getSchema();
await neoSchema.assertIndexesAndConstraints({
driver,
sessionConfig: { database: databaseName },
options: { create: true },
});

const query = `
Expand Down Expand Up @@ -1305,11 +1309,13 @@ describe("@fulltext directive", () => {
},
},
});

await testHelper.createFulltextIndex(`${personType.name}Index`, personType.name, ["name"]);

await neoSchema.getSchema();
await neoSchema.assertIndexesAndConstraints({
driver,
sessionConfig: { database: databaseName },
options: { create: true },
});

const query = `
Expand Down Expand Up @@ -1366,11 +1372,13 @@ describe("@fulltext directive", () => {
},
},
});

await testHelper.createFulltextIndex(`${personType.name}Index`, personType.name, ["name"]);

await neoSchema.getSchema();
await neoSchema.assertIndexesAndConstraints({
driver,
sessionConfig: { database: databaseName },
options: { create: true },
});

const query = `
Expand Down Expand Up @@ -1442,11 +1450,13 @@ describe("@fulltext directive", () => {
},
},
});

await testHelper.createFulltextIndex(`${personType.name}Index`, personType.name, ["name"]);

await neoSchema.getSchema();
await neoSchema.assertIndexesAndConstraints({
driver,
sessionConfig: { database: databaseName },
options: { create: true },
});

const query = `
Expand Down Expand Up @@ -1498,11 +1508,13 @@ describe("@fulltext directive", () => {
},
},
});

await testHelper.createFulltextIndex(`${personType.name}Index`, personType.name, ["name"]);

await neoSchema.getSchema();
await neoSchema.assertIndexesAndConstraints({
driver,
sessionConfig: { database: databaseName },
options: { create: true },
});

const query = `
Expand Down Expand Up @@ -1557,11 +1569,13 @@ describe("@fulltext directive", () => {
},
},
});

await testHelper.createFulltextIndex(`${personType.name}Index`, personType.name, ["name"]);

await neoSchema.getSchema();
await neoSchema.assertIndexesAndConstraints({
driver,
sessionConfig: { database: databaseName },
options: { create: true },
});

const query = `
Expand Down Expand Up @@ -1617,11 +1631,13 @@ describe("@fulltext directive", () => {
},
},
});

await testHelper.createFulltextIndex(`${personType.name}Index`, personType.name, ["name"]);

await neoSchema.getSchema();
await neoSchema.assertIndexesAndConstraints({
driver,
sessionConfig: { database: databaseName },
options: { create: true },
});

const query = `
Expand Down Expand Up @@ -1669,11 +1685,13 @@ describe("@fulltext directive", () => {
neoSchema = await testHelper.initNeo4jGraphQL({
typeDefs,
});

await testHelper.createFulltextIndex(`${movieType.name}Index`, movieType.name, ["title", "description"]);

await neoSchema.getSchema();
await neoSchema.assertIndexesAndConstraints({
driver,
sessionConfig: { database: databaseName },
options: { create: true },
});

const query = `
Expand Down Expand Up @@ -1736,11 +1754,13 @@ describe("@fulltext directive", () => {
neoSchema = await testHelper.initNeo4jGraphQL({
typeDefs,
});

await testHelper.createFulltextIndex(`${personType.name}CustomIndex`, personType.name, ["name"]);

await neoSchema.getSchema();
await neoSchema.assertIndexesAndConstraints({
driver,
sessionConfig: { database: databaseName },
options: { create: true },
});

const query = `
Expand Down Expand Up @@ -1793,11 +1813,13 @@ describe("@fulltext directive", () => {
neoSchema = await testHelper.initNeo4jGraphQL({
typeDefs,
});

await testHelper.createFulltextIndex(`${movieType.name}Index`, movieType.name, ["title", "description"]);

await neoSchema.getSchema();
await neoSchema.assertIndexesAndConstraints({
driver,
sessionConfig: { database: databaseName },
options: { create: true },
});

const query = `
Expand Down Expand Up @@ -1862,11 +1884,14 @@ describe("@fulltext directive", () => {
neoSchema = await testHelper.initNeo4jGraphQL({
typeDefs,
});

await testHelper.createFulltextIndex(`${movieType.name}CustomIndex`, movieType.name, ["title"]);
await testHelper.createFulltextIndex(`${movieType.name}CustomIndex2`, movieType.name, ["description"]);

await neoSchema.getSchema();
await neoSchema.assertIndexesAndConstraints({
driver,
sessionConfig: { database: databaseName },
options: { create: true },
});

const query1 = `
Expand Down
1 change: 0 additions & 1 deletion packages/graphql/tests/integration/directives/vector/vector-filtering.int.test.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,6 @@ describe("@vector directive - filtering", () => {
await neoSchema.assertIndexesAndConstraints({
driver,
sessionConfig: { database: databaseName },
options: { create: true },
});
});

Expand Down
1 change: 0 additions & 1 deletion packages/graphql/tests/integration/directives/vector/vector-pagination.int.test.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,6 @@ describe("@vector directive - pagination", () => {
await neoSchema.assertIndexesAndConstraints({
driver,
sessionConfig: { database: databaseName },
options: { create: true },
});
});

Expand Down
1 change: 0 additions & 1 deletion packages/graphql/tests/integration/directives/vector/vector-query.int.test.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,6 @@ describe("@vector directive - Query", () => {
await neoSchema.assertIndexesAndConstraints({
driver,
sessionConfig: { database: databaseName },
options: { create: true },
});
});

Expand Down
1 change: 0 additions & 1 deletion packages/graphql/tests/integration/directives/vector/vector-sorting.int.test.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,6 @@ describe("@vector directive - Query", () => {
await neoSchema.assertIndexesAndConstraints({
driver,
sessionConfig: { database: databaseName },
options: { create: true },
});
});

Expand Down
4 changes: 3 additions & 1 deletion packages/graphql/tests/integration/issues/5378.int.test.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -64,11 +64,13 @@ describe("https://github.com/neo4j/graphql/issues/5378", () => {
typeDefs,
});

await testHelper.createFulltextIndex("fulltext_index_space_name_number", Space.name, ["Name", "Number"]);
await testHelper.createUniqueConstraint("unique_constraint_space_id", Space.name, "Id");

await neoSchema.getSchema();
await neoSchema.assertIndexesAndConstraints({
driver: await testHelper.getDriver(),
sessionConfig: { database: databaseName },
options: { create: true },
});
});

Expand Down
20 changes: 20 additions & 0 deletions packages/graphql/tests/utils/tests-helper.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -208,6 +208,26 @@ export class TestHelper {
return new Neo4jDatabaseInfo(rawVersion, edition);
}

public async createFulltextIndex(name: string, label: string, properties: string[]): Promise<void> {
const cypher = [
`CREATE FULLTEXT INDEX ${name}`,
`IF NOT EXISTS FOR (n:${label})`,
`ON EACH [${properties.map((p) => `n.${p}`).join(", ")}]`,
].join(" ");

await this.executeCypher(cypher);
}

public async createUniqueConstraint(name: string, label: string, property: string): Promise<void> {
const cypher = [
`CREATE CONSTRAINT ${name}`,
`IF NOT EXISTS FOR (n:${label})`,
`REQUIRE n.${property} IS UNIQUE`,
].join(" ");

await this.executeCypher(cypher);
}

private async checkConnectivity(driver: neo4j.Driver): Promise<string> {
if (process.env.USE_DEFAULT_DB) {
return this.checkConnectivityToDefaultDatabase(driver);
Expand Down

0 comments on commit 3c69066

Please # to comment.