Add installer attributes for name, version, platform, and type to .installer.info by stacynoland · Pull Request #1260 · conda/constructor

stacynoland · 2026-06-10T03:17:01Z

Description

This PR adds attributes to a .installer.info file stored in the workspace directory for persistent storage.

The installer attributes are stored in JSON format using the following keys:

name
version
platform
type

This information is being stored so other services, such as telemetry, can find details about the installer that was used to setup conda.

Checklist - did you ...

Add a file to the news directory (using the template) for the next release's release notes?
Add / update necessary tests?
Add / update outdated documentation?

…nstructor-build.info

stacynoland · 2026-06-10T05:06:41Z

pre-commit.ci autofix

for more information, see https://pre-commit.ci

lrandersson · 2026-06-10T12:57:20Z

+    out["installer_name"] = info.get("installer_name", "Unknown")
+    out["installer_version"] = info.get("installer_version", "Unknown")
+    out["installer_platform"] = info.get("installer_platform", "Unknown")


Suggested change

out["installer_name"] = info.get("installer_name", "Unknown")

out["installer_version"] = info.get("installer_version", "Unknown")

out["installer_platform"] = info.get("installer_platform", "Unknown")

out["installer_name"] = info.get("name", "Unknown")

out["installer_version"] = info.get("version", "Unknown")

out["installer_platform"] = info.get("_platform", "Unknown")

I looked at the keys again that I mentioned yesterday and I realized that was incorrect. I added this suggestion which should be accurate:

name from construct.yaml

version from construct.yaml

_platform is set via main.py

installer_type also set via main.py

I also wonder if we should simply have empty strings as default but no strong opinion, I guess the consumer of this data might have an opinion of this.
Perhaps also installer_name and installer_version should not even have a default since something must be fundamentally wrong if it not set.

They're all guaranteed to be set. I think a simple get() without default values is good here - in the unlikely case that a value isn't set, we'd get null instead of a special string in the JSON file. Empty string is a good alternative, which I'd prefer over "Unknown".

@lrandersson Thanks for catching the info dict keys issue. I made sure this was updated.

@marcoesters I also removed the default value as suggested on the get() method.

marcoesters

I think we should use a separate file to not conflate installer and build environment information. I would also like to see the changes be covered by a test - I recommend just modifying an existing one.

marcoesters · 2026-06-10T14:25:39Z


 files = (
-    "pkgs/.constructor-build.info",
+    ".constructor-build.info",


I'm not sure about whether to re-use that file. The file contains information about the build process and contains information on conda, python, etc. from the build environment. Adding information of the installer could imply that these are the version of conda, python, etc. that are packaged in the installer.

I think a separate file makes more sense.

marcoesters · 2026-06-10T14:29:19Z

+    out["installer_name"] = info.get("installer_name", "Unknown")
+    out["installer_version"] = info.get("installer_version", "Unknown")
+    out["installer_platform"] = info.get("installer_platform", "Unknown")


They're all guaranteed to be set. I think a simple get() without default values is good here - in the unlikely case that a value isn't set, we'd get null instead of a special string in the JSON file. Empty string is a good alternative, which I'd prefer over "Unknown".

stacynoland · 2026-06-10T22:31:51Z

I think we should use a separate file to not conflate installer and build environment information. I would also like to see the changes be covered by a test - I recommend just modifying an existing one.

The installer attributes are now saved to a .installer.info file in the installer/workspace directory and I reverted the changes we had made to the .constructor-build.info file.

I'm still working on getting it covered by a test, but I will have that for review by tomorrow.

lrandersson

I think this looks good. As you mentioned maybe a simple unit test would be good to add and I think we should not hardcode .installer.info in both preconda.py and winexe.py, instead define a variable somewhere that can be utilized.

marcoesters · 2026-06-11T14:18:48Z

I think this looks good. As you mentioned maybe a simple unit test would be good to add and I think we should not hardcode .installer.info in both preconda.py and winexe.py, instead define a variable somewhere that can be utilized.

I think changing an existing test like test_example_miniforge is sufficient. The current hardcoding is consistent with existing code, actually. A general refactor to replace the hard-coding with variables is a good issue though.

lrandersson · 2026-06-11T15:07:19Z

I think this looks good. As you mentioned maybe a simple unit test would be good to add and I think we should not hardcode .installer.info in both preconda.py and winexe.py, instead define a variable somewhere that can be utilized.

I think changing an existing test like test_example_miniforge is sufficient. The current hardcoding is consistent with existing code, actually. A general refactor to replace the hard-coding with variables is a good issue though.

Created #1261

stacynoland · 2026-06-11T21:28:41Z

pre-commit.ci autofix

for more information, see https://pre-commit.ci

marcoesters · 2026-06-11T21:44:45Z

+        "platform": info.get("_platform"),
+        "type": info.get("installer_type"),
+    }
+    with open(join(workspace, ".installer.info"), "w") as fo:


Should this get the JSON extension since it's a JSON file? I know the build info is .info, but .json is more transparent.

.constructor-build.info is also a JSON file. I was following that as an example, so I guess that question would apply to both of these, correct?

I don't like that either. 😅 I don't have a strong opinion either way.

Yeah, I don't have a strong opinion either, but if we do make a choice I just want to stay consistent 🤓

