Loading offline resource bundles #511

jessiejuachon · 2020-04-15T00:45:19Z

No description provided.

…ation

https://sonarcloud.io/project/issues?id=jessiejuachon-java-client-g11n-java-client&issues=AXDG68NFL24bPpi-pS5s&open=AXDG68NFL24bPpi-pS5s https://sonarcloud.io/project/issues?id=jessiejuachon-java-client-g11n-java-client&issues=AXDG68IGL24bPpi-pS2r&open=AXDG68IGL24bPpi-pS2r Signed-off-by: Jessie <jessiejuachon@gmail.com>

…cache control

Signed-off-by: Jessie <jessiejuachon@gmail.com>

…and return them upstream.

…utAll(null)

…t in order to get a 304 NOT MODIFIED http response

…ne if component locale's cache has expired

…ingleton into g11n-java-client

…using cacheExpiredTime config

…g file. This means max age from server will be used. Setting VIPCfg.cacheExpiredTime to 0 disables caching.

…t need to be maintained.

Xiaochao8 · 2020-04-23T07:49:23Z

src/main/java/com/vmware/vipclient/i18n/base/instances/TranslationMessage.java

@@ -48,6 +49,43 @@ public TranslationMessage() {
        super();
    }

+    public String getMessage(final Locale locale, final String component, final SourceOpt sourceOpt,


Why was this method added?
Aren't we going to remove source-related things out of client SDK?

2 use cases for using source messages:

Source not collected yet
I think in some products, it is acceptable to deploy the product even if source messages have just been added/updated by developers, and available neither in Singleton service (online mode) nor offline bundles. (e.g. VMC deploys every 2 weeks if I am not mistaken. It can have new source strings that are not yet in the SaaS Singleton). In this case, the source message will be displayed.

isPseudo = true

That being said, only these 2 use cases use the source messages. #1 is not even applicable for on-prem products where translations have to be complete before release to production. #2 is not applicable in production.

On the other hand, there is no more source collection!
Also, the fallback mechanism (as seen in the new client workflow) uses the default locale instead of the source messages because the default locale may not be the same as the source locale. The implementation of this fallback mechanism is quite simple (about 10 lines of code in StringService.getString).

Note: I have updated the code with method comments for clarity.

src/main/java/com/vmware/vipclient/i18n/messages/api/opt/local/LocalMessagesOpt.java

src/main/java/com/vmware/vipclient/i18n/util/FormatUtils.java

…more; cleaning up tests; adding comments for javadoc

src/main/java/com/vmware/vipclient/i18n/base/instances/TranslationMessage.java

Xiaochao8 · 2020-04-26T03:48:50Z

src/main/java/com/vmware/vipclient/i18n/base/instances/TranslationMessage.java

+	            if (!source.equals(cachedSrcLocaleMsg) || 
+	            		cachedSrcLocaleMsg == null || cachedSrcLocaleMsg.isEmpty()) {
+	            	return FormatUtils.format(source, sourceOpt.getLocale(), args);
+	            }  


Still need to consider if isPseudo == true?

Question.. why do we need to fetch the actual localized message if isPseudo is true? Isn't isPseudo just to show which keys use the client library? So isn't it enough to wrap the key like @@key@@?

src/main/java/com/vmware/vipclient/i18n/base/instances/TranslationMessage.java

Xiaochao8 · 2020-04-26T03:54:23Z

src/main/java/com/vmware/vipclient/i18n/base/instances/TranslationMessage.java

+
+    		}
+    	}
+    	return FormatUtils.format(message, locale, args);	


Need to consider if adding ConstantsKeys.PSEUDOCHAR2?

Signed-off-by: Jessie <jessiejuachon@gmail.com>

src/main/java/com/vmware/vipclient/i18n/I18nFactory.java

src/main/java/com/vmware/vipclient/i18n/VIPCfg.java

linr211 · 2020-04-28T07:46:49Z

src/main/java/com/vmware/vipclient/i18n/VIPCfg.java

@@ -86,6 +103,10 @@ public static synchronized VIPCfg getInstance() {
        }
        return gcInstance;
    }
