Skip to content

Commit adaab2f

Browse files
ChlodAlejandroChlodAlejandro
committed
announcements system
1 parent e736fb0 commit adaab2f

12 files changed

+171
-8
lines changed

‎i18n/announcements/en.json

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"deputy.announcement.ues-06-2023.title": "Deputy user experience survey",
3+
"deputy.announcement.ues-06-2023.message": "Help improve Deputy by taking a short survey about your usage of the tool and your experience as a copyright cleanup editor.",
4+
"deputy.announcement.ues-06-2023.survey.label": "Take the survey",
5+
"deputy.announcement.ues-06-2023.survey.title": "Take the survey (opens the survey on LimeSurvey)",
6+
"deputy.announcement.ues-06-2023.learn.label": "Learn more",
7+
"deputy.announcement.ues-06-2023.learn.title": "Learn more about the survey (opens the Wikimedia Meta-Wiki page for this survey)"
8+
}

‎src/Deputy.ts

+8-2
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ import WikiConfiguration from './config/WikiConfiguration';
2424
import Recents from './wiki/Recents';
2525
import util from './util';
2626
import wikiUtil from './wiki/util';
27+
import DeputyAnnouncements from './DeputyAnnouncements';
2728

2829
/**
2930
* The main class for Deputy. Entry point for execution.
@@ -176,8 +177,13 @@ class Deputy {
176177

177178
mw.hook( 'deputy.load' ).fire( this );
178179

179-
// Asynchronously reload wiki configuration.
180-
this.wikiConfig.update().catch( () => { /* silently fail */ } );
180+
// Perform post-load tasks.
181+
await Promise.all( [
182+
// Show announcements (if any)
183+
await DeputyAnnouncements.init( this.config ),
184+
// Asynchronously reload wiki configuration.
185+
this.wikiConfig.update().catch( () => { /* silently fail */ } )
186+
] );
181187
}
182188

