[Bug] Path comparison issues causing plugin not able to build on Windows

[peterzhuamazon]

Coming from opensearch-project/reporting#191 (comment).

The issue being that Windows treat Administrator dir and ADMINI~1 dir as the same on Windows.
But the code here in dashboards core is using === to compare:

OpenSearch-Dashboards/packages/osd-plugin-helpers/src/load_opensearch_dashboards_platform_plugin.ts

Line 47 in d7004dc

const isRootPlugin = parentDir === Path.resolve(REPO_ROOT, 'plugins');

  const isRootPlugin = parentDir === Path.resolve(REPO_ROOT, 'plugins');

This cause a diff in comparison between these two paths in .ts, while on windows they point to the same location:

C:\Users\Administrator\AppData\Local\Temp\2\tmpndbrtuhg\OpenSearch-Dashboards\plugins
C:\Users\ADMINI~1\AppData\Local\Temp\2\tmpndbrtuhg\OpenSearch-Dashboards\plugins

This then cause the failure when building dashboards plugin:

+ yarn plugin_helpers build --opensearch-dashboards-version=2.4.0
yarn run v1.22.19
$ node ../../scripts/plugin_helpers build --opensearch-dashboards-version=2.4.0
ERROR Plugin located at [C:\Users\Administrator\AppData\Local\Temp\2\tmpzgwnkv7a\OpenSearch-Dashboards\plugins\dashboards-reports] must be moved to the plugins directory at the root of the OpenSearch Dashboards repo
error Command failed with exit code 1.

Thanks.

[seanneumann]

@manasvinibs can you prioritize this issue?

[peterzhuamazon]

More resources:

• https://learn.microsoft.com/en-us/windows/win32/fileio/naming-a-file?redirectedfrom=MSDN#short_vs._long_names

Seems like we can try to disable this behavior on windows agent:

• https://learn.microsoft.com/en-US/troubleshoot/windows-server/performance/stop-error-code-0x00000019

[peterzhuamazon]

I would say the best solution is to find a way to resolve this on typescript side, without pushing windows agent to disable short names.

Since there will be community members using this code to build themselves.

Thanks.

[peterzhuamazon]

More details:
https://manjusullad.wordpress.com/2016/01/06/how-can-i-find-create-short-path-for-windows-folders-directories/

[bbarani]

@AMoo-Miki Any update on this issue?

[AMoo-Miki]

Rolled out with 2.4.0.