@theia/plugin-ext 1.75.0-next.3 → 1.75.0-next.34

package/src/hosted/node/scanners/scanner-theia.spec.ts

@@ -21,7 +21,7 @@ import * as os from 'os';
 import * as path from 'path';
 import * as fs from 'fs';
 import { AbstractPluginScanner, TheiaPluginScanner } from './scanner-theia';
-import { PluginPackage, PluginEntryPoint } from '../../../common/plugin-protocol';
+import { PluginPackage, PluginEntryPoint, PluginPackageWalkthrough, WalkthroughContribution } from '../../../common/plugin-protocol';
 import { PreferenceSchema } from '@theia/core/lib/common/preferences/preference-schema';
 import URI from '@theia/core/lib/common/uri';
 
@@ -206,3 +206,227 @@ describe('TheiaPluginScanner configuration default derivation', () => {
         expect(props['ext.nullable'].default).to.equal(null);
     });
 });
+
+describe('TheiaPluginScanner - readWalkthroughs', () => {
+    let scannerInstance: TheiaPluginScanner;
+
+    before(() => {
+        scannerInstance = new (TheiaPluginScanner as any)();
+        (scannerInstance as any).logger = { error: () => { }, warn: () => { }, info: () => { }, debug: () => { } };
+    });
+
+    function callReadWalkthroughs(
+        walkthroughs: PluginPackageWalkthrough[],
+        publisher = 'test-publisher',
+        name = 'test-plugin',
+        icon?: string
+    ): WalkthroughContribution[] | undefined {
+        const pkg = {
+            name,
+            publisher,
+            version: '1.0.0',
+            icon,
+            contributes: { walkthroughs }
+        } as any;
+        return (scannerInstance as any).readWalkthroughs(pkg);
+    }
+
+    it('should resolve the icon of the contributing extension', () => {
+        const result = callReadWalkthroughs([{
+            id: 'wt1',
+            title: 'WT',
+            description: 'desc',
+            steps: [{ id: 's1', title: 'S1', description: 'd1' }]
+        }], 'test-publisher', 'test-plugin', 'images/icon.png');
+
+        expect(result![0].pluginIcon).to.equal('hostedPlugin/test_publisher_test_plugin/images/icon.png');
+    });
+
+    it('should leave the extension icon undefined when the package declares none', () => {
+        const result = callReadWalkthroughs([{
+            id: 'wt1',
+            title: 'WT',
+            description: 'desc',
+            steps: [{ id: 's1', title: 'S1', description: 'd1' }]
+        }]);
+
+        expect(result![0].pluginIcon).to.be.undefined;
+    });
+
+    it('should read a valid walkthrough contribution', () => {
+        const result = callReadWalkthroughs([{
+            id: 'my-walkthrough',
+            title: 'My Walkthrough',
+            description: 'A test walkthrough',
+            steps: [{
+                id: 'step1',
+                title: 'Step 1',
+                description: 'First step',
+                completionEvents: ['onCommand:my.command']
+            }]
+        }]);
+
+        expect(result).to.not.be.undefined;
+        expect(result).to.have.lengthOf(1);
+        expect(result![0].id).to.equal('my-walkthrough');
+        expect(result![0].title).to.equal('My Walkthrough');
+        expect(result![0].pluginId).to.equal('test-publisher.test-plugin');
+        expect(result![0].steps).to.have.lengthOf(1);
+        expect(result![0].steps[0].id).to.equal('step1');
+        expect(result![0].steps[0].completionEvents).to.deep.equal(['onCommand:my.command']);
+    });
+
+    it('should skip walkthroughs with missing id', () => {
+        const result = callReadWalkthroughs([{
+            id: '',
+            title: 'No ID Walkthrough',
+            description: 'Missing id',
+            steps: []
+        }]);
+
+        expect(result).to.be.undefined;
+    });
+
+    it('should skip walkthroughs with missing title', () => {
+        const result = callReadWalkthroughs([{
+            id: 'valid-id',
+            title: '',
+            description: 'Missing title',
+            steps: []
+        }]);
+
+        expect(result).to.be.undefined;
+    });
+
+    it('should skip walkthrough steps with missing id', () => {
+        const result = callReadWalkthroughs([{
+            id: 'wt1',
+            title: 'WT1',
+            description: 'desc',
+            steps: [
+                { id: '', title: 'Step', description: 'desc' },
+                { id: 'valid-step', title: 'Valid Step', description: 'desc' }
+            ]
+        }]);
+
+        expect(result).to.have.lengthOf(1);
+        expect(result![0].steps).to.have.lengthOf(1);
+        expect(result![0].steps[0].id).to.equal('valid-step');
+    });
+
+    it('should return undefined when no walkthroughs are contributed', () => {
+        const pkg = { name: 'test', publisher: 'pub', contributes: {} } as any;
+        const result = (scannerInstance as any).readWalkthroughs(pkg);
+        expect(result).to.be.undefined;
+    });
+
+    it('should read multiple walkthroughs', () => {
+        const result = callReadWalkthroughs([
+            {
+                id: 'wt1',
+                title: 'Walkthrough 1',
+                description: 'First',
+                steps: [{ id: 's1', title: 'S1', description: 'd1' }]
+            },
+            {
+                id: 'wt2',
+                title: 'Walkthrough 2',
+                description: 'Second',
+                steps: [{ id: 's2', title: 'S2', description: 'd2' }]
+            }
+        ]);
+
+        expect(result).to.have.lengthOf(2);
+        expect(result![0].id).to.equal('wt1');
+        expect(result![1].id).to.equal('wt2');
+    });
+
+    it('should preserve walkthrough optional fields', () => {
+        const result = callReadWalkthroughs([{
+            id: 'wt-full',
+            title: 'Full Walkthrough',
+            description: 'Full desc',
+            steps: [{
+                id: 's1',
+                title: 'S1',
+                description: 'step desc',
+                when: 'isLinux',
+                media: { markdown: 'content.md' },
+                completionEvents: ['onCommand:test']
+            }],
+            when: 'workspacePlatform == linux',
+            icon: 'book'
+        }]);
+
+        expect(result).to.have.lengthOf(1);
+        expect(result![0].when).to.equal('workspacePlatform == linux');
+        expect(result![0].icon).to.equal('book');
+        expect(result![0].steps[0].when).to.equal('isLinux');
+        expect(result![0].steps[0].media).to.deep.equal({ markdown: 'hostedPlugin/test_publisher_test_plugin/content.md' });
+    });
+
+    it('should lowercase pluginId', () => {
+        const result = callReadWalkthroughs([{
+            id: 'wt1',
+            title: 'WT',
+            description: 'desc',
+            steps: [{ id: 's1', title: 'S1', description: 'd1' }]
+        }], 'MyPublisher', 'MyPlugin');
+
+        expect(result).to.have.lengthOf(1);
+        expect(result![0].pluginId).to.equal('mypublisher.myplugin');
+    });
+
+    it('should resolve media image paths through toPluginUrl', () => {
+        const result = callReadWalkthroughs([{
+            id: 'wt1',
+            title: 'WT',
+            description: 'desc',
+            steps: [{
+                id: 's1',
+                title: 'S1',
+                description: 'd1',
+                media: { image: 'media/image.png' }
+            }]
+        }]);
+
+        expect(result).to.have.lengthOf(1);
+        expect(result![0].steps[0].media).to.deep.equal({ image: 'hostedPlugin/test_publisher_test_plugin/media/image.png' });
+    });
+
+    it('should keep the alt text of svg media', () => {
+        const result = callReadWalkthroughs([{
+            id: 'wt1',
+            title: 'WT',
+            description: 'desc',
+            steps: [{
+                id: 's1',
+                title: 'S1',
+                description: 'd1',
+                media: { svg: 'media/icon.svg', altText: 'An icon' }
+            }]
+        }]);
+
+        expect(result![0].steps[0].media).to.deep.equal({
+            svg: 'hostedPlugin/test_publisher_test_plugin/media/icon.svg',
+            altText: 'An icon'
+        });
+    });
+
+    it('should resolve media svg paths through toPluginUrl', () => {
+        const result = callReadWalkthroughs([{
+            id: 'wt1',
+            title: 'WT',
+            description: 'desc',
+            steps: [{
+                id: 's1',
+                title: 'S1',
+                description: 'd1',
+                media: { svg: 'media/icon.svg' }
+            }]
+        }]);
+
+        expect(result).to.have.lengthOf(1);
+        expect(result![0].steps[0].media).to.deep.equal({ svg: 'hostedPlugin/test_publisher_test_plugin/media/icon.svg' });
+    });
+});