refactor!: move `IDL*` types into the candid crate by ilbertt · Pull Request #622 · dfinity/candid

ilbertt · 2025-06-17T12:45:16Z

Overview
Move the parser's IDL* types to the candid crate, in order to share it between both the candid and the candid_parser crates.

The main reason is that we want to use the IDL* types in the bindings generators, instead of bringing around the TypeEnv, which holds inner Types that are not meant for codegen.

Considerations
Introduces breaking changes.

… feature flag

github-actions · 2025-06-17T12:50:34Z

Name	Max Mem (Kb)	Encode	Decode
blob	4_224	4_206_540	2_121_052
btreemap	75_456	4_261_360_651	15_229_108_210
nns	128	1_964_633	5_458_175 ($\textcolor{green}{-0.28\%}$)
nns_list_proposal	1_088	6_829_375 ($\textcolor{green}{-0.27\%}$)	67_489_699 ($\textcolor{red}{0.00\%}$)
option_list	128	7_481_613 ($\textcolor{red}{0.01\%}$)	25_909_653 ($\textcolor{red}{0.98\%}$)
text	6_336	4_203_487	7_877_208
variant_list	128	7_537_050 ($\textcolor{red}{0.00\%}$)	24_319_827 ($\textcolor{red}{0.35\%}$)
vec_int16	16_704	123_692_964	1_069_570_572

Parser cost: 15_006_070 ($\textcolor{green}{-0.00\%}$)
Extra args: 3_161_072 ($\textcolor{green}{-0.00\%}$)

Click to see raw report

---------------------------------------------------

Benchmark: blob
  total:
    instructions: 6.33 M (no change)
    heap_increase: 66 pages (no change)
    stable_memory_increase: 0 pages (no change)

  1. Encoding (scope):
    calls: 1 (no change)
    instructions: 4.21 M (no change)
    heap_increase: 66 pages (no change)
    stable_memory_increase: 0 pages (no change)

  2. Decoding (scope):
    calls: 1 (no change)
    instructions: 2.12 M (no change)
    heap_increase: 0 pages (no change)
    stable_memory_increase: 0 pages (no change)

---------------------------------------------------

Benchmark: text
  total:
    instructions: 12.08 M (no change)
    heap_increase: 99 pages (no change)
    stable_memory_increase: 0 pages (no change)

  1. Encoding (scope):
    calls: 1 (no change)
    instructions: 4.20 M (no change)
    heap_increase: 66 pages (no change)
    stable_memory_increase: 0 pages (no change)

  2. Decoding (scope):
    calls: 1 (no change)
    instructions: 7.88 M (no change)
    heap_increase: 33 pages (no change)
    stable_memory_increase: 0 pages (no change)

---------------------------------------------------

Benchmark: vec_int16
  total:
    instructions: 1.19 B (no change)
    heap_increase: 261 pages (no change)
    stable_memory_increase: 0 pages (no change)

  1. Encoding (scope):
    calls: 1 (no change)
    instructions: 123.69 M (no change)
    heap_increase: 261 pages (no change)
    stable_memory_increase: 0 pages (no change)

  2. Decoding (scope):
    calls: 1 (no change)
    instructions: 1.07 B (no change)
    heap_increase: 0 pages (no change)
    stable_memory_increase: 0 pages (no change)

---------------------------------------------------

Benchmark: btreemap
  total:
    instructions: 19.49 B (no change)
    heap_increase: 1179 pages (no change)
    stable_memory_increase: 0 pages (no change)

  1. Encoding (scope):
    calls: 1 (no change)
    instructions: 4.26 B (no change)
    heap_increase: 159 pages (no change)
    stable_memory_increase: 0 pages (no change)

  2. Decoding (scope):
    calls: 1 (no change)
    instructions: 15.23 B (no change)
    heap_increase: 1020 pages (no change)
    stable_memory_increase: 0 pages (no change)

---------------------------------------------------

Benchmark: option_list
  total:
    instructions: 33.39 M (0.76%) (change within noise threshold)
    heap_increase: 2 pages (no change)
    stable_memory_increase: 0 pages (no change)

  1. Encoding (scope):
    calls: 1 (no change)
    instructions: 7.48 M (0.01%) (change within noise threshold)
    heap_increase: 0 pages (no change)
    stable_memory_increase: 0 pages (no change)

  2. Decoding (scope):
    calls: 1 (no change)
    instructions: 25.91 M (0.98%) (change within noise threshold)
    heap_increase: 2 pages (no change)
    stable_memory_increase: 0 pages (no change)

