feat: add source column to tenant

to store the onboarding source of the tenant such as marketplace, internal etc.

services/tenant-management-service/migrations/pg/migrations/20241009052517-add-tenants-source-column.js

@@ -0,0 +1,59 @@
+'use strict';
+
+let dbm;
+let type;
+let seed;
+let fs = require('fs');
+let path = require('path');
+let Promise;
+
+/**
+ * We receive the dbmigrate dependency from dbmigrate initially.
+ * This enables us to not have to rely on NODE_PATH.
+ */
+exports.setup = function (options, seedLink) {
+  dbm = options.dbmigrate;
+  type = dbm.dataType;
+  seed = seedLink;
+  Promise = options.Promise;
+};
+
+exports.up = function (db) {
+  const filePath = path.join(
+    __dirname,
+    'sqls',
+    '20241009052517-add-tenants-source-column-up.sql',
+  );
+  return new Promise(function (resolve, reject) {
+    fs.readFile(filePath, {encoding: 'utf-8'}, function (err, data) {
+      if (err) return reject(err);
+      console.log('received data: ' + data);
+
+      resolve(data);
+    });
+  }).then(function (data) {
+    return db.runSql(data);
+  });
+};
+
+exports.down = function (db) {
+  const filePath = path.join(
+    __dirname,
+    'sqls',
+    '20241009052517-add-tenants-source-column-down.sql',
+  );
+  return new Promise(function (resolve, reject) {
+    fs.readFile(filePath, {encoding: 'utf-8'}, function (err, data) {
+      if (err) return reject(err);
+      console.log('received data: ' + data);
+
+      resolve(data);
+    });
+  }).then(function (data) {
+    return db.runSql(data);
+  });
+};
+
+exports._meta = {
+  version: 1,
+};

services/tenant-management-service/migrations/pg/migrations/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "commonjs"
+}

services/tenant-management-service/migrations/pg/migrations/sqls/20241009052517-add-tenants-source-column-down.sql

@@ -0,0 +1,2 @@
+ALTER TABLE main.tenants
+DROP COLUMN source;

services/tenant-management-service/migrations/pg/migrations/sqls/20241009052517-add-tenants-source-column-up.sql

@@ -0,0 +1,2 @@
+ALTER TABLE main.tenants
+ADD COLUMN source varchar(255) DEFAULT 'INTERNAL';

services/tenant-management-service/src/models/dtos/tenant-onboard-dto.model.ts

@@ -62,6 +62,13 @@ export class TenantOnboardDTO extends Model {
   })
   key: string;
 
+  @property({
+    type: 'string',
+    description:
+      'Acquisition source of the tenant. Eg. AWS Marketplace, Super Admin Portal, Registration Page.',
+  })
+  source: string;
+
   @property({
     required: true,
     jsonSchema: {

services/tenant-management-service/src/models/tenant.model.ts

@@ -50,6 +50,13 @@ export class Tenant extends UserModifiableEntity {
   })
   key: string;
 
+  @property({
+    type: 'string',
+    description:
+      'Acquisition source of the tenant. Eg. AWS Marketplace, Super Admin Portal, Registration Page.',
+  })
+  source: string;
+
   @property({
     name: 'spoc_user_id',
     description:

services/tenant-management-service/src/services/onboarding.service.ts

@@ -178,6 +178,7 @@ export class OnboardingService {
           domains: dto.domains,
           status: TenantStatus.PENDINGPROVISION,
           addressId: address?.id,
+          source: dto.source,
         },
         {transaction},
       );