Skip to content
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

Jump to bottom

Add downgrade logic for branch in DocLinkService #3483

Merged
merged 14 commits into from
Mar 23, 2023
Merged

Add downgrade logic for branch in DocLinkService #3483

Show file tree
Hide file tree
Changes from 13 commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
9df87a5
feature: patch pkg.branch when needed
SuZhou-Joe Feb 22, 2023
f533c75
feat: update CHANGELOG.md
SuZhou-Joe Feb 22, 2023
730d694
feat: use buildVersion
SuZhou-Joe Feb 22, 2023
b09c3eb
Update src/dev/build/tasks/create_package_json_task.ts
SuZhou-Joe Feb 23, 2023
8f8521d
feat: pass ts type check
SuZhou-Joe Mar 3, 2023
59897b0
feat: move branch logic to runtime to restrict impact
SuZhou-Joe Mar 21, 2023
361eaf5
feat: update changelog
SuZhou-Joe Mar 21, 2023
a6c1f8a
Revert "feat: pass ts type check"
SuZhou-Joe Mar 21, 2023
6f97098
Revert "Update src/dev/build/tasks/create_package_json_task.ts "
SuZhou-Joe Mar 21, 2023
1dff042
Revert "feat: use buildVersion"
SuZhou-Joe Mar 21, 2023
35fff82
Revert "feature: patch pkg.branch when needed"
SuZhou-Joe Mar 21, 2023
20c04b0
feat: remove error message and update unit test
SuZhou-Joe Mar 21, 2023
2a698e3
feat: add default value
SuZhou-Joe Mar 21, 2023
f0d6198
feat: optimize code logic
SuZhou-Joe Mar 23, 2023
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
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -200,6 +200,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
- Add path ignore for markdown files for CI ([#2312](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/2312))
- Updating WS scans to ignore BWC artifacts in `cypress` ([#2408](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/2408))
- [CI] Run functional test repo as workflow ([#2503](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/2503))
- Add downgrade logic for branch in DocLinkService([#3483](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/3483))

### 📝 Documentation

Expand Down
12 changes: 12 additions & 0 deletions src/core/public/doc_links/doc_links_service.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,4 +64,16 @@ describe('DocLinksService#start()', () => {
'https://opensearch.org/docs/1.1/dashboards/index/'
);
});

it('templates the doc links with the build version from injectedMetadata', () => {
const injectedMetadata = injectedMetadataServiceMock.createStartContract();
injectedMetadata.getOpenSearchDashboardsBranch.mockReturnValue('test-branch');
injectedMetadata.getOpenSearchDashboardsVersion.mockReturnValue('1.1.2');
const service = new DocLinksService();
const api = service.start({ injectedMetadata });
expect(api.DOC_LINK_VERSION).toEqual('1.1');
expect(api.links.opensearchDashboards.introduction).toEqual(
'https://opensearch.org/docs/1.1/dashboards/index/'
);
});
});
27 changes: 23 additions & 4 deletions src/core/public/doc_links/doc_links_service.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@
*/

import { deepFreeze } from '@osd/std';
import { parse } from 'semver';
import { InjectedMetadataSetup } from '../injected_metadata';

interface StartDeps {
Expand All @@ -39,10 +40,28 @@ interface StartDeps {
export class DocLinksService {
public setup() {}
public start({ injectedMetadata }: StartDeps): DocLinksStart {
const DOC_LINK_VERSION =
injectedMetadata.getOpenSearchDashboardsBranch() === 'main'
? 'latest'
: injectedMetadata.getOpenSearchDashboardsBranch();
const buildVersion = injectedMetadata.getOpenSearchDashboardsVersion();
const pkgBranch = injectedMetadata.getOpenSearchDashboardsBranch();
/**
* OpenSearch server uses the `branch` property from `package.json` to
* build links to the documentation. If set to `main`, it would use `/latest`
* and if not, it would use the `version` to construct URLs.
*/
let branch = pkgBranch;
if (pkgBranch === 'main') {
branch = 'latest';
} else {
const validDocPathsPattern = /^\d+\.\d+$/;
const parsedBuildVersion = parse(buildVersion);
if (validDocPathsPattern.test(pkgBranch)) {
branch = pkgBranch;
} else if (parsedBuildVersion) {
branch = `${parsedBuildVersion.major}.${parsedBuildVersion.minor}`;
} else {
branch = pkgBranch;
Copy link
Member

@abbyhu2000 abbyhu2000 Mar 22, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@SuZhou-Joe Can't we simplify line 54 to line 62 like this? since we already set let branch = pkgBranch; outside the block and line 57 and line 61 are doing the duplicate thing

      const validDocPathsPattern = /^\d+\.\d+$/;
      const parsedBuildVersion = parse(buildVersion);
      
      if (!validDocPathsPattern.test(pkgBranch) &&& parsedBuildVersion) {
        branch = `${parsedBuildVersion.major}.${parsedBuildVersion.minor}`;
      }

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

agree and done.

}
}
const DOC_LINK_VERSION = branch;
const OPENSEARCH_WEBSITE_URL = 'https://opensearch.org/';
const OPENSEARCH_WEBSITE_DOCS = `${OPENSEARCH_WEBSITE_URL}docs/${DOC_LINK_VERSION}`;
const OPENSEARCH_VERSIONED_DOCS = `${OPENSEARCH_WEBSITE_DOCS}/opensearch/`;
Expand Down