+
+    public static synchronized void resetInstance() {


when this function will be called?

See @before in CacheServiceTest.java and OfflineModeTest.java
VipCfg is different for each test so have to reset it.
I see that for other tests, you are manually putting configurations back to original as a workaround.

I will change this.

src/main/java/com/vmware/vipclient/i18n/VIPCfg.java

src/main/java/com/vmware/vipclient/i18n/base/instances/TranslationMessage.java

src/main/java/com/vmware/vipclient/i18n/messages/service/StringService.java

src/main/java/com/vmware/vipclient/i18n/VIPCfg.java

Xiaochao8 · 2020-04-29T10:04:50Z

src/main/java/com/vmware/vipclient/i18n/messages/api/opt/local/LocalMessagesOpt.java

+			path = Paths.get(Thread.currentThread().getContextClassLoader().
+					getResource(path.toString()).toURI());


The path should be relative to current working directory instead of Thread.currentThread().getContextClassLoader(), to make it easy to collect source.
Source collection will make use of config file.

Let's make this change after this PR because it is related to source collection?
Also, source collection will NOT make use of config file.

Xiaochao8 · 2020-04-30T01:07:16Z

src/main/java/com/vmware/vipclient/i18n/I18nFactory.java

@@ -53,6 +53,7 @@ public static synchronized I18nFactory getInstance(VIPCfg cfg) {
        if (factory == null) {
            factory = new I18nFactory(cfg);
        }
+        factory.setCfg(cfg);


Need to remove this?

Xiaochao8 · 2020-04-30T01:09:52Z

src/main/java/com/vmware/vipclient/i18n/VIPCfg.java

+	public void addMsgOriginsQueue(DataSourceEnum dataSource) {
+		this.msgOriginsQueue.add(dataSource);
+	}
+
+	public void setMsgOriginsQueue(List<DataSourceEnum> msgOriginsQueue) {


Remove this 2 methods or make them private?
They don't need to exported.

This is just a standard setter. This can be useful.

src/main/java/com/vmware/vipclient/i18n/base/cache/MessageCacheItem.java

Xiaochao8 · 2020-04-30T01:13:31Z

src/main/java/com/vmware/vipclient/i18n/base/cache/MessageCacheItem.java

+	public synchronized void setCacheItem (MessageCacheItem cacheItem) {
+		// Do not update cacheItem if timestamp is earlier than current. 
+		// An older timestamp comes from an old thread that was blocked.
+		if (cacheItem.getTimestamp() < this.timestamp) 
+			return;


In this logic, we should prevent querying fro server parallelly.

We can leave it if much effort.

Xiaochao8

Try to merge, please.

Dimiss

jessiejuachon and others added 30 commits March 10, 2020 17:00

Loading configuration from the JSON configuration file

f4c1214

Removing code that is not yet ready to be used from the sample applic…

1a4d95e

…ation

Adding a cache properties map to hold cache details such as etag and …

73d85ca

…cache control

Removing white space

2a38107

Signed-off-by: Jessie <jessiejuachon@gmail.com>

Fixing failing unit test

c7f5d4f

Parse headers, response code, response message from an HTTP response …

056891a

…and return them upstream.

Storing response headers in Map of cache properties

a2ba98b

Fixing failing unit test due to NullPointerException when doing Map.p…

17978bd

…utAll(null)

Changes after code review.

6c69170

Removing exception handling for now

41a8aa1

Deprecating VIPCfg.initialize; cleaning up code

dd2455d

Storing the http response code in the cache

e26d372

Using cached etag as if-none-match request header value in the reques…

01ab69e

…t in order to get a 304 NOT MODIFIED http response

Handling 404 response from Singleton service

750c9d2

Using HTTP repsonse's Cache-Control max-age and timestamp to dertermi…

529e5cc

…ne if component locale's cache has expired

Moving constants to URLUtils

b40fcf9

Fixing failing test

fa123f9

Fixing failing code scan

30b2054

Merge branch 'g11n-java-client' into g11n-java-client

0c69787

Cleaning up import in ComponentService,java

ffc0a74

Cleaning up code - caching/expiry

d8450e4

Merge branch 'g11n-java-client' of https://github.com/jessiejuachon/s…

d7f7641

…ingleton into g11n-java-client

Adding tests for new caching workflow; enabling old caching workflow …

0dcd827

…using cacheExpiredTime config

Fixing a failing test

d06adb3

Adding mock server response

48c8558

Removing unused file sampleconfig.json

4e45bed

Changes from code review

6a40dc8

Value of VIPCfg.cacheExpiredTime is -1 when value is not set in confi…

4c3c12d

…g file. This means max age from server will be used. Setting VIPCfg.cacheExpiredTime to 0 disables caching.

Changing a LinkedHashMap to a HashMap because insertion order does no…

7e0d939

…t need to be maintained.

Deprecating methods in TranslationMessage; adding new method getMessage

17bc16c

Xiaochao8 reviewed Apr 23, 2020

View reviewed changes

jessiejuachon added 8 commits April 24, 2020 01:58

Added tests for TranslationMessage.getMessage

15da010

Fixing test

631de86

Fixing test

ffd9adb

Fixing test

c00f7ae

Removing comment field because source collection is not supported any…

d0504c4

…more; cleaning up tests; adding comments for javadoc

Code clean up

79b18d0

Changes from code review

ec9f5db

Code clean up

2e8bd36

Xiaochao8 reviewed Apr 26, 2020

View reviewed changes

jessiejuachon added 4 commits April 26, 2020 15:36

Optional SourceOpt in initialization

4e44a8c

Signed-off-by: Jessie <jessiejuachon@gmail.com>

Fixing test

de5c4ee

Adding comments to code

406cb2a

Adding comment for javadoc

c80696a

linr211 reviewed Apr 28, 2020

View reviewed changes

src/main/java/com/vmware/vipclient/i18n/messages/service/StringService.java Show resolved Hide resolved

linr211 reviewed Apr 28, 2020

View reviewed changes

src/main/java/com/vmware/vipclient/i18n/VIPCfg.java Outdated Show resolved Hide resolved

jessiejuachon added 5 commits April 28, 2020 14:54

Cleaning up code

79d111e

Code clean up

24d8d5d

Fixing test

23e62b6

Removing source message fallback from this PR

369643f

Merge branch 'g11n-java-client' into g11n-java-client

4e67e25

linr211 approved these changes Apr 29, 2020

View reviewed changes

Xiaochao8 suggested changes Apr 29, 2020

View reviewed changes

Xiaochao8 approved these changes Apr 30, 2020

View reviewed changes

Xiaochao8 previously requested changes Apr 30, 2020

View reviewed changes

Xiaochao8 reviewed Apr 30, 2020

View reviewed changes

jessiejuachon merged commit 6bbdad3 into vmware:g11n-java-client Apr 30, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Loading offline resource bundles #511

Loading offline resource bundles #511

jessiejuachon commented Apr 15, 2020

Xiaochao8 Apr 23, 2020

jessiejuachon Apr 23, 2020

Xiaochao8 Apr 26, 2020

jessiejuachon Apr 27, 2020

Xiaochao8 Apr 26, 2020

linr211 Apr 28, 2020

jessiejuachon Apr 28, 2020

jessiejuachon Apr 29, 2020

Xiaochao8 Apr 29, 2020 •

edited by jessiejuachon

Loading

jessiejuachon Apr 29, 2020

Xiaochao8 Apr 30, 2020

jessiejuachon Apr 30, 2020

Xiaochao8 Apr 30, 2020

jessiejuachon Apr 30, 2020

Xiaochao8 Apr 30, 2020

Xiaochao8 Apr 30, 2020

Xiaochao8 left a comment

		path = Paths.get(Thread.currentThread().getContextClassLoader().
		getResource(path.toString()).toURI());

Loading offline resource bundles #511

Loading offline resource bundles #511

Conversation

jessiejuachon commented Apr 15, 2020

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

Xiaochao8 Apr 29, 2020 • edited by jessiejuachon Loading

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

Xiaochao8 left a comment

Choose a reason for hiding this comment

Xiaochao8 Apr 29, 2020 •

edited by jessiejuachon

Loading