GNU bug report logs - #68482
29.1; multisession does not seem to work with maps (e.g. alists or hash tables)

Message received at submit <at> debbugs.gnu.org:

Received: (at submit) by debbugs.gnu.org; 15 Jan 2024 19:28:59 +0000
From debbugs-submit-bounces <at> debbugs.gnu.org Mon Jan 15 14:28:59 2024
Received: from localhost ([127.0.0.1]:46870 helo=debbugs.gnu.org)
	by debbugs.gnu.org with esmtp (Exim 4.84_2)
	(envelope-from <debbugs-submit-bounces <at> debbugs.gnu.org>)
	id 1rPSdm-0006Kx-HT
	for submit <at> debbugs.gnu.org; Mon, 15 Jan 2024 14:28:58 -0500
Received: from lists.gnu.org ([2001:470:142::17]:38574)
 by debbugs.gnu.org with esmtp (Exim 4.84_2)
 (envelope-from <adam@HIDDEN>) id 1rPSdk-0006Kl-Bz
 for submit <at> debbugs.gnu.org; Mon, 15 Jan 2024 14:28:56 -0500
Received: from eggs.gnu.org ([2001:470:142:3::10])
 by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256)
 (Exim 4.90_1) (envelope-from <adam@HIDDEN>)
 id 1rPSdf-0004lm-1c
 for bug-gnu-emacs@HIDDEN; Mon, 15 Jan 2024 14:28:51 -0500
Received: from cyan.elm.relay.mailchannels.net ([23.83.212.47])
 by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256)
 (Exim 4.90_1) (envelope-from <adam@HIDDEN>)
 id 1rPSdd-0000Mu-AS
 for bug-gnu-emacs@HIDDEN; Mon, 15 Jan 2024 14:28:50 -0500
X-Sender-Id: dreamhost|x-authsender|adam@HIDDEN
Received: from relay.mailchannels.net (localhost [127.0.0.1])
 by relay.mailchannels.net (Postfix) with ESMTP id 8C9E81014F5
 for <bug-gnu-emacs@HIDDEN>; Mon, 15 Jan 2024 19:28:46 +0000 (UTC)
Received: from pdx1-sub0-mail-a243.dreamhost.com (unknown [127.0.0.6])
 (Authenticated sender: dreamhost)
 by relay.mailchannels.net (Postfix) with ESMTPA id 20528102718
 for <bug-gnu-emacs@HIDDEN>; Mon, 15 Jan 2024 19:28:46 +0000 (UTC)
ARC-Seal: i=1; s=arc-2022; d=mailchannels.net; t=1705346926; a=rsa-sha256;
 cv=none;
 b=KMIy0/qrszXlbfozy8BslGfGwWHLHdfKN6n6BnP58eJExFonx1NdFqba2eZ6ufCfT8QsyJ
 eZZJWWxlmmTn3ReCxIsoHMrTbl1UNc5qO4rQcekzvKgw9ccWzzfLOS6JKAyJYQA0uyjTqw
 ThKTfpSog5BKw9i8byfytrDXr6ItHyDk4E26g3drwMQ9z5eW0stKT3ZmTyMORkRqPaGexX
 YuCfPTHT/m/4BpfhE/UKWOp9ivRKbBbaVMAb55a/HAKIPeTnXyVANheFdKza7VqtIYMGbV
 jBCDgIU2NGFuC6r8nP6Rk/b/v6dMhcrXwJQW9iT22hW+I50LziUktTWJY0hqhA==
ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed;
 d=mailchannels.net; s=arc-2022; t=1705346926;
 h=from:from:reply-to:subject:subject:date:date:message-id:message-id:
 to:to:cc:mime-version:mime-version:content-type:content-type:
 content-transfer-encoding:content-transfer-encoding:dkim-signature;
 bh=0tbzZFekDWxe1IuTo+nXQjLSgiTkx9ODnhLrIwytsDg=;
 b=WDRM684vGsFsuYyjuG+XGhTF7PDjEJpBgh5KbCB/HkRW2ASCuJz9HqNUpmr+8JXJiuaSGg
 q3yaeoF+m3V1pxITCpFHIPitqpmXdpLPPwkQ+m+LO3KFHxy4pXsIVv3h4f90QZF50PnZOW
 nqA9d3xNZrGpAIGPpbGUS31z8/D2S7TNCrDBSEtBncbZt/7jBlfuZ3NRYogIKO5jb07eY/
 1oB7nd3tv2KCwah9BksSGjrXYMsm6iZYIDpYZUWEgc+bNuobdeBIwiVQslwna9KrMBJhO5
 TJK4b1e6llyKr3drmoFQMntCxYJOWahLEpyNCUhXrK1W5v4uLPfsnOK1jUgV4Q==
