ABP 10.6 Angular proxy generation produces missing or incorrect imports for Audit Logging DTOs #10896

3 Answer(s)

• 

  0

  AI-Bot created 4 days ago

  Support Team ABP Agent

  • This is a bug/limitation in the Angular proxy generator (@abp/ng.schematics 10.6.0) around package DTO import resolution, and it can surface exactly as you described:

    • Your custom DTO (EntityChangeWithUsernameDto) references Volo.Abp.AuditLogging.EntityChangeDto.
    • EntityChangeDto is in VOLO_PACKAGE_PROXY_IMPORTS, so it is intentionally not generated into your local models.ts.
    • However, the model import builder can still end up not adding the required import type { EntityChangeDto } from '@volo/abp.ng.audit-logging/proxy', leaving an unbound type and causing Cannot find name 'EntityChangeDto'.

  • Verified from the ABP repo: EntityChangeDto is explicitly mapped to the audit-logging proxy package:

  export const VOLO_PACKAGE_PROXY_IMPORTS = new Map<string, string>([
      ['Volo.Abp.AuditLogging.EntityChangeDto', '@volo/abp.ng.audit-logging/proxy'],
      // ...
    ]);
  

  (from npm/ng-packs/packages/schematics/src/constants/volo.ts)

  • Workaround (safe & minimal, no schematics patch): ensure your generated DTO file has the correct import by introducing a tiny “bridge” type in your own contract so the generator is forced to import it from the package.
    1. Create a DTO in your own namespace that directly uses EntityChangeDto in a property (not only via inheritance/indirect reference). Example:

  using Volo.Abp.AuditLogging;
  
       namespace Acme.MyApp.Audit
       {
           public class EntityChangeWithUsernameDto
           {
               public EntityChangeDto Change { get; set; } = default!;
               public string? UserName { get; set; }
           }
       }
  

  2. Change your endpoint to return that DTO shape (composition instead of inheritance/flattening).
  3. Re-run:

  abp generate-proxy -t ng
  

  This typically makes the generator treat the reference as an “external” type and it will import it (and since it’s in VOLO_PACKAGE_PROXY_IMPORTS, it should import from @volo/abp.ng.audit-logging/proxy).

  • Alternative workaround (most direct, but requires re-applying after regen): add the missing import manually in the generated file that contains EntityChangeWithUsernameDto:

  import type { EntityChangeDto } from '@volo/abp.ng.audit-logging/proxy';
  

  and/or fix wrong service imports that incorrectly point to local ./models instead of the package proxy. This is consistent with what you already did locally.

  • What to do for a permanent fix (upstream):

    • The generator already has the mapping (VOLO_PACKAGE_PROXY_IMPORTS) and also has a resolveAbpPackages(models) step in utils/model.ts that rewrites import paths for model imports, but the behavior you observed indicates the import collection step can skip adding the import before that resolution can apply.
    • So this needs to be fixed inside @abp/ng.schematics so that:
      1. referenced types that are excluded from local model generation (because they are in VOLO_PACKAGE_PROXY_IMPORTS) are still imported, even if they share the same C# namespace as the current model; and
      2. service-generation import building applies the same package import mapping logic as model-generation (so services don’t accidentally import audit-logging DTOs from local ./models).

  • If you want to avoid maintaining a fork, the only “no-regeneration-maintenance” workaround today is the composition DTO approach above (return a DTO that has an EntityChangeDto property), because it tends to produce stable imports.

  (Links omitted because no specific public issue/patch URL was provided in the verified tool context for this exact 10.6.0 scenario.)

  ---

  This response was generated by AI. If it didn’t solve your problem, feel free to post a new answer — our support team will jump in to help you soon.

  Markdown supported.

  Copy, paste, or drag & drop images and files (max 100 MB per file, 100 MB total per post)

  Save Cancel
• 

  0

  rshapiro created 4 days ago

  EntityChangeWithUsernameDto is not a custom Dto it's an ABP DTO that's part of the audit logging namespace and is the return from IAuditLogsAppService.GetEntityChangesWithUsernameAsync.

  Yes, I know it's a bug but just wanted to make sure you're aware of the issue and can provide a permanent fix so that future ABP updates don't override my manual fix

  Markdown supported.

  Copy, paste, or drag & drop images and files (max 100 MB per file, 100 MB total per post)

  Save Cancel
• 

  0

  maliming created 3 days ago

  Support Team Fullstack Developer

  Hi,

  This is a bug in the Angular proxy generator. The fix is in https://github.com/abpframework/abp/pull/26212 and will be in the next release. After you upgrade, you won't need your local changes anymore.

  Until then, you can keep your changes. If you want them to stay after reinstalling packages, save them as a patch with patch-package:

  yarn add patch-package --dev
  npx patch-package @abp/ng.schematics
  

  Then add "postinstall": "patch-package" to the scripts in package.json. If you use npm, install it with npm install patch-package --save-dev instead. Remove the patch and the script after you upgrade.

  We've refunded your ticket.

  Thanks

  Markdown supported.

  Copy, paste, or drag & drop images and files (max 100 MB per file, 100 MB total per post)

  Save Cancel