feat(gsi): Add Composite Key Support to Global Secondary Indexes

Author: stephen-belcher-ta

src/index.js

@@ -56,8 +56,18 @@ export default class {
       }
       delete params.projectionType;
     }
-    newIndex.IndexName = params.value + '-index';
-    newIndex.KeySchema.push(this.generateKey(params));
+    // Check for composite key
+    if (params.values) {
+      newIndex.IndexName = '';
+      params.values.forEach(obj => {
+        newIndex.IndexName += obj.value + '-';
+        newIndex.KeySchema.push(this.generateKey(obj));
+      });
+      newIndex.IndexName += 'index';
+    } else {
+      newIndex.IndexName = params.value + '-index';
+      newIndex.KeySchema.push(this.generateKey(params));
+    }
     return newIndex;
   }
 
@@ -143,7 +153,16 @@ export default class {
     let newTable = _.clone(tables.table, true);
     newTable.Table.TableName = this.schemas[version].tableName;
     _.each(this.schemas[version].indexes, (row) => {
-      newTable.Table.AttributeDefinitions.push(this.generateDefinition(row));
+      // Check for composite key
+      if (row.values) {
+        row.values.forEach(obj => {
+          newTable.Table.AttributeDefinitions.push(this.generateDefinition(obj));
+        });
+      } else {
+        newTable.Table.AttributeDefinitions.push(this.generateDefinition(row));
+      }
+      // Remove duplicates in AttributeDefinitions on AttributeName
+      newTable.Table.AttributeDefinitions = _.uniq(newTable.Table.AttributeDefinitions, 'AttributeName');
       if (row.keytype === 'hash' || row.keytype === 'range') {
         newTable.Table.KeySchema.push(this.generateKey(row));
       } else if (row.keytype === 'secondary') {

test/src/index.spec.js

@@ -19,6 +19,7 @@ const failAdapter = new DynamoAdapter(dynamoConfig);
 const nogsiAdapter = new DynamoAdapter(dynamoConfig);
 const projectionAdapter = new DynamoAdapter(dynamoConfig);
 const includeAdapter = new DynamoAdapter(dynamoConfig);
+const compositeAdapter = new DynamoAdapter(dynamoConfig);
 
 // Set the schemas
 numeric.setSchema(dbData.testNumericModel, '1');
@@ -27,6 +28,7 @@ failAdapter.setSchema(dbData.badModel, '1');
 nogsiAdapter.setSchema(dbData.nogsiModel, '1');
 projectionAdapter.setSchema(dbData.testProjectionModel, '1');
 includeAdapter.setSchema(dbData.testIncludeModel, '1');
+compositeAdapter.setSchema(dbData.testCompositeModel, '1');
 
 const validate = (body) => {
   return new Promise((resolve, reject) => {
@@ -58,6 +60,19 @@ failAdapter.sanitize = sanitize;
 nogsiAdapter.sanitize = sanitize;
 projectionAdapter.sanitize = sanitize;
 includeAdapter.sanitize = sanitize;
+compositeAdapter.sanitize = sanitize;
+
+describe('Composite Keys', () => {
+  after(() => compositeAdapter.deleteTable({TableName: dbData.testCompositeModel.tableName}));
+  it('creates a table with a composite key global secondary index', () => {
+    return compositeAdapter.createTableFromModel().then((data) => {
+      data.TableDescription.CreationDateTime = '';
+      data.TableDescription.ProvisionedThroughput.LastDecreaseDateTime = '';
+      data.TableDescription.ProvisionedThroughput.LastIncreaseDateTime = '';
+      expect(data).to.deep.equal(dbData.testCompositeModelResult);
+    });
+  });
+});
 
 describe('Non standard projection types', () => {
   it('Creates the KEYS_ONLY only table', (done) => {

test/src/test-data.js

@@ -166,3 +166,86 @@ dbData.nogsiModel = {
     permissions: {}
   }
 };
+
+dbData.testCompositeModel = {
+  name: 'usercomposite',
+  version: 1,
+  autoCreate: false,
+  indexes: [
+    { keytype: 'hash', value: 'id', type: 'N'},
+    { keytype: 'range', value: 'createdAt', type: 'S'},
+    { keytype: 'secondary', values: [{keytype: 'hash', value: 'login', type: 'S'}, {keytype: 'range', value: 'createdAt', type: 'S'}]}
+  ],
+  tableName: 'usercomposites',
+  schema: {
+    permissions: {}
+  }
+};
+
+dbData.testCompositeModelResult = {
+  'TableDescription': {
+    'CreationDateTime': '',
+    'AttributeDefinitions': [
+      {
+        'AttributeName': 'id',
+        'AttributeType': 'N'
+      },
+      {
+        'AttributeName': 'createdAt',
+        'AttributeType': 'S'
+      },
+      {
+        'AttributeName': 'login',
+        'AttributeType': 'S'
+      }
+    ],
+    'TableArn': 'arn:aws:dynamodb:ddblocal:000000000000:table/usercomposites',
+    'TableName': 'usercomposites',
+    'TableSizeBytes': 0,
+    'TableStatus': 'ACTIVE',
+    'ItemCount': 0,
+    'KeySchema': [
+      {
+        'AttributeName': 'id',
+        'KeyType': 'HASH'
+      },
+      {
+        'AttributeName': 'createdAt',
+        'KeyType': 'RANGE'
+      }
+    ],
+    'ProvisionedThroughput': {
+      'LastDecreaseDateTime': '',
+      'LastIncreaseDateTime': '',
+      'NumberOfDecreasesToday': 0,
+      'ReadCapacityUnits': 1,
+      'WriteCapacityUnits': 1
+    },
+    'GlobalSecondaryIndexes': [
+      {
+        'IndexArn': 'arn:aws:dynamodb:ddblocal:000000000000:table/usercomposites/index/login-createdAt-index',
+        'IndexName': 'login-createdAt-index',
+        'IndexSizeBytes': 0,
+        'IndexStatus': 'ACTIVE',
+        'ItemCount': 0,
+        'KeySchema': [
+          {
+            'AttributeName': 'login',
+            'KeyType': 'HASH'
+          },
+          {
+            'AttributeName': 'createdAt',
+            'KeyType': 'RANGE'
+          }
+        ],
+        'Projection': {
+          'ProjectionType': 'ALL'
+        },
+        'ProvisionedThroughput': {
+          'ReadCapacityUnits': 1,
+          'WriteCapacityUnits': 1
+        }
+      }
+    ]
+  }
+};