Skip to content

feat(cli-repl): only store non-default config keys on disk MONGOSH-794 #919

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.

Sign up for GitHub

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
May 31, 2021
Merged

feat(cli-repl): only store non-default config keys on disk MONGOSH-794 #919

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
23 changes: 23 additions & 0 deletions packages/cli-repl/src/cli-repl.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,29 @@ describe('CliRepl', () => {
expect(JSON.parse(content).enableTelemetry).to.be.false;
});

it('does not store config options on disk that have not been changed', async() => {
let content = await fs.readFile(path.join(tmpdir.path, 'config'), { encoding: 'utf8' });
expect(Object.keys(JSON.parse(content))).to.deep.equal([
'userId', 'enableTelemetry', 'disableGreetingMessage'
]);

input.write('config.set("inspectDepth", config.get("inspectDepth"))\n');

await waitEval(cliRepl.bus);
content = await fs.readFile(path.join(tmpdir.path, 'config'), { encoding: 'utf8' });
expect(Object.keys(JSON.parse(content))).to.deep.equal([
'userId', 'enableTelemetry', 'disableGreetingMessage', 'inspectDepth'
]);

// When a new REPL is created:
cliRepl = new CliRepl(cliReplOptions);
await cliRepl.start('', {});
content = await fs.readFile(path.join(tmpdir.path, 'config'), { encoding: 'utf8' });
expect(Object.keys(JSON.parse(content))).to.deep.equal([
'userId', 'enableTelemetry', 'disableGreetingMessage', 'inspectDepth'
]);
});

it('emits exit when asked to, Node.js-style', async() => {
input.write('.exit\n');
await exitPromise;
Expand Down
22 changes: 13 additions & 9 deletions packages/cli-repl/src/cli-repl.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,8 @@ export type CliReplOptions = {
analyticsOptions?: AnalyticsOptions;
} & Pick<MongoshNodeReplOptions, 'nodeReplOptions'>;

type CliUserConfigOnDisk = Partial<CliUserConfig> & Pick<CliUserConfig, 'enableTelemetry' | 'userId'>;

/**
* The REPL used from the terminal.
*/
Expand All @@ -51,8 +53,8 @@ class CliRepl {
cliOptions: CliOptions;
mongocryptdManager: MongocryptdManager;
shellHomeDirectory: ShellHomeDirectory;
configDirectory: ConfigManager<CliUserConfig>;
config: CliUserConfig = new CliUserConfig();
configDirectory: ConfigManager<CliUserConfigOnDisk>;
config: CliUserConfigOnDisk;
input: Readable;
output: Writable;
logId: string;
Expand All @@ -73,15 +75,19 @@ class CliRepl {
this.analyticsOptions = options.analyticsOptions;
this.logId = new bson.ObjectId().toString();
this.onExit = options.onExit;
this.config = {
userId: new bson.ObjectId().toString(),
enableTelemetry: true
};

this.shellHomeDirectory = new ShellHomeDirectory(options.shellHomePaths);
this.configDirectory = new ConfigManager<CliUserConfig>(
this.configDirectory = new ConfigManager<CliUserConfigOnDisk>(
this.shellHomeDirectory)
.on('error', (err: Error) =>
this.bus.emit('mongosh:error', err))
.on('new-config', (config: CliUserConfig) =>
.on('new-config', (config: CliUserConfigOnDisk) =>
this.bus.emit('mongosh:new-user', config.userId, config.enableTelemetry))
.on('update-config', (config: CliUserConfig) =>
.on('update-config', (config: CliUserConfigOnDisk) =>
this.bus.emit('mongosh:update-user', config.userId, config.enableTelemetry));

this.mongocryptdManager = new MongocryptdManager(
Expand Down Expand Up @@ -147,8 +153,6 @@ class CliRepl {
return this.analytics;
});

this.config.userId = new bson.ObjectId().toString();
this.config.enableTelemetry = true;
try {
this.config = await this.configDirectory.generateOrReadConfig(this.config);
} catch (err) {
Expand Down Expand Up @@ -309,7 +313,7 @@ class CliRepl {
}

async getConfig<K extends keyof CliUserConfig>(key: K): Promise<CliUserConfig[K]> {
return this.config[key];
return (this.config as CliUserConfig)[key] ?? (new CliUserConfig())[key];
}

async setConfig<K extends keyof CliUserConfig>(key: K, value: CliUserConfig[K]): Promise<'success'> {
Expand All @@ -326,7 +330,7 @@ class CliRepl {
}

listConfigOptions(): string[] {
const keys = Object.keys(this.config) as (keyof CliUserConfig)[];
const keys = Object.keys(new CliUserConfig()) as (keyof CliUserConfig)[];
return keys.filter(key => key !== 'userId' && key !== 'disableGreetingMessage');
}

Expand Down