wiseengineering/crispy-api

Typescript GraphQL API for `crispy-web`

crispy-api's Issues

Add api -> worker communication

There is introduced schema in WiseEngineering/crispy-worker#6

We need to add a call in API to be able to run something in specific worker.
The flow will be like this:

Crispy-web is able to see workers and migrations.
Crispy-web is able to run mutation in crispy-api to run specific migration in specific workers.

Here we need to implement this ability to call worker with migration and job from API.

Init TS server

based on docs
https://github.com/graphql-boilerplates/typescript-graphql-server we need an initial structure and project init for our API.

Need to think about the following areas:

• init database connection
• provide commands to start the environment
• use environment variables based server setup
• init tests/linting/formatting commands

As it's a basic area where we all are going working on, let's follow a few points:

• share POC with team
• avoid packages where it's possible
• document commands and base Components

Modification in README.md

Need to specify somewhere that this is developers guide to setup dev environment

We also need a root do user docs

Originally posted by @melnychukvitaliy in #5

add worker CRUD

not sure we need user schema for start.
We've decided to start from migrations and them move forward with them

• logging
• workers
• migrations
• running flow

We have to look at those areas first
I think we have to change this schema with the workers schema. This is the one we really need.
The interface could simple for start:

name: 'beta' //worker name will be sent from server where this migration going to be run
created_at
updated_at
endpoint // where worker is hosted. We will call this API to communicate with worker
api_key? // not required will figure out later how we are going to make auth

Let's change this schema with those fields, then we will be ready to use it in client side

Originally posted by @melnychukvitaliy in https://github.com/WiseEngineering/crispy-api/pull/5/files

Add Config file with types

this is good start 👍

Thinking about moving all configuration into one file, where we will define types
will be something like
https://github.com/WiseEngineering/crispy-cli/blob/master/src/config.ts
but, there is no need for user config as we will use environment variables for these purposes

Originally posted by @melnychukvitaliy in https://github.com/WiseEngineering/crispy-api/pull/5/files

Review docker file

Need to review docker-compose and Dockerfile and change user permission of volumes.
I think after changes we will remove https://github.com/WiseEngineering/crispy-api/blob/master/.dockerignore file.

Describe API endpoints

We need somehow describe API endpoints and how they would interact with crispy-web & crispy-cli

For start, we might use some tool to generate GraphQL schema based docs
and for further instruction, we need to think about how we will provide use cases for API endpoints.
For example, how API would be used by the web and how from cli

Use docker multistage

minor comment:
can be changed with docker multistage
https://docs.docker.com/develop/develop-images/multistage-build/

Originally posted by @melnychukvitaliy in https://github.com/WiseEngineering/crispy-api/pull/5/files

Configure cicd base

Once WiseEngineering/crispy#4 is done, configure a base for ci/cd pipeline for this component.
It's ok to put only 'hello world' task in it and add linter and unit tests execution in follow-up tasks.