Base setup for i18n for server with go-i18n library #782

Kshitij-Katiyar · 2024-05-28T10:18:15Z

Summary

It includes:

Added the go-i18n library v2.
Added sample translation and also en.json file

Fixes #783

mickmister

LGTM, just a suggestion on wording

mickmister · 2024-05-28T13:01:38Z

server/plugin/plugin.go

@@ -95,6 +96,8 @@ type Plugin struct {
 	poster      poster.Poster
 	flowManager *FlowManager

+	b *i18n.Bundle


This names seems a bit cryptic to me. Maybe we can call it localization or i18n? @hanzei Thoughts on this?

Yeah, b isn't quite telling. 2./5 on bundle as i18n is already a library name.

mickmister · 2024-05-28T13:02:52Z

server/plugin/command.go

@@ -609,14 +610,22 @@ func (p *Plugin) handleMe(_ *plugin.Context, _ *model.CommandArgs, _ []string, u
 	return text
 }

-func (p *Plugin) handleHelp(_ *plugin.Context, _ *model.CommandArgs, _ []string, _ *GitHubUserInfo) string {
+func (p *Plugin) handleHelp(_ *plugin.Context, args *model.CommandArgs, _ []string, _ *GitHubUserInfo) string {
+	l := p.b.GetUserLocalizer(args.UserId)
 	message, err := renderTemplate("helpText", p.getConfiguration())


Curious how we can use the translations in the templates?

yeah @mickmister I was trying to find the same thing.

Can we expose functions to call from within the template?

I think this is something we should try and solve before merging the PR. Any question marks we have on how to do things like this should ideally be resolved before contributors go and work on the same sort of things

We can implement this method:

func (p *Plugin) localize(id, other string) string { return p.b.LocalizeWithConfig(l, &i18n.LocalizeConfig{ DefaultMessage: &i18n.Message{ ID: id, Other: other, }, }) }

Then change

mattermost-plugin-github/server/plugin/template.go

Line 38 in e958064

func init() {

to

func (p *Plugin) initTemplates() {

and add a block here

mattermost-plugin-github/server/plugin/template.go

Lines 108 to 116 in e958064

funcMap["commitAuthor"] = func(commit *github.HeadCommit) *github.CommitAuthor {

if showAuthorInCommitNotification {

return commit.GetAuthor()

}

return commit.GetCommitter()

}

masterTemplate = template.Must(template.New("master").Funcs(funcMap).Parse(""))

to

funcMap["i18n"] = p.localize

Then we should be able to use the i18n function in the templates

Hey @mickmister Thanks for the approach above, I tried a bunch of things as stated above but faced several issues.
First of all, there is a huge lack of documentation and resources on the internet regarding Go's text/template and i was not able to find anything which connects the translation and template together. If you have some resources, please share those i would love to deep dive into those.

First of all, When using higher-order functions inside the template directly, it prints the function returned by the parent function instead of trying to run the child function returned with the arguments passed(similar code here dummy code). I also tried storing the child function in a variable and calling it with the arguments, but that didn't work either. (You can have a link here goPlayground)

Secondly, the approach of making the initTemplate a method of the Plugin also didn't work because, during the initialization of the template, the Plugin is null.

Secondly, the approach of making the initTemplate a method of the Plugin also didn't work because, during the initialization of the template, the Plugin is null.

@Kshitij-Katiyar We should be able to call initTemplate during OnActivate to make that work

I'm not sure about the template functions behavior

mickmister · 2024-06-04T00:39:26Z

In order to include localization in templates, we'll need to have the code-operated parts (i.e. markdown link construction) of the message be parameterized into the translation string. We can pass the calculated sub-template calls as a dictionary argument to the localize function

With this in i18n/en.json

{
     "newPullRequestCollapsed": "{{.RepoName}} New pull request {{.PullRequestTitle}} was opened by {{.UserName}}.",
}

func localize(bundle *i18n.Bundle, lang string) func(id string, data map[string]interface{}) string {
    return func(id string, data map[string]interface{}) string {
        localizer := i18n.NewLocalizer(bundle, lang)
        return localizer.MustLocalize(&i18n.LocalizeConfig{
            MessageID:    id,
            TemplateData: data,
        })
    }
}

Then we can change

mattermost-plugin-github/server/plugin/template.go

Line 207 in e958064

    
           {{template "repo" .Event.GetRepo}} New pull request {{template "pullRequest" .Event.GetPullRequest}} was opened by {{template "user" .Event.GetSender}}.

to

{{ localize "newPullRequestCollapsed" dict "RepoName" (template "repo" .Event.GetRepo) "PullRequestTitle" (template "pullRequest" .Event.GetPullRequest) "UserName" (template "user" .Event.GetSender) }}

Or we could instead make local variables in the template like this for potentially better readability, but we'll need to implement an expose a templateToString function to return a string:

{{ $repo := templateToString "repo" .Event.GetRepo }}
{{ $pullRequest := templateToString "pullRequest" .Event.GetPullRequest }}
{{ $user := templateToString "user" .Event.GetSender }}
{{ localize "newPullRequestCollapsed" dict "RepoName" $repo "PullRequestTitle" $pullRequest "UserName" $user }}

hanzei

That is a great starting point!

How can community members contribute to translations? Do we plan to hook the repo up to https://translate.mattermost.com/?

hanzei · 2024-06-27T11:10:45Z

server/plugin/plugin.go

@@ -95,6 +96,8 @@ type Plugin struct {
 	poster      poster.Poster
 	flowManager *FlowManager

+	b *i18n.Bundle


Yeah, b isn't quite telling. 2./5 on bundle as i18n is already a library name.

Kshitij-Katiyar requested review from hanzei and mickmister as code owners May 28, 2024 10:18

Base setup for i18n for server with go-i18n library

8e398e5

Kshitij-Katiyar force-pushed the base_setup_i18n_server branch from 7dad047 to 8e398e5 Compare May 28, 2024 10:38

mickmister approved these changes May 28, 2024

View reviewed changes

mickmister mentioned this pull request Jun 3, 2024

Implement server-side localization for the plugin #783

Open

hanzei added the 2: Dev Review Requires review by a core committer label Jun 27, 2024

hanzei approved these changes Jun 27, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Base setup for i18n for server with go-i18n library #782

Base setup for i18n for server with go-i18n library #782

Kshitij-Katiyar commented May 28, 2024 •

edited by mickmister

Loading

mickmister left a comment

mickmister May 28, 2024

hanzei Jun 27, 2024

mickmister May 28, 2024

Kshitij-Katiyar May 28, 2024

mickmister May 30, 2024

mickmister May 31, 2024

mickmister Jun 3, 2024

Kshitij-Katiyar Jun 24, 2024 •

edited

Loading

mickmister Jul 8, 2024

mickmister commented Jun 4, 2024

hanzei left a comment

hanzei Jun 27, 2024

	funcMap["commitAuthor"] = func(commit github.HeadCommit) github.CommitAuthor {
	if showAuthorInCommitNotification {
	return commit.GetAuthor()
	}

	return commit.GetCommitter()
	}

	masterTemplate = template.Must(template.New("master").Funcs(funcMap).Parse(""))

Base setup for i18n for server with go-i18n library #782

Are you sure you want to change the base?

Base setup for i18n for server with go-i18n library #782

Conversation

Kshitij-Katiyar commented May 28, 2024 • edited by mickmister Loading

Summary

mickmister left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Kshitij-Katiyar Jun 24, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mickmister commented Jun 4, 2024

hanzei left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Kshitij-Katiyar commented May 28, 2024 •

edited by mickmister

Loading

Kshitij-Katiyar Jun 24, 2024 •

edited

Loading