prow-authority 3.6.3

package/src/v1/daos/policy-dao.ts

@@ -0,0 +1,105 @@
+import { Where } from '@beseif-solutions/utility-functions/dist/utils/sql-utils';
+import mySql from '../../helpers/mysql';
+import { DBRecord } from '../types/admin/policy-types';
+import { Modifiers } from '../common-types';
+
+class PolicyDao {
+  public readonly get = async (
+    params: Pick<DBRecord, 'id'>
+  ): Promise<DBRecord[]> => {
+    try {
+      const { query: q, params: p } = await mySql.queryConstructor<DBRecord>({
+        select: `*`,
+        from: `policy`,
+        where: params,
+      });
+      const response = await mySql.promiseQuery(q, p);
+      return response;
+    } catch (e) {
+      throw e;
+    }
+  };
+
+  public readonly list = async (params: Where<DBRecord>, modifiers: Modifiers = {}): Promise<DBRecord[]> => {
+    try {
+      const { query: q, params: p } = await mySql.queryConstructor<DBRecord>({
+        select: `*`,
+        from: `policy`,
+        where: params,
+        ...modifiers.order && { order: { by: modifiers.order.by, direction: modifiers.order.direction } },
+        ...modifiers.limit && {
+          limit: {
+            count: parseInt(modifiers.limit.count, 10),
+            ...modifiers.limit.from && { from: parseInt(modifiers.limit.from, 10) },
+          },
+        },
+      });
+      const response = await mySql.promiseQuery(q, p);
+      return response;
+    } catch (e) {
+      throw e;
+    }
+  };
+
+  public readonly add = async (
+    data: Omit<DBRecord, 'id'>
+  ): Promise<{ insertId: number }> => {
+    try {
+      const q = `insert into policy (uuid, name, metadata, internal) values (?,?,?,?)`;
+      const p = [
+        data.uuid,
+        data.name,
+        JSON.stringify(data.metadata || {}),
+        JSON.stringify(data.internal || {}),
+      ];
+      const response = await mySql.promiseQuery(q, p);
+      return response;
+    } catch (e) {
+      throw e;
+    }
+  };
+
+  public readonly update = async (
+    params: Pick<DBRecord, 'id'>,
+    data: Omit<DBRecord, 'id'>
+  ): Promise<{ affectedRows: number }> => {
+    try {
+      const q = `update policy set
+        uuid = ?,
+        name = ?,
+        metadata = ?,
+        internal = ?
+      where id = ?`;
+      const p = [
+        data.uuid,
+        data.name,
+        JSON.stringify(data.metadata || {}),
+        JSON.stringify(data.internal || {}),
+        params.id,
+      ];
+      const response = await mySql.promiseQuery(q, p);
+      return response;
+    } catch (e) {
+      throw e;
+    }
+  };
+
+  public readonly delete = async (
+    params: Pick<DBRecord, 'id'>
+  ): Promise<{ affectedRows: number }> => {
+    try {
+      const { query: q, params: p } = await mySql.queryConstructor<DBRecord>({
+        delete: null,
+        from: `policy`,
+        where: params,
+      });
+      const response = await mySql.promiseQuery(q, p);
+      return response;
+    } catch (e) {
+      throw e;
+    }
+  };
+}
+
+const policyDao = new PolicyDao();
+export default policyDao;

package/src/v1/daos/policy-version-dao.ts

