Skip to content

feat(port-forward): improve usability of the create and edit port-forward modal #704

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

Open
m-dilorenzi wants to merge 2 commits into
base: main
Choose a base branch
from
Open

feat(port-forward): improve usability of the create and edit port-forward modal #704

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fa130f7
feat(port-forward): add traffic type selection and enhance destinatio…
m-dilorenzi Feb 18, 2026
307db42
style(port-forward): format code for better readability
m-dilorenzi Feb 18, 2026
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
182 changes: 132 additions & 50 deletions src/components/standalone/firewall/CreateOrEditPortForwardDrawer.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,18 @@ const supportedDestinationZones = computed<NeComboboxOption[]>(() => {
}
})

const trafficType = ref<'select_protocols' | 'all_traffic'>('select_protocols')
const trafficTypeOptions = [
{
id: 'select_protocols',
label: t('standalone.port_forward.select_protocols')
},
{
id: 'all_traffic',
label: t('standalone.port_forward.all_traffic')
}
]

// Form fields
const id = ref('')
const name = ref('')
Expand All @@ -125,7 +137,7 @@ const reflectionZones = ref<NeComboboxOption[]>([])
const reflectionZonesRef = ref()
const destinationZone = ref('')
const destinationZoneRef = ref()
const destinationAddressType = ref<'address' | 'object'>('address')
const destinationAddressType = ref<'address' | 'object' | 'firewall'>('address')
const destinationAddressObject = ref('')
const destinationObjectRef = ref()
const restrictType = ref<'address' | 'object'>('address')
Expand All @@ -140,6 +152,10 @@ const destinationAddressOptions = ref([
{
id: 'object',
label: t('standalone.port_forward.select_an_object')
},
{
id: 'firewall',
label: t('standalone.port_forward.firewall')
}
])

Expand Down Expand Up @@ -186,7 +202,13 @@ const restrictObjectsComboboxOptions = computed(() => {
return [noObjectOption, ...restrictOptions]
})

const anyProtocolSelected = computed(() => protocols.value.length == 0)
const filteredDestinationAddressOptions = computed(() => {
// when traffic type is 'all_traffic', exclude the firewall option
if (trafficType.value === 'all_traffic') {
return destinationAddressOptions.value.filter((option) => option.id !== 'firewall')
}
return destinationAddressOptions.value
})

