Skip to content

Commit

Permalink
preferences: fix PreferenceProvider.merge method (eclipse-theia#12126)
Browse files Browse the repository at this point in the history
Merge properties of type array when merging preferences objects.
  • Loading branch information
AlexandraBuzila authored Jan 31, 2023
1 parent 6091474 commit b28c8b9
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 0 deletions.
36 changes: 36 additions & 0 deletions packages/core/src/browser/preferences/preference-provider.spec.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
// *****************************************************************************
// Copyright (C) 2023 EclipseSource and others.
//
// This program and the accompanying materials are made available under the
// terms of the Eclipse Public License v. 2.0 which is available at
// http://www.eclipse.org/legal/epl-2.0.
//
// This Source Code may also be made available under the following Secondary
// Licenses when the conditions for such availability set forth in the Eclipse
// Public License v. 2.0 are satisfied: GNU General Public License, version 2
// with the GNU Classpath Exception which is available at
// https://www.gnu.org/software/classpath/license.html.
//
// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
// *****************************************************************************

import { PreferenceProvider } from './preference-provider';
const { expect } = require('chai');

describe('PreferenceProvider', () => {
it('should preserve extra source fields on merge', () => {
const result = PreferenceProvider.merge({ 'configurations': [], 'compounds': [] }, { 'configurations': [] });
expect(result).deep.equals({ 'configurations': [], 'compounds': [] });
});
it('should preserve extra target fields on merge', () => {
const result = PreferenceProvider.merge({ 'configurations': [] }, { 'configurations': [], 'compounds': [] });
expect(result).deep.equals({ 'configurations': [], 'compounds': [] });
});
it('should merge array values', () => {
const result = PreferenceProvider.merge(
{ 'configurations': [{ 'name': 'test1', 'request': 'launch' }], 'compounds': [] },
{ 'configurations': [{ 'name': 'test2' }] }
);
expect(result).deep.equals({ 'configurations': [{ 'name': 'test1', 'request': 'launch' }, { 'name': 'test2' }], 'compounds': [] });
});
});
3 changes: 3 additions & 0 deletions packages/core/src/browser/preferences/preference-provider.ts
Original file line number Diff line number Diff line change
Expand Up @@ -235,6 +235,9 @@ export abstract class PreferenceProvider implements Disposable {
if (JSONExt.isObject(source[key]) && JSONExt.isObject(value)) {
this.merge(source[key], value);
continue;
} else if (JSONExt.isArray(source[key]) && JSONExt.isArray(value)) {
source[key] = [...JSONExt.deepCopy(source[key] as any), ...JSONExt.deepCopy(value)];
continue;
}
}
source[key] = JSONExt.deepCopy(value);
Expand Down

0 comments on commit b28c8b9

Please sign in to comment.