183189
/**

‎src/DeputyAnnouncements.ts

+130
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,130 @@
1+
import DeputyLanguage from './DeputyLanguage';
2+
import deputyAnnouncementsEnglish from '../i18n/announcements/en.json';
3+
import deputySharedEnglish from '../i18n/shared/en.json';
4+
import UserConfiguration from './config/UserConfiguration';
5+
import DeputyMessageWidget from './ui/shared/DeputyMessageWidget';
6+
import unwrapWidget from './util/unwrapWidget';
7+
8+
/**
9+
* An announcement. The "Dismiss" option will always be pre-added.
10+
*
11+
* Title, description, and action labels are automatically loaded from
12+
* `i18n/announcements/<lang>.json`. Ensure that the relevant message
13+
* keys are available.
14+
*/
15+
interface Announcement {
16+
actions: { id: string, flags?: string[], action: () => void }[];
17+
}
18+
19+
/**
20+
*
21+
* Deputy announcements
22+
*
23+
* This will be loaded on all standalone modules and on main Deputy.
24+
* Be conservative with what you load!
25+
*
26+
*/
27+
export default class DeputyAnnouncements {
28+
29+
static knownAnnouncements: Record<string, Announcement> = {
30+
'ues-06-2023': {
31+
actions: [
32+
{
33+
id: 'survey',
34+
flags: [ 'primary', 'progressive' ],
35+
action: () => {
36+
open(
37+
'https://hourglass.limesurvey.net/188262',
38+
'_blank'
39+
);
40+
}
41+
},
42+
{
43+
id: 'learn',
44+
flags: [ 'primary' ],
45+
action: () => {
46+
open(
47+
'https://meta.wikimedia.org/wiki/Deputy/Research/Surveys/06-2023',
48+
'_blank'
49+
);
50+
}
51+
}
52+
]
53+
}
54+
};
55+
56+
/**
57+
* Initialize announcements.
58+
* @param config
59+
*/
60+
static async init( config: UserConfiguration ) {
61+
await Promise.all( [
62+
DeputyLanguage.load( 'shared', deputySharedEnglish ),
63+
DeputyLanguage.load( 'announcements', deputyAnnouncementsEnglish )
64+
] );
65+
mw.util.addCSS( '#siteNotice .deputy { text-align: left; }' );
66+
for ( const [ id, announcements ] of Object.entries( this.knownAnnouncements ) ) {
67+
if ( config.core.seenAnnouncements.get().includes( id ) ) {
68+
continue;
69+
}
70+
71+
this.showAnnouncement( config, id, announcements );
72+
}
73+
}
74+
75+
/**
76+
*
77+
* @param config
78+
* @param announcementId
79+
* @param announcement
80+
*/
81+
static showAnnouncement(
82+
config: UserConfiguration,
83+
announcementId: string,
84+
announcement: Announcement
85+
) {
86+
mw.loader.using( [
87+
'oojs-ui-core',
88+
'oojs-ui.styles.icons-interactions'
89+
], () => {
90+
const messageWidget = DeputyMessageWidget( {
91+
classes: [ 'deputy' ],
92+
icon: 'feedback',
93+
// Messages that can be used here:
94+
// * deputy.announcement.<id>.title
95+
title: mw.msg( `deputy.announcement.${announcementId}.title` ),
96+
// Messages that can be used here:
97+
// * deputy.announcement.<id>.message
98+
message: mw.msg( `deputy.announcement.${announcementId}.message` ),
99+
closable: true,
100+
actions: announcement.actions.map( action => {
101+
const button = new OO.ui.ButtonWidget( {
102+
// Messages that can be used here:
103+
// * deputy.announcement.<id>.<action id>.message
104+
label: mw.msg(
105+
`deputy.announcement.${announcementId}.${action.id}.label`
106+
),
107+
// Messages that can be used here:
108+
// * deputy.announcement.<id>.<action id>.title
109+
title: mw.msg(
110+
`deputy.announcement.${announcementId}.${action.id}.title`
111+
),
112+
flags: action.flags ?? []
113+
} );
114+
button.on( 'click', action.action );
115+
return button;
116+
} )
117+
} );
118+
messageWidget.on( 'close', () => {
119+
config.core.seenAnnouncements.set(
120+
[ ...config.core.seenAnnouncements.get(), announcementId ]
121+
);
122+
config.save();
123+
} );
124+
document.getElementById( 'siteNotice' ).appendChild(
125+
unwrapWidget( messageWidget )
126+
);
127+
} );
128+
}
129+
130+
}

‎src/DeputyLanguage.ts

+8
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,14 @@ export default class DeputyLanguage {
7171
return;
7272
}
7373