---------------------------------------------------

Benchmark: variant_list
  total:
    instructions: 31.86 M (0.26%) (change within noise threshold)
    heap_increase: 2 pages (no change)
    stable_memory_increase: 0 pages (no change)

  1. Encoding (scope):
    calls: 1 (no change)
    instructions: 7.54 M (0.00%) (change within noise threshold)
    heap_increase: 0 pages (no change)
    stable_memory_increase: 0 pages (no change)

  2. Decoding (scope):
    calls: 1 (no change)
    instructions: 24.32 M (0.35%) (change within noise threshold)
    heap_increase: 2 pages (no change)
    stable_memory_increase: 0 pages (no change)

---------------------------------------------------

Benchmark: nns
  total:
    instructions: 23.27 M (-0.07%) (change within noise threshold)
    heap_increase: 2 pages (no change)
    stable_memory_increase: 0 pages (no change)

  0. Parsing (scope):
    calls: 1 (no change)
    instructions: 15.01 M (-0.00%) (change within noise threshold)
    heap_increase: 2 pages (no change)
    stable_memory_increase: 0 pages (no change)

  1. Encoding (scope):
    calls: 1 (no change)
    instructions: 1.96 M (no change)
    heap_increase: 0 pages (no change)
    stable_memory_increase: 0 pages (no change)

  2. Decoding (scope):
    calls: 1 (no change)
    instructions: 5.46 M (-0.28%) (change within noise threshold)
    heap_increase: 0 pages (no change)
    stable_memory_increase: 0 pages (no change)

---------------------------------------------------

Benchmark: nns_list_proposal
  total:
    instructions: 74.32 M (-0.03%) (change within noise threshold)
    heap_increase: 17 pages (no change)
    stable_memory_increase: 0 pages (no change)

  1. Encoding (scope):
    calls: 1 (no change)
    instructions: 6.83 M (-0.27%) (change within noise threshold)
    heap_increase: 3 pages (no change)
    stable_memory_increase: 0 pages (no change)

  2. Decoding (scope):
    calls: 1 (no change)
    instructions: 67.49 M (0.00%) (change within noise threshold)
    heap_increase: 14 pages (no change)
    stable_memory_increase: 0 pages (no change)

---------------------------------------------------

Benchmark: extra_args
  total:
    instructions: 3.16 M (-0.00%) (change within noise threshold)
    heap_increase: 0 pages (no change)
    stable_memory_increase: 0 pages (no change)

---------------------------------------------------

Summary:
  instructions:
    status:   No significant changes 👍
    counts:   [total 9 | regressed 0 | improved 0 | new 0 | unchanged 9]
    change:   [max +252.87K | p75 0 | median 0 | p25 -2 | min -18.71K]
    change %: [max +0.76% | p75 0.00% | median 0.00% | p25 -0.00% | min -0.07%]

  heap_increase:
    status:   No significant changes 👍
    counts:   [total 9 | regressed 0 | improved 0 | new 0 | unchanged 9]
    change:   [max 0 | p75 0 | median 0 | p25 0 | min 0]
    change %: [max 0.00% | p75 0.00% | median 0.00% | p25 0.00% | min 0.00%]

  stable_memory_increase:
    status:   No significant changes 👍
    counts:   [total 9 | regressed 0 | improved 0 | new 0 | unchanged 9]
    change:   [max 0 | p75 0 | median 0 | p25 0 | min 0]
    change %: [max 0.00% | p75 0.00% | median 0.00% | p25 0.00% | min 0.00%]

---------------------------------------------------
Successfully persisted results to canbench_results.yml

christoph-dfinity

Looks good to me. One bikeshed comment would be that src/types/syntax.rs rather than src/types/parser.rs might be a nicer name, as the idea is that it describes the syntax of candid files. Not just the parser is a consumer of this format, but also everyone that wants to generate a .did file.

ilbertt · 2025-06-18T07:26:56Z