function resetForm() {
validationErrorBag.value.clear()
Expand All @@ -203,11 +225,16 @@ function resetForm() {
destinationAddressType.value = 'object'
destinationIP.value = ''
destinationAddressObject.value = props.initialItem.ns_dst
} else {
// destination address is an IP address
} else if (props.initialItem.dest_ip && props.initialItem.dest_ip !== '127.0.0.1') {
// destination address is a custom IP address
destinationAddressType.value = 'address'
destinationIP.value = props.initialItem.dest_ip
destinationAddressObject.value = ''
} else {
// destination address is 127.0.0.1 (firewall's IP)
destinationAddressType.value = 'firewall'
destinationIP.value = ''
destinationAddressObject.value = ''
}
} else {
// creating new port forward
Expand Down Expand Up @@ -266,12 +293,13 @@ async function fetchOptions() {
loading.value.listProtocolsAndZones = true

try {
supportedProtocols.value = (
await ubusCall('ns.redirects', 'list-protocols')
).data.protocols.map((proto: string) => ({
id: proto,
label: proto.toUpperCase()
}))
supportedProtocols.value = (await ubusCall('ns.redirects', 'list-protocols')).data.protocols
// filter out 'all' protocol as there is the dedicated 'all_traffic' option in the UI
.filter((proto: string) => proto.toLowerCase() !== 'all')
.map((proto: string) => ({
id: proto,
label: proto.toUpperCase()
}))
} catch (err: any) {
error.value.notificationTitle = t('error.cannot_retrieve_protocols')
error.value.notificationDescription = t(getAxiosErrorMessage(err))
Expand Down Expand Up @@ -318,6 +346,16 @@ watchEffect(() => {
resetForm()
})

// reset destination address type to 'address' when switching to all_traffic and firewall is selected
watch(
() => trafficType.value,
(newTrafficType) => {
if (newTrafficType === 'all_traffic' && destinationAddressType.value === 'firewall') {
destinationAddressType.value = 'address'
}
}
)

function close() {
error.value.notificationTitle = ''
error.value.notificationDescription = ''
Expand Down Expand Up @@ -346,6 +384,17 @@ function resetRestrictIPValidationErrors() {
restrictIPValidationErrors.value = []
}

function handleSelectAllProtocolsManually() {
// prevent selecting all protocols
if (
protocols.value.length === supportedProtocols.value.length &&
supportedProtocols.value.length > 0
) {
// remove the last selected protocol
protocols.value.pop()
}
}

function runFieldValidators(
validators: validationOutput[],
fieldName: string,
Expand Down Expand Up @@ -399,8 +448,12 @@ function validate(): boolean {
const sourceDestinationPortValidators: [validationOutput[], string, Ref][] = [
[
[
// if destination port is present, source port is required
destinationPort.value ? validateRequired(sourcePort.value) : { valid: true },
// source port required when destination is firewall or destination port is present
destinationAddressType.value === 'firewall'
? validateRequired(sourcePort.value)
: destinationPort.value
? validateRequired(sourcePort.value)
: { valid: true },
sourcePort.value
? validateAnyOf(
[validatePort, validatePortRange],
Expand All @@ -427,26 +480,38 @@ function validate(): boolean {
]
]

const destinationIpRequired = sourcePort.value == '' || destinationPort.value == ''
// if traffic type is 'select_protocols', at least one protocol must be selected from the dropdown
const protocolValidators: [validationOutput[], string, Ref][] =
trafficType.value === 'select_protocols'
? [[[validateRequiredOption(protocols.value)], 'protocols', protocolsRef]]
: []

// destination address validation based on type
const destinationValidators: [validationOutput[], string, Ref][] = []

if (destinationAddressType.value === 'address') {
// type is 'address', IP is required and must be valid
destinationValidators.push([
[validateRequired(destinationIP.value), validateIpAddress(destinationIP.value)],
'destinationIP',
destinationIpRef
])
} else if (destinationAddressType.value === 'object') {
// type is 'object'
destinationValidators.push([
[validateRequired(destinationAddressObject.value)],
'destinationAddressObject',
destinationObjectRef
])
}
// if type is 'firewall', no validation needed as the destination address is the firewall's IP
// and the source port is checked above in sourceDestinationPortValidators

const validators: [validationOutput[], string, Ref][] = [
[[validateRequired(name.value)], 'name', nameRef],
...(anyProtocolSelected.value ? [] : sourceDestinationPortValidators),
destinationAddressType.value === 'address'
? [
destinationIpRequired
? [validateRequired(destinationIP.value), validateIpAddress(destinationIP.value)]
: destinationIP.value
? [validateIpAddress(destinationIP.value)]
: [{ valid: true }],
'destinationIP',
destinationIpRef
]
: [
[validateRequired(destinationAddressObject.value)],
'destinationAddressObject',
destinationObjectRef
],
...protocolValidators,
...(trafficType.value === 'all_traffic' ? [] : sourceDestinationPortValidators),
...destinationValidators,
[
reflection.value ? [validateRequiredOption(reflectionZones.value)] : [],
'reflectionZones',
Expand Down Expand Up @@ -478,11 +543,12 @@ async function createOrEditPortForward() {
const payload: CreateEditPortForwardPayload = {
dest_ip: '',
ns_dst: '',
proto: anyProtocolSelected.value
? ['all']
: protocols.value.map((protoObj: NeComboboxOption) => protoObj.id),
src_dport: anyProtocolSelected.value ? '' : sourcePort.value,
dest_port: anyProtocolSelected.value ? '' : destinationPort.value,
proto:
trafficType.value === 'all_traffic'
? ['all']
: protocols.value.map((protoObj: NeComboboxOption) => protoObj.id),
src_dport: trafficType.value === 'all_traffic' ? '' : sourcePort.value,
dest_port: trafficType.value === 'all_traffic' ? '' : destinationPort.value,
name: name.value,
src_dip: wan.value === 'any' ? '' : wan.value,
enabled: enabled.value ? '1' : '0',
Expand All @@ -503,10 +569,11 @@ async function createOrEditPortForward() {
if (destinationAddressType.value === 'address') {
// destination address
payload.dest_ip = destinationIP.value
} else {
} else if (destinationAddressType.value === 'object') {
// destination object
payload.ns_dst = destinationAddressObject.value
}
// if destinationAddressType is 'firewall', dest_ip and ns_dst remain empty

if (restrictType.value === 'address') {
// restrict addresses
Expand Down Expand Up @@ -583,11 +650,26 @@ async function createOrEditPortForward() {
:disabled="isSubmittingRequest"
:invalid-message="validationErrorBag.getFirstFor('name')"
/>

<NeRadioSelection
v-model="trafficType"
:label="t('standalone.port_forward.traffic_type')"
:options="trafficTypeOptions"
:disabled="isSubmittingRequest"
/>

<NeInlineNotification
v-show="trafficType === 'all_traffic'"
kind="info"
:title="t('standalone.port_forward.forward_all_traffic')"
:description="t('standalone.port_forward.forward_all_traffic_message')"
/>

<NeCombobox
v-show="trafficType !== 'all_traffic'"
ref="protocolsRef"
v-model="protocols"
:label="t('standalone.port_forward.protocols')"
:helper-text="t('standalone.port_forward.protocol_helper')"
:multiple="true"
:options="supportedProtocols"
:placeholder="t('standalone.port_forward.choose_protocol')"
Expand All @@ -599,23 +681,24 @@ async function createOrEditPortForward() {
:selected-label="t('ne_combobox.selected')"
:user-input-label="t('ne_combobox.user_input_label')"
:optional-label="t('common.optional')"
@update:model-value="handleSelectAllProtocolsManually"
/>
<NeInlineNotification
v-if="anyProtocolSelected"
kind="info"
:title="t('standalone.port_forward.any_protocol')"
:description="t('standalone.port_forward.any_protocol_message')"
/>

<NeTextInput
v-if="!anyProtocolSelected"
v-show="trafficType !== 'all_traffic'"
ref="sourcePortRef"
v-model="sourcePort"
:label="t('standalone.port_forward.source_port')"
:invalid-message="validationErrorBag.getFirstFor('sourcePort')"
:optional="true"
:optional="destinationAddressType !== 'firewall'"
:disabled="isSubmittingRequest"
:optional-label="t('common.optional')"
:helper-text="t('standalone.port_forward.source_destination_port_helper')"
:helper-text="
destinationAddressType !== 'firewall'
? t('standalone.port_forward.source_destination_port_helper')
: ''
"
:placeholder="t('standalone.port_forward.port_placeholder')"
>
<template #tooltip>
<NeTooltip>
Expand All @@ -640,7 +723,7 @@ async function createOrEditPortForward() {
<NeRadioSelection
v-model="destinationAddressType"
:label="t('standalone.port_forward.destination_address_type')"
:options="destinationAddressOptions"
:options="filteredDestinationAddressOptions"
:disabled="isSubmittingRequest"
>
<template #tooltip>
Expand All @@ -658,9 +741,8 @@ async function createOrEditPortForward() {
v-model="destinationIP"
:label="t('standalone.port_forward.destination_address')"
:invalid-message="validationErrorBag.getFirstFor('destinationIP')"
:helper-text="t('standalone.port_forward.leave_blank_for_firewall')"
:disabled="isSubmittingRequest"
optional
:optional-label="t('common.optional')"
/>
<!-- destination object -->
<NeCombobox
Expand Down Expand Up @@ -688,15 +770,15 @@ async function createOrEditPortForward() {
</template>
</NeCombobox>
<NeTextInput
v-if="!anyProtocolSelected"
v-show="trafficType !== 'all_traffic'"
ref="destinationPortRef"
v-model="destinationPort"
:label="t('standalone.port_forward.destination_port')"
:invalid-message="validationErrorBag.getFirstFor('destinationPort')"
:optional="true"
:optional-label="t('common.optional')"
:helper-text="t('standalone.port_forward.source_destination_port_helper')"
:disabled="isSubmittingRequest"
:placeholder="t('standalone.port_forward.port_placeholder')"
>
<template #tooltip
><NeTooltip
Expand Down
21 changes: 13 additions & 8 deletions src/components/standalone/firewall/PortForwardTable.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,25 +96,25 @@ function getCellClasses(item: PortForward) {
class="z-10"
>
<NeTableHead>
<NeTableHeadCell>
<NeTableHeadCell style="width: 16%">
{{ t('standalone.port_forward.name') }}
</NeTableHeadCell>
<NeTableHeadCell>
<NeTableHeadCell style="width: 14%">
{{ t('standalone.port_forward.source_port') }}
</NeTableHeadCell>
<NeTableHeadCell>
<NeTableHeadCell style="width: 14%">
{{ t('standalone.port_forward.destination_port') }}
</NeTableHeadCell>
<NeTableHeadCell>
<NeTableHeadCell style="width: 14%">
{{ t('standalone.port_forward.protocols') }}
</NeTableHeadCell>
<NeTableHeadCell>
<NeTableHeadCell style="width: 14%">
{{ t('standalone.port_forward.wan_ip') }}
</NeTableHeadCell>
<NeTableHeadCell>
<NeTableHeadCell style="width: 14%">
{{ t('standalone.port_forward.restrict_access_from') }}
</NeTableHeadCell>
<NeTableHeadCell>
<NeTableHeadCell style="width: 14%">
{{ t('standalone.port_forward.status') }}
</NeTableHeadCell>
<NeTableHeadCell>
Expand Down Expand Up @@ -165,7 +165,12 @@ function getCellClasses(item: PortForward) {
<div v-else :class="getCellClasses(item)" class="flex flex-row items-center">
<FontAwesomeIcon
:icon="item.enabled ? faCircleCheck : faCircleXmark"
class="mr-2 h-5 w-5"
:class="[
'mr-2',
'h-5',
'w-5',
item.enabled ? 'text-green-700 dark:text-green-500' : ''
]"
aria-hidden="true"
/>
<p>
Expand Down
Loading
Loading