refactor: turn meta service into abstract class with factory provider (…

…#873)
davidlj95 · Oct 2, 2024 · 1fdf846 · 1fdf846
1 parent ae0f46d
commit 1fdf846
Show file tree

Hide file tree

Showing 7 changed files with 59 additions and 70 deletions.
diff --git a/projects/ngx-meta/api-extractor/ngx-meta.api.md b/projects/ngx-meta/api-extractor/ngx-meta.api.md
@@ -132,19 +132,6 @@ export const _maybeNonHttpUrlDevMessage: (url: string | URL | undefined | null,
 // @internal
 export const _maybeTooLongDevMessage: (value: string | undefined | null, maxLength: number, opts: _FormatDevMessageOptions) => void;
 
-// @internal (undocumented)
-interface MetadataRegistry {
-    // (undocumented)
-    readonly findByGlobalOrJsonPath: (globalOrJsonPath: string) => Iterable<NgxMetaMetadataManager>;
-    // (undocumented)
-    readonly getAll: () => Iterable<NgxMetaMetadataManager>;
-    // (undocumented)
-    readonly register: (manager: NgxMetaMetadataManager) => void;
-}
-
-// @internal (undocumented)
-type MetadataResolver = (values: MetadataValues, resolverOptions: MetadataResolverOptions) => unknown;
-
 // @public
 export interface MetadataResolverOptions {
     readonly global?: string;
@@ -225,13 +212,10 @@ export class NgxMetaRoutingModule {
 }
 
 // @public
-export class NgxMetaService {
-    // Warning: (ae-forgotten-export) The symbol "MetadataRegistry" needs to be exported by the entry point all-entry-points.d.ts
-    // Warning: (ae-forgotten-export) The symbol "MetadataResolver" needs to be exported by the entry point all-entry-points.d.ts
-    constructor(registry: MetadataRegistry, resolver: MetadataResolver);
-    clear(): void;
-    set(values?: MetadataValues): void;
-    setOne(globalOrJsonPath: string, value: unknown): void;
+export abstract class NgxMetaService {
+    abstract clear(): void;
+    abstract set(values?: MetadataValues): void;
+    abstract setOne(globalOrJsonPath: string, value: unknown): void;
 }
 
 // @public

diff --git a/projects/ngx-meta/src/core/src/managers/metadata-registry.ts b/projects/ngx-meta/src/core/src/managers/metadata-registry.ts
@@ -4,9 +4,6 @@ import {
   NgxMetaMetadataManager,
 } from './ngx-meta-metadata-manager'
 
-/**
- * @internal
- */
 export interface MetadataRegistry {
   readonly register: (manager: NgxMetaMetadataManager) => void
   readonly getAll: () => Iterable<NgxMetaMetadataManager>

diff --git a/projects/ngx-meta/src/core/src/providers/provide-ngx-meta-core.ts b/projects/ngx-meta/src/core/src/providers/provide-ngx-meta-core.ts
@@ -1,5 +1,6 @@
 import { EnvironmentProviders, makeEnvironmentProviders } from '@angular/core'
 import { CoreFeatures, providersFromCoreFeatures } from './core-feature'
+import { provideNgxMetaService } from '../service/ngx-meta.service'
 
 /**
  * Provides `ngx-meta`'s core library services.
@@ -20,4 +21,7 @@ import { CoreFeatures, providersFromCoreFeatures } from './core-feature'
 export const provideNgxMetaCore = (
   ...features: CoreFeatures
 ): EnvironmentProviders =>
-  makeEnvironmentProviders(providersFromCoreFeatures(features))
+  makeEnvironmentProviders([
+    provideNgxMetaService(),
+    providersFromCoreFeatures(features),
+  ])
diff --git a/projects/ngx-meta/src/core/src/resolvers/metadata-resolver.ts b/projects/ngx-meta/src/core/src/resolvers/metadata-resolver.ts
@@ -40,9 +40,6 @@ export const METADATA_RESOLVER = new InjectionToken<MetadataResolver>(
   },
 )
 
-/**
- * @internal
- */
 export type MetadataResolver = (
   values: MetadataValues,
   resolverOptions: MetadataResolverOptions,

diff --git a/projects/ngx-meta/src/core/src/service/ngx-meta.service.spec.ts b/projects/ngx-meta/src/core/src/service/ngx-meta.service.spec.ts
@@ -1,5 +1,5 @@
 import { TestBed } from '@angular/core/testing'
-import { NgxMetaService } from './ngx-meta.service'
+import { NgxMetaService, provideNgxMetaService } from './ngx-meta.service'
 import { MockProvider } from 'ng-mocks'
 import { makeMetadataManagerSpy } from '../managers/__tests__/make-metadata-manager-spy'
 import { enableAutoSpy } from '@/ngx-meta/test/enable-auto-spy'
@@ -76,7 +76,7 @@ describe('Main service', () => {
 function makeSut() {
   TestBed.configureTestingModule({
     providers: [
-      NgxMetaService,
+      provideNgxMetaService(),
       MockProvider(
         METADATA_REGISTRY,
         jasmine.createSpyObj<MetadataRegistry>(['getAll']),

diff --git a/projects/ngx-meta/src/core/src/service/ngx-meta.service.ts b/projects/ngx-meta/src/core/src/service/ngx-meta.service.ts
@@ -1,13 +1,7 @@
-import { Inject, Injectable } from '@angular/core'
 import { MetadataValues } from './metadata-values'
-import {
-  METADATA_REGISTRY,
-  MetadataRegistry,
-} from '../managers/metadata-registry'
-import {
-  METADATA_RESOLVER,
-  MetadataResolver,
-} from '../resolvers/metadata-resolver'
+import { FactoryProvider, inject } from '@angular/core'
+import { METADATA_REGISTRY } from '../managers/metadata-registry'
+import { METADATA_RESOLVER } from '../resolvers/metadata-resolver'
 import { _formatDevMessage } from '../messaging'
 import { MODULE_NAME } from '../module-name'
 
@@ -16,13 +10,7 @@ import { MODULE_NAME } from '../module-name'
  *
  * @public
  */
-@Injectable({ providedIn: 'root' })
-export class NgxMetaService {
-  constructor(
-    @Inject(METADATA_REGISTRY) private readonly registry: MetadataRegistry,
-    @Inject(METADATA_RESOLVER) private readonly resolver: MetadataResolver,
-  ) {}
-
+export abstract class NgxMetaService {
   /**
    * Sets the metadata values of the current page
    *
@@ -45,12 +33,7 @@ export class NgxMetaService {
    *
    * @param values - Metadata values to set, as a JSON object
    */
-  public set(values: MetadataValues = {}): void {
-    const allMetadata = this.registry.getAll()
-    for (const metadata of allMetadata) {
-      metadata.set(this.resolver(values, metadata.resolverOptions))
-    }
-  }
+  abstract set(values?: MetadataValues): void
 
   /**
    * Sets a metadata value for the page
@@ -87,26 +70,47 @@ export class NgxMetaService {
    *                           argument.
    * @param value - Value to set for matching metadata elements
    */
-  public setOne(globalOrJsonPath: string, value: unknown): void {
-    const managers = this.registry.findByGlobalOrJsonPath(globalOrJsonPath)
-    /* istanbul ignore next - not unit tested hence no warning test */
-    if (ngDevMode && [...managers].length === 0) {
-      console.warn(
-        _formatDevMessage(
-          'no metadata managers found for global or JSON Path',
-          { module: MODULE_NAME, value: globalOrJsonPath },
-        ),
-      )
-    }
-    for (const manager of managers) {
-      manager.set(value)
-    }
-  }
+  abstract setOne(globalOrJsonPath: string, value: unknown): void
 
   /**
    * Clears all managed metadata elements of the current page
    */
-  public clear(): void {
-    this.set()
-  }
+  abstract clear(): void
 }
+
+export const provideNgxMetaService: () => FactoryProvider = () => ({
+  provide: NgxMetaService,
+  useFactory: (): NgxMetaService => {
+    const registry = inject(METADATA_REGISTRY)
+    const resolver = inject(METADATA_RESOLVER)
+    return {
+      set(values = {}) {
+        const allMetadata = registry.getAll()
+        for (const metadata of allMetadata) {
+          metadata.set(resolver(values, metadata.resolverOptions))
+        }
+      },
+      setOne(globalOrJsonPath, value) {
+        const managers = registry.findByGlobalOrJsonPath(globalOrJsonPath)
+        /* istanbul ignore next - not unit tested hence no warning test */
+        if (ngDevMode && [...managers].length === 0) {
+          console.warn(
+            _formatDevMessage(
+              'no metadata managers found for global or JSON Path',
+              {
+                module: MODULE_NAME,
+                value: globalOrJsonPath,
+              },
+            ),
+          )
+        }
+        for (const manager of managers) {
+          manager.set(value)
+        }
+      },
+      clear() {
+        this.set()
+      },
+    }
+  },
+})
diff --git a/projects/ngx-meta/src/routing/src/listener/router-listener.spec.ts b/projects/ngx-meta/src/routing/src/listener/router-listener.spec.ts
@@ -118,7 +118,10 @@ function makeSut(
   TestBed.configureTestingModule({
     providers: [
       MockProvider(Router, { events: events$ }),
-      MockProvider(NgxMetaService),
+      MockProvider(
+        NgxMetaService,
+        jasmine.createSpyObj<NgxMetaService>(['set']),
+      ),
     ],
   })