catbag / redux-android-sample

A Android sample that implements Redux architecture with React and NoSQL

redux-android-sample

An Android sample that implements Redux architecture (using Fluxxan and Anvil) and NoSQL (using SnappyDB)

Architecture

#App State Example

{
    hasMoreGifs: true,
    gifs: [{
        path: "path",
        url: "url",
        title: "string",
        watched: false,
        status: PAUSED //PAUSED, LOOPING, DOWNLOADING, DOWNLOADED, NOT_DOWNLOADED, DOWNLOAD_FAILED
    }]
}

#Tests

• Testing fundamentals
• Tests The Android Way
• Espresso Test Life Cycle
• Tests with Espresso, Mockito, Dagger 2
• Espresso Tutorial
• Roboeletric vs Android Test Framework

###Integration tests

• The integration tests are running on top of espresso framework, and using mockito to handle mocks.

To setup a CI or run tests in command line use this command:

adb shell am instrument -w br.com.catbag.gifreduxsample.test/android.support.test.runner.AndroidJUnitRunner

###Unit tests

• The unit tests are running with roboeletric, that is a android test framework with builtin mock capabilities of android sdk. The roboeletric give us the power to run some unit tests with functions from android SDK without the requirement of an emulator running, what results in very fast tests.

To run unit tests through a CI or command line:

./gradlew  clean test --daemon --continue

Drone CI

Running drone build locally

• Install drone CLI

    curl http://downloads.drone.io/drone-cli/drone_linux_amd64.tar.gz | tar zx
   sudo install -t /usr/local/bin drone
  

• Run drone build inside project dir

    drone exec --trusted
  

CI last build reports

• Instrumentation tests
• Unit tests
• Coverage
• PMD
• Findbugs
• Checkstyle (without errors, no page generated)
• Artifacts history

#Good Practices

###Actions Creators

• Pay attention on action creation UI calls that do something async and dispatch action, the main action has to be dispatched before other async created actions, and its not a good practice dispatch two actions on the same synchronous cycle.

CODE INSPECT

How to use

1. Run check task on Gradle Tasks -> verification

2. After this attention on Android Studio Run console or on gradle output if you run on terminal.

3. The reports are inside app/build/reports/tool_name folders. eg. flux-android-sample/app/build/reports/lint

4. The inspect tools custom configurations are inside app/inspect/ folder.

5. Problems found by inspect tools stops the check task.

References

Summary

Checkstyle

FindBugs

PMD

Android Lint

redux-android-sample's Issues

Medium post about redux on android and other related things

Maybe reducers can auto registrate on Fluxxan

Because for every new reducer we have to remember to add them Fluxxan on Application creation.

Capture artifacts generated during builds on drone CI

Change views StageChange listener set/unset local

We don't want views responding state changes after they get out of screen (like activity on pause)

The project have to use dependency injection (tests will be more easy to implement)

If yes...let's go change, this maybe will make testing more easy. We need a discussion about this.

Activate proguard on project because methods limit

Project + dependencies are passing the methods limit of dex

I think your dex file is reached to its maximum method count. Try to use multiDexEnabled true
in your deafault config or try to minmize your playservices from your dependencies. Use only required > packages. Try changing your version or exclude unwanted packages

Create integration tests

• Testing fundamentals
• Tests The Android Way
• Espresso Test Life Cycle
• Tests with Espresso, Mockito, Dagger 2
• Espresso Tutorial
• Roboeletric vs Android Test Framework

Add LeakCanary and Strictmode for development builds

The two above don't run on tests and release (they broke test CI)...but i found some resolutions:

mapbox/mapbox-gl-native#6277
square/leakcanary#143
https://code.tutsplus.com/tutorials/android-best-practices-strictmode--mobile-7581

Go and search more before solve this.

Refactor AnvilRenderListener/AnvilRenderableComponent to manage multiples listeners/componets

Update versions and inspect tools rules

Include rules like pmd:UnusedModifier from http://pmd.sourceforge.net/snapshot/pmd-java/rules/java/unusedcode.html

It's possible to update gradle inspect tools versions: https://discuss.gradle.org/t/how-can-i-upgrade-pmd-version/4866

When AppStateReducer.listUpdated receive a empty gifs the state is changed

change to desirable behavior: if the list is empty return the actual state.

Project stop to fetch gifs from net

We need a control flow inside DataManager to decide when to fetch gifs...or a direct action from user using a gesture or a button on activity

When gif list is loaded some downloaded gifs don't show (or show as shaped color box)

Create tests for flux layer

What the responsability of AppState and pieces of states?

Some UI Tests are not sufiently robust to run conditions

