Skip to content

fix: save and remove of user-settings are not working #4994

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 30, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions lib/services/user-settings-service.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ export class UserSettingsService implements IUserSettingsService {
const userSettingsFilePath = path.join(this.$settingsService.getProfileDir(), "user-settings.json");
return this.$injector.resolve("jsonFileSettingsService", { jsonFileSettingsPath: userSettingsFilePath });
}

constructor(private $injector: IInjector,
private $settingsService: ISettingsService) {
}
Expand All @@ -14,15 +15,15 @@ export class UserSettingsService implements IUserSettingsService {
}

public saveSetting<T>(key: string, value: T, cacheOpts?: IUseCacheOpts): Promise<void> {
return this.saveSetting<T>(key, value, cacheOpts);
return this.$jsonFileSettingsService.saveSetting<T>(key, value, cacheOpts);
}

public saveSettings(data: IDictionary<{}>, cacheOpts?: IUseCacheOpts): Promise<void> {
return this.$jsonFileSettingsService.saveSettings(data, cacheOpts);
}

public removeSetting(key: string): Promise<void> {
return this.removeSetting(key);
return this.$jsonFileSettingsService.removeSetting(key);
}

public loadUserSettingsFile(): Promise<void> {
Expand Down
82 changes: 82 additions & 0 deletions test/services/user-settings-service.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
import { Yok } from "../../lib/common/yok";
import { UserSettingsService } from "../../lib/services/user-settings-service";
import { assert } from "chai";
import * as path from "path";

class JsonFileSettingsServiceMock {
constructor(public jsonFileSettingsPath: string) { }
}

describe("userSettingsService", () => {
const profileDir = "my-profile-dir";
const expectedJsonFileSettingsFilePath = path.join(profileDir, "user-settings.json");

const createTestInjector = (): IInjector => {
const testInjector = new Yok();
testInjector.register("settingsService", {
getProfileDir: () => profileDir
});

testInjector.register("jsonFileSettingsService", JsonFileSettingsServiceMock);
testInjector.register("userSettingsService", UserSettingsService);
return testInjector;
};

const testCases = [
{
methodName: "getSettingValue",
input: ["settingName"],
expectedArgs: [
"settingName",
undefined
]
},
{
methodName: "saveSetting",
input: ["settingName", "settingValue"],
expectedArgs: [
"settingName",
"settingValue",
undefined
]
},
{
methodName: "saveSettings",
input: [{ value: { subValue: 1 } }],
expectedArgs: [
{ value: { subValue: 1 } },
undefined
]
},
{
methodName: "removeSetting",
input: ["settingName"],
expectedArgs: [
"settingName"
]
},
{
methodName: "loadUserSettingsFile",
input: [],
expectedArgs: []
}
];

for (const testCase of testCases) {
it(`calls ${testCase.methodName} method of jsonFileSettingsService with correct args`, async () => {
const testInjector = createTestInjector();
const dataPassedToJsonFileSettingsService: any[] = [];
const userSettingsService = testInjector.resolve("userSettingsService");
const jsonFileSettingsService = userSettingsService.$jsonFileSettingsService;

jsonFileSettingsService[testCase.methodName] = async (...args: any[]): Promise<void> => {
dataPassedToJsonFileSettingsService.push(...args);
};

await userSettingsService[testCase.methodName](...testCase.input);

assert.deepEqual(dataPassedToJsonFileSettingsService, testCase.expectedArgs);
assert.equal(jsonFileSettingsService.jsonFileSettingsPath, expectedJsonFileSettingsFilePath);
});
}
});