Fix outdated NodeJS Extensions documentation - update package installation examples to use callback API#815
Merged
Merged
Conversation
…ation examples to use callback API instead of array API Co-authored-by: aaronpowell <434140+aaronpowell@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Outdated doc, passing additional args to npm/yarn/Pnpm is no longer an array but an callback instead
Fix outdated NodeJS Extensions documentation - update package installation examples to use callback API
Aug 28, 2025
aaronpowell
approved these changes
Aug 28, 2025
Contributor
Minimum allowed line rate is |
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR fixes outdated documentation examples in the NodeJS Extensions README by updating package installation code snippets to use the current callback-based API instead of the deprecated array-based API that was changed in PR #740.
- Updates three package manager examples (npm, yarn, pnpm) to use callback-based configuration
- Replaces old
args: ["..."]syntax with newconfigureInstaller => { configureInstaller.WithArgs("..."); }pattern - Ensures documentation matches the actual implementation and test examples
This was referenced Sep 1, 2025
This was referenced Sep 26, 2025
axies20
added a commit
to axies20/CommunityToolkit.Aspire
that referenced
this pull request
Nov 30, 2025
- Introduced `CommunityToolkit.Aspire.Hosting.Logto` project for integrating Logto with PostgreSQL and Redis. - Added extension methods for configuring Logto containers, health checks, and resource dependencies. - Created test projects for validating Logto container configuration and health checks. - Added example projects under `examples/logto` showcasing Logto integration with PostgreSQL and Redis. - Updated solution file and package references to include the new Logto project.
aaronpowell
added a commit
that referenced
this pull request
Jun 17, 2026
* Add Logto with PostgreSQL and Redis integration (#815) - Introduced `CommunityToolkit.Aspire.Hosting.Logto` project for integrating Logto with PostgreSQL and Redis. - Added extension methods for configuring Logto containers, health checks, and resource dependencies. - Created test projects for validating Logto container configuration and health checks. - Added example projects under `examples/logto` showcasing Logto integration with PostgreSQL and Redis. - Updated solution file and package references to include the new Logto project. * Add Logto client hosting support (#817) - Introduced `CommunityToolkit.Aspire.Hosting.Logto.Client` project for integrating Logto client configuration. - Added `LogtoClientBuilder` for seamless setup of Logto client services in `IHostApplicationBuilder`. - Implemented connection string helper for parsing Logto connection strings. - Updated solution and centralized package references to include the new project. * Add Logto Client API example project - Introduced `CommunityToolkit.Aspire.Hosting.Logto.ClientApi` under `examples/logto` to demonstrate Logto client integration. - Added project configuration files (`Program.cs`, `appsettings.json`, `launchSettings.json`) for application setup. - Renamed `AddLogtoClient` to `AddLogtoSDKClient` in `LogtoClientBuilder`. - Updated solution and centralized package references to include the new example project and dependencies. * Add tests and enhancements for Logto Client integration - Introduced a new test project `CommunityToolkit.Aspire.Hosting.Logto.Client.Tests` for validating Logto client behavior. - Added integration and unit tests for `LogtoClientBuilder` and `LogtoConnectionStringHelper`. - Implemented OIDC authentication and JWT bearer support in `LogtoClientBuilder`. - Extended `Program.cs` in `ClientApi` example with authentication routes (`/me`, `/signin`, `/signout`). - Updated dependencies and centralized package references for added functionalities. - Modified project and solution files to include updated references. * Refactor Logto client integration - Updated method names from `AddLogtoSDKClient` to `AddLogtoOIDC` for better alignment with OIDC usage. - Enhanced `AddLogtoOIDC` and `AddLogtoJwtBearer` methods to support additional configuration options. - Added `Microsoft.Extensions.DependencyInjection.Abstractions` package reference to support service registration. - Updated tests to reflect the method renaming and new configuration capabilities. - Extended `Program.cs` in the ClientApi example to include `UseAuthentication` and `UseAuthorization`. - Improved consistency and readability of XML documentation across updated methods. - Centralized package references for additional dependencies in `Directory.Packages.props`. * Remove unused `/signout` route from ClientApi example * Rename `ClientApi` example to `ClientOIDC` and update method signatures - Changed the `ClientApi` project to `ClientOIDC` for better alignment with OIDC standards. - Updated method signatures in `LogtoClientBuilder` to use `appIndeficator` instead of `appId` and support multiple audience identifiers. - Improved XML documentation consistency for updated methods. - Adjusted solution, project references, and configuration files to reflect the renaming and API changes. * Add `ClientJWT` example with Logto JWT authentication support - Introduced `CommunityToolkit.Aspire.Hosting.Logto.ClientJWT` project under `examples/logto` to demonstrate Logto JWT authentication. - Configured authentication and authorization middleware with Logto's JWT Bearer scheme in `Program.cs`. - Added example routes (`/secure` and `/tokens`) for testing secured endpoint access and token retrieval. - Updated `AppHost` to include `ClientJWT` project as a dependency. - Improved XML documentation for `AddLogtoJwtBearer` methods, including updated parameter descriptions and exception handling. * Update examples/logto/CommunityToolkit.Aspire.Hosting.Logto.AppHost/CommunityToolkit.Aspire.Hosting.Logto.AppHost.csproj Co-authored-by: Aaron Powell <me@aaron-powell.com> * Update src/CommunityToolkit.Aspire.Hosting.Logto.Client/CommunityToolkit.Aspire.Hosting.Logto.Client.csproj Co-authored-by: Aaron Powell <me@aaron-powell.com> * Remove unused package references and resolve merge conflict in project and package configuration files * Update package versions and project SDKs for Logto client integration - Upgraded `Aspire.AppHost.Sdk` from `13.0.0` to `13.2.0` in `examples/logto/CommunityToolkit.Aspire.Hosting.Logto.AppHost.csproj`. - Added `Microsoft.AspNetCore.Authentication.JwtBearer` and `Microsoft.AspNetCore.Authentication.OpenIdConnect` package versions to `Directory.Packages.props`. * Update `ClientJWT` example to use a constant for API audience in Logto JWT configuration - Replaced hardcoded API audience with a `const` string in `Program.cs` for improved readability and maintainability. * Remove `<IsPreview>` property from Logto project * Rename `Hosting.Logto.Client` to `Logto.Client` and adjust related references - Renamed `CommunityToolkit.Aspire.Hosting.Logto.Client` to `CommunityToolkit.Aspire.Logto.Client` for improved namespace consistency. - Updated all project, namespace, and solution references to reflect the renaming. - Adjusted example projects (`ClientJWT` and `ClientOIDC`) and `AppHost` references accordingly. * Add `WithDeprecationTracing` method to enable Node.js deprecation tracing in Logto container * Add `Hosting.Logto.Tests` and `Logto.Client.Tests` to test matrix in GitHub Actions * Refactor Logto configuration: introduce validation for Logto options and add support for data volume mapping. * Refactor `AppHostTest` to use `AspireIntegrationTestFixture`; add `AppHost` project reference to test project * Allow null `port` and `adminPort` in `WithResourcePort` to enable random host port assignment. * Update Logto container tag to v1.38 * Refactor `LogtoContainerResource` to `LogtoResource` and update related APIs and tests. Streamline naming for consistency. * Set default HTTP and admin ports in `WithResourcePort` method of `LogtoBuilderExtensions`. * Update examples/logto/CommunityToolkit.Aspire.Hosting.Logto.AppHost/CommunityToolkit.Aspire.Hosting.Logto.AppHost.csproj * Add Logto integration: introduce `LogtoResource` and client builders with OIDC and JWT Bearer configurations. Update APIs, examples, and tests. * Apply suggestion from @aaronpowell * Fixing build errors * Fix Logto test startup Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * not using persisted db This seems to be messing with local dev auth from postgres. * Testing a better endpoint * deleting the generated files * Adding missing README.md --------- Co-authored-by: Aaron Powell <me@aaron-powell.com> Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The documentation in the NodeJS Extensions README was showing outdated examples for passing additional arguments to package managers during installation. The examples were using the old array-based API that was changed to a callback-based API in PR #740.
Before (incorrect):
After (correct):
Updated all three package manager examples (npm, yarn, and pnpm) in the "Package installation with custom flags" section to use the current callback-based configuration API that matches the actual implementation and test examples.
Fixes #807.
Warning
Firewall rules blocked me from connecting to one or more addresses (expand for details)
I tried to connect to the following addresses, but was blocked by firewall rules:
dnceng.pkgs.visualstudio.comdotnet build(dns block)dotnet test --no-build --verbosity normal(dns block)If you need me to access, download, or install something from one of these locations, you can either:
💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.