This test for example:

    @Test
    public void whenGifIsDownloadingTest() {
        Gif gif = gifBuilder()
                .status(Gif.Status.DOWNLOADING)
                .build();

        dispatchFakeReduceAction(createStateFromGif(gif));

        /** On activity create the Fluxxan calls onStateChanged synchronously.
         * So isn't required to use idling resources or others wait conditions **/
        mActivityTestRule.launchActivity(new Intent());

        onView(withId(R.id.gif_loading)).check(matches(isDisplayed()));
    }

must be:

    @Test
    public void whenGifIsDownloadingTest() {
        Gif gif = gifBuilder()
                .status(Gif.Status.DOWNLOADING)
                .build();

        dispatchFakeReduceAction(createStateFromGif(gif));

        mActivityTestRule.launchActivity(new Intent());
        
        UiTestLocker locker = new UiTestLocker(getGifComponent(0));
        locker.registerIdlingResource();

        onView(withId(R.id.gif_loading)).check(matches(isDisplayed()));

        locker.unregisterIdlingResource();
    }

All other tests have to be fixed too, including this locker after mActivityTestRule.launchActivity(new Intent());

Espresso waits the activity launch to continue the tests...i make some tests with sleep here, but we have to investigate more...

Move this project from Catbag Drone to Drone.io

Unlimited free builds for public repositories to https://drone.io/

The default/empty values of GifState will be in class declaration?

Implementation of the "before" and "after" methods in the middleware

Currently the events are intercepted before any reduction occurs, to allow more flexibility to the middlewares it would be interesting to implement an after method that would be called after states reduction.

Spread the project on web

Requirements: readme update. Issue #2

• https://android-arsenal.com/contact/suggest
• Redux and Flux sample repositories.
• Medium post
• Friends and colleagues

Add a list of gifs

Persist the app state using a NoSQL DB

Add endless scrolling

https://guides.codepath.com/android/Endless-Scrolling-with-AdapterViews-and-RecyclerView

Create unit tests for Download and DB

Improve the drawable cache on FeedComponent RecyclerView

To avoid keep all those drawables on memory.

Turn all GIF list outside AppState immutable too

The question is...all state "reference" outside AppState Will be immutable too? This will be our pattern?

Default base url inside Retrofit Builder when createApiEndpoint

A default base url and a option to not pass this value on createApiEndpoint, a default_base_url can be company domain, or http://none.com

Compute test coverage report

Given almost any state, the reducers transform to next state without validations

Example:
Initial state: An app state with a not downloaded gif.
When: Receive an action for play.
Then: Change his status to play.
Expected behavior: The status should not change.

Immutable library recommends use Guava immutable collections to avoid data clone

Array attributes are cloned for safety (due to the mutable nature of Java arrays). Collection attributes are backed by Guava immutable collections if Guava is available in on the classpath. Otherwise, they are safely copied and wrapped in unmodifiable collection classes from the standard JDK.

https://immutables.github.io/immutable.html#array-collection-and-map-attributes

Abstract initialState, setState and onStateChange on all anvil renderables view (like react)

Add some explanation about the architecture in README

Change the file header to a more elaborated one

With apache license and the three colaborators until now: @fpbitencourt @niltonvasques and @raulccabreu

Setup a CI process

Refactor retrofit used on FileDownloader

Extract RoutesGenerator from FileDownloader and make a singleton class that will be used by others. Only routes will stay inside FileDownloader and any Retrofit resource.

Make Anvil exposes an listener to be called when render ends

Make a PR directly to Anvil repository

Pass AndroidSudio inspect tool and fix problems

Actually the automatized inspect tools process don't have all desirable rules because lack of configuration and update, so to solve for now a one pass on AndroidStudio inspect and soon resolve issue #72

Pull app state from a REST API

Play/Pause change the gif position on feed

Probably because new immutable nature of gifs map plus not ordered nature of maps, mainly because past map position will not be guaranteed on new map instance.

Add a network layer to pull gifs from Riffsy Web API

Encapsulate glide lib in some component

Move async layer to middleware layer

• Change spy in the architecture chart to middleware
• The persistance layer will be a special middleware that can hear state changes

Clean up Lint Warnings

See the report and go cleaning...
Lint Warnings Report

Refactor GifList RecyclerView tests

• whenLoadGifListWithMultipleItemsTest
• whenScrollDownAndPlayLastItemTest
• whenScrollUpAndPlayFirstItemTest

Activate inspect tools for tests package

Actually they don't run on test packages

Add anvil react library to build a reactive ui

Optmize adapter notifyDataSetChanged to notifyItemChanged on FeedComponent

One option that i think is don't calling adapter.notify when one gif state has change, letting the specific gif manage his change and rendering itself.

But this issue is not so simple.