@@ -0,0 +1,112 @@
+import { Where } from '@beseif-solutions/utility-functions/dist/utils/sql-utils';
+import mySql from '../../helpers/mysql';
+import { DBRecord } from '../types/admin/policy-version-types';
+import { Modifiers } from '../common-types';
+
+class PolicyVersionDao {
+  public readonly get = async (
+    params: Pick<DBRecord, 'id'>
+  ): Promise<DBRecord[]> => {
+    try {
+      const { query: q, params: p } = await mySql.queryConstructor<DBRecord>({
+        select: `*`,
+        from: `policy_version`,
+        where: params,
+      });
+      const response = await mySql.promiseQuery(q, p);
+      return response;
+    } catch (e) {
+      throw e;
+    }
+  };
+
+  public readonly list = async (params: Where<DBRecord>, modifiers: Modifiers = {}): Promise<DBRecord[]> => {
+    try {
+      const { query: q, params: p } = await mySql.queryConstructor<DBRecord>({
+        select: `*`,
+        from: `policy_version`,
+        where: params,
+        ...modifiers.order && { order: { by: modifiers.order.by, direction: modifiers.order.direction } },
+        ...modifiers.limit && {
+          limit: {
+            count: parseInt(modifiers.limit.count, 10),
+            ...modifiers.limit.from && { from: parseInt(modifiers.limit.from, 10) },
+          },
+        },
+      });
+      const response = await mySql.promiseQuery(q, p);
+      return response;
+    } catch (e) {
+      throw e;
+    }
+  };
+
+  public readonly add = async (
+    data: Omit<DBRecord, 'id' | 'created_date'>
+  ): Promise<{ insertId: number }> => {
+    try {
+      const q = `insert into policy_version (policy, version, url, metadata, internal, created_date, effective_date) values (?,?,?,?,?,?,?)`;
+      const p = [
+        data.policy,
+        data.version,
+        data.url,
+        JSON.stringify(data.metadata || {}),
+        JSON.stringify(data.internal || {}),
+        new Date(),
+        data.effective_date ? new Date(data.effective_date) : null,
+      ];
+      const response = await mySql.promiseQuery(q, p);
+      return response;
+    } catch (e) {
+      throw e;
+    }
+  };
+
+  public readonly update = async (
+    params: Pick<DBRecord, 'id'>,
+    data: Omit<DBRecord, 'id' | 'created_date'>
+  ): Promise<{ affectedRows: number }> => {
+    try {
+      const q = `update policy_version set
+        policy = ?,
+        version = ?,
+        url = ?,
+        metadata = ?,
+        internal = ?,
+        effective_date = ?
+      where id = ?`;
+      const p = [
+        data.policy,
+        data.version,
+        data.url,
+        JSON.stringify(data.metadata || {}),
+        JSON.stringify(data.internal || {}),
+        data.effective_date ? new Date(data.effective_date) : null,
+        params.id,
+      ];
+      const response = await mySql.promiseQuery(q, p);
+      return response;
+    } catch (e) {
+      throw e;
+    }
+  };
+
+  public readonly delete = async (
+    params: Pick<DBRecord, 'id'>
+  ): Promise<{ affectedRows: number }> => {
+    try {
+      const { query: q, params: p } = await mySql.queryConstructor<DBRecord>({
+        delete: null,
+        from: `policy_version`,
+        where: params,
+      });
+      const response = await mySql.promiseQuery(q, p);
+      return response;
+    } catch (e) {
+      throw e;
+    }
+  };
+}
+
+const policyVersionDao = new PolicyVersionDao();
+export default policyVersionDao;

package/src/v1/daos/redis-dao.ts

@@ -0,0 +1,38 @@
+
+import { Redis } from '@beseif-solutions/utility-functions/dist/utils/sql-utils';
+import nconf from '../../helpers/config';
+
+class RedisDao<T extends Record<string, any>> {
+
+  private readonly redis = new Redis({
+    url: `redis://${nconf.get(`SERVICES:REDIS:URL`)}:${nconf.get(`SERVICES:REDIS:PORT`)}`,
+  });
+
+  public readonly add = async (key: string, value: T, expires?: number): Promise<void> => {
+    try {
+      await this.redis.set(key, JSON.stringify(value), { EX: expires });
+    } catch (e) { throw e; }
+  };
+
+  public readonly get = async (mask: string): Promise<T> => {
+    try {
+      const response = (await this.redis.getAll(mask))[0];
+      return response ? JSON.parse(response) : undefined;
+    } catch (e) { throw e; }
+  };
+
+  public readonly list = async (mask: string): Promise<T[]> => {
+    try {
+      const response = await this.redis.getAll(mask);
+      return response.map((r) => JSON.parse(r));
+    } catch (e) { throw e; }
+  };
+
+  public readonly delete = async (mask: string): Promise<void> => {
+    try {
+      await this.redis.deleteAll(mask);
+    } catch (e) { throw e; }
+  };
+}
+
+export default RedisDao;

package/src/v1/daos/schema.sql