Looks good to me. One bikeshed comment would be that src/types/syntax.rs rather than src/types/parser.rs might be a nicer name, as the idea is that it describes the syntax of candid files. Not just the parser is a consumer of this format, but also everyone that wants to generate a .did file.

@christoph-dfinity good point. I've renamed both the module and the feature flag accordingly.

ilbertt · 2025-06-18T07:33:26Z

Since this PR introduces breaking changes, I'll wait before merging it to check if the changes make sense in the branch I'm working on: https://github.com/dfinity/candid/compare/luca/idl-types-in-parser

ilbertt · 2025-06-20T16:45:04Z

@christoph-dfinity I realized I need the syntax module inside candid for the export_service macro, so I've removed the feature.

lwshang · 2025-06-24T15:43:33Z

Luca and I discussed the upcoming changes offline.

We've decided to proceed with the current PR structure for now, given the dependent work (e.g., #625). However, we'll plan to move the types into a separate, privately-dependent crate (could be named candid_syntax) before the final release.

Since development in this repo has been slow, we can continue using the master branch as our active development branch and aren't expecting any patch releases soon.

Effectively reverts #622

…650) **Overview** Effectively reverts #622.

refactor: move IDL* types into the candid crate, under the parser…

b1d118c

… feature flag

chore: update changelog and docs

6f0fd78

ilbertt marked this pull request as ready for review June 17, 2025 14:39

ilbertt requested a review from a team as a code owner June 17, 2025 14:39

refactor: map pretty error

a9aee1c

christoph-dfinity approved these changes Jun 18, 2025

View reviewed changes

refactor: rename parser to syntax

74f84c9

ilbertt added 2 commits June 20, 2025 18:39

Merge remote-tracking branch 'origin/master' into luca/candid-idl-types

2d3887d

refactor: remove "syntax" feature

3144ce6

ilbertt changed the title ~~refactor!: move IDL* types into the candid crate, under the parser feature flag~~ refactor!: move IDL* types into the candid crate Jun 20, 2025

chore: update changelog

f097c4c

ilbertt requested a review from christoph-dfinity June 20, 2025 16:45

ilbertt mentioned this pull request Jun 22, 2025

feat!: use IDL types in parser #625

Closed

ilbertt added 4 commits June 25, 2025 15:01

Merge remote-tracking branch 'origin/master' into luca/candid-idl-types

b571cb1

Merge remote-tracking branch 'origin/master' into luca/candid-idl-types

106bdc1

style: remove unused import

b93c4d8

Merge branch 'master' into luca/candid-idl-types

6694147

ilbertt merged commit b1d4a57 into master Jun 25, 2025
11 checks passed

ilbertt deleted the luca/candid-idl-types branch June 25, 2025 18:38

ilbertt added a commit that referenced this pull request Jul 21, 2025

refactor: move the syntax module from candid to candid_parser

a53f463

Effectively reverts #622

ilbertt mentioned this pull request Jul 21, 2025

refactor: move the syntax module from candid to candid_parser #650

Merged

ilbertt added a commit that referenced this pull request Jul 21, 2025

refactor: move the syntax module from candid to candid_parser (#…

dcf9129

…650) **Overview** Effectively reverts #622.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor!: move `IDL*` types into the candid crate#622

refactor!: move `IDL*` types into the candid crate#622
ilbertt merged 11 commits intomasterfrom
luca/candid-idl-types

ilbertt commented Jun 17, 2025 •

edited

Loading

Uh oh!

github-actions Bot commented Jun 17, 2025 •

edited

Loading

Uh oh!

christoph-dfinity left a comment

Uh oh!

ilbertt commented Jun 18, 2025 •

edited

Loading

Uh oh!

ilbertt commented Jun 18, 2025

Uh oh!

ilbertt commented Jun 20, 2025

Uh oh!

lwshang commented Jun 24, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

ilbertt commented Jun 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Jun 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

christoph-dfinity left a comment

Choose a reason for hiding this comment

Uh oh!

ilbertt commented Jun 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ilbertt commented Jun 18, 2025

Uh oh!

ilbertt commented Jun 20, 2025

Uh oh!

lwshang commented Jun 24, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

ilbertt commented Jun 17, 2025 •

edited

Loading

github-actions Bot commented Jun 17, 2025 •

edited

Loading

ilbertt commented Jun 18, 2025 •

edited

Loading