ARC-Authentication-Results: i=1; rspamd-88587c4b9-pvh8b;
 auth=pass smtp.auth=dreamhost smtp.mailfrom=adam@HIDDEN
X-Sender-Id: dreamhost|x-authsender|adam@HIDDEN
X-MC-Relay: Neutral
X-MailChannels-SenderId: dreamhost|x-authsender|adam@HIDDEN
X-MailChannels-Auth-Id: dreamhost
X-Attack-Cooperative: 3af7d81960d6d85d_1705346926345_2006575435
X-MC-Loop-Signature: 1705346926345:1087827440
X-MC-Ingress-Time: 1705346926344
Received: from pdx1-sub0-mail-a243.dreamhost.com (pop.dreamhost.com
 [64.90.62.162]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384)
 by 100.96.118.165 (trex/6.9.2); Mon, 15 Jan 2024 19:28:46 +0000
Received: from [10.43.0.46] (unknown [193.56.116.15])
 (using TLSv1.3 with cipher TLS_AES_128_GCM_SHA256 (128/128 bits)
 key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256)
 (No client certificate requested)
 (Authenticated sender: adam@HIDDEN)
 by pdx1-sub0-mail-a243.dreamhost.com (Postfix) with ESMTPSA id 4TDMd94KLlz2R
 for <bug-gnu-emacs@HIDDEN>; Mon, 15 Jan 2024 11:28:45 -0800 (PST)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=alphapapa.net;
 s=dreamhost; t=1705346925;
 bh=0tbzZFekDWxe1IuTo+nXQjLSgiTkx9ODnhLrIwytsDg=;
 h=Date:To:From:Subject:Content-Type:Content-Transfer-Encoding;
 b=DmuiX5+vfyHToHFvWhOMYXQtOx1SlBxU2HKaf245Lpg3qmbywNp1QHeIOEi74YSVY
 h6tyG8l7Hn20RZqEtU0BG8tSawq9pcVHaV0vVuXVKxAPEQUHGLtyRwNZ0PT2Beib46
 56ln5sZYzM+PSm3fJBNNPy7dOiG20c+vATfyX6Ya5n9LsGzUZuB7Vf8Dg09LAiXE1+
 IxChz6wan58aBDOXOuCfVif/SRiC/BGNr9NTkL/QLh9GinFCPP6jMLiddO4/AXZW1a
 LpWjtTbNE6DLvq8ht1MJf8z5KEi2N1b76OEYLICo18Up2kh/CdQtoHbgW6BdeApf67
 gY6d87Q2+rXYg==
Message-ID: <e081a02b-e07e-4149-b79c-14f9878b0fde@HIDDEN>
Date: Mon, 15 Jan 2024 13:28:34 -0600
MIME-Version: 1.0
User-Agent: Mozilla Thunderbird
To: bug-gnu-emacs@HIDDEN
Content-Language: en-US
From: Adam Porter <adam@HIDDEN>
Subject: 29.1; multisession does not seem to work with maps (e.g. alists or
 hash tables)
Content-Type: text/plain; charset=UTF-8; format=flowed
Content-Transfer-Encoding: 7bit
Received-SPF: neutral client-ip=23.83.212.47; envelope-from=adam@HIDDEN;
 helo=cyan.elm.relay.mailchannels.net
