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

Fix develop changelog parsing #28232

Merged
merged 5 commits into from
Oct 18, 2024
Merged

Fix develop changelog parsing #28232

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f3c0909
Fix develop changelog parsing and DRY it
t3chguy Oct 18, 2024
fd17937
duh
t3chguy Oct 18, 2024
1fc425a
Improve coverage
t3chguy Oct 18, 2024
e7fefc9
Typeguards!
t3chguy Oct 18, 2024
692af4b
Discard changes to test/unit-tests/components/views/dialogs/__snapsho…
t3chguy Oct 18, 2024
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
30 changes: 22 additions & 8 deletions src/components/views/dialogs/ChangelogDialog.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,22 @@ interface Commit {

const REPOS = ["element-hq/element-web", "matrix-org/matrix-js-sdk"] as const;

/*
* Parse a version string is compatible with the Changelog dialog ([element-version]-js-[js-sdk-version])
*/
export function parseVersion(version: string): Record<(typeof REPOS)[number], string> | null {
const parts = version.split("-");
if (parts.length === 3 && parts[1] === "js") {
const obj: Record<string, string> = {};
for (let i = 0; i < REPOS.length; i++) {
const commit = parts[2 * i];
obj[REPOS[i]] = commit;
}
return obj;
}
return null;
}

export default class ChangelogDialog extends React.Component<IProps, State> {
public constructor(props: IProps) {
super(props);
Expand All @@ -58,14 +74,12 @@ export default class ChangelogDialog extends React.Component<IProps, State> {
}

public componentDidMount(): void {
const version = this.props.newVersion.split("-");
const version2 = this.props.version.split("-");
if (version == null || version2 == null) return;
// parse versions of form: [vectorversion]-react-[react-sdk-version]-js-[js-sdk-version]
for (let i = 0; i < REPOS.length; i++) {
const oldVersion = version2[2 * i];
const newVersion = version[2 * i];
this.fetchChanges(REPOS[i], oldVersion, newVersion);
const commits = parseVersion(this.props.version);
const newCommits = parseVersion(this.props.newVersion);
if (commits == null || newCommits == null) return;

for (const repo of REPOS) {
this.fetchChanges(repo, commits[repo], newCommits[repo]);
}
}

Expand Down
13 changes: 2 additions & 11 deletions src/toasts/UpdateToast.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,21 +13,12 @@ import SdkConfig from "../SdkConfig";
import GenericToast from "../components/views/toasts/GenericToast";
import ToastStore from "../stores/ToastStore";
import QuestionDialog from "../components/views/dialogs/QuestionDialog";
import ChangelogDialog from "../components/views/dialogs/ChangelogDialog";
import ChangelogDialog, { parseVersion } from "../components/views/dialogs/ChangelogDialog";
import PlatformPeg from "../PlatformPeg";
import Modal from "../Modal";

const TOAST_KEY = "update";

/*
* Check a version string is compatible with the Changelog
* dialog ([element-version]-react-[react-sdk-version]-js-[js-sdk-version])
*/
function checkVersion(ver: string): boolean {
const parts = ver.split("-");
return parts.length === 5 && parts[1] === "react" && parts[3] === "js";
}

function installUpdate(): void {
PlatformPeg.get()?.installUpdate();
}
Expand All @@ -52,7 +43,7 @@ export const showToast = (version: string, newVersion: string, releaseNotes?: st
},
});
};
} else if (checkVersion(version) && checkVersion(newVersion)) {
} else if (parseVersion(version) && parseVersion(newVersion)) {
onAccept = () => {
Modal.createDialog(ChangelogDialog, {
version,
Expand Down
Loading