Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion eslint.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ const sharedPlugins = {
};

const sharedRules = {
'svelte/no-navigation-without-resolve': 'off',
'no-undef': 'off',
quotes: ['error', 'single', { avoidEscape: true }],
'@typescript-eslint/no-unused-vars': [
Expand Down Expand Up @@ -126,7 +127,6 @@ export default [
rules: {
...sharedRules,
'svelte/require-each-key': 'warn',
'svelte/no-navigation-without-resolve': 'warn',
'svelte/no-reactive-reassign': 'warn',
'svelte/no-reactive-functions': 'warn',
'svelte/no-reactive-literals': 'warn',
Expand Down
4 changes: 2 additions & 2 deletions src/lib/pages/workflow-history.svelte
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
import { onMount } from 'svelte';

import { goto } from '$app/navigation';
import { page } from '$app/stores';
import { page } from '$app/state';

import { eventFilterSort } from '$lib/stores/event-view';
import { routeForEventHistory } from '$lib/utilities/route-for';

const { namespace, workflow, run } = $page.params;
const { namespace, workflow, run } = page.params;

onMount(async () => {
const queryParams = {
Expand Down
5 changes: 2 additions & 3 deletions src/lib/stores/schedules.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
import { writable } from 'svelte/store';

import { goto } from '$app/navigation';
import { resolve } from '$app/paths';

import { translate } from '$lib/i18n/translate';
import { createSchedule, editSchedule } from '$lib/services/schedule-service';
Expand Down Expand Up @@ -173,7 +172,7 @@ export const submitCreateSchedule = async ({
createTimeout = setTimeout(() => {
error.set('');
loading.set(false);
goto(resolve(routeForSchedules({ namespace }), {}));
goto(routeForSchedules({ namespace }));
}, 2000);
}
};
Expand Down Expand Up @@ -266,7 +265,7 @@ export const submitEditSchedule = async (
} else {
clearTimeout(editTimeout);
editTimeout = setTimeout(() => {
goto(resolve(routeForSchedule({ namespace, scheduleId: name }), {}));
goto(routeForSchedule({ namespace, scheduleId: name }));
error.set('');
loading.set(false);
}, 2000);
Expand Down
232 changes: 232 additions & 0 deletions src/lib/utilities/route-for-base-path.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,232 @@
import { describe, expect, it, vi } from 'vitest';

const BASE_PATH = '/temporal';

vi.mock('$app/paths', () => ({
resolve: (route: string, params?: Record<string, string>) => {
let resolved = route;
if (params) {
resolved = Object.entries(params).reduce(
(path, [key, value]) => path.replace(`[${key}]`, value),
resolved,
);
}
return `${BASE_PATH}${resolved}`;
},
}));

import * as routeForModule from './route-for';
import {
routeForArchivalEventHistory,
routeForArchivalWorkflows,
routeForAuthentication,
routeForBatchOperation,
routeForBatchOperations,
routeForCallStack,
routeForEventHistory,
routeForEventHistoryEvent,
routeForEventHistoryImport,
routeForLoginPage,
routeForNamespace,
routeForNamespaces,
routeForNamespaceSelector,
routeForNexus,
routeForNexusEndpoint,
routeForNexusEndpointCreate,
routeForNexusEndpointEdit,
routeForNexusLinks,
routeForPendingActivities,
routeForRelationships,
routeForSchedule,
routeForScheduleCreate,
routeForScheduleEdit,
routeForSchedules,
routeForStandaloneActivities,
routeForStandaloneActivitiesWithQuery,
routeForStandaloneActivityDetails,
routeForStandaloneActivityMetadata,
routeForStandaloneActivitySearchAttributes,
routeForStandaloneActivityWorkers,
routeForStartStandaloneActivity,
routeForTaskQueue,
routeForTimeline,
routeForUserMetadata,
routeForWorkerDeployment,
routeForWorkerDeployments,
routeForWorkerDeploymentVersion,
routeForWorkers,
routeForWorkflow,
routeForWorkflowMemo,
routeForWorkflowQuery,
routeForWorkflows,
routeForWorkflowSearchAttributes,
routeForWorkflowStart,
routeForWorkflowsWithQuery,
routeForWorkflowUpdate,
} from './route-for';

describe('routeFor functions should resolve the base path exactly once', () => {
const namespaceParams = { namespace: 'default' };
const workflowParams = {
namespace: 'default',
workflow: 'wf-id',
run: 'run-id',
};
const scheduleParams = { namespace: 'default', scheduleId: 'sched-1' };

const activityParams = {
namespace: 'default',
activityId: 'act-1',
runId: 'run-1',
};

const cases: [string, () => string | undefined][] = [
['routeForNamespaces', () => routeForNamespaces()],
['routeForNexus', () => routeForNexus()],
['routeForNexusEndpoint', () => routeForNexusEndpoint('ep-1')],
['routeForNexusEndpointEdit', () => routeForNexusEndpointEdit('ep-1')],
['routeForNexusEndpointCreate', () => routeForNexusEndpointCreate()],
['routeForNamespace', () => routeForNamespace(namespaceParams)],
['routeForNamespaceSelector', () => routeForNamespaceSelector()],
['routeForWorkflows', () => routeForWorkflows(namespaceParams)],
[
'routeForArchivalWorkflows',
() => routeForArchivalWorkflows(namespaceParams),
],
['routeForWorkflow', () => routeForWorkflow(workflowParams)],
['routeForSchedules', () => routeForSchedules(namespaceParams)],
['routeForScheduleCreate', () => routeForScheduleCreate(namespaceParams)],
['routeForSchedule', () => routeForSchedule(scheduleParams)],
['routeForScheduleEdit', () => routeForScheduleEdit(scheduleParams)],
[
'routeForArchivalEventHistory',
() => routeForArchivalEventHistory(workflowParams),
],
[
'routeForEventHistoryEvent',
() => routeForEventHistoryEvent({ ...workflowParams, eventId: '1' }),
],
['routeForEventHistory', () => routeForEventHistory(workflowParams)],
['routeForTimeline', () => routeForTimeline(workflowParams)],
['routeForWorkers', () => routeForWorkers(workflowParams)],
[
'routeForWorkerDeployments',
() => routeForWorkerDeployments(namespaceParams),
],
[
'routeForWorkerDeployment',
() =>
routeForWorkerDeployment({
namespace: 'default',
deployment: 'dep-1',
}),
],
[
'routeForWorkerDeploymentVersion',
() =>
routeForWorkerDeploymentVersion({
namespace: 'default',
deployment: 'dep-1',
version: 'v1',
}),
],
['routeForRelationships', () => routeForRelationships(workflowParams)],
[
'routeForTaskQueue',
() => routeForTaskQueue({ namespace: 'default', queue: 'q-1' }),
],
['routeForCallStack', () => routeForCallStack(workflowParams)],
['routeForWorkflowQuery', () => routeForWorkflowQuery(workflowParams)],
['routeForUserMetadata', () => routeForUserMetadata(workflowParams)],
[
'routeForWorkflowSearchAttributes',
() => routeForWorkflowSearchAttributes(workflowParams),
],
['routeForWorkflowMemo', () => routeForWorkflowMemo(workflowParams)],
['routeForWorkflowUpdate', () => routeForWorkflowUpdate(workflowParams)],
[
'routeForPendingActivities',
() => routeForPendingActivities(workflowParams),
],
['routeForNexusLinks', () => routeForNexusLinks(workflowParams)],
['routeForEventHistoryImport', () => routeForEventHistoryImport()],
['routeForBatchOperations', () => routeForBatchOperations(namespaceParams)],
[
'routeForBatchOperation',
() => routeForBatchOperation({ namespace: 'default', jobId: 'job-1' }),
],
[
'routeForStandaloneActivities',
() => routeForStandaloneActivities(namespaceParams),
],
[
'routeForStandaloneActivitiesWithQuery',
() =>
routeForStandaloneActivitiesWithQuery(namespaceParams, 'test-query'),
],
[
'routeForStartStandaloneActivity',
() => routeForStartStandaloneActivity(namespaceParams),
],
[
'routeForStandaloneActivityDetails',
() => routeForStandaloneActivityDetails(activityParams),
],
[
'routeForStandaloneActivityWorkers',
() => routeForStandaloneActivityWorkers(activityParams),
],
[
'routeForStandaloneActivitySearchAttributes',
() => routeForStandaloneActivitySearchAttributes(activityParams),
],
[
'routeForStandaloneActivityMetadata',
() => routeForStandaloneActivityMetadata(activityParams),
],
[
'routeForWorkflowStart',
() => routeForWorkflowStart({ namespace: 'default' }),
],
[
'routeForWorkflowsWithQuery',
() => routeForWorkflowsWithQuery({ namespace: 'default', query: 'test' }),
],
[
'routeForAuthentication',
() =>
routeForAuthentication({
settings: { auth: {}, baseUrl: 'https://example.com' },
searchParams: new URLSearchParams(),
}),
],
['routeForLoginPage', () => routeForLoginPage('', false)],
];

it.each(cases)('%s should resolve the base path', (_name, fn) => {
const result = fn();
expect(typeof result).toBe('string');
expect(result?.length).toBeGreaterThan(0);
expect(result).toMatch(new RegExp(`${BASE_PATH}`));
expect(result).not.toMatch(new RegExp(`${BASE_PATH}${BASE_PATH}`));
});

it('should have a test case for every exported routeFor function', () => {
const testedNames = new Set(cases.map(([name]) => name));
const exportedRouteForFunctions = Object.keys(routeForModule).filter(
(key) =>
key.startsWith('routeFor') &&
typeof routeForModule[key as keyof typeof routeForModule] ===
'function',
);

const missing = exportedRouteForFunctions.filter(
(name) => !testedNames.has(name),
);
if (missing.length > 0) {
throw new Error(
`Missing base path test cases for: ${missing.join(', ')}. Add them to the cases array above.`,
);
}
});
});
Loading
Loading