feat(plugins-portlet): migrate OSGi Plugins portlet from Dojo to Angular #34732

core-web/apps/dotcms-ui/src/app/app.routes.ts

@@ -157,9 +157,19 @@ const PORTLETS_ANGULAR: Route[] = [
     },
     {
         path: 'tags',
+        canActivate: [MenuGuardService],
+        canActivateChild: [MenuGuardService],
         data: { reuseRoute: false },
         loadChildren: () => import('@dotcms/portlets/dot-tags/portlet').then((m) => m.dotTagsRoutes)
     },
+    {
+        path: 'plugins',
+        canActivate: [MenuGuardService],
+        canActivateChild: [MenuGuardService],
+        data: { reuseRoute: false },
+        loadChildren: () =>
+            import('@dotcms/portlets/dot-plugins/portlet').then((m) => m.dotPluginsRoutes)
+    },
     {
         path: '',
         canActivate: [MenuGuardService],

core-web/libs/data-access/src/index.ts

@@ -72,3 +72,5 @@ export * from './lib/dot-page-contenttype/dot-page-contenttype.service';
 export * from './lib/dot-favorite-contenttype/dot-favorite-contenttype.service';
 export * from './lib/dot-content-drive/dot-content-drive.service';
 export * from './lib/dot-usage/dot-usage.service';
+export * from './lib/dot-osgi/bundle-map.model';
+export * from './lib/dot-osgi/dot-osgi.service';

core-web/libs/data-access/src/lib/dot-osgi/bundle-map.model.ts

@@ -0,0 +1,50 @@
+/**
+ * OSGi bundle representation matching backend BundleMap.
+ * @see dotCMS OSGIResource ResponseEntityBundleListView
+ */
+
+/**
+ * Sentinel value accepted by the backend's extra-packages PUT endpoint to reset
+ * the exported-packages list to its installation defaults.
+ * @see OSGIResource#updateExtraPackages
+ */
+export const OSGI_EXTRA_PACKAGES_RESET = 'RESET';
+
+/** OSGi bundle states (org.osgi.framework.Bundle constants). */
+export const BUNDLE_STATE = {
+    UNINSTALLED: 1,
+    INSTALLED: 2,
+    RESOLVED: 4,
+    STARTING: 8,
+    STOPPING: 16,
+    ACTIVE: 32
+} as const;
+
+/** Union of valid OSGi bundle state integers (values of {@link BUNDLE_STATE}). */
+export type OsgiBundleState = (typeof BUNDLE_STATE)[keyof typeof BUNDLE_STATE];
+
+export interface BundleMap {
+    bundleId: number;
+    symbolicName: string;
+    location: string;
+    jarFile: string;
+    state: OsgiBundleState;
+    version: string;
+    separator: string;
+    isSystem: boolean;
+    javaVersion?: string;
+    javaClassVersion?: number;
+    isMultiRelease?: boolean;
+    isBuiltWithMaven?: boolean;
+    usesDotcmsApis?: boolean;
+    dotcmsCoreDependencyVersion?: string;
+}
+
+/** Unified row model for the plugins table (installed bundles + undeployed jars). */
+export interface PluginRow {
+    jarFile: string;
+    symbolicName: string;
+    state: OsgiBundleState | 'undeployed';
+    bundleId?: number;
+    version?: string;
+}

core-web/libs/data-access/src/lib/dot-osgi/dot-osgi.service.spec.ts

@@ -0,0 +1,179 @@
+import { createHttpFactory, HttpMethod, SpectatorHttp } from '@ngneat/spectator/jest';
+
+import { BUNDLE_STATE, BundleMap } from './bundle-map.model';
+import { DotOsgiService } from './dot-osgi.service';
+
+function mockBundle(overrides: Partial<BundleMap> = {}): BundleMap {
+    return {
+        bundleId: 1,
+        symbolicName: 'test',
+        location: 'file:plugins/test.jar',
+        jarFile: 'test.jar',
+        state: BUNDLE_STATE.ACTIVE,
+        version: '1.0.0',
+        separator: '|',
+        isSystem: false,
+        ...overrides
+    };
+}
+
+describe('DotOsgiService', () => {
+    let spectator: SpectatorHttp<DotOsgiService>;
+
+    const createHttp = createHttpFactory({
+        service: DotOsgiService
+    });
+
+    beforeEach(() => {
+        spectator = createHttp();
+    });
+
+    describe('getInstalledBundles', () => {
+        it('should GET with ignoresystembundles=false by default', () => {
+            const entity = [mockBundle()];
+            spectator.service.getInstalledBundles().subscribe((res) => {
+                expect(res.entity).toEqual(entity);
+            });
+            const req = spectator.expectOne(
+                '/api/v1/osgi?ignoresystembundles=false',
+                HttpMethod.GET
+            );
+            req.flush({ entity });
+        });
+
+        it('should GET with ignoresystembundles=false when passed explicitly', () => {
+            spectator.service.getInstalledBundles(false).subscribe();
+            spectator.expectOne('/api/v1/osgi?ignoresystembundles=false', HttpMethod.GET).flush({});
+        });
+
+        it('should GET with ignoresystembundles=true when requested', () => {
+            spectator.service.getInstalledBundles(true).subscribe();
+            spectator.expectOne('/api/v1/osgi?ignoresystembundles=true', HttpMethod.GET).flush({});
+        });
+    });
+
+    describe('getAvailablePlugins', () => {
+        it('should GET available-plugins', () => {
+            const entity = ['plugin1.jar', 'plugin2.jar'];
+            spectator.service.getAvailablePlugins().subscribe((res) => {
+                expect(res.entity).toEqual(entity);
+            });
+            const req = spectator.expectOne('/api/v1/osgi/available-plugins', HttpMethod.GET);
+            req.flush({ entity });
+        });
+    });
+
+    describe('uploadBundles', () => {
+        it('should POST FormData with each file under key "file"', () => {
+            const fileA = new File(['a'], 'a.jar', { type: 'application/java-archive' });
+            const fileB = new File(['b'], 'b.jar', { type: 'application/java-archive' });
+
+            spectator.service.uploadBundles([fileA, fileB]).subscribe();
+
+            const req = spectator.expectOne('/api/v1/osgi', HttpMethod.POST);
+            expect(req.request.body).toBeInstanceOf(FormData);
+            const body = req.request.body as FormData;
+            expect(body.getAll('file')).toEqual([fileA, fileB]);
+            req.flush({});
+        });
+    });
+
+    describe('deploy', () => {
+        it('should PUT deploy URL with plain jar name', () => {
+            spectator.service.deploy('my.jar').subscribe();
+            const req = spectator.expectOne('/api/v1/osgi/jar/my.jar/_deploy', HttpMethod.PUT);
+            expect(req.request.body).toEqual({});
+            req.flush({});
+        });
+
+        it('should encode jar name in deploy path', () => {
+            spectator.service.deploy('my plugin.jar').subscribe();
+            spectator
+                .expectOne('/api/v1/osgi/jar/my%20plugin.jar/_deploy', HttpMethod.PUT)
+                .flush({});
+        });
+    });
+
+    describe('start', () => {
+        it('should PUT start URL', () => {
+            spectator.service.start('my.jar').subscribe();
+            const req = spectator.expectOne('/api/v1/osgi/jar/my.jar/_start', HttpMethod.PUT);
+            expect(req.request.body).toEqual({});
+            req.flush({});
+        });
+
+        it('should encode jar name in start path', () => {
+            spectator.service.start('a/b.jar').subscribe();
+            spectator.expectOne('/api/v1/osgi/jar/a%2Fb.jar/_start', HttpMethod.PUT).flush({});
+        });
+    });
+
+    describe('stop', () => {
+        it('should PUT stop URL', () => {
+            spectator.service.stop('my.jar').subscribe();
+            const req = spectator.expectOne('/api/v1/osgi/jar/my.jar/_stop', HttpMethod.PUT);
+            expect(req.request.body).toEqual({});
+            req.flush({});
+        });
+    });
+
+    describe('undeploy', () => {
+        it('should DELETE jar URL', () => {
+            spectator.service.undeploy('my.jar').subscribe();
+            spectator.expectOne('/api/v1/osgi/jar/my.jar', HttpMethod.DELETE).flush({});
+        });
+
+        it('should encode jar name in undeploy path', () => {
+            spectator.service.undeploy('x+y.jar').subscribe();
+            spectator.expectOne('/api/v1/osgi/jar/x%2By.jar', HttpMethod.DELETE).flush({});
+        });
+    });
+
+    describe('processExports', () => {
+        it('should GET processExports with encoded bundle symbolic name', () => {
+            spectator.service.processExports('com.example.plugin').subscribe();
+            spectator
+                .expectOne('/api/v1/osgi/_processExports/com.example.plugin', HttpMethod.GET)
+                .flush({});
+        });
+
+        it('should encode special characters in bundle name', () => {
+            spectator.service.processExports('bundle name').subscribe();
+            spectator
+                .expectOne('/api/v1/osgi/_processExports/bundle%20name', HttpMethod.GET)
+                .flush({});
+        });
+    });
+
+    describe('getExtraPackages', () => {
+        it('should GET extra-packages', () => {
+            const entity = 'pkg1;version=1\npkg2;version=2';
+            spectator.service.getExtraPackages().subscribe((res) => {
+                expect(res.entity).toEqual(entity);
+            });
+            const req = spectator.expectOne('/api/v1/osgi/extra-packages', HttpMethod.GET);
+            req.flush({ entity });
+        });
+    });
+
+    describe('updateExtraPackages', () => {
+        it('should PUT extra-packages with body', () => {
+            const packages = 'com.foo;version=1';
+            spectator.service.updateExtraPackages(packages).subscribe((res) => {
+                expect(res.entity).toEqual(packages);
+            });
+            const req = spectator.expectOne('/api/v1/osgi/extra-packages', HttpMethod.PUT);
+            expect(req.request.body).toEqual({ packages });
+            req.flush({ entity: packages });
+        });
+    });
+
+    describe('restart', () => {
+        it('should PUT _restart with empty body', () => {
+            spectator.service.restart().subscribe();
+            const req = spectator.expectOne('/api/v1/osgi/_restart', HttpMethod.PUT);
+            expect(req.request.body).toEqual({});
+            req.flush({});
+        });
+    });
+});

core-web/libs/data-access/src/lib/dot-osgi/dot-osgi.service.ts

@@ -0,0 +1,83 @@
+import { Observable } from 'rxjs';
+
+import { HttpClient, HttpParams } from '@angular/common/http';
+import { Injectable, inject } from '@angular/core';
+
+import { DotCMSAPIResponse } from '@dotcms/dotcms-models';
+
+import { BundleMap } from './bundle-map.model';
+
+const OSGI_BASE = '/api/v1/osgi';
+
+@Injectable({
+    providedIn: 'root'
+})
+export class DotOsgiService {
+    readonly #http = inject(HttpClient);
+
+    getInstalledBundles(ignoreSystemBundles = false): Observable<DotCMSAPIResponse<BundleMap[]>> {
+        const params = new HttpParams().set('ignoresystembundles', String(ignoreSystemBundles));
+        return this.#http.get<DotCMSAPIResponse<BundleMap[]>>(OSGI_BASE, { params });
+    }
+
+    getAvailablePlugins(): Observable<DotCMSAPIResponse<string[]>> {
+        return this.#http.get<DotCMSAPIResponse<string[]>>(`${OSGI_BASE}/available-plugins`);
+    }
+
+    uploadBundles(files: File[]): Observable<DotCMSAPIResponse<unknown>> {
+        const formData = new FormData();
+        files.forEach((file) => formData.append('file', file, file.name));
+        return this.#http.post<DotCMSAPIResponse<unknown>>(OSGI_BASE, formData);
+    }
+
+    deploy(jar: string): Observable<DotCMSAPIResponse<unknown>> {
+        return this.#http.put<DotCMSAPIResponse<unknown>>(
+            `${OSGI_BASE}/jar/${encodeURIComponent(jar)}/_deploy`,
+            {}
+        );
+    }
+
+    start(jar: string): Observable<DotCMSAPIResponse<unknown>> {
+        return this.#http.put<DotCMSAPIResponse<unknown>>(
+            `${OSGI_BASE}/jar/${encodeURIComponent(jar)}/_start`,
+            {}
+        );
+    }
+
+    stop(jar: string): Observable<DotCMSAPIResponse<unknown>> {
+        return this.#http.put<DotCMSAPIResponse<unknown>>(
+            `${OSGI_BASE}/jar/${encodeURIComponent(jar)}/_stop`,
+            {}
+        );
+    }
+
+    undeploy(jar: string): Observable<DotCMSAPIResponse<unknown>> {
+        return this.#http.delete<DotCMSAPIResponse<unknown>>(
+            `${OSGI_BASE}/jar/${encodeURIComponent(jar)}`
+        );
+    }
+
+    processExports(bundle: string): Observable<DotCMSAPIResponse<unknown>> {
+        return this.#http.get<DotCMSAPIResponse<unknown>>(
+            `${OSGI_BASE}/_processExports/${encodeURIComponent(bundle)}`
+        );
+    }
+
+    getExtraPackages(): Observable<DotCMSAPIResponse<string>> {
+        return this.#http.get<DotCMSAPIResponse<string>>(`${OSGI_BASE}/extra-packages`);
+    }
+
+    updateExtraPackages(packages: string): Observable<DotCMSAPIResponse<string>> {
+        return this.#http.put<DotCMSAPIResponse<string>>(`${OSGI_BASE}/extra-packages`, {
+            packages
+        });
+    }
+
+    /**
+     * Restarts the OSGI framework and all dynamic plugins (cluster-wide).
+     * Returns the server message (e.g. "OSGI Framework Restarted") on success.
+     */
+    restart(): Observable<DotCMSAPIResponse<unknown>> {
+        return this.#http.put<DotCMSAPIResponse<unknown>>(`${OSGI_BASE}/_restart`, {});
+    }
+}