74+
if ( mw.loader.getState( 'moment' ) !== 'ready' ) {
75+
// moment.js is not yet loaded.
76+
console.warn(
77+
'Deputy tried loading moment.js locales but moment.js is not yet ready.'
78+
);
79+
return;
80+
}
81+
7482
if ( window.moment.locales().indexOf( locale ) !== -1 ) {
7583
// Already loaded.
7684
return;

‎src/config/UserConfiguration.ts

+5-1
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,11 @@ export default class UserConfiguration extends ConfigurationBase {
6767
PortletNameView
6868
>(
6969
generateEnumConfigurationProperties( PortletNameView, PortletNameView.Full )
70-
)
70+
),
71+
seenAnnouncements: new Setting<string[], string[]>( {
72+
defaultValue: [],
73+
displayOptions: { hidden: true }
74+
} )
7175
};
7276
public readonly cci = <const>{
7377
enablePageToolbar: new Setting<boolean, boolean>( {

‎src/modules/ante/CopiedTemplateEditor.ts

-4
Original file line numberDiff line numberDiff line change
@@ -81,10 +81,6 @@ export default class CopiedTemplateEditor extends DeputyModule {
8181
if ( !await super.preInit( deputyAnteEnglish ) ) {
8282
return false;
8383
}
84-
await Promise.all( [
85-
DeputyLanguage.load( 'shared', deputySharedEnglish ),
86-
DeputyLanguage.loadMomentLocale()
87-
] );
8884

8985
if (
9086
// Button not yet appended

‎src/modules/ante/CopiedTemplateEditorStandalone.ts

+2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
import CopiedTemplateEditor from './CopiedTemplateEditor';
22
import Recents from '../../wiki/Recents';
3+
import DeputyAnnouncements from '../../DeputyAnnouncements';
34

45
/**
56
* This function handles CTE loading when Deputy isn't present. When Deputy is not
@@ -16,5 +17,6 @@ import Recents from '../../wiki/Recents';
1617
Recents.save();
1718
window.CopiedTemplateEditor = new CopiedTemplateEditor();
1819
await window.CopiedTemplateEditor.preInit();
20+
await DeputyAnnouncements.init( window.CopiedTemplateEditor.config );
1921

2022
} )( window );

‎src/modules/ia/InfringementAssistant.ts

+5-1
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,9 @@ export default class InfringementAssistant extends DeputyModule {
102102

103103
// Query parameter-based autostart disable (i.e. don't start if param exists)
104104
if ( !/[?&]ia-autostart(=(0|no|false|off)?(&|$)|$)/.test( window.location.search ) ) {
105-
await this.init();
105+
return mw.loader.using( InfringementAssistant.dependencies, async () => {
106+
await this.init();
107+
} );
106108
}
107109
return true;
108110
}
@@ -118,6 +120,7 @@ export default class InfringementAssistant extends DeputyModule {
118120
this.wikiConfig.ia.listingWikitextMatch.get() != null &&
119121
this.wikiConfig.ia.responses.get() != null
120122
) {
123+
await DeputyLanguage.loadMomentLocale();
121124
this.session = new CopyrightProblemsSession();
122125
mw.hook( 'wikipage.content' ).add( ( el: Element[] ) => {
123126
if ( el[ 0 ].classList.contains( 'ia-upgraded' ) ) {
@@ -153,6 +156,7 @@ export default class InfringementAssistant extends DeputyModule {
153156
async openWorkflowDialog(): Promise<void> {
154157
return mw.loader.using( InfringementAssistant.dependencies, async () => {
155158
if ( !this.dialog ) {
159+
await DeputyLanguage.loadMomentLocale();
156160
this.dialog = SinglePageWorkflowDialog( {
157161
page: new mw.Title( mw.config.get( 'wgPageName' ) ),
158162
revid: mw.config.get( 'wgCurRevisionId' )

‎src/modules/ia/InfringementAssistantStandalone.ts

+2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
import InfringementAssistant from './InfringementAssistant';
22
import Recents from '../../wiki/Recents';
3+
import DeputyAnnouncements from '../../DeputyAnnouncements';
34

45
/**
56
* This function handles IA loading when Deputy isn't present. When Deputy is not
@@ -16,5 +17,6 @@ import Recents from '../../wiki/Recents';
1617
Recents.save();
1718
window.InfringementAssistant = new InfringementAssistant();
1819
await window.InfringementAssistant.preInit();
20+
await DeputyAnnouncements.init( window.InfringementAssistant.config );
1921

2022
} )( window );

‎src/modules/ia/ui/ListingActionLink.tsx

+1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ import { h } from 'tsx-dom';
22
import type CopyrightProblemsListing from '../models/CopyrightProblemsListing';
33
import type CopyrightProblemsSession from '../models/CopyrightProblemsSession';
44
import ListingResponsePanel from './ListingResponsePanel';
5+
import DeputyLanguage from '../../../DeputyLanguage';
56

67
/**
78
*

‎src/modules/ia/ui/NewCopyrightProblemsListing.tsx

+1
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ import { CompletionAction } from '../../shared/CompletionAction';
1111
import purge from '../../../wiki/util/purge';
1212
import { blockExit, unblockExit } from '../../../util/blockExit';
1313
import CCICaseInputWidget from './CCICaseInputWidget';
14+
import DeputyLanguage from '../../../DeputyLanguage';
1415

1516
/**
1617
*

‎src/ui/shared/DeputyMessageWidget.tsx

+1
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@ function initDeputyMessageWidget() {
5555
} );
5656
closeButton.on( 'click', () => {
5757
removeElement( unwrapWidget( this ) );
58+
this.emit( 'close' );
5859
} );
5960
actionContainer.appendChild( unwrapWidget( closeButton ) );
6061
}

0 commit comments

Comments
 (0)