Fix handling malformed recentworkspace.json

In case a recentworkspace.json contains any non string element in its recentRoots array, the JSON is not considered valid.

Signed-off-by: Alexander Flammer <alex.flammer.dev@outlook.com>

fix test on windows

Signed-off-by: Alexander Flammer <alex.flammer.dev@outlook.com>

one more try to fix test

Signed-off-by: Alexander Flammer <alex.flammer.dev@outlook.com>

use uri for windows to try to make test pass

Signed-off-by: Alexander Flammer <alex.flammer.dev@outlook.com>

ignore non-string array entries

Signed-off-by: Alexander Flammer <alex.flammer.dev@outlook.com>

Replace check for undefined with null

Signed-off-by: Alexander Flammer <alex.flammer.dev@outlook.com>

packages/workspace/src/node/default-workspace-server.spec.ts

@@ -0,0 +1,101 @@
+/********************************************************************************
+ * Copyright (C) 2022 Alexander Flammer 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 { Container } from '@theia/core/shared/inversify';
+import { MockEnvVariablesServerImpl } from '@theia/core/lib/browser/test/mock-env-variables-server';
+import { EnvVariablesServer } from '@theia/core/lib/common/env-variables';
+import URI from '@theia/core/lib/common/uri';
+import { FileUri } from '@theia/core/lib/node';
+import { CommonWorkspaceUtils } from '../common';
+import { DefaultWorkspaceServer, WorkspaceCliContribution } from './default-workspace-server';
+import { expect } from 'chai';
+import * as temp from 'temp';
+import * as fs from 'fs';
+
+/* eslint-disable no-unused-expressions */
+
+describe('DefaultWorkspaceServer', function (): void {
+
+    describe('getRecentWorkspaces()', async () => {
+        let workspaceServer: DefaultWorkspaceServer;
+        let tmpConfigDir: URI;
+        let recentWorkspaceFile: string;
+
+        beforeEach(() => {
+            // create a temporary directory
+            const tempDirPath = temp.track().mkdirSync();
+            tmpConfigDir = FileUri.create(fs.realpathSync(tempDirPath));
+            recentWorkspaceFile = FileUri.fsPath(tmpConfigDir.resolve('recentworkspace.json'));
+
+            // create a container with the necessary bindings for the DefaultWorkspaceServer
+            const container = new Container();
+            container.bind(WorkspaceCliContribution).toSelf().inSingletonScope();
+            container.bind(CommonWorkspaceUtils).toSelf().inSingletonScope();
+            container.bind(DefaultWorkspaceServer).toSelf().inSingletonScope();
+            container.bind(EnvVariablesServer).toConstantValue(new MockEnvVariablesServerImpl(tmpConfigDir));
+
+            workspaceServer = container.get(DefaultWorkspaceServer);
+        });
+
+        it('should return empty list of workspaces if no recent workspaces file is existing', async function (): Promise<void> {
+            const recent = await workspaceServer.getRecentWorkspaces();
+            expect(recent).to.be.empty;
+        });
+
+        it('should not return non-existing workspaces from recent workspaces file', async function (): Promise<void> {
+            fs.writeFileSync(recentWorkspaceFile, JSON.stringify({
+                recentRoots: [
+                    tmpConfigDir.resolve('somethingNotExisting').toString(),
+                    tmpConfigDir.resolve('somethingElseNotExisting').toString()
+                ]
+            }));
+
+            const recent = await workspaceServer.getRecentWorkspaces();
+
+            expect(recent).to.be.empty;
+        });
+
+        it('should return only existing workspaces from recent workspaces file', async function (): Promise<void> {
+            fs.writeFileSync(recentWorkspaceFile, JSON.stringify({
+                recentRoots: [
+                    tmpConfigDir.toString(),
+                    tmpConfigDir.resolve('somethingNotExisting').toString()
+                ]
+            }));
+
+            const recent = await workspaceServer.getRecentWorkspaces();
+
+            expect(recent).to.have.members([FileUri.fsPath(tmpConfigDir)]);
+        });
+
+        it('should ignore non-string array entries but return remaining existing file paths', async function (): Promise<void> {
+            // previously caused: 'TypeError: Cannot read property 'fsPath' of undefined', see issue #10250
+            fs.writeFileSync(recentWorkspaceFile, JSON.stringify({
+                recentRoots: [
+                    [tmpConfigDir.toString()],
+                    {},
+                    12345678,
+                    undefined,
+                    tmpConfigDir.toString(),
+                ]
+            }));
+
+            const recent = await workspaceServer.getRecentWorkspaces();
+
+            expect(recent).to.have.members([FileUri.fsPath(tmpConfigDir)]);
+        });
+    });
+});

packages/workspace/src/node/default-workspace-server.ts

@@ -165,7 +165,7 @@ export class DefaultWorkspaceServer implements WorkspaceServer, BackendApplicati
     protected async readRecentWorkspacePathsFromUserHome(): Promise<RecentWorkspacePathsData | undefined> {
         const fsPath = await this.getUserStoragePath();
         const data = await this.readJsonFromFile(fsPath);
-        return RecentWorkspacePathsData.is(data) ? data : undefined;
+        return RecentWorkspacePathsData.create(data);
     }
 
     protected async readJsonFromFile(fsPath: string): Promise<object | undefined> {
@@ -200,8 +200,19 @@ interface RecentWorkspacePathsData {
 }
 
 namespace RecentWorkspacePathsData {
-    export function is(data: Object | undefined): data is RecentWorkspacePathsData {
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        return !!data && typeof data === 'object' && ('recentRoots' in data) && Array.isArray((data as any)['recentRoots']);
+    /**
+     * Parses `data` as `RecentWorkspacePathsData` but removes any non-string array entry.
+     *
+     * Returns undefined if the given `data` does not contain a `recentRoots` array property.
+     */
+    export function create(data: Object | undefined): RecentWorkspacePathsData | undefined {
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any, no-null/no-null
+        if (typeof data !== 'object' || data === null || !Array.isArray((data as any)['recentRoots'])) {
+            return;
+        }
+        return {
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            recentRoots: (data as any)['recentRoots'].filter((root: unknown) => typeof root === 'string')
+        };
     }
 }