X2Go Bug report logs - #1476
x2goclient interface code needs refactoring to make it more accessible and make improvements easier to implement and test

version graph

Package: x2goclient; Maintainer for x2goclient is X2Go Developers <x2go-dev@lists.x2go.org>; Source for x2goclient is src:x2goclient.

Reported by: Dave Chamberlin-Kidd <dave@flamangoes.co.uk>

Date: Sun, 7 Jun 2020 15:55:01 UTC

Severity: wishlist

Found in version 4.1.2.3

Full log

🔗 View this message in rfc822 format

X-Loop: owner@bugs.x2go.org
Subject: Bug#1476: x2goclient interface code needs refactoring to make it more accessible and make improvements easier to implement and test
Reply-To: Dave Chamberlin-Kidd <dave@flamangoes.co.uk>, 1476@bugs.x2go.org
Resent-From: Dave Chamberlin-Kidd <dave@flamangoes.co.uk>
Resent-To: x2go-dev@lists.x2go.org
Resent-CC: X2Go Developers <x2go-dev@lists.x2go.org>
X-Loop: owner@bugs.x2go.org
Resent-Date: Sun, 07 Jun 2020 15:55:01 +0000
Resent-Message-ID: <handler.1476.B.15915450125544@bugs.x2go.org>
Resent-Sender: owner@bugs.x2go.org
X-X2Go-PR-Message: report 1476
X-X2Go-PR-Package: x2goclient
X-X2Go-PR-Keywords: 
Received: via spool by submit@bugs.x2go.org id=B.15915450125544
          (code B); Sun, 07 Jun 2020 15:55:01 +0000
Received: (at submit) by bugs.x2go.org; 7 Jun 2020 15:50:12 +0000
X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on
	ymir.das-netzwerkteam.de
X-Spam-Level: 
X-Spam-Status: No, score=-1.9 required=3.0 tests=BAYES_00,HTML_MESSAGE,
	RCVD_IN_MSPIKE_H2,SPF_HELO_NONE,URIBL_BLOCKED autolearn=ham
	autolearn_force=no version=3.4.2
Received: from mail-io1-f47.google.com (mail-io1-f47.google.com [209.85.166.47])
	by ymir.das-netzwerkteam.de (Postfix) with ESMTPS id 01E925DAD6
	for <submit@bugs.x2go.org>; Sun,  7 Jun 2020 17:49:35 +0200 (CEST)
Received: by mail-io1-f47.google.com with SMTP id r2so15936992ioo.4
        for <submit@bugs.x2go.org>; Sun, 07 Jun 2020 08:49:35 -0700 (PDT)
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
        d=1e100.net; s=20161025;
        h=x-gm-message-state:mime-version:from:date:message-id:subject:to;
        bh=ZMel9S6wzUy5POCC0cAMbg5065jWLOdu/7Zo3sVUXNM=;
        b=TlmQ/ua2dVmDqYQQcaUqSTqb2qPsQxC2brTJJR1InTDECUvkD7cNJ31cAXIZnhGcTN
         8/irdKy14XlNrTscja3LljqetBlHKdu+j9OfO9RnqcRLs+TAsO7aoyDTVQRx0ViCDHyM
         BGLwQgVntqe3UZGvQv/Io17dV+ZhBk710v/GnK4B5RRAKsd5whZpPYlfoRhU+v+S1QQg
         Sp7NbeyzajJlJ7LozA+wsJIXjGJdwm8zxz7udepe3g3XC8leSFTlvN5RJSbzNqZHCBVL
         qUQPSXSudZquR0YWB72o8qKnYBpWVTYZOdKzmCgf4zkJbOnwNeDt5/bUALf3OI2vpFne
         6oaw==
X-Gm-Message-State: AOAM532C6i1Qc1SVglCWkCH7/YtEfnHSwxi6aZVBGBRwWiHoRZuJ9j81
	+YpbXv3ssJpdDL3dQGTmkYC5JND3t9zg9ChqfnliSg==
X-Google-Smtp-Source: ABdhPJyr4KNCKpOLjOAeeqptKCV0BEzrPRp+wNWuF5pmKYxjZqq7nXbjWOotGDDmorT3SbsnMVjMJ8oaFMFl1zUwCvk=
X-Received: by 2002:a5e:a70c:: with SMTP id b12mr17067141iod.96.1591544973425;
 Sun, 07 Jun 2020 08:49:33 -0700 (PDT)
MIME-Version: 1.0
From: Dave Chamberlin-Kidd <dave@flamangoes.co.uk>
Date: Sun, 7 Jun 2020 16:49:21 +0100
Message-ID: <CAL4gekBJSL8f_uv8pHNNrsHiWvy_31YCvi+tzG4XzJ76n6Gc6A@mail.gmail.com>
To: submit@bugs.x2go.org
Content-Type: multipart/mixed; boundary="000000000000c9530205a780703c"

[Message part 1 (text/plain, inline)]
Package: x2goclient
Version: 4.1.2.3
Severity: wishlist
Tag: patch

There are a number of minor issues, oddities and limitations with the
current x2goclient gui which would be good to fix, resolve and improve on.
Like all projects however the core team have more important issues to
resolve. The code in its current state is difficult to understand and amend
and as it has no tests it is risky for developers to make functional
changes unless they spend a lot of time getting to know the code and doing
extensive manual testing.

Attached are 10 small refactorings which start extracting out some of the
code into smaller functions. As the code is separated out it becomes easier
to understand and change.

There are no functional changes in these patches, nor do they attempt or
claim to fix any known issues. On their own the benefit of these patches is
limited however the hope is that over time I will be able to submit more
refactorings as I learn more and then start fixing issues and improving the
UI. Extracting out functions is just one of many techniques that can be
used to make code cleaner but in my experience it's a good one to start
with. It should also be noted that sometimes code is extracted "as is" even
when it is clear further refactoring can be done to improve things, this is
by design in order to keep risk and size of patches to a minimum.

Cheers
Dave

[Message part 2 (text/html, inline)]
[0007-Refactor-Extract-geometry-setup.patch (text/x-patch, attachment)]
[0008-Refactor-Extract-sound-setup.patch (text/x-patch, attachment)]
[0009-Refactor-Extract-server-setup.patch (text/x-patch, attachment)]
[0010-Refactor-Extract-edit-button-setup.patch (text/x-patch, attachment)]
[0006-Refactor-Extract-command-setup.patch (text/x-patch, attachment)]
[0005-Refactor-Organise-object-creation-by-feature.patch (text/x-patch, attachment)]
[0004-Refactor-Remove-unnecessary-code.patch (text/x-patch, attachment)]
[0003-Refactor-Use-constant-for-color.patch (text/x-patch, attachment)]
[0002-Refactor-Extract-geometry-box-setup.patch (text/x-patch, attachment)]
[0001-Refactor-Extract-palette-setup.patch (text/x-patch, attachment)]

Send a report that this bug log contains spam.

X2Go Developers <owner@bugs.x2go.org>. Last modified: Thu Nov 21 14:42:43 2024; Machine Name: ymir.das-netzwerkteam.de

X2Go Bug tracking system

Debbugs is free software and licensed under the terms of the GNU Public License version 2. The current version can be obtained from https://bugs.debian.org/debbugs-source/.

Copyright © 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson, 2005-2017 Don Armstrong, and many other contributors.