fix: can recover index files if locale is not en

Signed-off-by: Akos Kitta <[email protected]>

Author: Akos Kitta

arduino-ide-extension/package.json

@@ -68,7 +68,7 @@
     "cpy": "^8.1.2",
     "cross-fetch": "^3.1.5",
     "dateformat": "^3.0.3",
-    "deepmerge": "2.0.1",
+    "deepmerge": "^4.2.2",
     "electron-updater": "^4.6.5",
     "fast-json-stable-stringify": "^2.1.0",
     "fast-safe-stringify": "^2.1.1",

arduino-ide-extension/src/node/core-client-provider.ts

@@ -530,7 +530,6 @@ function isPrimaryPackageIndexMissingStatus(
   { directories: { data } }: DefaultCliConfig
 ): boolean {
   const predicate = ({ message }: RpcStatus.AsObject) =>
-    message.includes('loading json index file') &&
     message.includes(join(data, 'package_index.json'));
   // https://github.com/arduino/arduino-cli/blob/f0245bc2da6a56fccea7b2c9ea09e85fdcc52cb8/arduino/cores/packagemanager/package_manager.go#L247
   return evaluate(status, predicate);
@@ -551,8 +550,6 @@ function isLibraryIndexMissingStatus(
   { directories: { data } }: DefaultCliConfig
 ): boolean {
   const predicate = ({ message }: RpcStatus.AsObject) =>
-    message.includes('index file') &&
-    message.includes('reading') &&
     message.includes(join(data, 'library_index.json'));
   // https://github.com/arduino/arduino-cli/blob/f0245bc2da6a56fccea7b2c9ea09e85fdcc52cb8/arduino/cores/packagemanager/package_manager.go#L247
   return evaluate(status, predicate);

arduino-ide-extension/src/test/node/core-client-provider.slow-test.ts

@@ -13,7 +13,7 @@ import {
   LibraryService,
 } from '../../common/protocol';
 import { ArduinoDaemonImpl } from '../../node/arduino-daemon-impl';
-import { CLI_CONFIG } from '../../node/cli-config';
+import { CLI_CONFIG, DefaultCliConfig } from '../../node/cli-config';
 import { BoardListRequest } from '../../node/cli-protocol/cc/arduino/cli/commands/v1/board_pb';
 import { CoreClientProvider } from '../../node/core-client-provider';
 import { ConfigDirUriProvider } from '../../node/theia/env-variables/env-variables-server';
@@ -45,6 +45,20 @@ describe('core-client-provider', () => {
     });
   });
 