marcoesters · 2026-06-11T21:48:20Z

+                else "Miniforge3-mamba2"
+            )
+            assert installer_info["version"] == "25.0.0-1" if example == "miniforge" else "25.1.1-0"
+            assert installer_info["platform"] in SUPPORTED_PLATFORMS


That doesn't test that the platform is correct, just that it's a supported platform.

We can use the platform module and piece together each "platform" value that way to check against it, replicating the format SUPPORTED_PLATFORMS expects. That's the only option I see here, because this value isn't provided by the construct.yaml files.

Since you don't cross-build in this test, you could use cc_platform:

constructor/constructor/conda_interface.py

Line 98 in f80d676

cc_platform = conda_context.subdir

That's the default value for the platform.

I kept seeing that in places and wasn't 100% sure if that was it. I'll make that change and send it along in the next push.

…'test_example_miniforge'

stacynoland · 2026-06-11T22:29:57Z

pre-commit.ci autofix

for more information, see https://pre-commit.ci

Co-authored-by: Marco Esters <mesters@anaconda.com>

….info values

stacynoland · 2026-06-11T23:09:23Z

pre-commit.ci autofix

for more information, see https://pre-commit.ci

Add installer attributes for name, version, platform, and type to .co…

65eedcb

…nstructor-build.info

conda-bot added this to 🔎 Review Jun 10, 2026

github-project-automation Bot moved this to 🆕 New in 🔎 Review Jun 10, 2026

conda-bot added the cla-signed [bot] added once the contributor has signed the CLA label Jun 10, 2026

stacynoland changed the title ~~Add installer attributes for name, version, platform, and type to .co…~~ Add installer attributes for name, version, platform, and type to .constructor-build.info Jun 10, 2026

Add news item for PR 1260

abc9e06

[pre-commit.ci] auto fixes from pre-commit.com hooks

ded8235

for more information, see https://pre-commit.ci

stacynoland marked this pull request as ready for review June 10, 2026 05:09

stacynoland requested a review from a team as a code owner June 10, 2026 05:09

stacynoland marked this pull request as draft June 10, 2026 05:15

stacynoland marked this pull request as ready for review June 10, 2026 05:16

lrandersson reviewed Jun 10, 2026

View reviewed changes

marcoesters reviewed Jun 10, 2026

View reviewed changes

Revert changes for .constructor-build.info file

6e8711d

stacynoland changed the title ~~Add installer attributes for name, version, platform, and type to .constructor-build.info~~ Add installer attributes for name, version, platform, and type to .installer.info Jun 10, 2026

stacynoland added 2 commits June 10, 2026 18:08

Add installer name, version, platform, and type to .installer.info file

55c2820

Change 'platform' to '_platform' for 'info.get()' call

62aa904

lrandersson reviewed Jun 11, 2026

View reviewed changes

Add test statements for .installer.info to 'test_example_miniforge'

cafb6ae

[pre-commit.ci] auto fixes from pre-commit.com hooks

e308b0b

for more information, see https://pre-commit.ci

stacynoland requested review from lrandersson and marcoesters June 11, 2026 21:39

marcoesters reviewed Jun 11, 2026

View reviewed changes

stacynoland added 2 commits June 11, 2026 18:21

Reduce if-else statements in 'test_example_miniforge'

cdfb2f8

Move installer_name and installer_version to parameterized values in …

1ae2807

…'test_example_miniforge'

[pre-commit.ci] auto fixes from pre-commit.com hooks

7ebb1ec

for more information, see https://pre-commit.ci

stacynoland requested a review from marcoesters June 11, 2026 22:33

stacynoland and others added 2 commits June 11, 2026 18:46

Update tests/test_examples.py

72ada77

Co-authored-by: Marco Esters <mesters@anaconda.com>

Check installer platform against 'cc_platform' for testing .installer…

edee167

….info values

[pre-commit.ci] auto fixes from pre-commit.com hooks

9523ea1

for more information, see https://pre-commit.ci

lrandersson approved these changes Jun 12, 2026

View reviewed changes

github-project-automation Bot moved this from 🆕 New to ✅ Approved in 🔎 Review Jun 12, 2026

marcoesters approved these changes Jun 12, 2026

View reviewed changes

marcoesters merged commit 37ed3cc into conda:main Jun 12, 2026
20 checks passed

github-project-automation Bot moved this from ✅ Approved to 🏁 Done in 🔎 Review Jun 12, 2026

Uh oh!

Conversation

stacynoland commented Jun 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist - did you ...

Uh oh!

stacynoland commented Jun 10, 2026

Uh oh!

lrandersson Jun 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

stacynoland Jun 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

marcoesters left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

stacynoland commented Jun 10, 2026

Uh oh!

lrandersson left a comment

Choose a reason for hiding this comment

Uh oh!

marcoesters commented Jun 11, 2026

Uh oh!

lrandersson commented Jun 11, 2026

Uh oh!

stacynoland commented Jun 11, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

stacynoland commented Jun 11, 2026

Uh oh!

stacynoland commented Jun 11, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

stacynoland commented Jun 10, 2026 •

edited

Loading

lrandersson Jun 10, 2026 •

edited

Loading

stacynoland Jun 10, 2026 •

edited

Loading