all: add method parameter to Index creation

Indexes are now created with a `type` and `method` parameter.
However, each only has one option today: `token` for type, and
`sum` for method.

The method signatures for creating an index with the SDKs
now look like:

```
# Ruby/Node
chain.indexes.create(
   type: 'token',
   method: 'sum',
   filter: 'account_id = $1'
 )

# Java
Index.TokenSum.Builder()
  .setFilter("tags.type=$1")
  .create(client);
```

In the interest of being very explicit about just what is being indexed
`type` and `method` are essentially non-options right now,
but give users an innate understanding of what's being created
while being a flexible design that can (likely) be extended
in the future.

Closes #4390

Author: Dominic Dagradi <ddagradi@gmail.com>
Date: Fri Jul 27 14:20:02 2018 -0700
upstream:c4c4ca5af5db14ddbff2e1823955dc46136453e8

Author: dominic

src/api/indexes.ts

@@ -13,10 +13,13 @@ import { Query } from '../query'
  * Unique identifier of the index.
  *
  * @property {String} type
- * Type of index, "action" or "token".
+ * Type of index, currently must be "token".
+ *
+ * @property {String} method
+ * Method for index, currently must be "sum".
  *
  * @property {String[]} groupBy
- * Token/Action object fields to group by.
+ * Token object fields to group by.
  *
  * @property {String} filter
  * The query filter used to select matching items.
@@ -35,7 +38,8 @@ export const indexesAPI = (client: Client) => {
      * Create a new index.
      *
      * @param {Object} params - Parameters for index creation.
-     * @param {String} params.type - Type of index, "action" or "token".
+     * @param {String} params.type - Type of index, currently only "token".
+     * @param {String} params.method - Method for index, currently only "sum".
      * @param {String} params.filter - filter string, see {@link https://dashboard.seq.com/docs/filters}.
      * @param {Array<String>} params.groupBy - object fields to group by.
      * @param {String} params.id - Unique identifier. Will be auto-generated if
@@ -44,6 +48,7 @@ export const indexesAPI = (client: Client) => {
      */
     create: (params: {
       type: string
+      method: string
       id?: string
       filter: string
       groupBy?: string[]

src/validate.ts

@@ -28,6 +28,7 @@ ajv.addSchema(
     properties: {
       id: { type: 'string' },
       type: { type: 'string' },
+      method: { type: 'string' },
       filter: { type: 'string' },
       groupBy: { type: 'array', items: { type: 'string' } },
     },

test/indexes.ts

@@ -14,25 +14,46 @@ import { testHelpers } from './testHelpers'
 const { client, createAccount, createFlavor } = testHelpers
 
 describe('Index', () => {
-  it('creates an action index', async () => {
+  it('rejects bad types', () => {
+    return expect(client.indexes.create({
+      type: 'not-a-type',
+      method: 'sum',
+      filter: `tags.type=$1`,
+    }) as any).to.be.rejectedWith(
+      'SEQ611'
+    )
+  })
+
+  it('rejects bad methods', () => {
+    return expect(client.indexes.create({
+      type: 'token',
+      method: 'not-a-method',
+      filter: `tags.type=$1`,
+    }) as any).to.be.rejectedWith(
+      'SEQ611'
+    )
+  })
+
+  it('creates an index', async () => {
     const uuidCreated = uuid.v4()
 
     const index = await client.indexes.create({
-      type: 'action',
-      id: `actionIndex-${uuidCreated}`,
+      type: 'token',
+      method: 'sum',
+      id: `tokenIndex-${uuidCreated}`,
       filter: `tags.type-${uuidCreated}=$1`,
+      groupBy: ["flavorId"],
     })
-    expect(index.type).to.equal('action')
+    expect(index.type).to.equal('token')
   })
 
-  it('creates a token index', async () => {
+  it('creates an index without id', async () => {
     const uuidCreated = uuid.v4()
 
     const index = await client.indexes.create({
       type: 'token',
-      id: `tokenIndex-${uuidCreated}`,
+      method: 'sum',
       filter: `tags.type-${uuidCreated}=$1`,
-      groupBy: ["flavorId"],
     })
     expect(index.type).to.equal('token')
   })
@@ -41,7 +62,8 @@ describe('Index', () => {
     const uuidDeleted = uuid.v4()
 
     const index = await client.indexes.create({
-      type: 'action',
+      type: 'token',
+      method: 'sum',
       id: `index-${uuidDeleted}`,
       filter: `tags.type-${uuidDeleted}=$1`,
     })
@@ -55,21 +77,23 @@ describe('Index', () => {
   it('lists indexes', async () => {
     const uuidListed = uuid.v4()
 
-    const actionIndex = await client.indexes.create({
-      type: 'action',
-      id: `actionIndex-${uuidListed}`,
+    const tokenIndex1 = await client.indexes.create({
+      type: 'token',
+      method: 'sum',
       filter: `tags.type-${uuidListed}=$1`,
+      groupBy: ["flavorId"],
     })
 
-    const tokenIndex = await client.indexes.create({
+    const tokenIndex2 = await client.indexes.create({
       type: 'token',
-      id: `tokenIndex-${uuidListed}`,
+      method: 'sum',
       filter: `tags.type-${uuidListed}=$1`,
-      groupBy: ["flavorId"],
+      groupBy: ["flavorId", "accountId"],
     })
 
+
     const items = await testHelpers.asyncAll(client.indexes.list().all())
     const ids = items.map(item => item.id)
-    expect(ids).to.include(actionIndex.id, tokenIndex.id)
+    expect(ids).to.include(tokenIndex1.id, tokenIndex2.id)
   })
 })