core-web/libs/portlets/dot-plugins/.eslintrc.json

@@ -0,0 +1,18 @@
+{
+    "extends": ["../../../.eslintrc.base.json"],
+    "ignorePatterns": ["!**/*"],
+    "overrides": [
+        {
+            "files": ["*.ts", "*.tsx", "*.js", "*.jsx"],
+            "rules": {}
+        },
+        {
+            "files": ["*.ts", "*.tsx"],
+            "rules": {}
+        },
+        {
+            "files": ["*.js", "*.jsx"],
+            "rules": {}
+        }
+    ]
+}

core-web/libs/portlets/dot-plugins/README.md

@@ -0,0 +1,11 @@
+# dot-plugins portlet
+
+Plugins admin UI (OSGi bundles list, upload, exported packages).
+
+## Tests
+
+```bash
+yarn nx run portlets-dot-plugins-portlet:test
+```
+
+Entry: `@dotcms/portlets/dot-plugins/portlet` → `dotPluginsRoutes` (`DotPluginsShellComponent`).

core-web/libs/portlets/dot-plugins/jest.config.ts

@@ -0,0 +1,22 @@
+export default {
+    displayName: 'portlets-dot-plugins-portlet',
+    preset: '../../../jest.preset.js',
+    setupFilesAfterEnv: ['<rootDir>/src/test-setup.ts'],
+    coverageDirectory: '../../../coverage/libs/portlets/dot-plugins',
+    transform: {
+        '^.+\\.(ts|mjs|js|html)$': [
+            'jest-preset-angular',
+            {
+                isolatedModules: true,
+                tsconfig: '<rootDir>/tsconfig.spec.json',
+                stringifyContentPathRegex: '\\.(html|svg)$'
+            }
+        ]
+    },
+    transformIgnorePatterns: ['node_modules/(?!.*\\.mjs$)'],
+    snapshotSerializers: [
+        'jest-preset-angular/build/serializers/no-ng-attributes',
+        'jest-preset-angular/build/serializers/ng-snapshot',
+        'jest-preset-angular/build/serializers/html-comment'
+    ]
+};