@@ -0,0 +1,462 @@
+drop database if exists prow_authority;
+create database prow_authority;
+use prow_authority;
+
+-- ACCESS ENTITIES
+
+create table `user` (
+  id integer not null auto_increment,
+  uuid varchar(36) not null,
+  email varchar(200) not null,
+  password varchar(64),
+  omnipotent boolean default false,
+  properties JSON not null,
+  preferences JSON not null,
+  utm JSON not null,
+  referrer varchar(200),
+  created_date datetime default now(),
+  modified_date datetime default now(),
+  status varchar(20) not null,
+  metadata json not null,
+  
+  constraint user_pk primary key (id),
+  constraint user_uniq_uuid unique key (uuid),
+  constraint user_uniq_email unique key (email)
+);
+
+create table organization (
+  id integer not null auto_increment,
+  uuid varchar(36) not null,
+  properties json not null,
+  billing json not null,
+  preferences json not null,
+  created_date datetime default now(),
+  modified_date datetime default now(),
+  status varchar(20) not null,
+  metadata json not null,
+  internal json not null,
+
+  constraint organization_pk primary key (id),
+  constraint organization_uniq_uuid unique key (uuid)
+);
+
+create table user_organization (
+  id integer not null auto_increment,
+  user integer not null,
+  organization integer not null,
+  role varchar(10) not null,
+  invite varchar(36),
+  invited_by integer,
+  created_date datetime default now(),
+  modified_date datetime default now(),
+  enabled boolean not null,
+  preferences json not null,
+  metadata JSON not null,
+
+  constraint user_organization_pk primary key (id),
+  constraint user_organization_uniq_user_on_organization unique key (user, organization),
+  constraint user_organization_uniq_invite_for_organization unique key (organization, invite),
+  constraint user_organization_fk_user foreign key (user)
+    references user (id),
+  constraint user_organization_fk_invited_by foreign key (invited_by)
+    references user (id)
+    on delete set null,
+  constraint user_organization_fk_organization foreign key (organization)
+    references organization (id)
+    on delete cascade,
+
+  index (role),
+  index (invite),
+  index (enabled)
+);
+
+-- LICENSE ENTITIES (SYSTEM)
+
+create table service (
+  id integer not null auto_increment,
+  uuid varchar(36) not null,
+  token varchar(100) not null,
+  properties json not null,
+  preferences JSON not null,
+  created_date datetime default now(),
+  modified_date datetime default now(),
+  enabled boolean not null,
+  metadata json not null,
+  internal json not null,
+
+  constraint service_pk primary key (id),
+  constraint service_uniq_uuid unique key (uuid)
+);
+
+create table service_notifications (
+  id integer not null auto_increment,
+  service integer not null,
+  event varchar(100) not null,
+  template varchar(36) not null,
+  scope json not null,
+  created_date datetime default now(),
+  modified_date datetime default now(),
+  `default` boolean not null default false,
+  enabled boolean not null,
+  metadata json not null,
+
+  constraint service_notifications_pk primary key (id, service),
+  constraint service_notifications_uniq_event_per_service unique key (service, event),
+  constraint service_notifications_fk_service foreign key (service)
+    references service (id)
+    on delete cascade,
+
+  index (event),
+  index (`default`),
+  index (enabled)
+);
+
+create table license (
+  id integer not null auto_increment,
+  uuid varchar(36) not null,
+  service integer not null,
+  type varchar(10) not null,
+  associated integer,
+  properties json not null,
+  data json not null,
+  created_date datetime default now(),
+  modified_date datetime default now(),
+  public boolean not null,
+  enabled boolean not null,
+  metadata json not null,
+
+  constraint license_pk primary key (id),
+  constraint license_uniq_uuid unique key (uuid),
+  constraint license_fk_service foreign key (service)
+    references service (id)
+    on delete cascade,
+  constraint license_fk_associated foreign key (associated)
+    references license (id)
+    on delete cascade,
+  
+  index (type),
+  index (public),
+  index (enabled)
+);
+
+create table license_limit (
+  id integer not null auto_increment,
+  license integer not null,
+  name varchar(100) not null,
+  `limit` integer not null,
+  period varchar(10),
+  monthly_price_abs decimal(10,2) not null,
+  annual_price_abs decimal(10,2) not null,
+  overconsume_monthly_price_per_unit decimal(64,30),
+  overconsume_annual_price_per_unit decimal(64,30),
+  metadata json not null,
+
+  constraint license_limit_pk primary key (id),
+  constraint license_limit_fk_license foreign key (license)
+    references license (id)
+    on delete cascade,
+  constraint license_limit_uniq_limit_per_license unique key (license, name),
+
+  index (name),
+  index (period)
+);
+
+-- create a view for prices
+-- drop view license_prices;
+create view license_prices as
+select 
+	l.*, 
+	sum(ll.annual_price_abs) as annual_price,
+	sum(ll.monthly_price_abs) as monthly_price
+from 
+	license l
+	left outer join license_limit ll on ll.license = l.id
+group by l.id;
+
+-- LICENSE ENTITIES (ORGANIZATION)
+
+create table organization_license (
+  id integer not null auto_increment,
+  uuid varchar(36) not null,
+  organization integer not null,
+  service integer not null,
+  type varchar(10) not null,
+  associated integer,
+  original integer,
+  billing varchar(10) not null,
+  properties json not null,
+  data json not null,
+  start_date datetime not null,
+  end_date datetime,
+  metadata json not null,
+  internal json not null,
+
+  constraint organization_license_pk primary key (id),
+  constraint organization_license_uniq_uuid unique key (uuid),
+  constraint organization_license_fk_organization foreign key (organization)
+    references organization (id)
+    on delete cascade,
+  constraint organization_license_fk_service foreign key (service)
+    references service (id)
+    on delete cascade,
+  constraint organization_license_fk_associated foreign key (associated)
+    references organization_license (id)
+    on delete cascade,
+  constraint organization_license_fk_original foreign key (original)
+    references license (id)
+    on delete set null,
+  
+  index (type),
+  index (billing),
+  index (start_date),
+  index (end_date),
+  index (start_date, end_date)
+);
+
+-- create a view to override license end_date with associated license's
+-- drop view organization_license_associated;
+create view organization_license_associated as
+select l.id, l.uuid, l.organization, l.service, l.`type`, l.billing, l.properties, l.data, l.start_date, 
+	IF(a.end_date is not null, a.end_date, l.end_date) as end_date, 
+	l.end_date as original_end_date,
+	l.metadata, l.internal, l.associated, l.original 
+from 
+	organization_license l 
+	left outer join organization_license a
+		on l.associated = a.id;
+
+-- create a view for the enabled status
+-- drop view organization_license_enabled;
+create view organization_license_enabled as
+select 
+	ola.*, 
+	sum(oll.annual_price_abs) as annual_price,
+	sum(oll.monthly_price_abs) as monthly_price,
+	(CONVERT_TZ(now(), 'SYSTEM', 'Europe/Madrid') >= start_date and (end_date is null or  CONVERT_TZ(now(), 'SYSTEM', 'Europe/Madrid') < end_date)) as enabled
+from 
+	organization_license_associated ola
+	left outer join organization_license_limit oll on oll.license = ola.id
+group by ola.id;
+
+create table organization_license_limit (
+  id integer not null auto_increment,
+  organization integer not null,
+  license integer not null,
+  name varchar(100) not null,
+  `limit` integer not null,
+  period varchar(10),
+  monthly_price_abs decimal(10,2) not null,
+  annual_price_abs decimal(10,2) not null,
+  overconsume boolean not null,
+  overconsume_monthly_price_per_unit decimal(64,30),
+  overconsume_annual_price_per_unit decimal(64,30),
+  metadata json not null,
+
+  constraint organization_license_limit_pk primary key (id),
+  constraint organization_license_limit_fk_organization foreign key (organization)
+    references organization (id)
+    on delete cascade,
+  constraint organization_license_limit_fk_license foreign key (license)
+    references organization_license (id)
+    on delete cascade,
+  constraint organization_license_limit_uniq_limit_per_license unique key (license, name),
+
+  index (name),
+  index (period),
+  index (overconsume)
+);
+
+-- CONSUMPTION AND QUOTA
+
+create table organization_usage (
+  id integer not null auto_increment,
+  organization integer not null,
+  service integer not null,
+  name varchar(100) not null,
+  count decimal(64,30) not null,
+  date datetime default now(),
+
+  constraint organization_usage_pk primary key (id),
+  constraint organization_usage_fk_organization foreign key (organization)
+    references organization (id)
+    on delete cascade,
+  constraint organization_usage_fk_service foreign key (service)
+    references service (id)
+    on delete cascade,
+
+  index (name),
+  index (date),
+  index idx_lookup_optimized (organization, service, name, date)
+);
+
+-- PAYMENTS AND BILLING
+
+create table billing_cycle (
+  id integer not null auto_increment,
+  uuid varchar(36) not null,
+  organization integer not null,
+  trial boolean default false,
+  start_date datetime not null,
+  end_date datetime not null,
+  metadata json not null,
+  internal json not null,
+
+  constraint billing_cycle_pk primary key (id),
+  constraint billing_cycle_uniq_uuid_for_organization unique key (organization, uuid),
+  constraint billing_cycle_fk_organization foreign key (organization)
+    references organization (id)
+    on delete cascade,
+
+  index (uuid),
+  index (organization),
+  index (start_date),
+  index (end_date)
+);
+
+create table payment_method (
+  id integer not null auto_increment,
+  uuid varchar(36) not null,
+  organization integer not null,
+  type varchar(10) not null,
+  properties json not null,
+  enabled boolean not null,
+  created_date datetime default now(),
+  modified_date datetime default now(),
+  metadata json not null,
+  internal json not null,
+
+  constraint payment_method_pk primary key (id),
+  constraint payment_method_uniq_uuid_for_organization unique key (organization, uuid),
+  constraint payment_method_fk_organization foreign key (organization)
+    references organization (id)
+    on delete cascade,
+
+  index (uuid),
+  index (organization),
+  index (type),
+  index (enabled)
+);
+
+create table invoice (
+  id integer not null auto_increment,
+  uuid varchar(36) not null,
+  organization integer not null,
+  date datetime not null,
+  amount decimal(64,30) not null,
+  tax_code varchar(20) not null,
+  tax_percentage decimal(64,30) not null,
+  concepts json not null,
+  billing json not null,
+  status varchar(20) not null,
+  invoice varchar(255),
+  number varchar(255),
+  payment varchar(255),
+  method integer,
+  metadata json not null,
+  internal json not null,
+
+  constraint invoice_pk primary key (id),
+  constraint invoice_uniq_uuid_for_organization unique key (organization, uuid),
+  constraint invoice_fk_organization foreign key (organization)
+    references organization (id)
+    on delete cascade,
+  constraint invoice_fk_method foreign key (method)
+    references payment_method (id)
+    on delete cascade,
+
+  index (uuid),
+  index (organization),
+  index (date),
+  index (method),
+  index (status),
+  index (invoice),
+  index (number),
+  index (payment)
+);
+
+create table accounting_seat (
+  id integer not null auto_increment,
+  uuid varchar(36) not null,
+  organization integer not null,
+  invoice integer not null,
+  date datetime not null,
+  amount decimal(64,30) not null,
+  done boolean not null,
+  metadata json not null,
+  internal json not null,
+
+  constraint accounting_seat_pk primary key (id),
+  constraint accounting_seat_uniq_uuid_for_organization unique key (organization, uuid),
+  constraint accounting_seat_fk_organization foreign key (organization)
+    references organization (id)
+    on delete cascade,
+  constraint accounting_seat_fk_invoice foreign key (invoice)
+    references invoice (id)
+    on delete cascade,
+
+  index (uuid),
+  index (organization),
+  index (invoice),
+  index (date),
+  index (done)
+);
+
+-- POLICY ENTITIES
+
+create table policy (
+  id integer not null auto_increment,
+  uuid varchar(36) not null,
+  name varchar(100) not null,
+  metadata json not null,
+  internal json not null,
+
+  constraint policy_pk primary key (id),
+  constraint policy_uniq_uuid unique key (uuid),
+  constraint policy_uniq_name unique key (name)
+);
+
+create table policy_version (
+  id integer not null auto_increment,
+  policy integer not null,
+  version varchar(20) not null,
+  url varchar(255) not null,
+  metadata json not null,
+  internal json not null,
+  created_date datetime default now(),
+  effective_date datetime default now(),
+
+  constraint policy_version_pk primary key (id),
+  constraint policy_version_uniq_version_for_policy unique key (policy, version),
+  constraint policy_version_fk_policy foreign key (policy)
+    references policy (id)
+    on delete cascade,
+
+  index (effective_date)
+);
+
+create table user_policy (
+  id integer not null auto_increment,
+  user integer not null,
+  policy integer not null,
+  version integer not null,
+  metadata json not null,
+  internal json not null,
+  informed_date datetime default now(),
+
+  constraint user_policy_pk primary key (id),
+  constraint user_policy_fk_user foreign key (user)
+    references user (id)
+    on delete cascade,
+  constraint user_policy_fk_policy foreign key (policy)
+    references policy (id)
+    on delete cascade,
+  constraint user_policy_fk_version foreign key (version)
+    references policy_version (id)
+    on delete cascade,
+  constraint user_policy_uniq_user_policy_version unique key (user, policy, version),
+
+  index (user),
+  index (policy),
+  index (version),
+  index (informed_date)
+);