Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

added neo4j-bundle 1.0 #1694

Merged
merged 4 commits into from
Oct 18, 2024
Merged

added neo4j-bundle 1.0 #1694

merged 4 commits into from
Oct 18, 2024

Conversation

AkshatSW
Copy link
Contributor

@AkshatSW AkshatSW commented Oct 17, 2024

Q A
License MIT
Packagist https://packagist.org/packages/neo4j/neo4j-bundle

All tests are passing except the test for PHP 7.4. We are unable to support that version due to upstream limitations of the neo4j-php-client library. Yet, our bundle should work with Symfony 5.4, if the user uses PHP 8.1. We found in the CI definition that this test is safe to ignore:

https://github.com/symfony/recipes/blob/802e06040c6bce727b9298d1eee0e0ae9002f486/.github/workflows/callable-qa.yml#L266C26-L266C123

We would love to have this recipe added to the contrib, as the definition for version 0.4 in this project contains a breaking configuration, potentially confusing new users before they are even started when they run composer install neo4j/neo4j-bundle.

Kindly let us know if there's anything we can do.

@symfony-recipes-bot symfony-recipes-bot enabled auto-merge (squash) October 17, 2024 08:37
Copy link

github-actions bot commented Oct 17, 2024

Thanks for the PR 😍

How to test these changes in your application

  1. Define the SYMFONY_ENDPOINT environment variable:

    # On Unix-like (BSD, Linux and macOS)
    export SYMFONY_ENDPOINT=https://raw.githubusercontent.com/symfony/recipes-contrib/flex/pull-1694/index.json
    # On Windows
    SET SYMFONY_ENDPOINT=https://raw.githubusercontent.com/symfony/recipes-contrib/flex/pull-1694/index.json
  2. Install the package(s) related to this recipe:

    composer req 'symfony/flex:^1.16'
    composer req 'neo4j/neo4j-bundle:^1.0'
  3. Don't forget to unset the SYMFONY_ENDPOINT environment variable when done:

    # On Unix-like (BSD, Linux and macOS)
    unset SYMFONY_ENDPOINT
    # On Windows
    SET SYMFONY_ENDPOINT=

Diff between recipe versions

In order to help with the review stage, I'm in charge of computing the diff between the various versions of patched recipes.
I'm going keep this comment up to date with any updates of the attached patch.

neo4j/neo4j-bundle

0.4 vs 1.0
diff --git a/neo4j/neo4j-bundle/0.4/config/packages/neo4j.yaml b/neo4j/neo4j-bundle/1.0/config/packages/neo4j.yaml
index 37ad241b..228f56b9 100644
--- a/neo4j/neo4j-bundle/0.4/config/packages/neo4j.yaml
+++ b/neo4j/neo4j-bundle/1.0/config/packages/neo4j.yaml
@@ -1,4 +1,4 @@
 neo4j:
-    connections:
+    drivers:
         default:
             dsn: '%env(resolve:NEO4J_DEFAULT_CONNECTION_DSN)%'
diff --git a/neo4j/neo4j-bundle/0.4/manifest.json b/neo4j/neo4j-bundle/1.0/manifest.json
index 1c2c5629..7aff089d 100644
--- a/neo4j/neo4j-bundle/0.4/manifest.json
+++ b/neo4j/neo4j-bundle/1.0/manifest.json
@@ -6,6 +6,6 @@
         "config/": "%CONFIG_DIR%/"
     },
     "env": {
-        "NEO4J_DEFAULT_CONNECTION_DSN": "bolt://foo:bar@localhost:7687"
+        "NEO4J_DEFAULT_CONNECTION_DSN": "neo4j://<my-username>:<my-password>@localhost"
     }
 }

auto-merge was automatically disabled October 17, 2024 08:45

Head branch was pushed to by a user without write access

@symfony-recipes-bot symfony-recipes-bot enabled auto-merge (squash) October 17, 2024 08:45
auto-merge was automatically disabled October 17, 2024 08:53

Head branch was pushed to by a user without write access

@symfony-recipes-bot symfony-recipes-bot enabled auto-merge (squash) October 17, 2024 08:53
auto-merge was automatically disabled October 17, 2024 08:55

Head branch was pushed to by a user without write access

@symfony-recipes-bot symfony-recipes-bot enabled auto-merge (squash) October 17, 2024 08:56
Copy link
Member

@diimpp diimpp left a comment

Choose a reason for hiding this comment

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

Thank you.

On unrelated note, at your bundle, either default_driver property should have been called default_connection or connections as drivers. Those terms used interchangeably, which is confusing at glance reading.

image

@symfony-recipes-bot symfony-recipes-bot merged commit 19cca46 into symfony:main Oct 18, 2024
1 of 2 checks passed
@diimpp
Copy link
Member

diimpp commented Oct 18, 2024

P.S. Follow-up on unrelated note, it's error at bundle docs to call it connections instead of drivers.

neo4j-php/neo4j-symfony#86

@transistive
Copy link

Thank you so much for being so thorough. We are excited to see it merged! 🥳

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants