refactor(editor): Migrate versions.store to use composition API (no-changelog) (#9798)

This commit is contained in:
Ricardo Espinoza 2024-06-19 08:34:58 -07:00 committed by GitHub
parent adbd0d17ab
commit f6b8b8d956
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -1,86 +1,111 @@
import { getNextVersions } from '@/api/versions';
import * as versionsApi from '@/api/versions';
import { STORES, VERSIONS_MODAL_KEY } from '@/constants';
import type { IVersion, IVersionNotificationSettings, IVersionsState } from '@/Interface';
import type { IVersion, IVersionNotificationSettings } from '@/Interface';
import { defineStore } from 'pinia';
import { useRootStore } from './root.store';
import { useToast } from '@/composables/useToast';
import { useUIStore } from '@/stores/ui.store';
import { computed, ref } from 'vue';
export const useVersionsStore = defineStore(STORES.VERSIONS, {
state: (): IVersionsState => ({
versionNotificationSettings: {
enabled: false,
endpoint: '',
infoUrl: '',
},
nextVersions: [],
currentVersion: undefined,
}),
getters: {
hasVersionUpdates(): boolean {
return this.nextVersions.length > 0;
},
areNotificationsEnabled(): boolean {
return this.versionNotificationSettings.enabled;
},
infoUrl(): string {
return this.versionNotificationSettings.infoUrl;
},
},
actions: {
setVersions({ versions, currentVersion }: { versions: IVersion[]; currentVersion: string }) {
this.nextVersions = versions.filter((version) => version.name !== currentVersion);
this.currentVersion = versions.find((version) => version.name === currentVersion);
},
setVersionNotificationSettings(settings: IVersionNotificationSettings) {
this.versionNotificationSettings = settings;
},
async fetchVersions() {
try {
const { enabled, endpoint } = this.versionNotificationSettings;
if (enabled && endpoint) {
const rootStore = useRootStore();
const currentVersion = rootStore.versionCli;
const instanceId = rootStore.instanceId;
const versions = await getNextVersions(endpoint, currentVersion, instanceId);
this.setVersions({ versions, currentVersion });
}
} catch (e) {}
},
async checkForNewVersions() {
const enabled = this.areNotificationsEnabled;
if (!enabled) {
return;
type SetVersionParams = { versions: IVersion[]; currentVersion: string };
export const useVersionsStore = defineStore(STORES.VERSIONS, () => {
const versionNotificationSettings = ref({ enabled: false, endpoint: '', infoUrl: '' });
const nextVersions = ref<IVersion[]>([]);
const currentVersion = ref<IVersion | undefined>();
const { showToast } = useToast();
const uiStore = useUIStore();
// ---------------------------------------------------------------------------
// #region Computed
// ---------------------------------------------------------------------------
const hasVersionUpdates = computed(() => {
return nextVersions.value.length > 0;
});
const areNotificationsEnabled = computed(() => {
return versionNotificationSettings.value.enabled;
});
const infoUrl = computed(() => {
return versionNotificationSettings.value.infoUrl;
});
// #endregion
// ---------------------------------------------------------------------------
// #region Methods
// ---------------------------------------------------------------------------
const fetchVersions = async () => {
try {
const { enabled, endpoint } = versionNotificationSettings.value;
if (enabled && endpoint) {
const rootStore = useRootStore();
const currentVersion = rootStore.versionCli;
const instanceId = rootStore.instanceId;
const versions = await versionsApi.getNextVersions(endpoint, currentVersion, instanceId);
setVersions({ versions, currentVersion });
}
} catch (e) {}
};
const setVersions = (params: SetVersionParams) => {
nextVersions.value = params.versions.filter((v) => v.name !== params.currentVersion);
currentVersion.value = params.versions.find((v) => v.name === params.currentVersion);
};
const setVersionNotificationSettings = (settings: IVersionNotificationSettings) => {
versionNotificationSettings.value = settings;
};
const checkForNewVersions = async () => {
const enabled = areNotificationsEnabled.value;
if (!enabled) {
return;
}
await fetchVersions();
if (
currentVersion.value &&
currentVersion.value.hasSecurityIssue &&
nextVersions.value.length
) {
const fixVersion = currentVersion.value.securityIssueFixVersion;
let message = 'Please update to latest version.';
if (fixVersion) {
message = `Please update to version ${fixVersion} or higher.`;
}
const { showToast } = useToast();
const uiStore = useUIStore();
message = `${message} <a class="primary-color">More info</a>`;
showToast({
title: 'Critical update available',
message,
onClick: () => {
uiStore.openModal(VERSIONS_MODAL_KEY);
},
closeOnClick: true,
customClass: 'clickable',
type: 'warning',
duration: 0,
});
}
};
await this.fetchVersions();
// #endregion
const currentVersion = this.currentVersion;
const nextVersions = this.nextVersions;
if (currentVersion && currentVersion.hasSecurityIssue && nextVersions.length) {
const fixVersion = currentVersion.securityIssueFixVersion;
let message = 'Please update to latest version.';
if (fixVersion) {
message = `Please update to version ${fixVersion} or higher.`;
}
message = `${message} <a class="primary-color">More info</a>`;
showToast({
title: 'Critical update available',
message,
onClick: () => {
uiStore.openModal(VERSIONS_MODAL_KEY);
},
closeOnClick: true,
customClass: 'clickable',
type: 'warning',
duration: 0,
});
}
},
},
return {
currentVersion,
nextVersions,
hasVersionUpdates,
areNotificationsEnabled,
infoUrl,
fetchVersions,
setVersions,
setVersionNotificationSettings,
checkForNewVersions,
};
});