Add @namespaced directive for namespacing by seperation of concerns

[spawnia]

Resolves #2266, supersedes #2469

• Added or updated tests
• Documented user facing changes
• Updated CHANGELOG.md

Changes

Adds the @namespaced directive.

Breaking changes

None.

[spawnia]

@sniper7kills Could you rebase your pull request atop this branch and add a test? I think directives such as @find or @create might not work as intended in the example.

[sniper7kills]

@spawnia If you could give me a little push-start I'd be more than glad to take a shot at implementing some tests for this.
(Although I'm likely not the best candidate to be doing such, I'll give it a go)

I'm in the namespaced-directive branch with the following test; but I get an error "No directive found for namespaced". If you could give me a base test to start off of I'd be grateful.

    public function testNamespaced(): void
    {

        $this->mockResolver()
            ->with(null, [
                'foo' => 1,
            ]);

        $this->schema = /** @lang GraphQL */ 'type Query {
            foo: FooQueries! @namespaced
        }

        type FooQueries {
            single(id: Int @spread): Int
        }
        ';

        $this->graphQL(/** @lang GraphQL */ '{
            foo {
                single(id: 1)
            }
        }
        ');
    }

---

Regarding the @find and @create directives; I would love to learn more as to why you believe that. (I'm very new to this project and GraphQL as a whole) I have the following schema in my project and it appears to be working without issues, so if I have a better understanding I can try to build tests cases accordingly.

type Contact @model(class: "\\App\\Models\\Core\\Contact"){
    id: ID!

    company_id: ID

    name: String!

    "The contact profile photo URL"
    photo: String

    type: ContactTypes!

    description: String

    phone: String

    email: String

    company: Contact @BelongsTo

    employees: [Contact!] @HasMany

    "The notes for the contact"
    notes: [Note]! @morphMany

    "The attachments for the contact"
    attachments: [Attachment]! @morphMany

    "When the contact was created."
    created_at: DateTime!

    "When the contact was last updated."
    updated_at: DateTime!
}

enum ContactTypes {
    company
    person
}

extend type CoreQueries {
  contacts: ContactQueries! @namespaced
}

type ContactQueries {
  "Find a contact by an identifying attribute."
    single(
      "Search by primary key."
      id: ID @eq @rules(apply: ["prohibits:name", "required_without:name"])

      "Search by name."
      name: String @eq @rules(apply: ["prohibits:id", "required_without:id"])
    ): Contact @find

    "List multiple contacts."
    list(
      "Filters by name. Accepts SQL LIKE wildcards `%` and `_`."
      name: String @where(operator: "like")
      includeIds: [String!] @in(key: "id", , ignoreNull: true)
      parentId: String @where(key: "company_id", ignoreNull: true)
      type: ContactTypes @where(ignoreNull: true)
    ): [Contact!]! @paginate(defaultCount: 10)
}

extend type CoreMutations {
  contacts: ContactMutations! @namespaced
}

type ContactMutations {
  create(
    input: CreateContactInput! @spread
  ): Contact! @create
  update(
    input: UpdateContactInput @spread
  ): Contact! @update
  delete(
    id: String! @whereKey
  ): Contact @delete
}


input CreateContactInput {
    company_id: ID
    name: String!
    type: ContactTypes!
    company_id: ID
    description: String
    phone: String
    email: String

    file: VaporFileUpload

    notes: CreateNoteBelongsToMany
    attachments: CreateAttachmentBelongsToMany
}

input UpdateContactInput {
    id: ID!
    company_id: ID
    name: String
    type: ContactTypes
    description: String
    phone: String
    email: String

    file: VaporFileUpload

    notes: CreateNoteBelongsToMany
    attachments: CreateAttachmentBelongsToMany
}

input UpsertContactInput {
    id: ID
    company_id: ID
    name: String
    type: ContactTypes
    description: String
    phone: String
    email: String

    file: VaporFileUpload

    notes: CreateNoteBelongsToMany
    attachments: CreateAttachmentBelongsToMany
}

input CreateContactBelongsToMany{
    create: [CreateContactInput!]
    upsert: [UpsertContactInput!]
    connect: [ID!]
    sync: [ID!]
}

[spawnia]

Your test should look similar to the ones in https://github.com/nuwave/lighthouse/tree/master/tests/Integration/Schema/Directives. Make sure to extend the correct base class, then your directive should be found.

It is just because many directives are somewhat magical when it comes to figuring out the correct model to use, the correct namespace, etc.

[sniper7kills]

Ah! Thank you! I was mistakenly making a Unit Test instead of an Integration Test.

Please let me know if there are any special test cases you would like me to make to address any concerns I simply duplicated the nest directive test.

[spawnia]

Thank you @sniper7kills, works as intended.