X-Spam_score_int: -12
X-Spam_score: -1.3
X-Spam_bar: -
X-Spam_report: (-1.3 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1,
 DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1,
 RCVD_IN_DNSWL_NONE=-0.0001, RCVD_IN_MSPIKE_H4=0.001, RCVD_IN_MSPIKE_WL=0.001,
 SPF_HELO_NONE=0.001, SPF_NEUTRAL=0.779,
 T_SCC_BODY_TEXT_LINE=-0.01 autolearn=no autolearn_force=no
X-Spam_action: no action
X-Spam-Score: 0.6 (/)
X-Debbugs-Envelope-To: submit
X-BeenThere: debbugs-submit <at> debbugs.gnu.org
X-Mailman-Version: 2.1.18
Precedence: list
List-Id: <debbugs-submit.debbugs.gnu.org>
List-Unsubscribe: <https://debbugs.gnu.org/cgi-bin/mailman/options/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=unsubscribe>
List-Archive: <https://debbugs.gnu.org/cgi-bin/mailman/private/debbugs-submit/>
List-Post: <mailto:debbugs-submit <at> debbugs.gnu.org>
List-Help: <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=help>
List-Subscribe: <https://debbugs.gnu.org/cgi-bin/mailman/listinfo/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=subscribe>
Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org
Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
X-Spam-Score: -0.4 (/)

I've noticed that `multisession' does not seem to work with maps,
including alists and hash tables, although it does not seem to mention
this in the documentation.

Specifically, setting an initial value in an empty alist does cause the 
value file to be written to disk.  But afterward, updating the map 
leaves the file on disk un-updated, so after restarting Emacs, only the 
original value is available.

I found no tests in multisession-tests.el that would seem to cover these
use cases, so here are a couple that indeed fail, showing that it does
not work with them:

   (ert-deftest multi-test-files-alist-values ()
     (ert-with-temp-file dir
       :directory t
       (let ((user-init-file "/tmp/sfoo.el")
             (multisession-storage 'files)
             (multisession-directory dir)
             last-sequence)
         (define-multisession-variable multisession--alist nil)
         (should (eq (multisession-value multisession--alist) nil)) ; 
Comment out for interactive testing.

         ;; There seems to be no way to "unload" a multisession variable
         ;; within a session, so we test the sequence number to ensure
         ;; that the value was rewritten.

         (setf (alist-get 'KEY (multisession-value multisession--alist)) 1)
         (should (eq (alist-get 'KEY (multisession-value 
multisession--alist)) 1))
         ;; The file should have been written now, setting the sequence.
         (should (setf last-sequence (multisession--cached-sequence 
multisession--alist)))

         (setf (alist-get 'KEY (multisession-value multisession--alist)) 2)
         (should (eq (alist-get 'KEY (multisession-value 
multisession--alist)) 2))
         ;; The file should have been written again now, so the sequence
         ;; should have changed.
         (should-not (equal last-sequence (multisession--cached-sequence 
multisession--alist))))))

   (ert-deftest multi-test-files-hash-table-values ()
     (ert-with-temp-file dir
       :directory t
       (let ((user-init-file "/tmp/sfoo.el")
             (multisession-storage 'files)
             (multisession-directory dir)
             last-sequence)
         (define-multisession-variable multisession--hash-table 
(make-hash-table))
         (should (hash-table-p (multisession-value 
multisession--hash-table)))

         (setf (map-elt (multisession-value multisession--hash-table) 
'KEY) 1)
         (should (eq (map-elt (multisession-value 
multisession--hash-table) 'KEY) 1))
         ;; The file should have been written now, setting the sequence.
         (should (setf last-sequence (multisession--cached-sequence 
multisession--hash-table)))

         (setf (map-elt (multisession-value multisession--hash-table) 
'KEY) 2)
         (should (eq (map-elt (multisession-value 
multisession--hash-table) 'KEY) 2))
         ;; The file should have been written again now, so the sequence
         ;; should have changed.
         (should-not (equal last-sequence (multisession--cached-sequence
         multisession--hash-table))))))

I don't know how to fix this.  But AFAICT the persist.el library on
GNU ELPA does work with maps, so it may have some good examples.

Thanks,
Adam