nikby53 / image-converter

Service that expose a RESTful API to convert JPEG to PNG and vice versa and compress the image with the compression ratio specified by the user.

Image-converter

Service that expose a RESTful API to convert JPEG to PNG and vice versa and compress the image with the compression ratio specified by the user. The user has the ability to view the history and status of their requests (queued, processed, completed) and download the original image and the processed one.

Build & Run (Locally)

Prerequisites

• go 1.16
• docker
• golangci-lint (optional, used to run code checks)
• aws access and secret key

Create .env file in root directory and add following values:

API_PORT=

DB_USERNAME=
DB_PASSWORD=
DB_NAME=
DB_HOST=
DB_PORT=
DB_SSL_MODE=

AWS_BUCKET_NAME=
AWS_ACC_ID=
AWS_SECRET_KEY=
AWS_REGION=

MINIO_BUCKET_NAME=
MINIO_ACC_ID=
MINIO_SECRET_KEY=
MINIO_REGION=
MINIO_ENDPOINT=

JWT_SIGNING_KEY=
JWT_TOKEN_TTL=

Use make run to build&run project, make lint to check code with linter.

Architecture Diagram

Entity–relationship model

Endpoints

• /auth/signup - user registration [POST]
• /auth/login - user authorization [POST]
• /image/convert - convert and compress image [POST]
• /image/download/{id} - downloads needed image [GET]
• /requests - get the user's requests history [GET]

Run image converter from a binary command line interface

Grab a binary from releases page

image-converter's Issues

Work with context

Add tests for aws s3 storage

Think about integration tests

Implement message broker (RabbitMQ)

Add a message broker to handle the high load of requests.

Fix docker and docker-compose

CLI

Implement atomacity in ACID pattern for application

The idea is to break transactions if one of them failed.

This can be useful:

func (db *DB) Transactional(ctx context.Context, f func(s cts.Service) error) error {
	sqlDB, ok := db.conn.(*sqlx.DB)
	if !ok {
		return errors.New("couldn't bring to DB")
	}
	tx, err := sqlDB.BeginTxx(ctx, &sql.TxOptions{})
	if err != nil {
		return errors.New("couldn't start transaction")
	}
	defer func() {
		if err != nil {
			tx.Rollback()
			return
		}
		err = tx.Commit()
	}()
	return f(&DB{conn: tx})
}

Hotfixex

Fix swagger bug in deploy

Deploy to aws

ci/cd

Add minio storage for api

Add minio storage in case, we want to change aws s3 storage to mino file storage

Finish handler tests

Finish convert and download image test cases

Smoke tests