Using setURLSuffix on URLSegment field is not respected in SiteTreeURLSegmentField.js correctly

[RVXD]

I'd like to be able to remove the ?stage=Stage link from the URLSegment field in the CMS. Some clients keep copying this link into their newsletters/socialmedia messages. If people click on it these links they need to login. For most non-technical users this is confusing.

Removing the urlSuffix in Page.php by setting it to false works in source, but javascript adds it again. Resulting in link with undefined at the end.

Setting URLSuffix to false, if page is published:

public function getCMSFields()
{
      $fields = parent::getCMSFields();
        if( $this->isPublished() ) {
            $fields->FieldByName('Root.Main.URLSegment')->setURLSuffix(false);
        }
}

Workaround setting URLSuffix to '?', if page is published:
Now all the links will end with a '?'

public function getCMSFields()
{
      $fields = parent::getCMSFields();
        if( $this->isPublished() ) {
            $fields->FieldByName('Root.Main.URLSegment')->setURLSuffix('?');
        }
}

Current SiteTreeURLSegmentField.js
Always adds suffix. If it is empty or false causing 'undefined' in the URL.

// Transfer current value to holder
this.find('.URL-link').attr('href', encodeURI(url + field.data('suffix'))).text(previewUrl);

Proposed change to SiteTreeURLSegmentField.js:
Only add suffix if it not false.

// Transfer current value to holder
this.find(".URL-link").attr("href",encodeURI(t+(e.data("suffix")?e.data("suffix"):''))).text(n)}

[michalkleiner]

Do you want to open a pull request, @RVXD?

[emteknetnz]

Sorry, we can't really do this. The ?stage=Stage query string is used to ensure that HTTP caching is disabled. Also at once point ?stage=Stage wasn't always used and instead sessions were used to say which stage you were on. However this was changed to always using the ?stage=Stage to resolve a class of bug of which I can't exactly remember

[RVXD]

I still think the change to SiteTreeURLSegmentField.js could and should be made without having a negative impact on the functionality. A lot of users think this is the URL they can communicate to the world. The ?stage=Stage part does not have to be removed at all from the preview pane or anywhere else. Just from the segment field, so that if someone copies it, it is not in there.
The functionality of $fields->FieldByName('Root.Main.URLSegment')->setURLSuffix(false) is broken in the javascript part of the CMS. If set to false it should not give back undefined in the url.
Hope you can give it another thought.

[michalkleiner]

Yeah, I think if @emteknetnz takes a second look and reads through the issue again, it is really only about fixing the JS to correctly respect the already existing settings, nothing else. It's not intended to remove the query param.
I'll reopen the issue and adjust the title.

[michalkleiner]

Alternatively, if we want to ensure false can't be passed to setURLSuffix we need to throw an application exception.

[GuySartorelli]

This change won't affect the default behaviour, but makes extending or changing the behaviour to suit the needs of a given project easier. Makes sense to me. I'd even go so far as to say that technically not respecting an empty suffix could be considered a bug.

[purplespider]

I came here looking to do as @RVXD wants to, but this bug stops it from being possible to remove ?stage=Stage for those who wish to.

Another workaround for the problem @RVXD is trying to stop could be to override SiteTreeURLSegmentField.ss to add a "Copy" button, .e.g. adding:

<button onclick="navigator.clipboard.writeText('{$URLPrefix}{$Value}')" role="button" type="button" class="btn btn-outline-secondary btn-sm font-icon-clipboard-pencil">Copy</button>

Which then looks like this: