Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #791 from nemtech/fix_unit_test
Fix unit test
- Loading branch information
Showing
8 changed files
with
192 additions
and
14 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
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
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,90 @@ | ||
/* | ||
* Copyright 2021 NEM | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"); | ||
* you may not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
|
||
import { ChronoUnit, Duration, Instant } from '@js-joda/core'; | ||
import { RepositoryFactory } from '../infrastructure'; | ||
import { Deadline, defaultChronoUnit, defaultDeadline } from '../model/transaction'; | ||
|
||
/** | ||
* A factory service that allows the client to generate Deadline objects based on different strategies. | ||
* | ||
* The main issue is that sometimes the local computer time is not in sync, the created deadlines may be too old or too in the future and rejected by the server. | ||
*/ | ||
export class DeadlineService { | ||
/** | ||
* The difference in milliseconds between the server and the local time. It used to create "server" deadline without asking for the server time every time a new deadline is created. | ||
*/ | ||
private localTimeOffset: number; | ||
|
||
/** | ||
* Private constructor, use the create static method | ||
* | ||
* @param repositoryFactory the repository factory to call the rest servers. | ||
* @param epochAdjustment the server epochAdjustment | ||
* @param serverTime the latest known server time to calculate the remote and local time difference. | ||
*/ | ||
private constructor( | ||
private readonly repositoryFactory: RepositoryFactory, | ||
private readonly epochAdjustment: number, | ||
serverTime: number, | ||
) { | ||
this.localTimeOffset = Instant.now().minusSeconds(epochAdjustment).toEpochMilli() - serverTime; | ||
} | ||
|
||
/** | ||
* It creates a deadline by querying the current time to the server each time. This is the most accurate but less efficient way. | ||
* | ||
* @param deadline the deadline value | ||
* @param chronoUnit the unit of the value. | ||
*/ | ||
public async createDeadlineUsingServerTime(deadline = defaultDeadline, chronoUnit: ChronoUnit = defaultChronoUnit): Promise<Deadline> { | ||
const serverTime = (await this.repositoryFactory.createNodeRepository().getNodeTime().toPromise()).receiveTimeStamp.compact(); | ||
return Deadline.createFromAdjustedValue(Duration.ofMillis(serverTime).plus(deadline, chronoUnit).toMillis()); | ||
} | ||
|
||
/** | ||
* It creates a deadline using the known difference between the local and server time. | ||
* | ||
* @param deadline the deadline value | ||
* @param chronoUnit the unit of the value. | ||
*/ | ||
public createDeadlineUsingOffset(deadline = defaultDeadline, chronoUnit: ChronoUnit = defaultChronoUnit): Deadline { | ||
return Deadline.createFromAdjustedValue( | ||
Instant.now().plus(deadline, chronoUnit).minusMillis(this.localTimeOffset).minusSeconds(this.epochAdjustment).toEpochMilli(), | ||
); | ||
} | ||
|
||
/** | ||
* It creates a deadline using the local time. If the local system time is not in sync, the Deadline may be rejected by the server. | ||
* | ||
* @param deadline the deadline value | ||
* @param chronoUnit the unit of the value. | ||
*/ | ||
public createDeadlineUsingLocalTime(deadline = defaultDeadline, chronoUnit: ChronoUnit = defaultChronoUnit): Deadline { | ||
return Deadline.create(this.epochAdjustment, deadline, chronoUnit); | ||
} | ||
|
||
/** | ||
* Factory method of this object. | ||
* | ||
* @param repositoryFactory the repository factory to call the rest servers. | ||
*/ | ||
public static async create(repositoryFactory: RepositoryFactory): Promise<DeadlineService> { | ||
const epochAdjustment = await repositoryFactory.getEpochAdjustment().toPromise(); | ||
const serverTime = (await repositoryFactory.createNodeRepository().getNodeTime().toPromise()).receiveTimeStamp.compact(); | ||
return new DeadlineService(repositoryFactory, epochAdjustment, serverTime); | ||
} | ||
} |
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,67 @@ | ||
/* | ||
* Copyright 2018 NEM | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"); | ||
* you may not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
import { ChronoUnit, Instant, ZoneId } from '@js-joda/core'; | ||
import { expect } from 'chai'; | ||
import { of as observableOf } from 'rxjs'; | ||
import { instance, mock, when } from 'ts-mockito'; | ||
import { NodeRepository, RepositoryFactory } from '../../src/infrastructure'; | ||
import { Deadline, UInt64 } from '../../src/model'; | ||
import { NodeTime } from '../../src/model/node'; | ||
import { DeadlineService } from '../../src/service/DeadlineService'; | ||
|
||
describe('DeadlineService', () => { | ||
const realNow = Instant.now; | ||
const currentSystemMillis = Instant.parse('2021-05-31T10:20:21.154Z').toEpochMilli(); | ||
const localtimeError = 10 * 1000; // 10 seconds diff | ||
const epochAdjustment = 1616694977; | ||
const currentServerMillis = currentSystemMillis - epochAdjustment * 1000 - localtimeError; | ||
before(() => { | ||
Instant.now = () => Instant.ofEpochMilli(currentSystemMillis); | ||
}); | ||
|
||
after(() => { | ||
Instant.now = realNow; | ||
}); | ||
const createService = () => { | ||
const mockNodeRepository: NodeRepository = mock<NodeRepository>(); | ||
when(mockNodeRepository.getNodeTime()).thenReturn( | ||
observableOf(new NodeTime(UInt64.fromUint(currentServerMillis), UInt64.fromUint(currentServerMillis))), | ||
); | ||
const mockRepoFactory = mock<RepositoryFactory>(); | ||
when(mockRepoFactory.getEpochAdjustment()).thenReturn(observableOf(epochAdjustment)); | ||
when(mockRepoFactory.createNodeRepository()).thenReturn(instance(mockNodeRepository)); | ||
const repositoryFactory = instance(mockRepoFactory); | ||
return DeadlineService.create(repositoryFactory); | ||
}; | ||
|
||
const printDeadline = (deadline: Deadline) => deadline.toLocalDateTimeGivenTimeZone(epochAdjustment, ZoneId.UTC).toString(); | ||
|
||
it('createDeadlines', async () => { | ||
const service = await createService(); | ||
// createDeadlineUsingLocalTime is 10 seconds ahead | ||
expect(printDeadline(service.createDeadlineUsingOffset())).eq('2021-05-31T12:20:11.154'); | ||
expect(printDeadline(await service.createDeadlineUsingServerTime())).eq('2021-05-31T12:20:11.154'); | ||
expect(printDeadline(service.createDeadlineUsingLocalTime())).eq('2021-05-31T12:20:21.154'); | ||
|
||
expect(printDeadline(service.createDeadlineUsingOffset(1))).eq('2021-05-31T11:20:11.154'); | ||
expect(printDeadline(await service.createDeadlineUsingServerTime(1))).eq('2021-05-31T11:20:11.154'); | ||
expect(printDeadline(service.createDeadlineUsingLocalTime(1))).eq('2021-05-31T11:20:21.154'); | ||
|
||
expect(printDeadline(service.createDeadlineUsingOffset(5, ChronoUnit.MINUTES))).eq('2021-05-31T10:25:11.154'); | ||
expect(printDeadline(await service.createDeadlineUsingServerTime(5, ChronoUnit.MINUTES))).eq('2021-05-31T10:25:11.154'); | ||
expect(printDeadline(service.createDeadlineUsingLocalTime(5, ChronoUnit.MINUTES))).eq('2021-05-31T10:25:21.154'); | ||
}); | ||
}); |