gophers-latam/gokey

Proyecto OSS sobre cache en memoria.

GoKey 🔑

Concepto:

Sistema de base de datos clave valor, distribuido. En forma de cache en memoria.

Especificaciones:

Para concentrar información documentada y contar con canal de comunicación para indicaciones y especificaciones sobre el desarrollo del proyecto se encuentra el discord de la comunidad con el canal de texto #🔑gokey en su descripción se fijó el acceso al Google Doc para documentar sobre realización del proyecto.

De ser necesario para reuniones puede hacerse uso de los canales #👥sala y #stage

🔗 Tablero tareas

🔗 Guia estilos de código

🔗 Convenciones commits

🔗 Código de conducta

Avance etapas

• [] V1. Core funcionalidad base (WIP)

• Agregar, leer, eliminar elementos.
• Darle un tamaño determinado de entradas.
• Opciones de configuración a la hora de crear la instancia del cache.
• Funcionalidades de Set (agregar/eliminar uno/muchos valor(es), leer todos).
• Cache eviction LIFO para que no exceda la capacidad máxima.
• Estadisticas.
  
  

• [] V2. Cache Distribuido

• Opcion de guardado en disco.
• Poder correr independientemente, no solo embebido.
• Conexión TCP, GRPC y HTTP.
• Shards/nodos.

Licencia MIT

gokey's Issues

[CORE] Tener la posibilidad de inicializar la cache con una configuracion, de tal modo que en esa estructura que le pasamos, podemos designar las caracteristicas que deseemos, por ejemplo, algoritmo a utilizar, tiempo por defecto que las entradas deben vivir en el cache, etc/

pasar de:

cache.New()

a

cache.New(&cache.Options{.....}

Y que se pueda configurar el algoritmo de hash (actualmente hay dos) y el TTL, en caso de que no pasen ninguno, usar los tiempos por defecto (agregarlos porque hasta ahora no hay).

[CI/CD-tests] agregar github action para realizar los test unitarios

agregar github action para realizar los test unitarios automatizados durante cada push y pull request realizado al proyecto.

Agregar funcionalidades de Set (agregar, leer)

Agregar metodo de estadisticas, donde se guarde toda la informacion referida al cache, entradas, lecturas, ratio, espacio restante, etc.

Depende del issue #32

[CORE] Agregar funcionalidad de cache eviction cuando la cache este llena, de tipo LIFO (last in first out) y mantener un puntero.

Este issue depende de #29 y #30

Complejidad intermiedia-avanzada

Agregar limite maximo al cache, validar el limite en cada entrada

[V2][CORE-persistencia] implementar el esqueleto basico para el cache de persistencia. Mismas funciones que hay en el cache. Para esta tarea solo el esqueleto.

nuevas branchs

Se pueden crear nuevas branchs para las features que están en desarrollo y darle nombres, ejemplo: go-key-0.x? (para referirnos a la versión que se está trabajando). la main seria la ultima versión "estable".

Saludos.