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

[Newsfeed] Ensure the version format when calling the API #76381

Merged
merged 3 commits into from
Sep 3, 2020
Merged

[Newsfeed] Ensure the version format when calling the API #76381

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
181665d
[Newsfeed] Ensure the version format when calling the API
afharo Sep 1, 2020
405e65a
Merge branch 'master' into newsfeed/api-version-format
elasticmachine Sep 1, 2020
836478e
Remove -SNAPSHOT from the test plugin for the builds to go through
afharo Sep 1, 2020
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
14 changes: 7 additions & 7 deletions src/plugins/newsfeed/public/lib/api.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Object.defineProperty(window, 'sessionStorage', {
});

describe('NewsfeedApiDriver', () => {
const kibanaVersion = 'test_version';
const kibanaVersion = '99.999.9-test_version'; // It'll remove the `-test_version` bit
const userLanguage = 'en';
const fetchInterval = 2000;
const getDriver = () => new NewsfeedApiDriver(kibanaVersion, userLanguage, fetchInterval);
Expand Down Expand Up @@ -179,7 +179,7 @@ describe('NewsfeedApiDriver', () => {
"error": null,
"feedItems": Array [],
"hasNew": false,
"kibanaVersion": "test_version",
"kibanaVersion": "99.999.9",
}
`);
});
Expand Down Expand Up @@ -227,7 +227,7 @@ describe('NewsfeedApiDriver', () => {
},
],
hasNew: true,
kibanaVersion: 'test_version',
kibanaVersion: '99.999.9',
});
});

Expand Down Expand Up @@ -309,7 +309,7 @@ describe('NewsfeedApiDriver', () => {
},
],
hasNew: true,
kibanaVersion: 'test_version',
kibanaVersion: '99.999.9',
});
});

Expand Down Expand Up @@ -375,7 +375,7 @@ describe('NewsfeedApiDriver', () => {
},
],
hasNew: true,
kibanaVersion: 'test_version',
kibanaVersion: '99.999.9',
});
});

Expand Down Expand Up @@ -405,7 +405,7 @@ describe('NewsfeedApiDriver', () => {
"error": null,
"feedItems": Array [],
"hasNew": false,
"kibanaVersion": "test_version",
"kibanaVersion": "99.999.9",
}
`);
});
Expand Down Expand Up @@ -436,7 +436,7 @@ describe('NewsfeedApiDriver', () => {
"error": null,
"feedItems": Array [],
"hasNew": false,
"kibanaVersion": "test_version",
"kibanaVersion": "99.999.9",
}
`);
});
Expand Down
8 changes: 6 additions & 2 deletions src/plugins/newsfeed/public/lib/api.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,13 +32,17 @@ import { ApiItem, NewsfeedItem, FetchResult, NewsfeedPluginBrowserConfig } from
type ApiConfig = NewsfeedPluginBrowserConfig['service'];

export class NewsfeedApiDriver {
private readonly kibanaVersion: string;
private readonly loadedTime = moment().utc(); // the date is compared to time in UTC format coming from the service

constructor(
private readonly kibanaVersion: string,
kibanaVersion: string,
private readonly userLanguage: string,
private readonly fetchInterval: number
) {}
) {
// The API only accepts versions in the format `X.Y.Z`, so we need to drop the `-SNAPSHOT` or any other label after it
this.kibanaVersion = kibanaVersion.replace(/^(\d+\.\d+\.\d+).*/, '$1');
Copy link
Contributor

Choose a reason for hiding this comment

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

It would be cool if we could do something like this:

this.kibanaVersion = `${semver.coerce(kibanaVersion).major}.${semver.coerce(kibanaVersion).minor}.${semver.coerce(kibanaVersion).patch}`

but I'm not sure if it's permissible in public folders.

Copy link
Member Author

Choose a reason for hiding this comment

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

I thought about using semver for this, but I didn't want to increase the bundle size by adding an external library.

}

shouldFetch(): boolean {
const lastFetchUtc: string | null = sessionStorage.getItem(NEWSFEED_LAST_FETCH_STORAGE_KEY);
Expand Down
2 changes: 1 addition & 1 deletion test/common/fixtures/plugins/newsfeed/server/plugin.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ export class NewsFeedSimulatorPlugin implements Plugin {

public setup({ http }: CoreSetup) {
const router = http.createRouter();
const version = this.initializerContext.env.packageInfo.version;
const version = this.initializerContext.env.packageInfo.version.replace('-SNAPSHOT', '');

router.get(
{
Expand Down