README

graphql-configuration-access

OXAPI (GraphQL based) access to configuration settings

Why we use this schema

To fetch and update the configurations we implemented a different query/mutation per value-type. We have chosen this schema because of GraphQL's strictness which doesn't allow for dynamic types. Without these types, the API consumer would always have to convert the value after queries or before mutations if, for example, we decided to use json encoded strings instead.

To get the specific type of a configuration, we provide queries like shopSettings/moduleSettings/themeSettings to figure out the type for configurations. As a result you get an array of setting types:

type SettingType {
  name: string!
  type: FieldType!
  isSupported: boolean!
}

enum FieldType {
  'str'
  'select'
  'bool'
  'num
  'arr'
  'aarr'
}

Branch compatibility

b-7.3.x branch is compatible with OXID eShop compilation b-7.3.x (which uses graphql-base b-7.3.x branch)
1.2.x + 2.0.x versions (or b-7.2.x branch) are compatible with OXID eShop compilation b-7.2.x (which uses graphql-base 10.x version resp. b-7.2.x branch)
1.1.x versions (or b-7.1.x branch) are compatible with OXID eShop compilation b-7.1.x (which uses graphql-base 9.x version resp. b-7.1.x branch)

Documentation

Full documentation can be found here.

Install

Switch to the shop root directory (the file composer.json and the directories source/ and vendor/ are located there).

# Install desired version of oxid-esales/graphql-configuration-access module, in this case - latest released 2.x version
$ composer require oxid-esales/graphql-configuration-access ^2.0.0

If you didn't have the oxid-esales/graphql-base module installed, composer will do that for you.

After installing the module, you need to activate it, either via OXID eShop admin or CLI.

$ vendor/bin/oe-console oe:module:activate oe_graphql_base
$ vendor/bin/oe-console oe:module:activate oe_graphql_configuration_access

How to use

A good starting point is to check the How to use section in the GraphQL Base Module

Blocking modules from de/activation via GraphQL

The file module_blockilst.yaml contains a list of modules which are necessary to handle configurations or de/activate modules via GraphQL or should be blocked for de/activation via GraphQL in general. Modules like oe_graphql_base and oe_graphql_configuration_access are listed there.

Testing

Linting, syntax check, static analysis

$ composer update
$ composer static

Unit/Integration/Acceptance tests

install this module into a running OXID eShop
reset shop's database

$ bin/oe-console oe:database:reset --db-host=db-host --db-port=db-port --db-name=db-name --db-user=db-user --db-password=db-password --force

run Unit + Integration tests

$ composer phpunit

run Unit tests

$ ./vendor/bin/phpunit -c vendor/oxid-esales/graphql-configuration-access/tests/phpunit.xml

run Integration tests

$ ./vendor/bin/phpunit --bootstrap=./source/bootstrap.php -c vendor/oxid-esales/graphql-configuration-access/tests/phpintegration.xml

run Acceptance tests

$ composer codeception

Development installation on OXID eShop SDK

The installation instructions below are shown for the current SDK for shop 7.3. Make sure your system meets the requirements of the SDK.

Ensure all docker containers are down to avoid port conflicts
Clone the SDK for the new project

echo MyProject && git clone https://github.com/OXID-eSales/docker-eshop-sdk.git $_ && cd $_

Clone the repository to the source directory

git clone --recurse-submodules https://github.com/OXID-eSales/graphql-configuration-access.git --branch=b-7.3.x ./source

Run the recipe to setup the development environment

./source/recipes/setup-development.sh

You should be able to access the shop with http://localhost.local and the admin panel with http://localhost.local/admin (credentials: noreply@oxid-esales.com / admin)

Running tests locally

Check the "scripts" section in the composer.json file for the available commands. Those commands can be executed by connecting to the php container and running the command from there, example:

make php
composer tests-coverage

Commands can be also triggered directly on the container with docker compose, example:

docker compose exec -T php composer tests-coverage

oxid-esales / graphql-configuration-access

Maintainers

Details