+  ['it', 'de'].map(([locale]) =>
+    it(`should recover from the missing 'directories.data' independently from the CLI locale: '${locale}'`, async function () {
+      this.timeout(timeout);
+      const configDirPath = await prepareTestConfigDir({ locale });
+
+      const container = await startCli(configDirPath, toDispose);
+      await assertFunctionalCli(container, ({ coreClientProvider }) => {
+        const { indexUpdateSummaryBeforeInit } = coreClientProvider;
+        expect(indexUpdateSummaryBeforeInit).to.be.not.undefined;
+        expect(indexUpdateSummaryBeforeInit).to.be.empty;
+      });
+    })
+  );
+
   it("should recover all when the 'directories.data' folder is missing", async function () {
     this.timeout(timeout);
     const configDirPath = await prepareTestConfigDir();
@@ -157,7 +171,7 @@ describe('core-client-provider', () => {
       ).to.be.equal(1);
     };
     const configDirPath = await prepareTestConfigDir(
-      additionalUrls,
+      { board_manager: { additional_urls: additionalUrls } },
       ({ boardsService }) => assertTeensyAvailable(boardsService)
     );
     const thirdPartyPackageIndexPath = join(
@@ -252,11 +266,11 @@ async function assertFunctionalCli(
  * the config folder.
  */
 async function prepareTestConfigDir(
-  additionalUrls: string[] = [],
+  configOverrides: Partial<DefaultCliConfig> = {},
   otherExpect?: (services: Services) => MaybePromise<void>
 ): Promise<string> {
   const toDispose = new DisposableCollection();
-  const params = { configDirPath: newTempConfigDirPath(), additionalUrls };
+  const params = { configDirPath: newTempConfigDirPath(), configOverrides };
   const container = await createContainer(params);
   try {
     await start(container, toDispose);
@@ -304,13 +318,13 @@ async function start(
 
 async function createContainer(
   params:
-    | { configDirPath: string; additionalUrls: string[] }
+    | { configDirPath: string; configOverrides: Partial<DefaultCliConfig> }
     | string = newTempConfigDirPath()
 ): Promise<Container> {
   if (typeof params === 'string') {
     return createBaseContainer({ configDirPath: params });
   }
-  const { configDirPath, additionalUrls } = params;
-  const cliConfig = await createCliConfig(configDirPath, additionalUrls);
+  const { configDirPath, configOverrides } = params;
+  const cliConfig = await createCliConfig(configDirPath, configOverrides);
   return createBaseContainer({ configDirPath, cliConfig });
 }

arduino-ide-extension/src/test/node/test-bindings.ts

@@ -22,6 +22,7 @@ import {
   injectable,
   interfaces,
 } from '@theia/core/shared/inversify';
+import * as deepmerge from 'deepmerge';
 import { promises as fs, mkdirSync } from 'fs';
 import { dump as dumpYaml } from 'js-yaml';
 import { join } from 'path';
@@ -367,14 +368,14 @@ async function writeCliConfigFile(
   const yaml = dumpYaml(cliConfig);
   const cliConfigPath = join(containerFolderPath, CLI_CONFIG);
   await fs.writeFile(cliConfigPath, yaml);
-  console.debug(`Created CLI configuration file at ${cliConfig}:
+  console.debug(`Created CLI configuration file at ${cliConfigPath}:
 ${yaml}
 `);
 }
 
 export async function createCliConfig(
   configDirPath: string,
-  additionalUrls: string[]
+  configOverrides: Partial<DefaultCliConfig> = {}
 ): Promise<DefaultCliConfig> {
   const directories = {
     data: join(configDirPath, 'data', 'Arduino15'),
@@ -385,13 +386,11 @@ export async function createCliConfig(
   for (const directoryPath of Object.values(directories)) {
     await fs.mkdir(directoryPath, { recursive: true });
   }
-  return {
-    directories,
-    board_manager: {
-      additional_urls: additionalUrls.length ? additionalUrls : [],
-    },
+  const config = { directories };
+  const mergedOverrides = deepmerge(configOverrides, <DefaultCliConfig>{
     logging: { level: 'trace' },
-  };
+  });
+  return deepmerge(config, mergedOverrides);
 }
 
 export async function startDaemon(

yarn.lock

@@ -6296,11 +6296,6 @@ deepmerge@*, deepmerge@^4.2.2:
   resolved "https://registry.yarnpkg.com/deepmerge/-/deepmerge-4.2.2.tgz#44d2ea3679b8f4d4ffba33f03d865fc1e7bf4955"
   integrity sha512-FJ3UgI4gIl+PHZm53knsuSFpE+nESMr7M4v9QcgB7S63Kj/6WqMiFQJpBBYz1Pt+66bZpP3Q7Lye0Oo9MPKEdg==
 
-[email protected]:
-  version "2.0.1"
-  resolved "https://registry.yarnpkg.com/deepmerge/-/deepmerge-2.0.1.tgz#25c1c24f110fb914f80001b925264dd77f3f4312"
-  integrity sha512-VIPwiMJqJ13ZQfaCsIFnp5Me9tnjURiaIFxfz7EH0Ci0dTSQpZtSLrqOicXqEd/z2r+z+Klk9GzmnRsgpgbOsQ==
-
 default-compare@^1.0.0:
   version "1.0.0"
   resolved "https://registry.yarnpkg.com/default-compare/-/default-compare-1.0.0.tgz#cb61131844ad84d84788fb68fd01681ca7781a2f"