mirror of https://github.com/ghostfolio/ghostfolio
KenTandrian
2 weeks ago
29 changed files with 1069 additions and 118 deletions
@ -0,0 +1,170 @@ |
|||||
|
import { |
||||
|
activityDummyData, |
||||
|
assetProfileDummyData, |
||||
|
userDummyData |
||||
|
} from '@ghostfolio/api/app/portfolio/calculator/portfolio-calculator-test-utils'; |
||||
|
import { PortfolioCalculatorFactory } from '@ghostfolio/api/app/portfolio/calculator/portfolio-calculator.factory'; |
||||
|
import { CurrentRateService } from '@ghostfolio/api/app/portfolio/current-rate.service'; |
||||
|
import { CurrentRateServiceMock } from '@ghostfolio/api/app/portfolio/current-rate.service.mock'; |
||||
|
import { RedisCacheService } from '@ghostfolio/api/app/redis-cache/redis-cache.service'; |
||||
|
import { RedisCacheServiceMock } from '@ghostfolio/api/app/redis-cache/redis-cache.service.mock'; |
||||
|
import { ConfigurationService } from '@ghostfolio/api/services/configuration/configuration.service'; |
||||
|
import { ExchangeRateDataService } from '@ghostfolio/api/services/exchange-rate-data/exchange-rate-data.service'; |
||||
|
import { PortfolioSnapshotService } from '@ghostfolio/api/services/queues/portfolio-snapshot/portfolio-snapshot.service'; |
||||
|
import { PortfolioSnapshotServiceMock } from '@ghostfolio/api/services/queues/portfolio-snapshot/portfolio-snapshot.service.mock'; |
||||
|
import { parseDate } from '@ghostfolio/common/helper'; |
||||
|
import { Activity } from '@ghostfolio/common/interfaces'; |
||||
|
import { PerformanceCalculationType } from '@ghostfolio/common/types/performance-calculation-type.type'; |
||||
|
|
||||
|
import { Big } from 'big.js'; |
||||
|
|
||||
|
jest.mock('@ghostfolio/api/app/portfolio/current-rate.service', () => { |
||||
|
return { |
||||
|
CurrentRateService: jest.fn().mockImplementation(() => { |
||||
|
return CurrentRateServiceMock; |
||||
|
}) |
||||
|
}; |
||||
|
}); |
||||
|
|
||||
|
jest.mock( |
||||
|
'@ghostfolio/api/services/queues/portfolio-snapshot/portfolio-snapshot.service', |
||||
|
() => { |
||||
|
return { |
||||
|
PortfolioSnapshotService: jest.fn().mockImplementation(() => { |
||||
|
return PortfolioSnapshotServiceMock; |
||||
|
}) |
||||
|
}; |
||||
|
} |
||||
|
); |
||||
|
|
||||
|
jest.mock('@ghostfolio/api/app/redis-cache/redis-cache.service', () => { |
||||
|
return { |
||||
|
RedisCacheService: jest.fn().mockImplementation(() => { |
||||
|
return RedisCacheServiceMock; |
||||
|
}) |
||||
|
}; |
||||
|
}); |
||||
|
|
||||
|
describe('PortfolioCalculator', () => { |
||||
|
let configurationService: ConfigurationService; |
||||
|
let currentRateService: CurrentRateService; |
||||
|
let exchangeRateDataService: ExchangeRateDataService; |
||||
|
let portfolioCalculatorFactory: PortfolioCalculatorFactory; |
||||
|
let portfolioSnapshotService: PortfolioSnapshotService; |
||||
|
let redisCacheService: RedisCacheService; |
||||
|
|
||||
|
beforeEach(() => { |
||||
|
PortfolioSnapshotServiceMock.reset(); |
||||
|
RedisCacheServiceMock.reset(); |
||||
|
|
||||
|
configurationService = new ConfigurationService(); |
||||
|
|
||||
|
currentRateService = new CurrentRateService(null, null, null); |
||||
|
|
||||
|
exchangeRateDataService = new ExchangeRateDataService( |
||||
|
null, |
||||
|
null, |
||||
|
null, |
||||
|
null |
||||
|
); |
||||
|
|
||||
|
portfolioSnapshotService = new PortfolioSnapshotService(null, null); |
||||
|
|
||||
|
redisCacheService = new RedisCacheService(null, null); |
||||
|
|
||||
|
portfolioCalculatorFactory = new PortfolioCalculatorFactory( |
||||
|
configurationService, |
||||
|
currentRateService, |
||||
|
exchangeRateDataService, |
||||
|
portfolioSnapshotService, |
||||
|
redisCacheService |
||||
|
); |
||||
|
}); |
||||
|
|
||||
|
describe('get current positions', () => { |
||||
|
it('with MANUAL buy and market price between two chart dates', async () => { |
||||
|
jest.useFakeTimers().setSystemTime(parseDate('2024-01-31').getTime()); |
||||
|
|
||||
|
const activities: Activity[] = [ |
||||
|
{ |
||||
|
...activityDummyData, |
||||
|
assetProfile: { |
||||
|
...assetProfileDummyData, |
||||
|
currency: 'USD', |
||||
|
dataSource: 'MANUAL', |
||||
|
name: 'Private Investment', |
||||
|
symbol: '6c0c5cee-0208-4975-b473-03baf2518497' |
||||
|
}, |
||||
|
date: parseDate('2021-01-04'), |
||||
|
feeInAssetProfileCurrency: 0, |
||||
|
feeInBaseCurrency: 0, |
||||
|
quantity: 10, |
||||
|
type: 'BUY', |
||||
|
unitPriceInAssetProfileCurrency: 50 |
||||
|
} |
||||
|
]; |
||||
|
|
||||
|
const portfolioCalculator = portfolioCalculatorFactory.createCalculator({ |
||||
|
activities, |
||||
|
calculationType: PerformanceCalculationType.ROAI, |
||||
|
currency: 'USD', |
||||
|
userId: userDummyData.id |
||||
|
}); |
||||
|
|
||||
|
const portfolioSnapshot = await portfolioCalculator.computeSnapshot(); |
||||
|
|
||||
|
const historicalDataByDate = Object.fromEntries( |
||||
|
portfolioSnapshot.historicalData.map((historicalDataItem) => { |
||||
|
return [historicalDataItem.date, historicalDataItem]; |
||||
|
}) |
||||
|
); |
||||
|
|
||||
|
/** |
||||
|
* The only historical market prices are on 2023-06-14 and 2023-06-15, |
||||
|
* which are not chart dates (every third day from 2021-01-03) |
||||
|
*/ |
||||
|
expect(historicalDataByDate['2023-06-14']).toBeUndefined(); |
||||
|
expect(historicalDataByDate['2023-06-15']).toBeUndefined(); |
||||
|
|
||||
|
/** |
||||
|
* The chart dates before the market prices use the unit price of the |
||||
|
* activity: 50 |
||||
|
*/ |
||||
|
expect(historicalDataByDate['2023-06-13']).toMatchObject({ |
||||
|
netPerformance: 0, // 10 * (50 - 50) = 0
|
||||
|
totalInvestment: 500, |
||||
|
value: 500 // 10 * 50 = 500
|
||||
|
}); |
||||
|
|
||||
|
/** |
||||
|
* The chart dates after the market prices carry the latest one forward |
||||
|
* (100), not the first one (80) |
||||
|
*/ |
||||
|
expect(historicalDataByDate['2023-06-16']).toMatchObject({ |
||||
|
netPerformance: 500, // 10 * (100 - 50) = 500
|
||||
|
totalInvestment: 500, |
||||
|
value: 1000 // 10 * 100 = 1000
|
||||
|
}); |
||||
|
|
||||
|
expect(historicalDataByDate['2024-01-30']).toMatchObject({ |
||||
|
netPerformance: 500, // 10 * (100 - 50) = 500
|
||||
|
totalInvestment: 500, |
||||
|
value: 1000 // 10 * 100 = 1000
|
||||
|
}); |
||||
|
|
||||
|
/** |
||||
|
* The market price is unchanged since 2023-06-15, hence there is no |
||||
|
* performance today |
||||
|
*/ |
||||
|
expect(portfolioSnapshot.positions[0]).toMatchObject({ |
||||
|
netPerformancePercentageWithCurrencyEffectMap: { |
||||
|
'1d': new Big(0) |
||||
|
}, |
||||
|
netPerformanceWithCurrencyEffectMap: { |
||||
|
'1d': new Big(0), |
||||
|
max: new Big(500) // 10 * (100 - 50) = 500
|
||||
|
} |
||||
|
}); |
||||
|
}); |
||||
|
}); |
||||
|
}); |
||||
@ -0,0 +1,123 @@ |
|||||
|
import { ConfigurationService } from '@ghostfolio/api/services/configuration/configuration.service'; |
||||
|
|
||||
|
import { DataSource } from '@prisma/client'; |
||||
|
|
||||
|
import { |
||||
|
encodeDataSource, |
||||
|
isValidEncodedDataSource, |
||||
|
transformDataSourceInRequest, |
||||
|
transformDataSourceInResponse |
||||
|
} from './data-source.helper'; |
||||
|
|
||||
|
function createConfigurationService({ |
||||
|
isSubscriptionEnabled |
||||
|
}: { |
||||
|
isSubscriptionEnabled: boolean; |
||||
|
}) { |
||||
|
const configuration: Record<string, unknown> = { |
||||
|
DATA_SOURCES_GHOSTFOLIO_DATA_PROVIDER: [DataSource.YAHOO], |
||||
|
ENABLE_FEATURE_SUBSCRIPTION: isSubscriptionEnabled |
||||
|
}; |
||||
|
|
||||
|
return { |
||||
|
get: jest.fn((key: string) => { |
||||
|
return configuration[key]; |
||||
|
}) |
||||
|
} as unknown as ConfigurationService; |
||||
|
} |
||||
|
|
||||
|
describe('DataSourceHelper', () => { |
||||
|
describe('isValidEncodedDataSource', () => { |
||||
|
it('Accepts an encoded data source', () => { |
||||
|
expect(isValidEncodedDataSource(encodeDataSource(DataSource.YAHOO))).toBe( |
||||
|
true |
||||
|
); |
||||
|
}); |
||||
|
|
||||
|
it('Refuses a data source which is not encoded', () => { |
||||
|
expect(isValidEncodedDataSource(DataSource.YAHOO)).toBe(false); |
||||
|
}); |
||||
|
|
||||
|
it('Refuses an unknown encoded data source', () => { |
||||
|
expect(isValidEncodedDataSource('ffffffff')).toBe(false); |
||||
|
}); |
||||
|
}); |
||||
|
|
||||
|
describe('transformDataSourceInRequest', () => { |
||||
|
const configurationService = createConfigurationService({ |
||||
|
isSubscriptionEnabled: true |
||||
|
}); |
||||
|
|
||||
|
it('Decodes an encoded data source', () => { |
||||
|
expect( |
||||
|
transformDataSourceInRequest({ |
||||
|
configurationService, |
||||
|
dataSource: encodeDataSource(DataSource.COINGECKO) |
||||
|
}) |
||||
|
).toBe(DataSource.COINGECKO); |
||||
|
}); |
||||
|
|
||||
|
it('Resolves the mask of the data source of the Ghostfolio data provider', () => { |
||||
|
expect( |
||||
|
transformDataSourceInRequest({ |
||||
|
configurationService, |
||||
|
dataSource: DataSource.GHOSTFOLIO |
||||
|
}) |
||||
|
).toBe(DataSource.YAHOO); |
||||
|
}); |
||||
|
|
||||
|
it('Keeps a data source which is not encoded', () => { |
||||
|
expect( |
||||
|
transformDataSourceInRequest({ |
||||
|
configurationService, |
||||
|
dataSource: DataSource.COINGECKO |
||||
|
}) |
||||
|
).toBe(DataSource.COINGECKO); |
||||
|
}); |
||||
|
|
||||
|
it('Keeps an absent data source', () => { |
||||
|
expect( |
||||
|
transformDataSourceInRequest({ |
||||
|
configurationService, |
||||
|
dataSource: undefined |
||||
|
}) |
||||
|
).toBeUndefined(); |
||||
|
}); |
||||
|
}); |
||||
|
|
||||
|
describe('transformDataSourceInResponse', () => { |
||||
|
it('Encodes the data source if the subscription is enabled', () => { |
||||
|
expect( |
||||
|
transformDataSourceInResponse({ |
||||
|
configurationService: createConfigurationService({ |
||||
|
isSubscriptionEnabled: true |
||||
|
}), |
||||
|
dataSource: DataSource.YAHOO |
||||
|
}) |
||||
|
).toBe(encodeDataSource(DataSource.YAHOO)); |
||||
|
}); |
||||
|
|
||||
|
it('Keeps the data sources GHOSTFOLIO and MANUAL if the subscription is enabled', () => { |
||||
|
const configurationService = createConfigurationService({ |
||||
|
isSubscriptionEnabled: true |
||||
|
}); |
||||
|
|
||||
|
for (const dataSource of [DataSource.GHOSTFOLIO, DataSource.MANUAL]) { |
||||
|
expect( |
||||
|
transformDataSourceInResponse({ configurationService, dataSource }) |
||||
|
).toBe(dataSource); |
||||
|
} |
||||
|
}); |
||||
|
|
||||
|
it('Keeps the data source if the subscription is not enabled', () => { |
||||
|
expect( |
||||
|
transformDataSourceInResponse({ |
||||
|
configurationService: createConfigurationService({ |
||||
|
isSubscriptionEnabled: false |
||||
|
}), |
||||
|
dataSource: DataSource.YAHOO |
||||
|
}) |
||||
|
).toBe(DataSource.YAHOO); |
||||
|
}); |
||||
|
}); |
||||
|
}); |
||||
@ -0,0 +1,5 @@ |
|||||
|
import { ConfigurationService } from '@ghostfolio/api/services/configuration/configuration.service'; |
||||
|
|
||||
|
export interface DataSourceTableContext { |
||||
|
configurationService: ConfigurationService; |
||||
|
} |
||||
@ -1,6 +1,8 @@ |
|||||
import { AssetClass, AssetSubClass } from '@prisma/client'; |
import { AssetClass, AssetSubClass } from '@prisma/client'; |
||||
|
|
||||
export interface HoldingsTableContext { |
import { DataSourceTableContext } from './data-source-table-context.interface'; |
||||
|
|
||||
|
export interface HoldingsTableContext extends DataSourceTableContext { |
||||
assetClassTranslations: Record<AssetClass, string>; |
assetClassTranslations: Record<AssetClass, string>; |
||||
assetSubClassTranslations: Record<AssetSubClass, string>; |
assetSubClassTranslations: Record<AssetSubClass, string>; |
||||
} |
} |
||||
|
|||||
Loading…
Reference in new issue