-
Notifications
You must be signed in to change notification settings - Fork 104
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Showing
10 changed files
with
301 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
82 changes: 82 additions & 0 deletions
82
indexer/packages/postgres/__tests__/stores/token-table.test.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,82 @@ | ||
import { TokenFromDatabase } from '../../src/types'; | ||
import { clearData, migrate, teardown } from '../../src/helpers/db-helpers'; | ||
import { defaultAddress2, defaultToken, defaultWallet } from '../helpers/constants'; | ||
import * as TokenTable from '../../src/stores/token-table'; | ||
import * as WalletTable from '../../src/stores/wallet-table'; | ||
|
||
describe('Token store', () => { | ||
beforeAll(async () => { | ||
await migrate(); | ||
}); | ||
|
||
beforeEach(async () => { | ||
// Default wallet is required in the DB for token creation | ||
// As token has a foreign key constraint on wallet | ||
await WalletTable.create(defaultWallet); | ||
}); | ||
|
||
afterEach(async () => { | ||
await clearData(); | ||
}); | ||
|
||
afterAll(async () => { | ||
await teardown(); | ||
}); | ||
|
||
it('Successfully creates a Token', async () => { | ||
await TokenTable.create(defaultToken); | ||
const token = await TokenTable.findByToken(defaultToken.token); | ||
expect(token).toEqual(expect.objectContaining(defaultToken)); | ||
}); | ||
|
||
it('Successfully upserts a Token multiple times', async () => { | ||
await TokenTable.upsert(defaultToken); | ||
let token: TokenFromDatabase | undefined = await TokenTable.findByToken( | ||
defaultToken.token, | ||
); | ||
|
||
expect(token).toEqual(expect.objectContaining(defaultToken)); | ||
|
||
// Upsert again to test update functionality | ||
const updatedToken = { ...defaultToken, updatedAt: new Date().toISOString(), language: 'es' }; | ||
await TokenTable.upsert(updatedToken); | ||
token = await TokenTable.findByToken(defaultToken.token); | ||
|
||
expect(token).toEqual(expect.objectContaining(updatedToken)); | ||
}); | ||
|
||
it('Successfully finds all Tokens', async () => { | ||
await WalletTable.create({ ...defaultWallet, address: defaultAddress2 }); | ||
const additionalToken = { | ||
token: 'fake_token', | ||
address: defaultAddress2, | ||
language: 'en', | ||
updatedAt: new Date().toISOString(), | ||
}; | ||
|
||
await Promise.all([ | ||
TokenTable.create(defaultToken), | ||
TokenTable.create(additionalToken), | ||
]); | ||
|
||
const tokens: TokenFromDatabase[] = await TokenTable.findAll( | ||
{}, | ||
[], | ||
{ readReplica: true }, | ||
); | ||
|
||
expect(tokens.length).toEqual(2); | ||
expect(tokens[0]).toEqual(expect.objectContaining(defaultToken)); | ||
expect(tokens[1]).toEqual(expect.objectContaining(additionalToken)); | ||
}); | ||
|
||
it('Successfully finds a Token by token', async () => { | ||
await TokenTable.create(defaultToken); | ||
|
||
const token: TokenFromDatabase | undefined = await TokenTable.findByToken( | ||
defaultToken.token, | ||
); | ||
|
||
expect(token).toEqual(expect.objectContaining(defaultToken)); | ||
}); | ||
}); |
16 changes: 16 additions & 0 deletions
16
...packages/postgres/src/db/migrations/migration_files/20240809153326_create_tokens_table.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
import * as Knex from 'knex'; | ||
|
||
export async function up(knex: Knex): Promise<void> { | ||
return knex.schema.createTable('tokens', (table) => { | ||
table.increments('id').primary(); | ||
table.string('token').notNullable().unique(); | ||
table.string('address').notNullable(); | ||
table.foreign('address').references('wallets.address').onDelete('CASCADE'); | ||
table.string('language').notNullable(); | ||
table.timestamp('updatedAt').notNullable().defaultTo(knex.fn.now()); | ||
}); | ||
} | ||
|
||
export async function down(knex: Knex): Promise<void> { | ||
return knex.schema.dropTable('tokens'); | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
import { Model } from 'objection'; | ||
|
||
import { IsoString } from '../types'; | ||
import WalletModel from './wallet-model'; | ||
|
||
class TokenModel extends Model { | ||
static tableName = 'tokens'; | ||
|
||
id!: number; | ||
token!: string; | ||
address!: string; | ||
updatedAt!: IsoString; | ||
language!: string; | ||
|
||
static relationMappings = { | ||
wallet: { | ||
relation: Model.BelongsToOneRelation, | ||
modelClass: WalletModel, | ||
join: { | ||
from: 'tokens.address', | ||
to: 'wallets.address', | ||
}, | ||
}, | ||
}; | ||
} | ||
|
||
export default TokenModel; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,132 @@ | ||
import { DateTime } from 'luxon'; | ||
import { PartialModelObject, QueryBuilder } from 'objection'; | ||
|
||
import { DEFAULT_POSTGRES_OPTIONS } from '../constants'; | ||
import { setupBaseQuery, verifyAllRequiredFields } from '../helpers/stores-helpers'; | ||
import Transaction from '../helpers/transaction'; | ||
import TokenModel from '../models/token-model'; | ||
import { | ||
Options, | ||
Ordering, | ||
QueryableField, | ||
QueryConfig, | ||
TokenColumns, | ||
TokenCreateObject, | ||
TokenFromDatabase, | ||
TokenQueryConfig, | ||
TokenUpdateObject, | ||
} from '../types'; | ||
|
||
export async function findAll( | ||
{ | ||
address, | ||
limit, | ||
}: TokenQueryConfig, | ||
requiredFields: QueryableField[], | ||
options: Options = DEFAULT_POSTGRES_OPTIONS, | ||
): Promise<TokenFromDatabase[]> { | ||
verifyAllRequiredFields( | ||
{ | ||
address, | ||
limit, | ||
} as QueryConfig, | ||
requiredFields, | ||
); | ||
|
||
let baseQuery: QueryBuilder<TokenModel> = setupBaseQuery<TokenModel>( | ||
TokenModel, | ||
options, | ||
); | ||
|
||
if (address) { | ||
baseQuery = baseQuery.where(TokenColumns.address, address); | ||
} | ||
|
||
if (options.orderBy !== undefined) { | ||
for (const [column, order] of options.orderBy) { | ||
baseQuery = baseQuery.orderBy( | ||
column, | ||
order, | ||
); | ||
} | ||
} else { | ||
baseQuery = baseQuery.orderBy( | ||
TokenColumns.updatedAt, | ||
Ordering.ASC, | ||
); | ||
} | ||
|
||
if (limit) { | ||
baseQuery = baseQuery.limit(limit); | ||
} | ||
|
||
return baseQuery.returning('*'); | ||
} | ||
|
||
export async function create( | ||
tokenToCreate: TokenCreateObject, | ||
options: Options = { txId: undefined }, | ||
): Promise<TokenFromDatabase> { | ||
return TokenModel.query( | ||
Transaction.get(options.txId), | ||
).insert(tokenToCreate).returning('*'); | ||
} | ||
|
||
export async function update( | ||
{ | ||
token, | ||
...fields | ||
}: TokenUpdateObject, | ||
options: Options = { txId: undefined }, | ||
): Promise<TokenFromDatabase> { | ||
const existingToken = await TokenModel.query( | ||
Transaction.get(options.txId), | ||
).findOne({ token }); | ||
const updatedToken = await existingToken.$query().patch(fields as PartialModelObject<TokenModel>).returning('*'); | ||
return updatedToken as unknown as TokenFromDatabase; | ||
} | ||
|
||
export async function upsert( | ||
tokenToUpsert: TokenCreateObject, | ||
options: Options = { txId: undefined }, | ||
): Promise<TokenFromDatabase> { | ||
const existingToken = await TokenModel.query( | ||
Transaction.get(options.txId), | ||
).findOne({ token: tokenToUpsert.token }); | ||
|
||
if (existingToken) { | ||
return update(tokenToUpsert, options); | ||
} else { | ||
return create(tokenToUpsert, options); | ||
} | ||
} | ||
|
||
export async function findByToken( | ||
token: string, | ||
options: Options = DEFAULT_POSTGRES_OPTIONS, | ||
): Promise<TokenFromDatabase | undefined> { | ||
const baseQuery: QueryBuilder<TokenModel> = setupBaseQuery<TokenModel>( | ||
TokenModel, | ||
options, | ||
); | ||
return baseQuery | ||
.findOne({ token }) | ||
.returning('*'); | ||
} | ||
|
||
export async function registerToken( | ||
token: string, | ||
address: string, | ||
language: string, | ||
options: Options = { txId: undefined }, | ||
): Promise<TokenFromDatabase> { | ||
return upsert( | ||
{ | ||
token, | ||
address, | ||
updatedAt: DateTime.now().toISO(), | ||
language, | ||
}, | ||
options, | ||
); | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
/* ------- TOKEN TYPES ------- */ | ||
|
||
type IsoString = string; | ||
|
||
export interface TokenCreateObject { | ||
token: string, | ||
address: string, | ||
language: string, | ||
updatedAt: IsoString, | ||
} | ||
|
||
export interface TokenUpdateObject { | ||
token: string, | ||
address: string, | ||
language: string, | ||
updatedAt: IsoString, | ||
} | ||
|
||
export enum TokenColumns { | ||
token = 'token', | ||
address = 'address', | ||
language = 'language', | ||
updatedAt = 'updatedAt', | ||
} |