Skip to content

feat(cli): seed correlation id from ATK_CLI_CORRELATION_ID env var#16222

Draft
JimmyCalhoun wants to merge 1 commit into
OfficeDev:devfrom
JimmyCalhoun:feat/cli-telemetry-correlation-id
Draft

feat(cli): seed correlation id from ATK_CLI_CORRELATION_ID env var#16222
JimmyCalhoun wants to merge 1 commit into
OfficeDev:devfrom
JimmyCalhoun:feat/cli-telemetry-correlation-id

Conversation

@JimmyCalhoun

Copy link
Copy Markdown

What

Lets a parent process that spawns the ATK CLI as a subprocess (e.g. the wiqd CLI) thread its own correlation id into this run, so both products' telemetry share one join key per invocation.

  // packages/fx-core/src/common/correlator.ts
- static setId(): string {
-   const id = uuid.v4();
+ static setId(id?: string): string {
+   const newId = id && uuid.validate(id) ? id : uuid.v4();

  // packages/cli/src/commands/engine.ts  (start())
- Correlator.setId();
+ Correlator.setId(process.env.ATK_CLI_CORRELATION_ID);
  • Correlator.setId(id?) now adopts a valid externally-supplied UUID and falls back to a freshly minted UUID when the value is absent or malformed (uuid.validate), so the correlation id is always well-formed.
  • The CLI entrypoint seeds it from process.env.ATK_CLI_CORRELATION_ID. This makes ATK's native correlation-id (already stamped on every telemetry event) equal the parent's id — no new dimension, no schema change.

Why

As wiqd adoption grows as a wrapper around ATK, there's no way today to join an ATK telemetry event back to the wiqd action that triggered it. Seeding correlation-id from an env var the parent controls closes that gap with zero new telemetry attributes on the ATK side. The env-var prefix follows the existing caller→ATK convention (ATK_CLI_SKILL), not the deprecated TEAMSFX_ brand.

Safety / backward-compat

  • Env var absent (ATK run standalone, or by an older parent): setId(undefined) → falls through to uuid.v4()byte-for-byte identical to prior behavior. The only production caller of setId is this entrypoint.
  • Env var malformed / empty: rejected by uuid.validate → fresh UUID. No injection surface (value is only ever used as a correlation id).
  • Correlator.run / runWithId paths are unchanged.

Safe to ship independently and in any order relative to the wiqd side.

Companion changes (cross-product correlation)

  • wiqd producer (injects the id): gim-home/wiqd#1339
  • wiqd un-suppress (so ATK emits in wiqd-driven runs at all): gim-home/wiqd#1332

The join key is ATK.correlation-id == wiqd.session.id. Correlation becomes visible once all three are live in the same invocation; until then every partial-deployment state degrades to "ATK mints its own id."

Testing

  • packages/fx-corevitest run tests/common/correlator.test.ts: 6/6 pass (valid id adopted; malformed → fresh; absent → fresh).
  • packages/clivitest run tests/unit/engine.tests.ts: 46/46 pass (env var present → setId(id); absent → setId(undefined)).
  • eslint + lint-staged precommit pass on both packages.

🤖 Drafted with GitHub Copilot CLI.

Allow a parent process that spawns the ATK CLI (e.g. the wiqd CLI) to
thread its own correlation id into this run, so both products' telemetry
share one join key per invocation.

- Correlator.setId(id?) now adopts a valid externally-supplied UUID and
  falls back to a freshly minted UUID when the value is absent or malformed,
  so the correlation id is always well-formed.
- The CLI entrypoint seeds it from process.env.ATK_CLI_CORRELATION_ID.

Behavior is unchanged when the env var is absent (the no-arg path), so
this is safe to ship independently of the producer side.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@microsoft-github-policy-service

Copy link
Copy Markdown
Contributor

@JimmyCalhoun please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

  • (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@microsoft-github-policy-service agree
  • (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@microsoft-github-policy-service agree company="Microsoft"
Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
and conveys certain license rights to Microsoft Corporation and its affiliates (“Microsoft”) for Your
contributions to Microsoft open source projects. This Agreement is effective as of the latest signature
date below.

  1. Definitions.
    “Code” means the computer software code, whether in human-readable or machine-executable form,
    that is delivered by You to Microsoft under this Agreement.
    “Project” means any of the projects owned or managed by Microsoft and offered under a license
    approved by the Open Source Initiative (www.opensource.org).
    “Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any
    Project, including but not limited to communication on electronic mailing lists, source code control
    systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of
    discussing and improving that Project, but excluding communication that is conspicuously marked or
    otherwise designated in writing by You as “Not a Submission.”
    “Submission” means the Code and any other copyrightable material Submitted by You, including any
    associated comments and documentation.
  2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any
    Project. This Agreement covers any and all Submissions that You, now or in the future (except as
    described in Section 4 below), Submit to any Project.
  3. Originality of Work. You represent that each of Your Submissions is entirely Your original work.
    Should You wish to Submit materials that are not Your original work, You may Submit them separately
    to the Project if You (a) retain all copyright and license information that was in the materials as You
    received them, (b) in the description accompanying Your Submission, include the phrase “Submission
    containing materials of a third party:” followed by the names of the third party and any licenses or other
    restrictions of which You are aware, and (c) follow any other instructions in the Project’s written
    guidelines concerning Submissions.
  4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else
    for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your
    Submission is made in the course of Your work for an employer or Your employer has intellectual
    property rights in Your Submission by contract or applicable law, You must secure permission from Your
    employer to make the Submission before signing this Agreement. In that case, the term “You” in this
    Agreement will refer to You and the employer collectively. If You change employers in the future and
    desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement
    and secure permission from the new employer before Submitting those Submissions.
  5. Licenses.
  • Copyright License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the
    Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute
    the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third
    parties.
  • Patent License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under
    Your patent claims that are necessarily infringed by the Submission or the combination of the
    Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and
    import or otherwise dispose of the Submission alone or with the Project.
  • Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement.
    No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are
    granted by implication, exhaustion, estoppel or otherwise.
  1. Representations and Warranties. You represent that You are legally entitled to grant the above
    licenses. You represent that each of Your Submissions is entirely Your original work (except as You may
    have disclosed under Section 3). You represent that You have secured permission from Your employer to
    make the Submission in cases where Your Submission is made in the course of Your work for Your
    employer or Your employer has intellectual property rights in Your Submission by contract or applicable
    law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You
    have the necessary authority to bind the listed employer to the obligations contained in this Agreement.
    You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS
    REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES
    EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS
    PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF
    NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
  2. Notice to Microsoft. You agree to notify Microsoft in writing of any facts or circumstances of which
    You later become aware that would make Your representations in this Agreement inaccurate in any
    respect.
  3. Information about Submissions. You agree that contributions to Projects and information about
    contributions may be maintained indefinitely and disclosed publicly, including Your name and other
    information that You submit with Your Submission.
  4. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and
    the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County,
    Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to
    exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all
    defenses of lack of personal jurisdiction and forum non-conveniens.
  5. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and
    supersedes any and all prior agreements, understandings or communications, written or oral, between
    the parties relating to the subject matter hereof. This Agreement may be assigned by Microsoft.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant